SetSecurityTokenServicePreferences
Sets the specified version of the global endpoint token as the token version used for the AWS account.
By default, AWS Security Token Service (AWS STS) is available as a global service, and all AWS STS requests
go to a single endpoint at https://sts.amazonaws.com. AWS recommends
using Regional AWS STS endpoints to reduce latency, build in redundancy, and increase
session token availability. For information about Regional endpoints for AWS STS, see
AWS Security Token Service
endpoints and quotas in the
AWS General Reference.
If you make an AWS STS call to the global endpoint, the resulting session tokens might be valid in some Regions but not others. It depends on the version that is set in this operation. Version 1 tokens are valid only in AWS Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens. For information, see Activating and deactivating AWS STS in an AWS Region in the IAM User Guide.
To view the current session token version, see the
GlobalEndpointTokenVersion entry in the response of the GetAccountSummary operation.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- GlobalEndpointTokenVersion
-
The version of the global endpoint token. Version 1 tokens are valid only in AWS Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens.
For information, see Activating and deactivating AWS STS in an AWS Region in the IAM User Guide.
Type: String
Valid Values:
v1Token | v2TokenRequired: Yes
Errors
For information about the errors that are common to all actions, see Common Errors.
- ServiceFailure
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
Examples
Example
This example illustrates one usage of SetSecurityTokenServicePreferences.
Sample Request
https://iam.amazonaws.com/?Action=SetSecurityTokenServicePreferences
&GlobalEndpointTokenVersion=v2Token
&Version=2010-05-08
&AUTHPARAMSSample Response
<SetSecurityTokenServicePreferences xmlns="https://iam.amazonaws.com/doc/2010-05-08/">
<ResponseMetadata>
<RequestId>31a241af-1ebc-12b4-9d0d-8f876EXAMPLE</RequestId>
</ResponseMetadata>
</SetSecurityTokenServicePreferences>See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
