共通パラメータ
次のリストには、すべてのアクションが署名バージョン 4 リクエストにクエリ文字列で署名するために使用するパラメータを示します。アクション固有のパラメータは、アクションのトピックに示されています。Signature Version 4 の詳細については、「IAM ユーザーガイド」の「AWS API リクエストの署名」を参照してください。
- Action
-
実行するアクション。
型: 文字列
必須: はい
- Version
-
リクエストが想定している API バージョンである、YYYY-MM-DD 形式で表示されます。
型: 文字列
必須: はい
- X-Amz-Algorithm
-
リクエストの署名を作成するのに使用したハッシュアルゴリズム。
条件: HTTP 認証ヘッダーではなくクエリ文字列に認証情報を含める場合は、このパラメータを指定します。
型: 文字列
有効な値:
AWS4-HMAC-SHA256
必須: 条件による
- X-Amz-Credential
-
認証情報スコープの値で、アクセスキー、日付、対象とするリージョン、リクエストしているサービス、および終了文字列 ("aws4_request") を含む文字列です。値は次の形式で表現されます。[access_key/YYYYYYYYMMDD/リージョン/サービス/aws4_request]
詳細については、「IAM ユーザーガイド」の「署名付きAWS API リクエストの作成」を参照してください。
条件: HTTP 認証ヘッダーではなくクエリ文字列に認証情報を含める場合は、このパラメータを指定します。
型: 文字列
必須: 条件による
- X-Amz-Date
-
署名を作成するときに使用する日付です。形式は ISO 8601 基本形式の YYYYMMDD'T'HHMMSS'Z' でなければなりません。例えば、日付
20120325T120000Z
は、有効な X-Amz-Date の値です。条件: X-Amz-Date はすべてのリクエストに対してオプションです。署名リクエストで使用する日付よりも優先される日付として使用できます。ISO 8601 ベーシック形式で日付ヘッダーが指定されている場合、X-Amz-Date は必要ありません。X-Amz-Date を使用すると、常に Date ヘッダーの値よりも優先されます。詳細については、「IAM ユーザーガイド」の「AWS API リクエスト署名の要素」を参照してください。
タイプ: 文字列
必須: 条件による
- X-Amz-Security-Token
-
AWS Security Token Service (AWS STS) へのを呼び出しで取得された一時的なセキュリティトークン。AWS STS の一時的なセキュリティ認証情報をサポートするサービスのリストについては、「IAM ユーザーガイド」の「IAM と連携するAWS サービス」を参照してください。
条件:AWS STS の一時的なセキュリティ認証情報を使用する場合、セキュリティトークンを含める必要があります。
タイプ: 文字列
必須: 条件による
- X-Amz-Signature
-
署名する文字列と派生署名キーから計算された 16 進符号化署名を指定します。
条件: HTTP 認証ヘッダーではなくクエリ文字列に認証情報を含める場合は、このパラメータを指定します。
型: 文字列
必須: 条件による
- X-Amz-SignedHeaders
-
正規リクエストの一部として含まれていたすべての HTTP ヘッダーを指定します。署名付きヘッダーの指定に関する詳細については、「IAM ユーザーガイド」の「署名付き AWS API リクエストの作成」を参照してください。
条件: HTTP 認証ヘッダーではなくクエリ文字列に認証情報を含める場合は、このパラメータを指定します。
型: 文字列
必須: 条件による