Application ID - 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).

Application ID

A single Amazon Web Services account can be used by multiple customer applications to make calls to Amazon Web Services. Application ID provides a way for customers to identify which source application made a set of calls using an Amazon Web Services account. Amazon SDKs and services don't use or interpret this value other than to surface it back in customer communications. For example, this value can be included in operational emails or in the Amazon Health Dashboard to uniquely identify which of your applications is associated with the notification.

Configure this functionality by using the following:

sdk_ua_app_id - shared Amazon config file setting
AWS_SDK_UA_APP_ID - environment variable
aws.userAgentAppId - JVM system property: Java/Kotlin only

This setting is a unique string you assign to your application to identify which of your applications within a particular Amazon Web Services account makes calls to Amazon.

Default value: None

Valid values: String with maximum length of 50. Letters, numbers and the following special characters are allowed: !,$,%,&,*,+,-,.,,,^,_,`,|,~.

Example of setting this value in the config file:

[default] sdk_ua_app_id=ABCDEF

Linux/macOS example of setting environment variables via command line:

export AWS_SDK_UA_APP_ID=ABCDEF export AWS_SDK_UA_APP_ID="ABC DEF"

Windows example of setting environment variables via command line:

setx AWS_SDK_UA_APP_ID ABCDEF setx AWS_SDK_UA_APP_ID="ABC DEF"

If you include symbols that have a special meaning to the shell being used, escape the value as appropriate.

Compatibility with Amazon SDKs

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 Notes or more information
Amazon CLI v2 No
SDK for C++ Yes shared config file not supported.
SDK for Go V2 (1.x) Yes
SDK for Go 1.x (V1) No
SDK for Java 2.x Partial Shared config file setting not supported; environment variable not supported.
SDK for Java 1.x No
SDK for JavaScript 3.x Yes
SDK for JavaScript 2.x No
SDK for Kotlin Yes
SDK for .NET 3.x Yes Environment variables not supported.
SDK for PHP 3.x Yes
SDK for Python (Boto3) Yes
SDK for Ruby 3.x Yes
SDK for Rust Yes
Tools for PowerShell No