Skip to content

[S3 DOCS] Example for AWS.S3 use "params" not documented #440

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

Closed
mfn opened this issue Dec 14, 2014 · 3 comments
Closed

[S3 DOCS] Example for AWS.S3 use "params" not documented #440

mfn opened this issue Dec 14, 2014 · 3 comments
Labels
documentation This is a problem with documentation.

Comments

@mfn
Copy link

mfn commented Dec 14, 2014

The examples on http://docs.aws.amazon.com/AWSJavaScriptSDK/guide/browser-examples.html use

  var bucket = new AWS.S3({params: {Bucket: 'myBucket'}});

But looking at the document for it, the purpose of params isn't documented: http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#constructor-property

@lsegal
Copy link
Contributor

lsegal commented Dec 15, 2014

Thanks for reporting this. Looks like the params config option is missing from services. For what it's worth, you can find docs on this option in the Bound Parameters section of the guide.

@lsegal lsegal added the documentation This is a problem with documentation. label Dec 15, 2014
@lsegal lsegal closed this as completed in 0dd8df7 Dec 15, 2014
@lsegal
Copy link
Contributor

lsegal commented Dec 15, 2014

I just added the params option to service config docs-- that doc update will be in our next release. Thanks for reporting this missing option.

AdityaManohar added a commit that referenced this issue Dec 17, 2014
@lock
Copy link

lock bot commented Sep 30, 2019

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.

@lock lock bot locked as resolved and limited conversation to collaborators Sep 30, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation This is a problem with documentation.
Projects
None yet
Development

No branches or pull requests

2 participants