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.
Name | Description | |
---|---|---|
![]() |
AddPermissionRequest |
Container for the parameters to the AddPermission operation. Adds a permission to a queue for a specific principal. This allows sharing access to the queue. When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide. |
![]() |
AddPermissionResponse |
This is the response object from the AddPermission operation. |
![]() |
BatchEntryIdsNotDistinctException |
Two or more batch entries in the request have the same |
![]() |
BatchRequestTooLongException |
The length of all the messages put together is more than the limit. |
![]() |
BatchResultErrorEntry |
Gives a detailed description of the result of an action on each entry in the request. |
![]() |
CancelMessageMoveTaskRequest |
Container for the parameters to the CancelMessageMoveTask operation.
Cancels a specified message movement task. A message movement can only be cancelled
when the current status is RUNNING. Cancelling a message movement task does not revert
the messages that have already been moved. It can only stop the messages that have
not been moved yet.
This action is currently limited to supporting message redrive from dead-letter
queues (DLQs) only. In this context, the source queue is the dead-letter queue
(DLQ), while the destination queue can be the original source queue (from which the
messages were driven to the dead-letter-queue), or a custom destination queue.
Only one active message movement task is supported per queue at any given time.
|
![]() |
CancelMessageMoveTaskResponse |
This is the response object from the CancelMessageMoveTask operation. |
![]() |
ChangeMessageVisibilityBatchRequest |
Container for the parameters to the ChangeMessageVisibilityBatch operation.
Changes the visibility timeout of multiple messages. This is a batch version of
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 |
![]() |
ChangeMessageVisibilityBatchRequestEntry |
Encloses a receipt handle and an entry ID for each message in |
![]() |
ChangeMessageVisibilityBatchResponse |
For each message in the batch, the response contains a |
![]() |
ChangeMessageVisibilityBatchResultEntry |
Encloses the |
![]() |
ChangeMessageVisibilityRequest |
Container for the parameters to the ChangeMessageVisibility operation. Changes the visibility timeout of a specified message in a queue to a new value. The default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.
For example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed
since you received the message, and you send a ChangeMessageVisibility call with An Amazon SQS message has three basic states:
A message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages. A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of in flight messages. Limits that apply to in flight messages are unrelated to the unlimited number of stored messages.
For most standard queues (depending on queue traffic and message backlog), there can
be a maximum of approximately 120,000 in flight messages (received from a queue by
a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS
returns the For FIFO queues, there can be a maximum of 20,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.
If you attempt to set the
Unlike with a queue, when you change the visibility timeout for a specific message
the timeout value is applied immediately but isn't saved in memory for that message.
If you don't delete a message after it is received, the visibility timeout for the
message reverts to the original timeout value (not to the value you set using the
|
![]() |
ChangeMessageVisibilityResponse |
This is the response object from the ChangeMessageVisibility operation. |
![]() |
CreateQueueRequest |
Container for the parameters to the CreateQueue operation. Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following in mind:
To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues. After you create a queue, you must wait at least one second after the queue is created to be able to use the queue.
To get the queue URL, use the
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide. |
![]() |
CreateQueueResponse |
Returns the |
![]() |
DeleteMessageBatchRequest |
Container for the parameters to the DeleteMessageBatch operation.
Deletes up to ten messages from the specified queue. This is a batch version of
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 |
![]() |
DeleteMessageBatchRequestEntry |
Encloses a receipt handle and an identifier for it. |
![]() |
DeleteMessageBatchResponse |
For each message in the batch, the response contains a |
![]() |
DeleteMessageBatchResultEntry |
Encloses the |
![]() |
DeleteMessageRequest |
Container for the parameters to the DeleteMessage operation.
Deletes the specified message from the specified queue. To select the message to delete,
use the
The
For standard queues, it is possible to receive a message even after you delete it.
This might happen on rare occasions if one of the servers which stores a copy of the
message is unavailable when you send the request to delete the message. The copy remains
on the server and might be returned to you during a subsequent receive request. You
should ensure that your application is idempotent, so that receiving a message more
than once does not cause issues.
|
![]() |
DeleteMessageResponse |
This is the response object from the DeleteMessage operation. |
![]() |
DeleteQueueRequest |
Container for the parameters to the DeleteQueue operation.
Deletes the queue specified by the
Be careful with the
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 When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
The delete operation uses the HTTP |
![]() |
DeleteQueueResponse |
This is the response object from the DeleteQueue operation. |
![]() |
EmptyBatchRequestException |
The batch request doesn't contain any entries. |
![]() |
GetQueueAttributesRequest |
Container for the parameters to the GetQueueAttributes operation.
Gets attributes for the specified queue.
To determine whether a queue is FIFO,
you can check whether |
![]() |
GetQueueAttributesResponse |
Get Queue Attributes Result |
![]() |
GetQueueUrlRequest |
Container for the parameters to the GetQueueUrl operation. Returns the URL of an existing Amazon SQS queue.
To access a queue that belongs to another AWS account, use the |
![]() |
GetQueueUrlResponse |
For more information, see Interpreting Responses in the Amazon SQS Developer Guide. |
![]() |
InvalidAddressException |
The |
![]() |
InvalidAttributeNameException |
The specified attribute doesn't exist. |
![]() |
InvalidAttributeValueException |
A queue attribute value is invalid. |
![]() |
InvalidBatchEntryIdException |
The |
![]() |
InvalidIdFormatException |
The specified receipt handle isn't valid for the current version. |
![]() |
InvalidMessageContentsException |
The message contains characters outside the allowed set. |
![]() |
InvalidSecurityException |
When the request to a queue is not HTTPS and SigV4. |
![]() |
KmsAccessDeniedException |
The caller doesn't have the required KMS access. |
![]() |
KmsDisabledException |
The request was denied due to request throttling. |
![]() |
KmsInvalidKeyUsageException |
The request was rejected for one of the following reasons:
|
![]() |
KmsInvalidStateException |
The request was rejected because the state of the specified resource is not valid for this request. |
![]() |
KmsNotFoundException |
The request was rejected because the specified entity or resource could not be found. |
![]() |
KmsOptInRequiredException |
The request was rejected because the specified key policy isn't syntactically or semantically correct. |
![]() |
KmsThrottledException |
Amazon Web Services KMS throttles requests for the following conditions. |
![]() |
ListDeadLetterSourceQueuesRequest |
Container for the parameters to the ListDeadLetterSourceQueues operation.
Returns a list of your queues that have the
The For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer Guide. |
![]() |
ListDeadLetterSourceQueuesResponse |
A list of your dead letter source queues. |
![]() |
ListMessageMoveTasksRequest |
Container for the parameters to the ListMessageMoveTasks operation.
Gets the most recent message movement tasks (up to 10) under a specific source queue.
This action is currently limited to supporting message redrive from dead-letter
queues (DLQs) only. In this context, the source queue is the dead-letter queue
(DLQ), while the destination queue can be the original source queue (from which the
messages were driven to the dead-letter-queue), or a custom destination queue.
Only one active message movement task is supported per queue at any given time.
|
![]() |
ListMessageMoveTasksResponse |
This is the response object from the ListMessageMoveTasks operation. |
![]() |
ListMessageMoveTasksResultEntry |
Contains the details of a message movement task. |
![]() |
ListQueuesRequest |
Container for the parameters to the ListQueues operation.
Returns a list of your queues in the current region. The response includes a maximum
of 1,000 results. If you specify a value for the optional
The Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide. |
![]() |
ListQueuesResponse |
A list of your queues. |
![]() |
ListQueueTagsRequest |
Container for the parameters to the ListQueueTags operation.
List all cost allocation tags added to the specified Amazon SQS queue. For an overview,
see Tagging
Your Amazon SQS Queues in the Amazon SQS Developer Guide.
Cross-account permissions don't apply to this action. For more information, see Grant
cross-account permissions to a role and a username in the Amazon SQS Developer
Guide.
|
![]() |
ListQueueTagsResponse |
This is the response object from the ListQueueTags operation. |
![]() |
Message |
An Amazon SQS message. |
![]() |
MessageAttributeValue |
The user-specified message attribute value. For string data types, the
|
![]() |
MessageNotInflightException |
The specified message isn't in flight. |
![]() |
MessageSystemAttributeValue |
The user-specified message system attribute value. For string data types, the
|
![]() |
OverLimitException |
The specified action violates a limit. For example, |
![]() |
PurgeQueueInProgressException |
Indicates that the specified queue previously received a |
![]() |
PurgeQueueRequest |
Container for the parameters to the PurgeQueue operation.
Deletes available messages in a queue (including in-flight messages) specified by
the
When you use the
The message deletion process takes up to 60 seconds. We recommend waiting for 60 seconds
regardless of your queue's size.
Messages sent to the queue before you call
Messages sent to the queue after you call |
![]() |
PurgeQueueResponse |
This is the response object from the PurgeQueue operation. |
![]() |
QueueDeletedRecentlyException |
You must wait 60 seconds after deleting a queue before you can create another queue with the same name. |
![]() |
QueueDoesNotExistException |
The specified queue doesn't exist. |
![]() |
QueueNameExistsException |
A queue with this name already exists. Amazon SQS returns this error only if the request includes attributes whose values differ from those of the existing queue. |
![]() |
ReceiptHandleIsInvalidException |
The specified receipt handle isn't valid. |
![]() |
ReceiveMessageRequest |
Container for the parameters to the ReceiveMessage operation.
Retrieves one or more messages (up to 10), from the specified queue. Using the
Short poll is the default behavior where a weighted random set of machines is sampled
on a 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 A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue. In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. |
![]() |
ReceiveMessageResponse |
A list of received messages. |
![]() |
RemovePermissionRequest |
Container for the parameters to the RemovePermission operation.
Revokes any permissions in the queue policy that matches the specified
Only the owner of a queue can remove permissions from it.
Cross-account permissions don't apply to this action. For more information, see Grant
cross-account permissions to a role and a username in the Amazon SQS Developer
Guide.
To remove the ability to change queue permissions, you must deny permission to the
|
![]() |
RemovePermissionResponse |
This is the response object from the RemovePermission operation. |
![]() |
RequestThrottledException |
The request was denied due to request throttling.
|
![]() |
ResourceNotFoundException |
One or more specified resources don't exist. |
![]() |
SendMessageBatchRequest |
Container for the parameters to the SendMessageBatch operation.
You can use
The result of sending 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
The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144 bytes). A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
Amazon SQS does not throw an exception or completely reject the message if it contains
invalid characters. Instead, it replaces those invalid characters with
If you don't specify the |
![]() |
SendMessageBatchRequestEntry |
Contains the details of a single Amazon SQS message along with an |
![]() |
SendMessageBatchResponse |
For each message in the batch, the response contains a |
![]() |
SendMessageBatchResultEntry |
Encloses a |
![]() |
SendMessageRequest |
Container for the parameters to the SendMessage operation.
Delivers a message to the specified queue.
A message can include only XML, JSON, and unformatted text. The following Unicode
characters are allowed. For more information, see the W3C
specification for characters.
Amazon SQS does not throw an exception or completely reject the message if it contains
invalid characters. Instead, it replaces those invalid characters with |
![]() |
SendMessageResponse |
The |
![]() |
SetQueueAttributesRequest |
Container for the parameters to the SetQueueAttributes operation.
Sets the value of one or more queue attributes, like a policy. When you change a queue's
attributes, the change can take up to 60 seconds for most of the attributes to propagate
throughout the Amazon SQS system. Changes made to the
In the future, new attributes might be added. If you write code that calls this action,
we recommend that you structure your code so that it can handle new attributes gracefully.
Cross-account permissions don't apply to this action. For more information, see Grant
cross-account permissions to a role and a username in the Amazon SQS Developer
Guide.
To remove the ability to change queue permissions, you must deny permission to the
|
![]() |
SetQueueAttributesResponse |
This is the response object from the SetQueueAttributes operation. |
![]() |
SQSPaginatorFactory |
Paginators for the SQS service |
![]() |
StartMessageMoveTaskRequest |
Container for the parameters to the StartMessageMoveTask operation.
Starts an asynchronous task to move messages from a specified source queue to a specified
destination queue.
This action is currently limited to supporting message redrive from queues that are
configured as dead-letter
queues (DLQs) of other Amazon SQS queues only. Non-SQS queue sources of dead-letter
queues, such as Lambda or Amazon SNS topics, are currently not supported.
In dead-letter queues redrive context, the
Only one active message movement task is supported per queue at any given time.
|
![]() |
StartMessageMoveTaskResponse |
This is the response object from the StartMessageMoveTask operation. |
![]() |
TagQueueRequest |
Container for the parameters to the TagQueue operation. Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide. When you use queue tags, keep the following guidelines in mind:
For a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer Guide. Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide. |
![]() |
TagQueueResponse |
This is the response object from the TagQueue operation. |
![]() |
TooManyEntriesInBatchRequestException |
The batch request contains more entries than permissible. |
![]() |
UnsupportedOperationException |
Error code 400. Unsupported operation. |
![]() |
UntagQueueRequest |
Container for the parameters to the UntagQueue operation.
Remove cost allocation tags from the specified Amazon SQS queue. For an overview,
see Tagging
Your Amazon SQS Queues in the Amazon SQS Developer Guide.
Cross-account permissions don't apply to this action. For more information, see Grant
cross-account permissions to a role and a username in the Amazon SQS Developer
Guide.
|
![]() |
UntagQueueResponse |
This is the response object from the UntagQueue operation. |
Name | Description | |
---|---|---|
![]() |
IListDeadLetterSourceQueuesPaginator |
Paginator for the ListDeadLetterSourceQueues operation |
![]() |
IListQueuesPaginator |
Paginator for the ListQueues operation |
![]() |
ISQSPaginatorFactory |
Paginators for the SQS service |