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

docs guide/configuration.rst: use_dualstack_endpoint only says S3 #4387

Open
ppena-LiveData opened this issue Jan 10, 2025 · 1 comment
Open
Assignees
Labels
documentation This is a problem with documentation. endpoints feature-request This issue requests a feature. p3 This is a minor priority issue response-requested Waiting on additional information or feedback.

Comments

@ppena-LiveData
Copy link

Describe the issue

The documentation in docs/source/guide/configuration.rst for use_dualstack_endpoint says this:

use_dualstack_endpoint: Specifies whether to direct all Amazon S3 requests to the dual IPv4/IPv6 endpoint for the configured Region.

But there are other AWS Services that supply dual stack endpoints. Please correct the documentation and direct the user to other documentation where they can learn more, e.g. these:

Links

https://github.com/boto/boto3/blob/28fc5bb15bc8c3abd59810290bf04912851f1f55/docs/source/guide/configuration.rst?plain=1#L399C1-L400C73

@ppena-LiveData ppena-LiveData added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Jan 10, 2025
@RyanFitzSimmonsAK RyanFitzSimmonsAK self-assigned this Jan 14, 2025
@RyanFitzSimmonsAK RyanFitzSimmonsAK added feature-request This issue requests a feature. endpoints investigating This issue is being investigated and/or work is in progress to resolve the issue. p3 This is a minor priority issue and removed needs-triage This issue or PR still needs to be triaged. labels Jan 14, 2025
@RyanFitzSimmonsAK
Copy link
Contributor

Hi @ppena-LiveData, thanks for reaching out. In this case, use_dualstack_endpoint actually is an S3-specific configuration option. From the documentation you referenced,

The s3 settings are nested configuration values that require special formatting in the AWS configuration file. If the values are set by the AWS CLI or programmatically by an SDK, the formatting is handled automatically. If you set them manually by editing the AWS configuration file, the following is the required format. Notice the indentation of each value.

If you wanted to use this option, it'd look something like this.

[default]
region = us-west-2
output = json
s3 = 
	use_dualstack_endpoint = True

For other services, you're intended to specify a dualstack endpoint with --endpoint-url. Please let me know if you have any follow-up questions.

@RyanFitzSimmonsAK RyanFitzSimmonsAK added response-requested Waiting on additional information or feedback. and removed investigating This issue is being investigated and/or work is in progress to resolve the issue. labels Jan 14, 2025
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. endpoints feature-request This issue requests a feature. p3 This is a minor priority issue response-requested Waiting on additional information or feedback.
Projects
None yet
Development

No branches or pull requests

2 participants