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

Update CreateBucketCommand documentation to clarify client usage #6633

Open
willsp opened this issue Nov 6, 2024 · 3 comments
Open

Update CreateBucketCommand documentation to clarify client usage #6633

willsp opened this issue Nov 6, 2024 · 3 comments
Assignees
Labels
documentation This is a problem with documentation. p2 This is a standard priority issue

Comments

@willsp
Copy link

willsp commented Nov 6, 2024

Describe the issue

Describe the documentation update
The documentation for the CreateBucketCommand in the S3 JavaScript client should be updated to include important information about client usage.

Proposed changes

  1. Add a note emphasizing that using regional clients is preferred over the global client when creating buckets.
  2. Include a warning that creating buckets in opt-in regions using the global client is not supported.

Suggested location for the update
These additions should be placed in a prominent position within the CreateBucketCommand documentation, preferably near the top of the page or in a "Best Practices" or "Important Notes" section.

Rationale
This information is crucial for developers to understand the best practices and limitations when using the CreateBucketCommand, especially in different AWS regions.

Thank you for considering this documentation update.

Links

https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/CreateBucketCommand/

@willsp willsp added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Nov 6, 2024
@zshzbh zshzbh self-assigned this Nov 6, 2024
@zshzbh zshzbh added p2 This is a standard priority issue queued This issues is on the AWS team's backlog and removed needs-triage This issue or PR still needs to be triaged. labels Nov 7, 2024
@zshzbh
Copy link
Contributor

zshzbh commented Nov 7, 2024

@zshzbh zshzbh added response-requested Waiting on additional info and feedback. Will move to \"closing-soon\" in 7 days. and removed queued This issues is on the AWS team's backlog labels Nov 7, 2024
@zshzbh
Copy link
Contributor

zshzbh commented Nov 7, 2024

I will create a ticket to the service team to ask them update the doc.

Thanks!

@github-actions github-actions bot removed the response-requested Waiting on additional info and feedback. Will move to \"closing-soon\" in 7 days. label Nov 8, 2024
@zshzbh
Copy link
Contributor

zshzbh commented Nov 8, 2024

Since this thread is public, I also want to clarify -

Amazon S3 creates buckets in a Region that you specify. Amazon S3 supports global buckets, which means that each bucket name must be unique across all AWS accounts in all the AWS Regions within a partition. A partition is a grouping of Regions. AWS currently has three partitions: aws (Standard Regions), aws-cn (China Regions), and aws-us-gov (AWS GovCloud (US)).

After a bucket is created, the name of that bucket cannot be used by another AWS account in the same partition until the bucket is deleted.Ref

So you can only create a s3 bucket with a specific region instead of a global s3 bucket.

The global client mentioned in this issue referred to this part

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation. p2 This is a standard priority issue
Projects
None yet
Development

No branches or pull requests

2 participants