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

Add link or example code to set regional endpoint to STS / Client / assume_root #4378

Open
lmaeffw opened this issue Dec 18, 2024 · 1 comment
Assignees
Labels
documentation This is a problem with documentation. feature-request This issue requests a feature. p2 This is a standard priority issue response-requested Waiting on additional information or feedback.

Comments

@lmaeffw
Copy link

lmaeffw commented Dec 18, 2024

Describe the issue

Looking at the API information page of [STS] / Client / assume_root
It requires more in depth search flipping through links to complete the prerequisite of setting regional endpoint for users to use the API AssumeRoot. Within the Note that warns "The global endpoint is not supported for AssumeRoot" can we add a link that directs [2] Manage AWS STS in an AWS Region - Writing code to use AWS STS Regions.
Customer enquired to add documentation for easier visibility as well as the code they had to write to enable regional endpoint from the following:
os.environ['AWS_STS_REGIONAL_ENDPOINTS'] = 'regional'

Links

[1] https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sts.html
[2] https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html#id_credentials_temp_enable-regions_writing_code

@lmaeffw lmaeffw added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Dec 18, 2024
@tim-finnigan tim-finnigan self-assigned this Dec 19, 2024
@tim-finnigan
Copy link
Contributor

Thanks for reaching out. User Guide pages like the one you referenced must be updated directly by service team doc writers. You can use the Provide feedback links at the bottom of those pages to send feedback to the appropriate team.

For Boto3 this is documented here: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html

image

Is that sufficient or did you think more should be added? For Boto3 code examples specifically maybe something could be added here: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/examples.html.

@tim-finnigan tim-finnigan added feature-request This issue requests a feature. response-requested Waiting on additional information or feedback. p2 This is a standard priority issue and removed needs-triage This issue or PR still needs to be triaged. labels Dec 19, 2024
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. feature-request This issue requests a feature. p2 This is a standard priority issue response-requested Waiting on additional information or feedback.
Projects
None yet
Development

No branches or pull requests

2 participants