Amazon Elastic Compute Cloud
API Reference (API Version 2014-06-15)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Did this page help you?  Yes | No |  Tell us about it...

Common Query Parameters

Most Amazon EC2 API actions support the parameters described in the following table.

NameDescriptionRequired

Action

The action to perform.

Example: RunInstances

Yes

Version

The API version to use, as specified in the WSDL file.

Example: 2014-06-15

Yes

AWSAccessKeyId

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.

AKIAIOSFODNN7EXAMPLE

Yes

DryRun

Checks whether you have the required permissions for the action, without actually making the request. If you have the required permissions, the request returns DryRunOperation; otherwise, it returns UnauthorizedOperation.

No

Timestamp

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: 2006-07-07T15:04:56Z

Yes

Expires

The date and time at which the signature included in the request expires, in the format YYYY-MM-DDThh:mm:ssZ.

Example: 2006-07-07T15:04:56Z

Yes

SecurityToken

The temporary security token obtained through a call to AWS Security Token Service.

Default: None

Type: String

No

Signature

The request signature. For more information, see Signature Version 2 Signing Process in the Amazon Web Services General Reference.

Example: Qnpl4Qk/7tINHzfXCiT7VEXAMPLE

Yes

SignatureMethod

The hash algorithm you use to create the request signature. Valid values: HmacSHA256 | HmacSHA1. For more information, see Signature Version 2 Signing Process in the Amazon Web Services General Reference.

Example: HmacSHA256

Yes

SignatureVersion

The signature version you use to sign the request. Set this value to 2. For more information, see Signature Version 2 Signing Process in the Amazon Web Services General Reference.

Example: 2

Yes

Note

The Timestamp parameter can be used instead of Expires. Requests must include either Timestamp or Expires, but cannot contain both.

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.