Account-based endpoints - Amazon SDKs and Tools
Support by Amazon SDKs and tools
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Account-based endpoints

Note

For help in understanding the layout of settings pages, or in interpreting the Support by Amazon SDKs and tools table that follows, see Understanding the settings pages of this guide.

Account-based endpoints help ensure high performance and scalability by using your Amazon Web Services account ID to route requests for services that support this feature. When you use an Amazon SDK and service that support account-based endpoints, the SDK client constructs and uses an account-based endpoint rather than a regional endpoint. If the account ID isn't visible to the SDK client, the client will use the regional endpoint. Account-based endpoints take the form of https://<account-id>.ddb.<region>.amazonaws.com, where <account-id> and <region> are your Amazon Web Services account ID and Amazon Web Services Region.

Configure this functionality by using the following:

aws_account_id - shared Amazon config file setting
AWS_ACCOUNT_ID - environment variable
aws.accountId - JVM system property: Java/Kotlin only

The Amazon Web Services account ID. Used for account-based endpoint routing. An Amazon Web Services account ID has a format like 111122223333.

Account-based endpoint routing provides better request performance for some services.

account_id_endpoint_mode - shared Amazon config file setting
AWS_ACCOUNT_ID_ENDPOINT_MODE - environment variable
aws.accountIdEndpointMode - JVM system property: Java/Kotlin only

This setting is used to turn off account-based endpoint routing if necessary, and bypass account-based rules.

Default value: preferred

Valid values:

  • preferred – The endpoint should include account ID if available.

  • disabled – A resolved endpoint doesn't include account ID.

  • required – The endpoint must include account ID. If the account ID isn't available, the SDK throws an error.

Support by Amazon SDKs and tools

The following SDKs support the features and settings described in this topic. Any partial exceptions are noted. Any JVM system property settings are supported by the Amazon SDK for Java and the Amazon SDK for Kotlin only.

SDK Supported Released in SDK version Notes or more information
Amazon CLI v2 Yes 2.25.0
Amazon CLI v1 Yes 1.38.0
SDK for C++ No
SDK for Go V2 (1.x) Yes v1.35.0
SDK for Go 1.x (V1) No
SDK for Java 2.x Yes v2.28.4
SDK for Java 1.x Yes v1.12.771
SDK for JavaScript 3.x Yes v3.656.0
SDK for JavaScript 2.x No
SDK for Kotlin Yes v1.3.37
SDK for .NET 4.x Yes 4.0.0
SDK for .NET 3.x No
SDK for PHP 3.x Yes v3.318.0
SDK for Python (Boto3) Yes 1.37.0
SDK for Ruby 3.x Yes v1.123.0
SDK for Rust No
SDK for Swift Yes 1.2.0
Tools for PowerShell No