Skip to content

(API Reference Docs) Client Config in code examples lacks reference #6858

Open
@aBurmeseDev

Description

@aBurmeseDev

Describe the feature

Every code example in service client page in API reference docs has this line for client config but it's not clear as to what goes into (config) for users that are new to SDK.

const client = new S3Client(config);
Image

Here's developer guide that explains everything about client config that a user could refer to: https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/configuring-the-jssdk.html

Use Case

Previously asked by users:

Proposed Solution

Add a comment in code example users can reference.

Other Information

No response

Acknowledgements

  • I may be able to implement this feature request
  • This feature might incur a breaking change

SDK version used

v3

Environment details (OS name and version, etc.)

Node

Metadata

Metadata

Assignees

Labels

documentationThis is a problem with documentation.feature-requestNew feature or enhancement. May require GitHub community feedback.p2This is a standard priority issue

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions