Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
1 of 2 tasks
aBurmeseDev opened this issue Jan 30, 2025 · 0 comments
Open
1 of 2 tasks
Assignees
Labels
feature-request New feature or enhancement. May require GitHub community feedback. p2 This is a standard priority issue

Comments

@aBurmeseDev
Copy link
Member

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

@aBurmeseDev aBurmeseDev added feature-request New feature or enhancement. May require GitHub community feedback. needs-triage This issue or PR still needs to be triaged. labels Jan 30, 2025
@aBurmeseDev aBurmeseDev self-assigned this Jan 30, 2025
@aBurmeseDev aBurmeseDev added p2 This is a standard priority issue and removed needs-triage This issue or PR still needs to be triaged. labels Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request New feature or enhancement. May require GitHub community feedback. p2 This is a standard priority issue
Projects
None yet
Development

No branches or pull requests

1 participant