Common Parameters
The following table contains the parameters that all actions use for signing Signature Version 4 requests with a query string.
Table: Common parameters
Parameters | Description |
|---|---|
Action | The action to be performed. Type: string Required: Yes |
Version | The API version that the request is written for, expressed in the format YYYY-MM-DD. Type: string Required: No |
X-Amz-Algorithm | The credential scope value that includes your access key, the date, the region, the service, and a termination string. The value is configured in the following format: access_key/YYYYMMDD/region/service/aws4_request. For more information, see Task 2: Create a String to Sign for Signature Version 4. Condition: Specify this parameter when you include authentication information in a query string instead of the HTTP authorization header. Type: string Required: Conditional |
X-Amz-Credential | The credential scope value that includes your access key, the date, the region, the service, and a termination string. The value is configured in the following format: access_key/YYYYMMDD/region/service/aws4_request. For more information, see Task 2: Create a String to Sign for Signature Version 4 Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional |
X-Amz-Date | The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20220525T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date that is used for signing requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see Handling Dates in Signature Version 4 Type: string Required: Conditional |
X-Amz-Signature | Specifies the hex-encoded signature that was calculated from the string to sign and the derived signing key. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional |
X-Amz-SignedHeaders | Specifies all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see Task 1: Create a Canonical Request For Signature Version 4 in the Amazon Web Services General Reference. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional |