アプリケーション ID
注記
設定ページのレイアウトを理解したり、以下の AWS SDK とツールによるサポートの表を解釈したりするには、「このガイドの設定ページについて」を参照してください。
単一の AWS アカウントを複数のカスタマーアプリケーションで使用して、AWS のサービスを呼び出すことができます。アプリケーション ID は、AWS アカウントを使用して一連の呼び出しを行ったソースアプリケーションを特定する方法を顧客に提供します。AWSSDK とサービスは、カスタマーコミュニケーションに返す以外の目的で、この値を使用したり解釈したりはしません。例えば、この値を運用 E メールや AWS Health Dashboard に含めることにより、通知に関連付けられているアプリケーションを一意に識別できます。
この機能を設定するには、以下のように使用します。
sdk_ua_app_id- AWSconfig共有ファイル設定AWS_SDK_UA_APP_ID- 環境変数sdk.ua.appId- JVM システムプロパティ: Java/Kotlin のみ-
この設定は、特定の AWS アカウント内のどのアプリケーションが AWS を呼び出すかを識別するためにアプリケーションに割り当てる一意の文字列です。
デフォルト値:
None有効な値: 最大長が 50 の文字列。文字、数字および次の特殊文字を使用することができます。
!、$、%、&、*、+、-、.、,、^、_、`、|、~。
config ファイルにこの値を設定する例を以下に示します。
[default] sdk_ua_app_id=ABCDEF
Linux/macOS のコマンドラインによる環境変数の設定の例を以下に示します。
export AWS_SDK_UA_APP_ID=ABCDEF export AWS_SDK_UA_APP_ID="ABC DEF"
Windows のコマンドラインによる環境変数の設定の例を以下に示します。
setx AWS_SDK_UA_APP_ID ABCDEF setx AWS_SDK_UA_APP_ID="ABC DEF"
使用するシェルに特別な意味を持つ記号を含める場合は、必要に応じて値をエスケープします。
AWS SDK とツールによるサポート
以下の SDK は、このトピックで説明する機能と設定をサポートします。部分的な例外があれば、すべて記載されています。JVM システムプロパティ設定は、AWS SDK for Java と AWS SDK for Kotlin でのみサポートされます。
| SDK | サポート | 注意または詳細情報 |
|---|---|---|
| AWS CLI v2 | あり | |
| SDK for C++ | あり | 共有 config ファイルはサポートされていません。 |
| SDK for Go V2 (1.x) |
あり | |
| SDK for Go 1.x (V1) | なし | |
| SDK for Java 2.x | 部分的 | 共有 config ファイル設定はサポートされておらず、環境変数はサポートされていません。 |
| SDK for Java 1.x | なし | |
| SDK for JavaScript 3.x | あり | |
| SDK for JavaScript 2.x | なし | |
| SDK for Kotlin | あり | JVM システムプロパティは aws.userAgentAppId です。 |
| SDK for .NET 4.x | あり | |
| SDK for .NET 3.x | あり | |
| SDK for PHP 3.x | あり | |
| SDK for Python (Boto3) |
あり | |
| SDK for Ruby 3.x | あり | |
| SDK for Rust | あり | |
| SDK for Swift | なし | |
| Tools for PowerShell V5 | なし | |
| Tools for PowerShell V4 | なし |
