Skip to content

Update CreateBucketCommand documentation to clarify client usage #6633

@willsp

Description

@willsp

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/

Metadata

Metadata

Assignees

Labels

documentationThis is a problem with documentation.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