Amazon Simple Queue Service
API Reference (API Version 2012-11-05)
« 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

The following table lists common parameters used by Query requests to SQS.

Parameter NameDescription

Action

The action to perform. For example: CreateQueue..

AWSAccessKeyId

Your Access Key ID. For example: AKIAIOSFODNN7EXAMPLE. For more information, see Your AWS Identifiers in the Amazon SQS Developer Guide.

Expires

The date and time at which the signature included in the request expires, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard. Query requests must include either Timestamp or Expires, but not both.

Signature

A request signature (for information, see Request Authentication in the Amazon SQS Developer Guide). For example: Qnpl4Qk/7tINHzfXCiT7VbBatDA=.

SignatureMethod

Required when you use signature version 2 or signature version 4 with Query requests. For more information, see Query Request Authentication in the Amazon SQS Developer Guide.

SignatureVersion

For more information, see Query Request Authentication in the Amazon SQS Developer Guide.

Timestamp

The date and time the request is signed, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard. Query requests must include either Timestamp or Expires, but not both.

Version

The API version to use, as specified in the WSDL. For example: 2012-11-05.

For Query requests, parameter values must be URL-encoded. This is true for any Query parameter passed to SQS and is typically necessary in the Signature, ReceiptHandle, and MessageBody parameters. Some clients do this automatically, but this is not the norm.