Document sigv4a signing region set #4306
Merged
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
aemous
reviewed
Oct 16, 2024
docs/source/guide/configuration.rst
Outdated
| @@ -232,6 +232,11 @@ You can set configuration settings using system-wide environment variables. Thes | |||
| When set it will be appended to the User-Agent header of every request | |||
| in the form of App/{AppId}. | |||
|
|
|||
| ``AWS_SIGV4A_SIGNING_REGION_SET`` | |||
| A comma delimited list of regions to sign when singing with SigV4a. For more information, | |||
There was a problem hiding this comment.
nit: 'comma delimited' -> 'comma-delimited'
typo: 'singing' -> 'signing'
docs/source/guide/configuration.rst
Outdated
| @@ -466,6 +471,10 @@ in the ``~/.aws/config`` file. | |||
| functionality of ``standard`` mode with automatic client-side | |||
| throttling. This is a provisional mode whose behavior might change. | |||
|
|
|||
| ``sigv4a_signing_region_set`` | |||
| A comma delimited list of regions use when signing with SigV4a. If this is not set, | |||
docs/source/guide/configuration.rst
Outdated
| @@ -466,6 +471,10 @@ in the ``~/.aws/config`` file. | |||
| functionality of ``standard`` mode with automatic client-side | |||
| throttling. This is a provisional mode whose behavior might change. | |||
|
|
|||
| ``sigv4a_signing_region_set`` | |||
| A comma delimited list of regions use when signing with SigV4a. If this is not set, | |||
| the SDK will check if the service has modeled a default; if none is found, this will | |||
There was a problem hiding this comment.
suggestion: 'If this is not set, the SDK will use a default value modeled by the service, if any; if no default value is provided by the service, this will default to *, which indicates the request is valid in all regions.'
nateprewitt
approved these changes
Oct 16, 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.
Add documentation for sigv4a signing region set configuration variables