Welcome to the Amazon Simple Queue Service API Reference.
Amazon Simple Queue Service (Amazon SQS) is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.
Standard queues are available in all regions. FIFO queues are available in the US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland) regions.
You can use AWS SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:
Cryptographically sign your service requests
Retry requests
Handle error responses
Additional Information
Amazon Simple Queue Service Developer Guide
Amazon Web Services General Reference
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 ChangeMessageVisibilityBatch
action.
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
.
Some actions take lists of parameters. These lists are specified using the param.n
notation. Values of n
are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=first
&Attribute.2=second
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
ChangeMessageVisibilityBatchRequest
|
object |
Entries
|
ChangeMessageVisibilityBatchRequestEntryList |
A list of receipt handles of the messages for which the visibility timeout must be changed. |
||||||||||||||||||||
|
||||||||||||||||||||||
QueueUrl
|
String |
The URL of the Amazon SQS queue whose messages' visibility is changed. Queue URLs and names are case-sensitive. |
||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
ChangeMessageVisibilityBatchResult
|
object |
For each message in the batch, the response contains a |
Failed
|
BatchResultErrorEntryList |
A list of |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
Successful
|
ChangeMessageVisibilityBatchResultEntryList |
A list of |
|||||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
TooManyEntriesInBatchRequest
|
Name | Data Type | Description |
---|---|---|
EmptyBatchRequest
|
Name | Data Type | Description |
---|---|---|
BatchEntryIdsNotDistinct
|
Name | Data Type | Description |
---|---|---|
InvalidBatchEntryId
|
Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value is 12 hours. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
For example, you have a message with a visibility timeout of 5 minutes. After 3 minutes, you call ChangeMessageVisibility
with a timeout of 10 minutes. You can continue to call ChangeMessageVisibility
to extend the visibility timeout to a maximum of 12 hours. If you try to extend the visibility timeout beyond 12 hours, your request is rejected.
A message is considered to be in flight after it's received from a queue by a consumer, but not yet deleted from the queue.
For standard queues, there can be a maximum of 120,000 inflight messages per queue. If you reach this limit, Amazon SQS returns the OverLimit
error message. To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages.
For FIFO queues, there can be a maximum of 20,000 inflight messages per queue. If you reach this limit, Amazon SQS returns no error messages.
If you attempt to set the VisibilityTimeout
to a value greater than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum remaining time.
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 ChangeMessageVisibility
action) the next time the message is received.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
ChangeMessageVisibilityRequest
|
object |
VisibilityTimeout
|
Integer |
The new value for the message's visibility timeout (in seconds). Values values: |
||||
|
||||||
ReceiptHandle
|
String |
The receipt handle associated with the message whose visibility timeout is changed. This parameter is returned by the |
||||
|
||||||
QueueUrl
|
String |
The URL of the Amazon SQS queue whose message's visibility is changed. Queue URLs and names are case-sensitive. |
||||
|
Name | Data Type | Description |
---|---|---|
MessageNotInflight
|
Name | Data Type | Description |
---|---|---|
ReceiptHandleIsInvalid
|
Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following caveats in mind:
If you don't specify the FifoQueue
attribute, Amazon SQS creates a standard queue.
You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the Amazon Simple Queue Service Developer Guide.
If you don't provide a value for an attribute, the queue is created with the default value for the attribute.
If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
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.
To get the queue URL, use the GetQueueUrl
action. GetQueueUrl
requires only the QueueName
parameter. be aware of existing queue names:
If you provide the name of an existing queue along with the exact names and values of all the queue's attributes, CreateQueue
returns the queue URL for the existing queue.
If the queue name, attribute names, or attribute values don't match an existing queue, CreateQueue
returns an error.
Some actions take lists of parameters. These lists are specified using the param.n
notation. Values of n
are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=first
&Attribute.2=second
Cross-account permissions don't apply to this action. For more information, see see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
CreateQueueRequest
|
object |
Attributes
|
QueueAttributeMap |
A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the
The following attributes apply only to server-side-encryption:
The following attributes apply only to FIFO (first-in-first-out) queues:
|
||||
|
||||||
QueueName
|
String |
The name of the new queue. The following limits apply to this name:
Queue URLs and names are case-sensitive. |
||||
|
Name | Data Type | Description |
---|---|---|
CreateQueueResult
|
object |
Returns the |
QueueUrl
|
String |
The URL of the created Amazon SQS queue. |
||||
|
Name | Data Type | Description |
---|---|---|
QueueDeletedRecently
|
Name | Data Type | Description |
---|---|---|
QueueNameExists
|
Deletes up to ten messages from the specified queue. This is a batch version of DeleteMessage.
The result of the 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
.
Some actions take lists of parameters. These lists are specified using the param.n
notation. Values of n
are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=first
&Attribute.2=second
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
DeleteMessageBatchRequest
|
object |
Entries
|
DeleteMessageBatchRequestEntryList |
A list of receipt handles for the messages to be deleted. |
|||||||||||||||||
|
|||||||||||||||||||
QueueUrl
|
String |
The URL of the Amazon SQS queue from which messages are deleted. Queue URLs and names are case-sensitive. |
|||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
DeleteMessageBatchResult
|
object |
For each message in the batch, the response contains a |
Failed
|
BatchResultErrorEntryList |
A list of |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
Successful
|
DeleteMessageBatchResultEntryList |
A list of |
|||||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
TooManyEntriesInBatchRequest
|
Name | Data Type | Description |
---|---|---|
EmptyBatchRequest
|
Name | Data Type | Description |
---|---|---|
BatchEntryIdsNotDistinct
|
Name | Data Type | Description |
---|---|---|
InvalidBatchEntryId
|
Deletes the specified message from the specified queue. To select the message to delete, use the ReceiptHandle
of the message (not the MessageId
which you receive when you send the message). Amazon SQS can delete a message from a queue even if a visibility timeout setting causes the message to be locked by another consumer. Amazon SQS automatically deletes messages left in a queue longer than the retention period configured for the queue.
The ReceiptHandle
is associated with a specific instance of receiving a message. If you receive a message more than once, the ReceiptHandle
is different each time you receive a message. When you use the DeleteMessage
action, you must provide the most recently received ReceiptHandle
for the message (otherwise, the request succeeds, but the message might not be deleted).
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.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
InvalidIdFormat
|
Name | Data Type | Description |
---|---|---|
ReceiptHandleIsInvalid
|
Deletes the queue specified by the QueueUrl
, regardless of the queue's contents. If the specified queue doesn't exist, Amazon SQS returns a successful response.
Be careful with the DeleteQueue
action: When you delete a queue, any messages in the queue are no longer available.
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 60 seconds the queue and the message you sent no longer exist.
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 see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
DeleteQueueRequest
|
object |
QueueUrl
|
String |
The URL of the Amazon SQS queue to delete. Queue URLs and names are case-sensitive. |
||||
|
Gets attributes for the specified queue.
To determine whether a queue is FIFO, you can check whether QueueName
ends with the .fifo
suffix.
Some actions take lists of parameters. These lists are specified using the param.n
notation. Values of n
are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=first
&Attribute.2=second
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
GetQueueAttributesRequest
|
object |
AttributeNames
|
AttributeNameList |
A list of attributes for which to retrieve information. 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. The following attributes are supported:
The following attributes apply only to server-side-encryption:
The following attributes apply only to FIFO (first-in-first-out) queues:
|
|||||||||||
|
|||||||||||||
QueueUrl
|
String |
The URL of the Amazon SQS queue whose attribute information is retrieved. Queue URLs and names are case-sensitive. |
|||||||||||
|
Name | Data Type | Description |
---|---|---|
GetQueueAttributesResult
|
object |
A list of returned queue attributes. |
Attributes
|
QueueAttributeMap |
A map of attributes to their respective values. |
||||
|
Name | Data Type | Description |
---|---|---|
InvalidAttributeName
|
Returns the URL of an existing Amazon SQS queue.
To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId
parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. For more information about shared queue access, see AddPermission
or see Allow Developers to Write Messages to a Shared Queue in the Amazon Simple Queue Service Developer Guide.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
GetQueueUrlRequest
|
object |
QueueOwnerAWSAccountId
|
String |
The AWS account ID of the account that created the queue. |
||||
|
||||||
QueueName
|
String |
The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values: alphanumeric characters, hyphens ( Queue URLs and names are case-sensitive. |
||||
|
Name | Data Type | Description |
---|---|---|
GetQueueUrlResult
|
object |
For more information, see Interpreting Responses in the Amazon Simple Queue Service Developer Guide. |
QueueUrl
|
String |
The URL of the queue. |
||||
|
Name | Data Type | Description |
---|---|---|
QueueDoesNotExist
|
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 in the Amazon Simple Queue Service Developer Guide.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
ListDeadLetterSourceQueuesRequest
|
object |
QueueUrl
|
String |
The URL of a dead-letter queue. Queue URLs and names are case-sensitive. |
||||
|
Name | Data Type | Description |
---|---|---|
ListDeadLetterSourceQueuesResult
|
object |
A list of your dead letter source queues. |
queueUrls
|
QueueUrlList |
A list of source queue URLs that have the |
|||||||||||
|
Name | Data Type | Description |
---|---|---|
QueueDoesNotExist
|
List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.
When you use queue tags, keep the following guidelines in mind:
Adding more than 50 tags to a queue isn't recommended.
Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
Tags are case-sensitive.
A new tag with a key identical to that of an existing tag overwrites the existing tag.
Tagging actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a technical support request.
For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.
Cross-account permissions don't apply to this action. For more information, see see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
ListQueueTagsRequest
|
object |
QueueUrl
|
String |
The URL of the queue. |
||||
|
Name | Data Type | Description |
---|---|---|
ListQueueTagsResult
|
object |
Tags
|
TagMap |
The list of all tags added to the specified queue. |
||||
|
Returns a list of your queues. The maximum number of queues that can be returned is 1,000. If you specify a value for the optional QueueNamePrefix
parameter, only queues with a name that begins with the specified value are returned.
Cross-account permissions don't apply to this action. For more information, see see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
ListQueuesRequest
|
object |
QueueNamePrefix
|
String |
A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned. Queue URLs and names are case-sensitive. |
||||
|
Name | Data Type | Description |
---|---|---|
ListQueuesResult
|
object |
A list of your queues. |
QueueUrls
|
QueueUrlList |
A list of queue URLs, up to 1,000 entries. |
|||||||||||
|
Deletes the messages in a queue specified by the QueueURL
parameter.
When you use the PurgeQueue
action, you can't retrieve any messages deleted from a queue.
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 PurgeQueue
might be received but are deleted within the next minute.
Messages sent to the queue after you call PurgeQueue
might be deleted while the queue is being purged.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
PurgeQueueRequest
|
object |
QueueUrl
|
String |
The URL of the queue from which the Queue URLs and names are case-sensitive. |
||||
|
Name | Data Type | Description |
---|---|---|
QueueDoesNotExist
|
Name | Data Type | Description |
---|---|---|
PurgeQueueInProgress
|
Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds
parameter enables long-poll support. For more information, see Amazon SQS Long Polling in the Amazon Simple Queue Service Developer Guide.
Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage
call. Thus, only the messages on the sampled machines are returned. If the number of messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per ReceiveMessage
call. If the number of messages in the queue is extremely small, you might not receive any messages in a particular ReceiveMessage
response. If this happens, repeat the request.
For each message returned, the response includes the following:
The message body.
An MD5 digest of the message body. For information about MD5, see RFC1321.
The MessageId
you received when you sent the message to the queue.
The receipt handle.
The message attributes.
An MD5 digest of the message attributes.
The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon Simple Queue Service Developer Guide.
You can provide the VisibilityTimeout
parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
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.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
ReceiveMessageRequest
|
object |
ReceiveRequestAttemptId
|
String |
This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of
The length of For best practices of using |
|||||||||||
|
|||||||||||||
WaitTimeSeconds
|
Integer |
The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than |
|||||||||||
|
|||||||||||||
VisibilityTimeout
|
Integer |
The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a |
|||||||||||
|
|||||||||||||
MaxNumberOfMessages
|
Integer |
The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10. Default: 1. |
|||||||||||
|
|||||||||||||
MessageAttributeNames
|
MessageAttributeNameList |
The name of the message attribute, where N is the index.
When using |
|||||||||||
|
|||||||||||||
AttributeNames
|
AttributeNameList |
A list of s that need to be returned along with each message. These attributes include:
|
|||||||||||
|
|||||||||||||
QueueUrl
|
String |
The URL of the Amazon SQS queue from which messages are received. Queue URLs and names are case-sensitive. |
|||||||||||
|
Name | Data Type | Description |
---|---|---|
ReceiveMessageResult
|
object |
A list of received messages. |
Messages
|
MessageList |
A list of messages. |
||||||||||||||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
OverLimit
|
Revokes any permissions in the queue policy that matches the specified Label
parameter.
Only the owner of a queue can remove permissions from it.
Cross-account permissions don't apply to this action. For more information, see see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
RemovePermissionRequest
|
object |
Label
|
String |
The identification of the permission to remove. This is the label added using the |
||||
|
||||||
QueueUrl
|
String |
The URL of the Amazon SQS queue from which permissions are removed. Queue URLs and names are case-sensitive. |
||||
|
Delivers up to ten messages to the specified queue. This is a batch version of SendMessage.
For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.
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 200
.
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 KB (262,144 bytes).
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
| #x10000
to #x10FFFF
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
If you don't specify the DelaySeconds
parameter for an entry, Amazon SQS uses the default value for the queue.
Some actions take lists of parameters. These lists are specified using the param.n
notation. Values of n
are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=first
&Attribute.2=second
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
SendMessageBatchRequest
|
object |
Entries
|
SendMessageBatchRequestEntryList |
A list of |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
QueueUrl
|
String |
The URL of the Amazon SQS queue to which batched messages are sent. Queue URLs and names are case-sensitive. |
|||||||||||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
SendMessageBatchResult
|
object |
For each message in the batch, the response contains a |
Failed
|
BatchResultErrorEntryList |
A list of |
||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
Successful
|
SendMessageBatchResultEntryList |
A list of |
||||||||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
TooManyEntriesInBatchRequest
|
Name | Data Type | Description |
---|---|---|
EmptyBatchRequest
|
Name | Data Type | Description |
---|---|---|
BatchEntryIdsNotDistinct
|
Name | Data Type | Description |
---|---|---|
BatchRequestTooLong
|
Name | Data Type | Description |
---|---|---|
InvalidBatchEntryId
|
Name | Data Type | Description |
---|---|---|
UnsupportedOperation
|
Delivers a message to the specified queue.
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
| #x10000
to #x10FFFF
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
SendMessageRequest
|
object |
MessageGroupId
|
String |
This parameter applies only to FIFO (first-in-first-out) queues. The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use
The length of For best practices of using |
||||
|
||||||
MessageDeduplicationId
|
String |
This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of sent messages. If a message with a particular
The If a message is sent successfully but the acknowledgement is lost and the message is resent with the same Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted. The length of For best practices of using |
||||
|
||||||
MessageAttributes
|
MessageBodyAttributeMap |
Each message attribute consists of a |
||||
|
||||||
DelaySeconds
|
Integer |
The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive When you set |
||||
|
||||||
MessageBody
|
String |
The message to send. The maximum string size is 256 KB. A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed: Any characters not included in this list will be rejected. For more information, see the W3C specification for characters. |
||||
|
||||||
QueueUrl
|
String |
The URL of the Amazon SQS queue to which a message is sent. Queue URLs and names are case-sensitive. |
||||
|
Name | Data Type | Description |
---|---|---|
SendMessageResult
|
object |
The |
SequenceNumber
|
String |
This parameter applies only to FIFO (first-in-first-out) queues. The large, non-consecutive number that Amazon SQS assigns to each message. The length of |
||||
|
||||||
MessageId
|
String |
An attribute containing the |
||||
|
||||||
MD5OfMessageAttributes
|
String |
An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321. |
||||
|
||||||
MD5OfMessageBody
|
String |
An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321. |
||||
|
Name | Data Type | Description |
---|---|---|
InvalidMessageContents
|
Name | Data Type | Description |
---|---|---|
UnsupportedOperation
|
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 Amazon SQS system. Changes made to the MessageRetentionPeriod
attribute can take up to 15 minutes.
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 see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
SetQueueAttributesRequest
|
object |
Attributes
|
QueueAttributeMap |
A map of attributes to set. The following lists the names, descriptions, and values of the special request parameters that the
The following attributes apply only to server-side-encryption:
The following attribute applies only to FIFO (first-in-first-out) queues:
|
||||
|
||||||
QueueUrl
|
String |
The URL of the Amazon SQS queue whose attributes are set. Queue URLs and names are case-sensitive. |
||||
|
Name | Data Type | Description |
---|---|---|
InvalidAttributeName
|
Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.
When you use queue tags, keep the following guidelines in mind:
Adding more than 50 tags to a queue isn't recommended.
Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
Tags are case-sensitive.
A new tag with a key identical to that of an existing tag overwrites the existing tag.
Tagging actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a technical support request.
For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.
Cross-account permissions don't apply to this action. For more information, see see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.
When you use queue tags, keep the following guidelines in mind:
Adding more than 50 tags to a queue isn't recommended.
Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
Tags are case-sensitive.
A new tag with a key identical to that of an existing tag overwrites the existing tag.
Tagging actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a technical support request.
For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.
Cross-account permissions don't apply to this action. For more information, see see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
UntagQueueRequest
|
object |
TagKeys
|
TagKeyList |
The list of tags to be removed from the specified queue. |
|||||||||||
|
|||||||||||||
QueueUrl
|
String |
The URL of the queue. |
|||||||||||
|
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 Simple Queue Service Developer Guide.
AddPermission
writes an Amazon-SQS-generated policy. If you want to write your own policy, use SetQueueAttributes
to upload your policy. For more information about writing your own policy, see Using Custom Policies with the Amazon SQS Access Policy Language in the Amazon Simple Queue Service Developer Guide.
An Amazon SQS policy can have a maximum of 7 actions.
Some actions take lists of parameters. These lists are specified using the param.n
notation. Values of n
are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=first
&Attribute.2=second
Cross-account permissions don't apply to this action. For more information, see see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
AddPermissionRequest
|
object |
Actions
|
ActionNameList |
The action the client wants to allow for the specified principal. Valid values: the name of any action or For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon Simple Queue Service Developer Guide. Specifying |
|||||||||||
|
|||||||||||||
AWSAccountIds
|
AWSAccountIdList |
The AWS account number of the principal who is given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see Your AWS Identifiers in the Amazon Simple Queue Service Developer Guide. |
|||||||||||
|
|||||||||||||
Label
|
String |
The unique identification of the permission you're setting (for example, |
|||||||||||
|
|||||||||||||
QueueUrl
|
String |
The URL of the Amazon SQS queue to which permissions are added. Queue URLs and names are case-sensitive. |
|||||||||||
|
Name | Data Type | Description |
---|---|---|
OverLimit
|
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
AWSAccountIdList
|
array [String] | |||||
|
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
ActionNameList
|
array [String] | |||||
|
Name | Data Type | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Actions
|
ActionNameList |
The action the client wants to allow for the specified principal. Valid values: the name of any action or For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon Simple Queue Service Developer Guide. Specifying |
|||||||||||
|
|||||||||||||
AWSAccountIds
|
AWSAccountIdList |
The AWS account number of the principal who is given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see Your AWS Identifiers in the Amazon Simple Queue Service Developer Guide. |
|||||||||||
|
|||||||||||||
Label
|
String |
The unique identification of the permission you're setting (for example, |
|||||||||||
|
|||||||||||||
QueueUrl
|
String |
The URL of the Amazon SQS queue to which permissions are added. Queue URLs and names are case-sensitive. |
|||||||||||
|
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
AttributeNameList
|
array [QueueAttributeName] Allowed values: - All - Policy - VisibilityTimeout - MaximumMessageSize - MessageRetentionPeriod - ApproximateNumberOfMessages - ApproximateNumberOfMessagesNotVisible - CreatedTimestamp - LastModifiedTimestamp - QueueArn - ApproximateNumberOfMessagesDelayed - DelaySeconds - ReceiveMessageWaitTimeSeconds - RedrivePolicy - FifoQueue - ContentBasedDeduplication - KmsMasterKeyId - KmsDataKeyReusePeriodSeconds |
|||||
|
Name | Data Type | Description |
---|---|---|
BatchEntryIdsNotDistinct
|
Name | Data Type | Description |
---|---|---|
BatchRequestTooLong
|
Gives a detailed description of the result of an action on each entry in the request.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
Message
|
String |
A message explaining why the action failed on this entry. |
||||
|
||||||
Code
|
String |
An error code representing why the action failed on this entry. |
||||
|
||||||
SenderFault
|
Boolean |
Specifies whether the error happened due to the producer. |
||||
|
||||||
Id
|
String |
The |
||||
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
BatchResultErrorEntryList
|
array [BatchResultErrorEntry] | |||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
Binary
|
string |
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
BinaryList
|
array [Binary] | |||||
|
Name | Data Type | Description |
---|---|---|
Boolean
|
boolean |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Entries
|
ChangeMessageVisibilityBatchRequestEntryList |
A list of receipt handles of the messages for which the visibility timeout must be changed. |
|||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||
QueueUrl
|
String |
The URL of the Amazon SQS queue whose messages' visibility is changed. Queue URLs and names are case-sensitive. |
|||||||||||||||||||||||||||||||||||||||||
|
Encloses a receipt handle and an entry id for each message in ChangeMessageVisibilityBatch.
All of the following list parameters must be prefixed with ChangeMessageVisibilityBatchRequestEntry.n
, where n
is an integer value starting with 1
. For example, a parameter list for this action might look like this:
&ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2
&ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=your_receipt_handle
&ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
VisibilityTimeout
|
Integer |
The new value (in seconds) for the message's visibility timeout. |
||||
|
||||||
ReceiptHandle
|
String |
A receipt handle. |
||||
|
||||||
Id
|
String |
An identifier for this particular receipt handle used to communicate the result. The |
||||
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ChangeMessageVisibilityBatchRequestEntryList
|
array [ChangeMessageVisibilityBatchRequestEntry] | |||||||||||||||||||||||||||||||||||
Properties
|
For each message in the batch, the response contains a ChangeMessageVisibilityBatchResultEntry
tag if the message succeeds or a BatchResultErrorEntry
tag if the message fails.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Failed
|
BatchResultErrorEntryList |
A list of |
|||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
Successful
|
ChangeMessageVisibilityBatchResultEntryList |
A list of |
|||||||||||||||||||||||||||||||||||||||||||||||||||
|
Encloses the Id
of an entry in ChangeMessageVisibilityBatch.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
Id
|
String |
Represents a message whose visibility timeout has been changed successfully. |
||||
|
Name | Data Type | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ChangeMessageVisibilityBatchResultEntryList
|
array [ChangeMessageVisibilityBatchResultEntry] | |||||||||||||||
Properties
|
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
VisibilityTimeout
|
Integer |
The new value for the message's visibility timeout (in seconds). Values values: |
||||
|
||||||
ReceiptHandle
|
String |
The receipt handle associated with the message whose visibility timeout is changed. This parameter is returned by the |
||||
|
||||||
QueueUrl
|
String |
The URL of the Amazon SQS queue whose message's visibility is changed. Queue URLs and names are case-sensitive. |
||||
|
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
Attributes
|
QueueAttributeMap |
A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the
The following attributes apply only to server-side-encryption:
The following attributes apply only to FIFO (first-in-first-out) queues:
|
||||
|
||||||
QueueName
|
String |
The name of the new queue. The following limits apply to this name:
Queue URLs and names are case-sensitive. |
||||
|
Returns the QueueUrl
attribute of the created queue.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
QueueUrl
|
String |
The URL of the created Amazon SQS queue. |
||||
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Entries
|
DeleteMessageBatchRequestEntryList |
A list of receipt handles for the messages to be deleted. |
|||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||
QueueUrl
|
String |
The URL of the Amazon SQS queue from which messages are deleted. Queue URLs and names are case-sensitive. |
|||||||||||||||||||||||||||||||
|
Encloses a receipt handle and an identifier for it.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
ReceiptHandle
|
String |
A receipt handle. |
||||
|
||||||
Id
|
String |
An identifier for this particular receipt handle. This is used to communicate the result. The |
||||
|
Name | Data Type | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
DeleteMessageBatchRequestEntryList
|
array [DeleteMessageBatchRequestEntry] | |||||||||||||||||||||||||
Properties
|
For each message in the batch, the response contains a DeleteMessageBatchResultEntry
tag if the message is deleted or a BatchResultErrorEntry
tag if the message can't be deleted.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Failed
|
BatchResultErrorEntryList |
A list of |
|||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
Successful
|
DeleteMessageBatchResultEntryList |
A list of |
|||||||||||||||||||||||||||||||||||||||||||||||||||
|
Encloses the Id
of an entry in DeleteMessageBatch.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
Id
|
String |
Represents a successfully deleted message. |
||||
|
Name | Data Type | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
DeleteMessageBatchResultEntryList
|
array [DeleteMessageBatchResultEntry] | |||||||||||||||
Properties
|
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
QueueUrl
|
String |
The URL of the Amazon SQS queue to delete. Queue URLs and names are case-sensitive. |
||||
|
Name | Data Type | Description |
---|---|---|
EmptyBatchRequest
|
Name | Data Type | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
AttributeNames
|
AttributeNameList |
A list of attributes for which to retrieve information. 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. The following attributes are supported:
The following attributes apply only to server-side-encryption:
The following attributes apply only to FIFO (first-in-first-out) queues:
|
|||||||||||
|
|||||||||||||
QueueUrl
|
String |
The URL of the Amazon SQS queue whose attribute information is retrieved. Queue URLs and names are case-sensitive. |
|||||||||||
|
A list of returned queue attributes.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
Attributes
|
QueueAttributeMap |
A map of attributes to their respective values. |
||||
|
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
QueueOwnerAWSAccountId
|
String |
The AWS account ID of the account that created the queue. |
||||
|
||||||
QueueName
|
String |
The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values: alphanumeric characters, hyphens ( Queue URLs and names are case-sensitive. |
||||
|
For more information, see Interpreting Responses in the Amazon Simple Queue Service Developer Guide.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
QueueUrl
|
String |
The URL of the queue. |
||||
|
Name | Data Type | Description |
---|---|---|
Integer
|
integer |
Name | Data Type | Description |
---|---|---|
InvalidAttributeName
|
Name | Data Type | Description |
---|---|---|
InvalidBatchEntryId
|
Name | Data Type | Description |
---|---|---|
InvalidIdFormat
|
Name | Data Type | Description |
---|---|---|
InvalidMessageContents
|
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
QueueUrl
|
String |
The URL of a dead-letter queue. Queue URLs and names are case-sensitive. |
||||
|
A list of your dead letter source queues.
Name | Data Type | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
queueUrls
|
QueueUrlList |
A list of source queue URLs that have the |
|||||||||||
|
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
QueueUrl
|
String |
The URL of the queue. |
||||
|
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
Tags
|
TagMap |
The list of all tags added to the specified queue. |
||||
|
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
QueueNamePrefix
|
String |
A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned. Queue URLs and names are case-sensitive. |
||||
|
A list of your queues.
Name | Data Type | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
QueueUrls
|
QueueUrlList |
A list of queue URLs, up to 1,000 entries. |
|||||||||||
|
An Amazon SQS message.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
MessageAttributes
|
MessageBodyAttributeMap |
Each message attribute consists of a |
||||
|
||||||
MD5OfMessageAttributes
|
String |
An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321. |
||||
|
||||||
Attributes
|
MessageSystemAttributeMap |
A map of the attributes requested in
|
||||
|
||||||
Body
|
String |
The message's contents (not URL-encoded). |
||||
|
||||||
MD5OfBody
|
String |
An MD5 digest of the non-URL-encoded message body string. |
||||
|
||||||
ReceiptHandle
|
String |
An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message. |
||||
|
||||||
MessageId
|
String |
A unique identifier for the message. A |
||||
|
Name | Data Type | Description |
---|---|---|
MessageAttributeName
|
string |
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
MessageAttributeNameList
|
array [MessageAttributeName] | |||||
|
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, see SendMessage.
Name
, type
, value
and the message body must not be empty or null. All parts of the message attribute, including Name
, Type
, and Value
, are part of the message size restriction (256 KB or 262,144 bytes).
Name | Data Type | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
DataType
|
String |
Amazon SQS supports the following logical data types: You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide. |
|||||||||||
|
|||||||||||||
BinaryListValues
|
BinaryList |
Not implemented. Reserved for future use. |
|||||||||||
|
|||||||||||||
StringListValues
|
StringList |
Not implemented. Reserved for future use. |
|||||||||||
|
|||||||||||||
BinaryValue
|
Binary |
Binary type attributes can store any binary data, such as compressed data, encrypted data, or images. |
|||||||||||
|
|||||||||||||
StringValue
|
String |
Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters. |
|||||||||||
|
Name | Data Type | Description |
---|---|---|
MessageBodyAttributeMap
|
array [object] |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
MessageList
|
array [Message] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
MessageNotInflight
|
Name | Data Type | Description |
---|---|---|
MessageSystemAttributeMap
|
array [object] |
Name | Data Type | Description |
---|---|---|
MessageSystemAttributeName
|
string Allowed values: - SenderId - SentTimestamp - ApproximateReceiveCount - ApproximateFirstReceiveTimestamp - SequenceNumber - MessageDeduplicationId - MessageGroupId |
Name | Data Type | Description |
---|---|---|
OverLimit
|
Name | Data Type | Description |
---|---|---|
PurgeQueueInProgress
|
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
QueueUrl
|
String |
The URL of the queue from which the Queue URLs and names are case-sensitive. |
||||
|
Name | Data Type | Description |
---|---|---|
QueueAttributeMap
|
array [object] |
Name | Data Type | Description |
---|---|---|
QueueAttributeName
|
string Allowed values: - All - Policy - VisibilityTimeout - MaximumMessageSize - MessageRetentionPeriod - ApproximateNumberOfMessages - ApproximateNumberOfMessagesNotVisible - CreatedTimestamp - LastModifiedTimestamp - QueueArn - ApproximateNumberOfMessagesDelayed - DelaySeconds - ReceiveMessageWaitTimeSeconds - RedrivePolicy - FifoQueue - ContentBasedDeduplication - KmsMasterKeyId - KmsDataKeyReusePeriodSeconds |
Name | Data Type | Description |
---|---|---|
QueueDeletedRecently
|
Name | Data Type | Description |
---|---|---|
QueueDoesNotExist
|
Name | Data Type | Description |
---|---|---|
QueueNameExists
|
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
QueueUrlList
|
array [String] | |||||
|
Name | Data Type | Description |
---|---|---|
ReceiptHandleIsInvalid
|
Name | Data Type | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ReceiveRequestAttemptId
|
String |
This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of
The length of For best practices of using |
|||||||||||
|
|||||||||||||
WaitTimeSeconds
|
Integer |
The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than |
|||||||||||
|
|||||||||||||
VisibilityTimeout
|
Integer |
The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a |
|||||||||||
|
|||||||||||||
MaxNumberOfMessages
|
Integer |
The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10. Default: 1. |
|||||||||||
|
|||||||||||||
MessageAttributeNames
|
MessageAttributeNameList |
The name of the message attribute, where N is the index.
When using |
|||||||||||
|
|||||||||||||
AttributeNames
|
AttributeNameList |
A list of s that need to be returned along with each message. These attributes include:
|
|||||||||||
|
|||||||||||||
QueueUrl
|
String |
The URL of the Amazon SQS queue from which messages are received. Queue URLs and names are case-sensitive. |
|||||||||||
|
A list of received messages.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Messages
|
MessageList |
A list of messages. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
Label
|
String |
The identification of the permission to remove. This is the label added using the |
||||
|
||||||
QueueUrl
|
String |
The URL of the Amazon SQS queue from which permissions are removed. Queue URLs and names are case-sensitive. |
||||
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Entries
|
SendMessageBatchRequestEntryList |
A list of |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
QueueUrl
|
String |
The URL of the Amazon SQS queue to which batched messages are sent. Queue URLs and names are case-sensitive. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contains the details of a single Amazon SQS message along with an Id
.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
MessageGroupId
|
String |
This parameter applies only to FIFO (first-in-first-out) queues. The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use
The length of For best practices of using |
||||
|
||||||
MessageDeduplicationId
|
String |
This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular
The If a message is sent successfully but the acknowledgement is lost and the message is resent with the same Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted. The length of For best practices of using |
||||
|
||||||
MessageAttributes
|
MessageBodyAttributeMap |
Each message attribute consists of a |
||||
|
||||||
DelaySeconds
|
Integer |
The length of time, in seconds, for which a specific message is delayed. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive When you set |
||||
|
||||||
MessageBody
|
String |
The body of the message. |
||||
|
||||||
Id
|
String |
An identifier for a message in this batch used to communicate the result. The This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_). |
||||
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
SendMessageBatchRequestEntryList
|
array [SendMessageBatchRequestEntry] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
For each message in the batch, the response contains a SendMessageBatchResultEntry
tag if the message succeeds or a BatchResultErrorEntry
tag if the message fails.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Failed
|
BatchResultErrorEntryList |
A list of |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Successful
|
SendMessageBatchResultEntryList |
A list of |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Encloses a MessageId
for a successfully-enqueued message in a SendMessageBatch.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
SequenceNumber
|
String |
This parameter applies only to FIFO (first-in-first-out) queues. The large, non-consecutive number that Amazon SQS assigns to each message. The length of |
||||
|
||||||
MD5OfMessageAttributes
|
String |
An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321. |
||||
|
||||||
MD5OfMessageBody
|
String |
An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321. |
||||
|
||||||
MessageId
|
String |
An identifier for the message. |
||||
|
||||||
Id
|
String |
An identifier for the message in this batch. |
||||
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
SendMessageBatchResultEntryList
|
array [SendMessageBatchResultEntry] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
MessageGroupId
|
String |
This parameter applies only to FIFO (first-in-first-out) queues. The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use
The length of For best practices of using |
||||
|
||||||
MessageDeduplicationId
|
String |
This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of sent messages. If a message with a particular
The If a message is sent successfully but the acknowledgement is lost and the message is resent with the same Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted. The length of For best practices of using |
||||
|
||||||
MessageAttributes
|
MessageBodyAttributeMap |
Each message attribute consists of a |
||||
|
||||||
DelaySeconds
|
Integer |
The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive When you set |
||||
|
||||||
MessageBody
|
String |
The message to send. The maximum string size is 256 KB. A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed: Any characters not included in this list will be rejected. For more information, see the W3C specification for characters. |
||||
|
||||||
QueueUrl
|
String |
The URL of the Amazon SQS queue to which a message is sent. Queue URLs and names are case-sensitive. |
||||
|
The MD5OfMessageBody
and MessageId
elements.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
SequenceNumber
|
String |
This parameter applies only to FIFO (first-in-first-out) queues. The large, non-consecutive number that Amazon SQS assigns to each message. The length of |
||||
|
||||||
MessageId
|
String |
An attribute containing the |
||||
|
||||||
MD5OfMessageAttributes
|
String |
An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321. |
||||
|
||||||
MD5OfMessageBody
|
String |
An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321. |
||||
|
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
Attributes
|
QueueAttributeMap |
A map of attributes to set. The following lists the names, descriptions, and values of the special request parameters that the
The following attributes apply only to server-side-encryption:
The following attribute applies only to FIFO (first-in-first-out) queues:
|
||||
|
||||||
QueueUrl
|
String |
The URL of the Amazon SQS queue whose attributes are set. Queue URLs and names are case-sensitive. |
||||
|
Name | Data Type | Description |
---|---|---|
String
|
string |
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
StringList
|
array [String] | |||||
|
Name | Data Type | Description |
---|---|---|
TagKey
|
string |
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
TagKeyList
|
array [TagKey] | |||||
|
Name | Data Type | Description |
---|---|---|
TagMap
|
array [object] |
Name | Data Type | Description |
---|---|---|
TagValue
|
string |
Name | Data Type | Description |
---|---|---|
TooManyEntriesInBatchRequest
|
Name | Data Type | Description |
---|---|---|
UnsupportedOperation
|
Name | Data Type | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
TagKeys
|
TagKeyList |
The list of tags to be removed from the specified queue. |
|||||||||||
|
|||||||||||||
QueueUrl
|
String |
The URL of the queue. |
|||||||||||
|
Amazon Signature authorization v4
header
Authorization
awsSigv4
Name | AWS |
External URL | https://docs.aws.amazon.com/sqs/index.html |
Release | v4 |
Provider Name | amazonaws.com |
Service Name | sqs |
Origin - ContentType | application/json |
Origin - Url | https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/sqs-2012-11-05.normal.json |
Api Client Registration | https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct |
Preferred | Yes |
API Version | 2012-11-05 |
Has Equivalent Paths | Yes |