Common query parameters
Most Amazon EC2 API actions support the parameters described in the following tables. The common parameters vary depending on whether you're using Signature Version 2 or Signature Version 4 to sign your requests. For more information, see Signing AWS API requests in the IAM User Guide.
Parameters for Signature Version 4
| Name | Description | Required |
|---|---|---|
|
|
The action to perform. Example: |
Yes |
|
|
The API version to use. |
Yes |
|
|
The hash algorithm you use to create the request signature. Example: |
Yes |
|
|
The credential scope for the request, in the format
Example: |
Yes |
|
|
The date and time at which the request is signed, in the format YYYYMMDDThhmmssZ. The
date must match the date that's included in the credential scope for the
Example: |
Yes |
X-Amz-SignedHeaders |
The headers you are including as part of the request. At a minimum, you must include the
Example: |
Yes |
|
|
A signature derived from your secret access key. Example: |
Yes |
|
|
The temporary security token obtained through a call to AWS Security Token Service. Example: |
No |
|
|
Checks whether you have the required permissions for the action, without actually making the request.
If you have the required permissions, the request returns |
No |
The X-Amz-Algorithm, X-Amz-Credential,
X-Amz-SignedHeaders, and X-Amz-Signature parameters can either
be specified as separate parameters in the query string, or their values can be included in
a single Authorization header. For more information, see Signing AWS API requests in the IAM User Guide.
Parameters for Signature Version 2
| Name | Description | Required |
|---|---|---|
|
|
The action to perform. Example: |
Yes |
|
|
The API version to use. |
Yes |
|
|
The access key ID for the request sender. This identifies the account which will be charged for usage of the service. The account that's associated with the access key ID must be signed up for Amazon EC2, or the request isn't accepted. Example: |
Yes |
|
|
The date and time at which the signature included in the request expires, in the
format YYYY-MM-DDThh:mm:ssZ. For more information, see ISO 8601 Example: |
Conditional. Requests must include either Timestamp or
Expires, but cannot contain both. |
|
|
The date and time at which the request is signed,
in the format YYYY-MM-DDThh:mm:ssZ. For more information, see
ISO 8601 Example: |
Conditional. Requests must include either Timestamp or
Expires, but cannot contain both. |
|
|
The request signature. Example: |
Yes |
|
|
The hash algorithm you use to create the request signature. Valid values:
Example: |
Yes |
|
|
The signature version you use to sign the request. Set this value to Example: |
Yes |
|
|
Checks whether you have the required permissions for the action, without
actually making the request. If you have the required permissions, the request
returns |
No |
|
|
The temporary security token obtained through a call to AWS Security Token Service. Example: |
No |
Parameter values must be URL-encoded. This is true for any Query parameter passed to Amazon EC2
and is typically necessary in the Signature parameter. Some clients do
this automatically, but this is not the norm.
