# SetSecurityTokenServicePreferences
<a name="API_SetSecurityTokenServicePreferences"></a>

Sets the specified version of the global endpoint token as the token version used for the Amazon Web Services account.

By default, Amazon Security Token Service (Amazon STS) is available as a global service, and all Amazon STS requests go to a single endpoint at `https://sts.amazonaws.com`. Amazon recommends using Regional Amazon STS endpoints to reduce latency, build in redundancy, and increase session token availability. For information about Regional endpoints for Amazon STS, see [Amazon Security Token Service endpoints and quotas](https://docs.amazonaws.cn/general/latest/gr/sts.html) in the * Amazon General Reference*.

If you make an Amazon 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 Amazon Web Services 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 Amazon STS in an Amazon Web Services Region](https://docs.amazonaws.cn/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the *IAM User Guide*.

To view the current session token version, see the `GlobalEndpointTokenVersion` entry in the response of the [GetAccountSummary](https://docs.amazonaws.cn/IAM/latest/APIReference/API_GetAccountSummary.html) operation.

## Request Parameters
<a name="API_SetSecurityTokenServicePreferences_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** GlobalEndpointTokenVersion **   
The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services 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 Amazon STS in an Amazon Web Services Region](https://docs.amazonaws.cn/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the *IAM User Guide*.  
Type: String  
Valid Values: `v1Token | v2Token`   
Required: Yes

## Errors
<a name="API_SetSecurityTokenServicePreferences_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ServiceFailure **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

## Examples
<a name="API_SetSecurityTokenServicePreferences_Examples"></a>

### Example
<a name="API_SetSecurityTokenServicePreferences_Example_1"></a>

This example illustrates one usage of SetSecurityTokenServicePreferences.

#### Sample Request
<a name="API_SetSecurityTokenServicePreferences_Example_1_Request"></a>

```
https://iam.amazonaws.com/?Action=SetSecurityTokenServicePreferences
&GlobalEndpointTokenVersion=v2Token
&Version=2010-05-08
&AUTHPARAMS
```

#### Sample Response
<a name="API_SetSecurityTokenServicePreferences_Example_1_Response"></a>

```
<SetSecurityTokenServicePreferences xmlns="https://iam.amazonaws.com/doc/2010-05-08/">
  <ResponseMetadata>
    <RequestId>31a241af-1ebc-12b4-9d0d-8f876EXAMPLE</RequestId>
  </ResponseMetadata>
</SetSecurityTokenServicePreferences>
```

## See Also
<a name="API_SetSecurityTokenServicePreferences_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/iam-2010-05-08/SetSecurityTokenServicePreferences) 
+  [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/iam-2010-05-08/SetSecurityTokenServicePreferences) 
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/iam-2010-05-08/SetSecurityTokenServicePreferences) 
+  [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/iam-2010-05-08/SetSecurityTokenServicePreferences) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/iam-2010-05-08/SetSecurityTokenServicePreferences) 
+  [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/iam-2010-05-08/SetSecurityTokenServicePreferences) 
+  [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/iam-2010-05-08/SetSecurityTokenServicePreferences) 
+  [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/iam-2010-05-08/SetSecurityTokenServicePreferences) 
+  [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/iam-2010-05-08/SetSecurityTokenServicePreferences) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/iam-2010-05-08/SetSecurityTokenServicePreferences)