AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the AddPermission operation.
Adds a permission to a queue for a specific principal.
This allows for sharing access to the queue.
When you create a queue, you have full control access rights for the queue. Only you (as owner of the queue) can grant or deny permissions to the queue. For more information about these permissions, see Shared Queues in the Amazon SQS Developer Guide.
|BatchResultErrorEntry||This is used in the responses of batch API to give a detailed description of the result of an action on each entry in the request.|
Container for the parameters to the ChangeMessageVisibilityBatch operation.
Changes the visibility timeout of multiple messages. This is a batch version of ChangeMessageVisibility.
The result of the action on each message is reported individually in the response.
You can send up to 10 ChangeMessageVisibility requests with each
Encloses a receipt handle and an entry id for each message in ChangeMessageVisibilityBatch.
All of the following parameters are list parameters that must be prefixed with
|ChangeMessageVisibilityBatchResponse||Configuration for accessing Amazon ChangeMessageVisibilityBatch service|
|ChangeMessageVisibilityBatchResult||For each message in the batch, the response contains a ChangeMessageVisibilityBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.|
|ChangeMessageVisibilityBatchResultEntry||Encloses the id of an entry in ChangeMessageVisibilityBatch.|
Container for the parameters to the ChangeMessageVisibility operation.
Changes the visibility timeout of a specified message in a queue to a new value. The
maximum allowed timeout value you can set the value to is 12 hours. This means you
can't extend the timeout of a message in an existing queue to more than a total visibility
timeout of 12 hours. (For more information visibility timeout, see Visibility
Timeout in the Amazon SQS Developer Guide.)
For example, let's say you have a message and its default message visibility timeout
is 30 minutes. You could call
There is a 120,000 limit for the number of inflight messages per queue. Messages are inflight after they have been received from the queue by a consuming component, but have not yet been deleted from the queue. If you reach the 120,000 limit, you will receive an OverLimit error message from Amazon SQS. To help avoid reaching the limit, you should delete the messages from the queue after they have been processed. You can also increase the number of queues you use to process the messages.
Container for the parameters to the CreateQueue operation.
Creates a new queue, or returns the URL of an existing one. When you request
If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
You may pass one or more attributes in the request. If you do not provide a value for any attribute, the queue will have the default value for that attribute. Permitted attributes are the same that can be set using SetQueueAttributes.
If you provide the name of an existing queue, along with the exact names and values
of all the queue's attributes,
|CreateQueueResponse||Configuration for accessing Amazon CreateQueue service|
|CreateQueueResult||Returns the QueueUrl element of the created queue.|
Container for the parameters to the DeleteMessageBatch operation.
Deletes up to ten messages from the specified queue. This is a batch version of DeleteMessage.
The result of the delete action on each message is reported individually in the response.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
|DeleteMessageBatchRequestEntry||Encloses a receipt handle and an identifier for it.|
|DeleteMessageBatchResponse||Configuration for accessing Amazon DeleteMessageBatch service|
|DeleteMessageBatchResult||For each message in the batch, the response contains a DeleteMessageBatchResultEntry tag if the message is deleted or a BatchResultErrorEntry tag if the message cannot be deleted.|
|DeleteMessageBatchResultEntry||Encloses the id an entry in DeleteMessageBatch.|
Container for the parameters to the DeleteMessage operation.
Deletes the specified message from the specified queue. You specify the message by
using the message's
The receipt handle is associated with a specific instance of receiving the message.
If you receive a message more than once, the receipt handle you get each time you
receive the message is different. When you request
It is possible you will receive a message even after you have deleted it. This might happen on rare occasions if one of the servers storing a copy of the message is unavailable when you request to delete the message. The copy remains on the server and might be returned to you again on a subsequent receive request. You should create your system to be idempotent so that receiving a particular message more than once is not a problem.
Container for the parameters to the DeleteQueue operation.
Deletes the queue specified by the queue URL, regardless of whether the queue
is empty. If the specified queue does not exist, Amazon SQS returns a successful response.
When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a SendMessage request might succeed, but after the 60 seconds, the queue and that message you sent no longer exist. Also, when you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
We reserve the right to delete queues that have had no activity for more than 30 days. For more information, see How Amazon SQS Queues Work in the Amazon SQS Developer Guide.
Container for the parameters to the GetQueueAttributes operation.
Gets attributes for the specified queue. The following attributes are supported:
|GetQueueAttributesResponse||Configuration for accessing Amazon GetQueueAttributes service|
|GetQueueAttributesResult||A list of returned queue attributes.|
Container for the parameters to the GetQueueUrl operation.
Returns the URL of an existing queue. This action provides a simple way to retrieve
the URL of an Amazon SQS queue.
To access a queue that belongs to another AWS account, use the
|GetQueueUrlResponse||Configuration for accessing Amazon GetQueueUrl service|
|GetQueueUrlResult||For more information, see Responses in the Amazon SQS Developer Guide.|
Container for the parameters to the ListDeadLetterSourceQueues operation.
Returns a list of your queues that have the RedrivePolicy queue attribute configured
with a dead letter queue.
For more information about using dead letter queues, see Using Amazon SQS Dead Letter Queues.
|ListDeadLetterSourceQueuesResponse||Configuration for accessing Amazon ListDeadLetterSourceQueues service|
|ListDeadLetterSourceQueuesResult||A list of your dead letter source queues.|
Container for the parameters to the ListQueues operation.
Returns a list of your queues. The maximum number of queues that can be returned is
1000. If you specify a value for the optional
|ListQueuesResponse||Configuration for accessing Amazon ListQueues service|
|ListQueuesResult||A list of your queues.|
|Message||An Amazon SQS message.|
The user-specified message attribute value. For string data types, the value attribute
has the same restrictions on the content as the message body. For more information,
Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes).
Container for the parameters to the PurgeQueue operation.
Deletes the messages in a queue specified by the queue URL.
When you purge a queue, the message deletion process takes up to 60 seconds. All messages
sent to the queue before calling
Container for the parameters to the ReceiveMessage operation.
Retrieves one or more messages, with a maximum limit of 10 messages, from the specified
queue. Long poll support is enabled by using the
Short poll is the default behavior where a weighted random set of machines is sampled
For each message returned, the response includes the following:
The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide.
You can provide the
Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
|ReceiveMessageResponse||Configuration for accessing Amazon ReceiveMessage service|
|ReceiveMessageResult||A list of received messages.|
Container for the parameters to the RemovePermission operation.
Revokes any permissions in the queue policy that matches the specified
Container for the parameters to the SendMessageBatch operation.
Delivers up to ten messages to the specified queue. This is a batch version of SendMessage.
The result of the send action on each message is reported individually in the response.
The maximum allowed individual message size is 256 KB (262,144 bytes).
The maximum total payload size (i.e., the sum of all a batch's individual message lengths) is also 256 KB (262,144 bytes).
#x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF]
Contains the details of a single Amazon SQS message along with a
|SendMessageBatchResponse||Configuration for accessing Amazon SendMessageBatch service|
|SendMessageBatchResult||For each message in the batch, the response contains a SendMessageBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.|
|SendMessageBatchResultEntry||Encloses a message ID for successfully enqueued message of a SendMessageBatch.|
Container for the parameters to the SendMessage operation.
Delivers a message to the specified queue. With Amazon SQS, you now have the ability
to send large payload messages that are up to 256KB (262,144 bytes) in size. To send
large payloads, you must use an AWS SDK that supports SigV4 signing. To verify whether
SigV4 is supported for an AWS SDK, check the SDK release notes.
The following list shows the characters (in Unicode) allowed in your message, according to the W3C XML specification. For more information, go to http://www.w3.org/TR/REC-xml/#charsets If you send any characters not included in the list, your request will be rejected.
#x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF]
|SendMessageResponse||Configuration for accessing Amazon SendMessage service|
|SendMessageResult||The MD5OfMessageBody and MessageId elements.|
Container for the parameters to the SetQueueAttributes operation.
Sets the value of one or more queue attributes. When you change a queue's attributes,
the change can take up to 60 seconds for most of the attributes to propagate throughout
the SQS system. Changes made to the