[Documentation] Warning against the use of S3 Global Endpoint (s3.amazonaws.com) as endpoint-url #9850
Conversation
This file contains hidden or 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
Add warning to S3 configuration documentation advising users to avoid using s3.amazonaws.com as the --endpoint-url parameter value to prevent PermanentRedirect errors and configuration confusion. This addresses user issues where setting the global S3 endpoint as a custom endpoint URL causes redirect loops and unexpected behavior. Addresses aws#9479
Add warning to S3 configuration docs advising against using the global S3 endpoint (s3.amazonaws.com) as --endpoint-url parameter value to prevent PermanentRedirect errors and other unwanted behaviors/errors from S3 Addresses aws#9479
adev-code
changed the title
kdaily
requested changes
Nov 18, 2025
awscli/topics/s3-config.rst
Outdated
| for performance reasons or to account for the specific environment where these | ||
| ``aws s3`` commands are being run. | ||
|
|
||
| .. warning:: |
Member
There was a problem hiding this comment.
I would move this into the "Configuration Values" section as a general comment, not a warning.
awscli/topics/s3-config.rst
Outdated
|
|
||
| .. warning:: | ||
| S3 commands have a parameter ``--endpoint-url`` that overrides the command's | ||
| default URL with the given URL. Avoid using the S3 Global Endpoint |
Member
There was a problem hiding this comment.
I think we could be a bit more general here and just say you should avoid configuring the endpoint URL at all when using the AWS S3 service? Generally endpoint URL is only going to be needed for 3P endpoints when using S3.
Member
|
This might be a good place to point customers to: https://docs.aws.amazon.com/sdkref/latest/guide/feature-ss-endpoints.html |
Move endpoint-url warning from warning block to note format and relocate to appropriate section based on code review feedback. Add reference to AWS service-specific endpoints documentation. Addresses aws#9479 Refactor the S3 endpoint-url guidance based on review feedback: - Change from warning block to note format - Add reference to official AWS service-specific endpoints guide - Improve clarity of when to use endpoint-url with appropriate actions - Maintain focus on preventing redirect issues and unintended behavior This addresses the original issue while incorporating reviewer suggestions for better placement and formatting of the guidance.
Improved clarity and readability of the endpoint_url parameter documentation for S3 commands.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Adds documentation improvements to S3 configuration documentation (in the AWS CLI) for the --endpoint-url parameter:
Warning against S3 Global endpoint: Advises users to avoid using
https://s3.amazonaws.comorhttp://s3.amazonaws.comas the --endpoint-url parameter value, as it can cause PermanentRedirect errors and configuration confusion.General endpoint_url guidance: Adds a note explaining the --endpoint-url parameter usage, including caution about S3 unintended behavior such as S3 redirect issues. References the AWS SDK reference guide for additional endpoint configuration information.
Testing
• [x] Documentation builds successfully with make html
• [x] Warning and note display correctly in generated docs
Addresses #9479