update the documentation for creating s3 bucket to address the region mismatch issue. #4337
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jonathan343
reviewed
Nov 11, 2024
There was a problem hiding this comment.
I feel like this warning makes this example confusing for most users following this guide. As a user, I would just want to follow an example that works and worry less about the nuance of creating buckets.
Why don't we simplify the example function to set a default region value ofus-east-1 if not provided by the user? We would eliminate the if region is None conditional and always create the client in the same region as what we set for the LocationConstraint.
nateprewitt
reviewed
Nov 11, 2024
nateprewitt
approved these changes
Nov 12, 2024
jonathan343
requested changes
Nov 12, 2024
jonathan343
reviewed
Nov 12, 2024
jonathan343
reviewed
Nov 12, 2024
jonathan343
approved these changes
Nov 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds documentation for an issue that results in
IllegalLocationConstraintExceptionerror when a user tries to create a bucket in a region that's different from the region in their configuration. By default, s3 creates a bucket inus-east-1if the region isn't defined in LocationConstraint, and if the region in user's configuration isn't set tous-east-1, its throws an error. This PR warns the users about this issue and provides them with options to prevent this.