Amazon::API::SQS
Amazon Simple Queue Service
Version 2.1.4
Adds a permission to a queue for a specific principal (https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P). 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 (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-writing-an-sqs-policy.html#write-messages-to-shared-queue) in the Amazon SQS Developer Guide.
AddPermission generates a policy for you. You can use
SetQueueAttributes to upload your policy. For more information, see
Using Custom Policies with the Amazon SQS Access Policy Language
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html)
in the Amazon SQS Developer Guide.AddPermission, RemovePermission, and
SetQueueAttributes actions in your IAM policy.AddPermission does not support adding a non-account
principal.Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) in the Amazon SQS Developer Guide.
AWSAccountIds
The Amazon Web Services account numbers of the principals (https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P) who are to receive permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html#sqs-api-request-authentication) in the Amazon SQS Developer Guide.
Actions
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 (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-overview-of-managing-access.html) in the Amazon SQS Developer Guide.
Specifying SendMessage, DeleteMessage, or
ChangeMessageVisibility for ActionName.n also grants permissions
for the corresponding batch versions of those actions:
SendMessageBatch, DeleteMessageBatch, and
ChangeMessageVisibilityBatch.
Label
The unique identification of the permission you're setting (for
example, AliceSendMessage). Maximum 80 characters. Allowed
characters include alphanumeric characters, hyphens (-), and
underscores (_).
QueueUrl
The URL of the Amazon SQS queue to which permissions are added.
Queue URLs and names are case-sensitive.
ERRORS
OverLimit
The specified action violates a limit. For example, ReceiveMessage
returns this error if the maximum number of in flight messages is
reached and AddPermission returns this error if the maximum number
of permissions for the queue is reached.
RequestThrottled
The request was denied due to request throttling.
QueueDoesNotExist
Ensure that the QueueUrl is correct and that the queue has not been
deleted.
InvalidAddress
The specified ID is invalid.
InvalidSecurity
The request was not made over HTTPS or did not use SigV4 for signing.
UnsupportedOperation
Error code 400. Unsupported operation.
METHOD
POST
REQUEST URI
/
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.
Only one active message movement task is supported per queue at any given time.
INPUT
TaskHandle
An identifier associated with a message movement task.
ApproximateNumberOfMessagesMoved
The approximate number of messages already moved to the destination queue.
ERRORS
ResourceNotFoundException
One or more specified resources don't exist.
RequestThrottled
The request was denied due to request throttling.
InvalidAddress
The specified ID is invalid.
InvalidSecurity
The request was not made over HTTPS or did not use SigV4 for signing.
UnsupportedOperation
Error code 400. Unsupported operation.
METHOD
POST
REQUEST URI
/
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 (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) 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 VisibilityTimeout set to 10
seconds, the 10 seconds begin to count from the time that you make the
ChangeMessageVisibility call. Thus, any attempt to change the
visibility timeout or to delete that message 10 seconds after you
initially change the visibility timeout (a total of 25 seconds) might
result in an error.
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
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. To
request a limit increase, file a support request
(https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-sqs).
For FIFO queues, there can be a maximum of 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 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.
QueueUrl
The URL of the Amazon SQS queue whose message's visibility is changed.
Queue URLs and names are case-sensitive.
ReceiptHandle
The receipt handle associated with the message, whose visibility
timeout is changed. This parameter is returned by the ReceiveMessage
action.
VisibilityTimeout
The new value for the message's visibility timeout (in seconds). Values
range: 0 to 43200. Maximum: 12 hours.
ERRORS
MessageNotInflight
The specified message isn't in flight.
ReceiptHandleIsInvalid
The specified receipt handle isn't valid.
RequestThrottled
The request was denied due to request throttling.
QueueDoesNotExist
Ensure that the QueueUrl is correct and that the queue has not been
deleted.
UnsupportedOperation
Error code 400. Unsupported operation.
InvalidAddress
The specified ID is invalid.
InvalidSecurity
The request was not made over HTTPS or did not use SigV4 for signing.
METHOD
POST
REQUEST URI
/
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.
Entries
Lists the receipt handles of the messages for which the visibility timeout must be changed.
QueueUrl
The URL of the Amazon SQS queue whose messages' visibility is changed.
Queue URLs and names are case-sensitive.
Failed
A list of BatchResultErrorEntry items.
Successful
A list of ChangeMessageVisibilityBatchResultEntry items.
ERRORS
TooManyEntriesInBatchRequest
The batch request contains more entries than permissible. For Amazon SQS, the maximum number of entries you can include in a single SendMessageBatch (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessageBatch.html), DeleteMessageBatch (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_DeleteMessageBatch.html), or ChangeMessageVisibilityBatch (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ChangeMessageVisibilityBatch.html) request is 10.
EmptyBatchRequest
The batch request doesn't contain any entries.
BatchEntryIdsNotDistinct
Two or more batch entries in the request have the same Id.
InvalidBatchEntryId
The Id of a batch entry in a batch request doesn't abide by the
specification.
RequestThrottled
The request was denied due to request throttling.
QueueDoesNotExist
Ensure that the QueueUrl is correct and that the queue has not been
deleted.
UnsupportedOperation
Error code 400. Unsupported operation.
InvalidAddress
The specified ID is invalid.
InvalidSecurity
The request was not made over HTTPS or did not use SigV4 for signing.
METHOD
POST
REQUEST URI
/
Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following 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 (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-moving) in the Amazon SQS Developer Guide.
If you don't provide a value for an attribute, the queue is created with the default value for the attribute.
To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html) 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 retrieve the URL of a queue, use the GetQueueUrl
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_GetQueueUrl.html)
action. This action only requires the QueueName
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html#API_CreateQueue_RequestSyntax)
parameter.
When creating queues, keep the following points in mind:
CreateQueue
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html)
action will return the URL of the existing queue instead of creating a
new one.CreateQueue action
will return an error. This ensures that existing queues are not
inadvertently altered.Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) in the Amazon SQS Developer Guide.
Attributes
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special
request parameters that the CreateQueue action uses:
DelaySeconds – The length of time, in seconds, for which the
delivery of all messages in the queue is delayed. Valid values: An
integer from 0 to 900 seconds (15 minutes). Default: 0.MaximumMessageSize – The limit of how many bytes a message
can contain before Amazon SQS rejects it. Valid values: An integer from
1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256
KiB).MessageRetentionPeriod – The length of time, in seconds, for
which Amazon SQS retains a message. Valid values: An integer from 60
seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4
days). 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 and will impact existing messages
in the queue potentially causing them to be expired and deleted if the
MessageRetentionPeriod is reduced below the age of existing
messages.Policy – The queue's policy. A valid Amazon Web Services
policy. For more information about policy structure, see Overview of
Amazon Web Services IAM Policies
(https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html)
in the IAM User Guide.ReceiveMessageWaitTimeSeconds – The length of time, in
seconds, for which a ReceiveMessage action waits for a message to
arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.VisibilityTimeout – The visibility timeout for the queue, in
seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default:The following attributes apply only to dead-letter queues: (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html)
RedrivePolicy – The string that includes the parameters for
the dead-letter queue functionality of the source queue as a JSON
object. The parameters are as follows:
deadLetterTargetArn – The Amazon Resource Name (ARN) of the
dead-letter queue to which Amazon SQS moves messages after the value of
maxReceiveCount is exceeded.maxReceiveCount – The number of times a message is delivered
to the source queue before being moved to the dead-letter queue.
Default: 10. When the ReceiveCount for a message exceeds the
maxReceiveCount for a queue, Amazon SQS moves the message to the
dead-letter-queue.RedriveAllowPolicy – The string that includes the parameters
for the permissions for the dead-letter queue redrive permission and
which source queues can specify dead-letter queues as a JSON object.
The parameters are as follows:
redrivePermission – The permission type that defines which
source queues can specify the current queue as the dead-letter queue.
Valid values are:
allowAll – (Default) Any source queues in this Amazon Web
Services account in the same Region can specify this queue as the
dead-letter queue.denyAll – No source queues can specify this queue as the
dead-letter queue.byQueue – Only queues specified by the sourceQueueArns
parameter can specify this queue as the dead-letter queue.sourceQueueArns – The Amazon Resource Names (ARN)s of the
source queues that can specify this queue as the dead-letter queue and
redrive messages. You can specify this parameter only when the
redrivePermission parameter is set to byQueue. You can specify up
to 10 source queue ARNs. To allow more than 10 source queues to specify
dead-letter queues, set the redrivePermission parameter to
allowAll.The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
The following attributes apply only to server-side-encryption (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html):
KmsMasterKeyId – The ID of an Amazon Web Services managed
customer master key (CMK) for Amazon SQS or a custom CMK. For more
information, see Key Terms
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms).
While the alias of the Amazon Web Services managed CMK for Amazon SQS
is always alias/aws/sqs, the alias of a custom CMK can, for example,
be alias/_MyAlias_. For more examples, see KeyId
(https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters)
in the Key Management Service API Reference.KmsDataKeyReusePeriodSeconds – The length of time, in
seconds, for which Amazon SQS can reuse a data key
(https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys)
to encrypt or decrypt messages before calling KMS again. An integer
representing seconds, between 60 seconds (1 minute) and 86,400 seconds
(24 hours). Default: 300 (5 minutes). A shorter time period provides
better security but results in more calls to KMS which might incur
charges after Free Tier. For more information, see How Does the Data
Key Reuse Period Work?
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work)SqsManagedSseEnabled – Enables server-side queue encryption
using SQS owned encryption keys. Only one server-side encryption option
is supported per queue (for example, SSE-KMS
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html)
or SSE-SQS
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)).The following attributes apply only to FIFO (first-in-first-out) queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html):
FifoQueue – Designates a queue as FIFO. Valid values are
true and false. If you don't specify the FifoQueue attribute,
Amazon SQS creates a standard queue. You can provide this attribute
only during queue creation. You can't change it for an existing queue.
When you set this attribute, you must also provide the
MessageGroupId for your messages explicitly.
For more information, see FIFO queue logic
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html)
in the _Amazon SQS Developer Guide_.
ContentBasedDeduplication – Enables content-based
deduplication. Valid values are true and false. For more
information, see Exactly-once processing
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html)
in the Amazon SQS Developer Guide. Note the following:
MessageDeduplicationId.
MessageDeduplicationId explicitly.MessageDeduplicationId and you
enable ContentBasedDeduplication for your queue, Amazon SQS uses a
SHA-256 hash to generate the MessageDeduplicationId using the body
of the message (but not the attributes of the message).MessageDeduplicationId and the queue doesn't
have ContentBasedDeduplication set, the action fails with an error.ContentBasedDeduplication set, your
MessageDeduplicationId overrides the generated one.ContentBasedDeduplication is in effect, messages with identical
content sent within the deduplication interval are treated as
duplicates and only one copy of the message is delivered.ContentBasedDeduplication enabled and
then another message with a MessageDeduplicationId that is the same
as the one generated for the first MessageDeduplicationId, the two
messages are treated as duplicates and only one copy of the message is
delivered.The following attributes apply only to high throughput for FIFO queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html):
DeduplicationScope – Specifies whether message deduplication
occurs at the message group or queue level. Valid values are
messageGroup and queue.FifoThroughputLimit – Specifies whether the FIFO queue
throughput quota applies to the entire queue or per message group.
Valid values are perQueue and perMessageGroupId. The
perMessageGroupId value is allowed only when the value for
DeduplicationScope is messageGroup.To enable high throughput for FIFO queues, do the following:
DeduplicationScope to messageGroup.FifoThroughputLimit to perMessageGroupId.If you set these attributes to anything other than the values shown for enabling high throughput, normal throughput is in effect and deduplication occurs as specified.
For information on throughput quotas, see Quotas related to messages (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the Amazon SQS Developer Guide.
QueueName
The name of the new queue. The following limits apply to this name:
-), and underscores
(_)..fifo suffix.Queue URLs and names are case-sensitive.
tags
Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html) 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 (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues) in the Amazon SQS Developer Guide.
To be able to tag a queue on creation, you must have the
sqs:CreateQueue and sqs:TagQueue permissions.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) in the Amazon SQS Developer Guide.
QueueUrl
The URL of the created Amazon SQS queue.
ERRORS
QueueDeletedRecently
You must wait 60 seconds after deleting a queue before you can create another queue with the same name.
QueueNameExists
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.
RequestThrottled
The request was denied due to request throttling.
InvalidAddress
The specified ID is invalid.
InvalidAttributeName
The specified attribute doesn't exist.
InvalidAttributeValue
A queue attribute value is invalid.
UnsupportedOperation
Error code 400. Unsupported operation.
InvalidSecurity
The request was not made over HTTPS or did not use SigV4 for signing.
METHOD
POST
REQUEST URI
/
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.
Each time you receive a message, meaning when a consumer retrieves a
message from the queue, it comes with a unique ReceiptHandle. If you
receive the same message more than once, you will get a different
ReceiptHandle each time. When you want to delete a message using the
DeleteMessage action, you must use the ReceiptHandle from the
most recent time you received the message. If you use an old
ReceiptHandle, the request will succeed, 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.
QueueUrl
The URL of the Amazon SQS queue from which messages are deleted.
Queue URLs and names are case-sensitive.
ReceiptHandle
The receipt handle associated with the message to delete.
ERRORS
InvalidIdFormat
The specified receipt handle isn't valid for the current version.
ReceiptHandleIsInvalid
The specified receipt handle isn't valid.
RequestThrottled
The request was denied due to request throttling.
QueueDoesNotExist
Ensure that the QueueUrl is correct and that the queue has not been
deleted.
UnsupportedOperation
Error code 400. Unsupported operation.
InvalidSecurity
The request was not made over HTTPS or did not use SigV4 for signing.
InvalidAddress
The specified ID is invalid.
METHOD
POST
REQUEST URI
/
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.
Entries
Lists the receipt handles for the messages to be deleted.
QueueUrl
The URL of the Amazon SQS queue from which messages are deleted.
Queue URLs and names are case-sensitive.
Failed
A list of BatchResultErrorEntry items.
Successful
A list of DeleteMessageBatchResultEntry items.
ERRORS
TooManyEntriesInBatchRequest
The batch request contains more entries than permissible. For Amazon SQS, the maximum number of entries you can include in a single SendMessageBatch (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessageBatch.html), DeleteMessageBatch (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_DeleteMessageBatch.html), or ChangeMessageVisibilityBatch (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ChangeMessageVisibilityBatch.html) request is 10.
EmptyBatchRequest
The batch request doesn't contain any entries.
BatchEntryIdsNotDistinct
Two or more batch entries in the request have the same Id.
InvalidBatchEntryId
The Id of a batch entry in a batch request doesn't abide by the
specification.
RequestThrottled
The request was denied due to request throttling.
QueueDoesNotExist
Ensure that the QueueUrl is correct and that the queue has not been
deleted.
UnsupportedOperation
Error code 400. Unsupported operation.
InvalidAddress
The specified ID is invalid.
InvalidSecurity
The request was not made over HTTPS or did not use SigV4 for signing.
METHOD
POST
REQUEST URI
/
Deletes the queue specified by the QueueUrl, regardless of the
queue's contents.
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 Grant cross-account permissions to a role and a username (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) in the Amazon SQS Developer Guide.
The delete operation uses the HTTP GET verb.
QueueUrl
The URL of the Amazon SQS queue to delete.
Queue URLs and names are case-sensitive.
ERRORS
RequestThrottled
The request was denied due to request throttling.
QueueDoesNotExist
Ensure that the QueueUrl is correct and that the queue has not been
deleted.
InvalidAddress
The specified ID is invalid.
UnsupportedOperation
Error code 400. Unsupported operation.
InvalidSecurity
The request was not made over HTTPS or did not use SigV4 for signing.
METHOD
POST
REQUEST URI
/
Gets attributes for the specified queue.
To determine whether a queue is FIFO
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html),
you can check whether QueueName ends with the .fifo suffix.
AttributeNames
A list of attributes for which to retrieve information.
The AttributeNames parameter is optional, but if you don't specify
values for this parameter, the request returns empty results.
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 ApproximateNumberOfMessagesDelayed,
ApproximateNumberOfMessagesNotVisible, and
ApproximateNumberOfMessages metrics may not achieve consistency
until at least 1 minute after the producers stop sending messages. This
period is required for the queue metadata to reach eventual
consistency.
All – Returns all values.ApproximateNumberOfMessages – Returns the approximate number
of messages available for retrieval from the queue.ApproximateNumberOfMessagesDelayed – Returns the approximate
number of messages in the queue that are delayed and not available for
reading immediately. This can happen when the queue is configured as a
delay queue or when a message has been sent with a delay parameter.ApproximateNumberOfMessagesNotVisible – Returns the
approximate number of messages that are in flight. Messages are
considered to be in flight if they have been sent to a client but
have not yet been deleted or have not yet reached the end of their
visibility window.CreatedTimestamp – Returns the time when the queue was
created in seconds (epoch time
(http://en.wikipedia.org/wiki/Unix_time)).DelaySeconds – Returns the default delay on the queue in
seconds.LastModifiedTimestamp – Returns the time when the queue was
last changed in seconds (epoch time
(http://en.wikipedia.org/wiki/Unix_time)).MaximumMessageSize – Returns the limit of how many bytes a
message can contain before Amazon SQS rejects it.MessageRetentionPeriod – Returns the length of time, in
seconds, for which Amazon SQS retains a message. 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 and will impact existing messages in the queue potentially
causing them to be expired and deleted if the MessageRetentionPeriod
is reduced below the age of existing messages.Policy – Returns the policy of the queue.QueueArn – Returns the Amazon resource name (ARN) of the
queue.ReceiveMessageWaitTimeSeconds – Returns the length of time,
in seconds, for which the ReceiveMessage action waits for a message
to arrive.VisibilityTimeout – Returns the visibility timeout for the
queue. For more information about the visibility timeout, see
Visibility Timeout
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html)
in the Amazon SQS Developer Guide.The following attributes apply only to dead-letter queues: (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html)
RedrivePolicy – The string that includes the parameters for
the dead-letter queue functionality of the source queue as a JSON
object. The parameters are as follows:
deadLetterTargetArn – The Amazon Resource Name (ARN) of the
dead-letter queue to which Amazon SQS moves messages after the value of
maxReceiveCount is exceeded.maxReceiveCount – The number of times a message is delivered
to the source queue before being moved to the dead-letter queue.
Default: 10. When the ReceiveCount for a message exceeds the
maxReceiveCount for a queue, Amazon SQS moves the message to the
dead-letter-queue.RedriveAllowPolicy – The string that includes the parameters
for the permissions for the dead-letter queue redrive permission and
which source queues can specify dead-letter queues as a JSON object.
The parameters are as follows:
redrivePermission – The permission type that defines which
source queues can specify the current queue as the dead-letter queue.
Valid values are:
allowAll – (Default) Any source queues in this Amazon Web
Services account in the same Region can specify this queue as the
dead-letter queue.denyAll – No source queues can specify this queue as the
dead-letter queue.byQueue – Only queues specified by the sourceQueueArns
parameter can specify this queue as the dead-letter queue.sourceQueueArns – The Amazon Resource Names (ARN)s of the
source queues that can specify this queue as the dead-letter queue and
redrive messages. You can specify this parameter only when the
redrivePermission parameter is set to byQueue. You can specify up
to 10 source queue ARNs. To allow more than 10 source queues to specify
dead-letter queues, set the redrivePermission parameter to
allowAll.The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
The following attributes apply only to server-side-encryption (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html):
KmsMasterKeyId – Returns the ID of an Amazon Web Services
managed customer master key (CMK) for Amazon SQS or a custom CMK. For
more information, see Key Terms
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms).KmsDataKeyReusePeriodSeconds – Returns the length of time, in
seconds, for which Amazon SQS can reuse a data key to encrypt or
decrypt messages before calling KMS again. For more information, see
How Does the Data Key Reuse Period Work?
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work).SqsManagedSseEnabled – Returns information about whether the
queue is using SSE-SQS encryption using SQS owned encryption keys. Only
one server-side encryption option is supported per queue (for example,
SSE-KMS
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html)
or SSE-SQS
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)).The following attributes apply only to FIFO (first-in-first-out) queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html):
FifoQueue – Returns information about whether the queue is
FIFO. For more information, see FIFO queue logic
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html)
in the Amazon SQS Developer Guide.
To determine whether a queue is FIFO
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html),
you can check whether `QueueName` ends with the `.fifo` suffix.
ContentBasedDeduplication – Returns whether content-based
deduplication is enabled for the queue. For more information, see
Exactly-once processing
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html)
in the Amazon SQS Developer Guide.The following attributes apply only to high throughput for FIFO queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html):
DeduplicationScope – Specifies whether message deduplication
occurs at the message group or queue level. Valid values are
messageGroup and queue.FifoThroughputLimit – Specifies whether the FIFO queue
throughput quota applies to the entire queue or per message group.
Valid values are perQueue and perMessageGroupId. The
perMessageGroupId value is allowed only when the value for
DeduplicationScope is messageGroup.To enable high throughput for FIFO queues, do the following:
DeduplicationScope to messageGroup.FifoThroughputLimit to perMessageGroupId.If you set these attributes to anything other than the values shown for enabling high throughput, normal throughput is in effect and deduplication occurs as specified.
For information on throughput quotas, see Quotas related to messages (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the Amazon SQS Developer Guide.
QueueUrl
The URL of the Amazon SQS queue whose attribute information is retrieved.
Queue URLs and names are case-sensitive.
Attributes
A map of attributes to their respective values.
ERRORS
InvalidAttributeName
The specified attribute doesn't exist.
RequestThrottled
The request was denied due to request throttling.
QueueDoesNotExist
Ensure that the QueueUrl is correct and that the queue has not been
deleted.
UnsupportedOperation
Error code 400. Unsupported operation.
InvalidSecurity
The request was not made over HTTPS or did not use SigV4 for signing.
InvalidAddress
The specified ID is invalid.
METHOD
POST
REQUEST URI
/
The GetQueueUrl API returns the URL of an existing Amazon SQS queue.
This is useful when you know the queue's name but need to retrieve its
URL for further operations.
To access a queue owned by another Amazon Web Services account, use the
QueueOwnerAWSAccountId parameter to specify the account ID of the
queue's owner. Note that the queue owner must grant you the necessary
permissions to access the queue. For more information about accessing
shared queues, see the AddPermission API or Allow developers to
write messages to a shared queue
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-writing-an-sqs-policy.html#write-messages-to-shared-queue)
in the Amazon SQS Developer Guide.
QueueName
(Required) The name of the queue for which you want to fetch the URL. The name can be up to 80 characters long and can include alphanumeric characters, hyphens (-), and underscores (_). Queue URLs and names are case-sensitive.
QueueOwnerAWSAccountId
(Optional) The Amazon Web Services account ID of the account that created the queue. This is only required when you are attempting to access a queue owned by another Amazon Web Services account.
QueueUrl
The URL of the queue.
ERRORS
RequestThrottled
The request was denied due to request throttling.
QueueDoesNotExist
Ensure that the QueueUrl is correct and that the queue has not been
deleted.
InvalidAddress
The specified ID is invalid.
InvalidSecurity
The request was not made over HTTPS or did not use SigV4 for signing.
UnsupportedOperation
Error code 400. Unsupported operation.
METHOD
POST
REQUEST URI
/
Returns a list of your queues that have the RedrivePolicy queue
attribute configured with a dead-letter queue.
The ListDeadLetterSourceQueues methods supports pagination. Set
parameter MaxResults in the request to specify the maximum number of
results to be returned in the response. If you do not set
MaxResults, the response includes a maximum of 1,000 results. If you
set MaxResults and there are additional results to display, the
response includes a value for NextToken. Use NextToken as a
parameter in your next request to ListDeadLetterSourceQueues to
receive the next page of results.
For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) in the Amazon SQS Developer Guide.
MaxResults
Maximum number of results to include in the response. Value range is 1
to 1000. You must set MaxResults to receive a value for NextToken
in the response.
NextToken
Pagination token to request the next set of results.
QueueUrl
The URL of a dead-letter queue.
Queue URLs and names are case-sensitive.
NextToken
Pagination token to include in the next request. Token value is null
if there are no additional results to request, or if you did not set
MaxResults in the request.
queueUrls
A list of source queue URLs that have the RedrivePolicy queue
attribute configured with a dead-letter queue.
ERRORS
QueueDoesNotExist
Ensure that the QueueUrl is correct and that the queue has not been
deleted.
RequestThrottled
The request was denied due to request throttling.
InvalidSecurity
The request was not made over HTTPS or did not use SigV4 for signing.
InvalidAddress
The specified ID is invalid.
UnsupportedOperation
Error code 400. Unsupported operation.
METHOD
POST
REQUEST URI
/
Gets the most recent message movement tasks (up to 10) under a specific source queue.
Only one active message movement task is supported per queue at any given time.
INPUT
MaxResults
The maximum number of results to include in the response. The default is 1, which provides the most recent message movement task. The upper limit is 10.
SourceArn
The ARN of the queue whose message movement tasks are to be listed.
Results
A list of message movement tasks and their attributes.
ERRORS
ResourceNotFoundException
One or more specified resources don't exist.
RequestThrottled
The request was denied due to request throttling.
InvalidAddress
The specified ID is invalid.
InvalidSecurity
The request was not made over HTTPS or did not use SigV4 for signing.
UnsupportedOperation
Error code 400. Unsupported operation.
METHOD
POST
REQUEST URI
/
List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html) 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 (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) in the Amazon SQS Developer Guide.
QueueUrl
The URL of the queue.
Tags
The list of all tags added to the specified queue.
ERRORS
RequestThrottled
The request was denied due to request throttling.
QueueDoesNotExist
Ensure that the QueueUrl is correct and that the queue has not been
deleted.
UnsupportedOperation
Error code 400. Unsupported operation.
InvalidAddress
The specified ID is invalid.
InvalidSecurity
The request was not made over HTTPS or did not use SigV4 for signing.
METHOD
POST
REQUEST URI
/
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 QueueNamePrefix parameter, only queues with a name that
begins with the specified value are returned.
The listQueues methods supports pagination. Set parameter
MaxResults in the request to specify the maximum number of results
to be returned in the response. If you do not set MaxResults, the
response includes a maximum of 1,000 results. If you set MaxResults
and there are additional results to display, the response includes a
value for NextToken. Use NextToken as a parameter in your next
request to listQueues to receive the next page of results.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) in the Amazon SQS Developer Guide.
MaxResults
Maximum number of results to include in the response. Value range is 1
to 1000. You must set MaxResults to receive a value for NextToken
in the response.
NextToken
Pagination token to request the next set of results.
QueueNamePrefix
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.
NextToken
Pagination token to include in the next request. Token value is null
if there are no additional results to request, or if you did not set
MaxResults in the request.
QueueUrls
A list of queue URLs, up to 1,000 entries, or the value of
MaxResults that you sent in the request.
ERRORS
RequestThrottled
The request was denied due to request throttling.
InvalidSecurity
The request was not made over HTTPS or did not use SigV4 for signing.
InvalidAddress
The specified ID is invalid.
UnsupportedOperation
Error code 400. Unsupported operation.
METHOD
POST
REQUEST URI
/
Deletes available messages in a queue (including in-flight messages)
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.
QueueUrl
The URL of the queue from which the PurgeQueue action deletes
messages.
Queue URLs and names are case-sensitive.
ERRORS
QueueDoesNotExist
Ensure that the QueueUrl is correct and that the queue has not been
deleted.
PurgeQueueInProgress
Indicates that the specified queue previously received a PurgeQueue
request within the last 60 seconds (the time it can take to delete the
messages in the queue).
RequestThrottled
The request was denied due to request throttling.
InvalidAddress
The specified ID is invalid.
InvalidSecurity
The request was not made over HTTPS or did not use SigV4 for signing.
UnsupportedOperation
Error code 400. Unsupported operation.
METHOD
POST
REQUEST URI
/
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
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html)
in the Amazon SQS Developer Guide.
Short poll is the default behavior where a weighted random set of
machines is sampled on a ReceiveMessage call. Therefore, 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:
MessageId you received when you sent the message to the queue.The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html) in the Amazon SQS 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. The default
visibility timeout for a queue is 30 seconds.
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.
AttributeNames
This parameter has been discontinued but will be supported for backward
compatibility. To provide attribute names, you are encouraged to use
MessageSystemAttributeNames.
A list of attributes that need to be returned along with each message. These attributes include:
All – Returns all values.ApproximateFirstReceiveTimestamp – Returns the time the
message was first received from the queue (epoch time
(http://en.wikipedia.org/wiki/Unix_time) in milliseconds).ApproximateReceiveCount – Returns the number of times a
message has been received across all queues but not deleted.AWSTraceHeader – Returns the X-Ray trace header string.SenderId
ABCDEFGHI1JKLMNOPQ23R.ABCDE1F2GH3I4JK5LMNOP:i-a123b456.SentTimestamp – Returns the time the message was sent to the
queue (epoch time (http://en.wikipedia.org/wiki/Unix_time) in
milliseconds).SqsManagedSseEnabled – Enables server-side queue encryption
using SQS owned encryption keys. Only one server-side encryption option
is supported per queue (for example, SSE-KMS
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html)
or SSE-SQS
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)).MessageDeduplicationId – Returns the value provided by the
producer that calls the SendMessage action.MessageGroupId – Returns the value provided by the producer
that calls the SendMessage action. Messages with the same
MessageGroupId are returned in sequence.SequenceNumber – Returns the value provided by Amazon SQS.MaxNumberOfMessages
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
The name of the message attribute, where N is the index.
_),
hyphen (-), and period (.).AWS. or
Amazon. (or any casing variants)..), and it should not
have periods in succession (..). When using ReceiveMessage, you can send a list of attribute names to
receive, or you can return all of the attributes by specifying All
or .* in your request. You can also use all message attributes
starting with a prefix, for example bar.*.
MessageSystemAttributeNames
A list of attributes that need to be returned along with each message. These attributes include:
All – Returns all values.ApproximateFirstReceiveTimestamp – Returns the time the
message was first received from the queue (epoch time
(http://en.wikipedia.org/wiki/Unix_time) in milliseconds).ApproximateReceiveCount – Returns the number of times a
message has been received across all queues but not deleted.AWSTraceHeader – Returns the X-Ray trace header string.SenderId
ABCDEFGHI1JKLMNOPQ23R.ABCDE1F2GH3I4JK5LMNOP:i-a123b456.SentTimestamp – Returns the time the message was sent to the
queue (epoch time (http://en.wikipedia.org/wiki/Unix_time) in
milliseconds).SqsManagedSseEnabled – Enables server-side queue encryption
using SQS owned encryption keys. Only one server-side encryption option
is supported per queue (for example, SSE-KMS
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html)
or SSE-SQS
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)).MessageDeduplicationId – Returns the value provided by the
producer that calls the SendMessage action.MessageGroupId – Returns the value provided by the producer
that calls the SendMessage action. Messages with the same
MessageGroupId are returned in sequence.SequenceNumber – Returns the value provided by Amazon SQS.QueueUrl
The URL of the Amazon SQS queue from which messages are received.
Queue URLs and names are case-sensitive.
ReceiveRequestAttemptId
This parameter applies only to FIFO (first-in-first-out) queues.
The token used for deduplication of ReceiveMessage calls. If a
networking issue occurs after a ReceiveMessage action, and instead
of a response you receive a generic error, it is possible to retry the
same action with an identical ReceiveRequestAttemptId to retrieve
the same set of messages, even if their visibility timeout has not yet
expired.
ReceiveRequestAttemptId only for 5 minutes after a
ReceiveMessage action.FifoQueue, a caller of the ReceiveMessage action can
provide a ReceiveRequestAttemptId explicitly.ReceiveMessage action with the same
ReceiveRequestAttemptId if none of the messages have been modified
(deleted or had their visibility changes).During a visibility timeout, subsequent calls with the same
ReceiveRequestAttemptId return the same messages and receipt
handles. If a retry occurs within the deduplication interval, it resets
the visibility timeout. For more information, see Visibility Timeout
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html)
in the Amazon SQS Developer Guide.
If a caller of the `ReceiveMessage` action still processes messages
when the visibility timeout expires and messages become visible,
another worker consuming from the same queue can receive the same
messages and therefore process duplicates. Also, if a consumer whose
message processing time is longer than the visibility timeout tries to
delete the processed messages, the action fails with an error.
To mitigate this effect, ensure that your application observes a safe
threshold before the visibility timeout expires and extend the
visibility timeout as necessary.
MessageGroupId are invisible, no
more messages belonging to the same MessageGroupId are returned
until the visibility timeout expires. You can still receive messages
with another MessageGroupId as long as it is also visible.ReceiveMessage can't track the
ReceiveRequestAttemptId, no retries work until the original
visibility timeout expires. As a result, delays might occur but the
messages in the queue remain in a strict order.The maximum length of ReceiveRequestAttemptId is 128 characters.
ReceiveRequestAttemptId can contain alphanumeric characters (a-z,
A-Z, 0-9) and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
For best practices of using ReceiveRequestAttemptId, see Using the
ReceiveRequestAttemptId Request Parameter
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-receiverequestattemptid-request-parameter.html)
in the Amazon SQS Developer Guide.
VisibilityTimeout
The duration (in seconds) that the received messages are hidden from
subsequent retrieve requests after being retrieved by a
ReceiveMessage request. If not specified, the default visibility
timeout for the queue is used, which is 30 seconds.
Understanding VisibilityTimeout:
--visibility-timeout
parameter in the receive-message command to match the processing
time required by your application.For more information, see Visibility Timeout (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the Amazon SQS Developer Guide.
WaitTimeSeconds
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 WaitTimeSeconds. If no messages are
available and the wait time expires, the call does not return a message
list. If you are using the Java SDK, it returns a
ReceiveMessageResponse object, which has a empty list instead of a
Null object.
To avoid HTTP errors, ensure that the HTTP response timeout for
ReceiveMessage requests is longer than the WaitTimeSeconds
parameter. For example, with the Java SDK, you can set HTTP transport
settings using the NettyNioAsyncHttpClient
(https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/nio/netty/NettyNioAsyncHttpClient.html)
for asynchronous clients, or the ApacheHttpClient
(https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.html)
for synchronous clients.
Messages
A list of messages.
ERRORS
UnsupportedOperation
Error code 400. Unsupported operation.
OverLimit
The specified action violates a limit. For example, ReceiveMessage
returns this error if the maximum number of in flight messages is
reached and AddPermission returns this error if the maximum number
of permissions for the queue is reached.
RequestThrottled
The request was denied due to request throttling.
QueueDoesNotExist
Ensure that the QueueUrl is correct and that the queue has not been
deleted.
InvalidSecurity
The request was not made over HTTPS or did not use SigV4 for signing.
KmsDisabled
The request was denied due to request throttling.
KmsInvalidState
The request was rejected because the state of the specified resource is not valid for this request.
KmsNotFound
The request was rejected because the specified entity or resource could not be found.
KmsOptInRequired
The request was rejected because the specified key policy isn't syntactically or semantically correct.
KmsThrottled
Amazon Web Services KMS throttles requests for the following conditions.
KmsAccessDenied
The caller doesn't have the required KMS access.
KmsInvalidKeyUsage
The request was rejected for one of the following reasons:
InvalidAddress
The specified ID is invalid.
METHOD
POST
REQUEST URI
/
Revokes any permissions in the queue policy that matches the specified
Label parameter.
To remove the ability to change queue permissions, you must deny
permission to the AddPermission, RemovePermission, and
SetQueueAttributes actions in your IAM policy.
INPUT
Label
The identification of the permission to remove. This is the label added
using the AddPermission action.
QueueUrl
The URL of the Amazon SQS queue from which permissions are removed.
Queue URLs and names are case-sensitive.
ERRORS
InvalidAddress
The specified ID is invalid.
RequestThrottled
The request was denied due to request throttling.
QueueDoesNotExist
Ensure that the QueueUrl is correct and that the queue has not been
deleted.
InvalidSecurity
The request was not made over HTTPS or did not use SigV4 for signing.
UnsupportedOperation
Error code 400. Unsupported operation.
METHOD
POST
REQUEST URI
/
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 (http://www.w3.org/TR/REC-xml/#charsets).
#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to
#xFFFD | #x10000 to #x10FFFF
Amazon SQS does not throw an exception or completely reject the message
if it contains invalid characters. Instead, it replaces those invalid
characters with U+FFFD before storing the message in the queue, as
long as the message body contains at least one valid character.
DelaySeconds
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
DelaySeconds value become available for processing after the delay
period is finished. If you don't specify a value, the default value for
the queue applies.
When you set FifoQueue, you can't set DelaySeconds per message.
You can set this parameter only on a queue level.
MessageAttributes
Each message attribute consists of a Name, Type, and Value.
For more information, see Amazon SQS message attributes
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes)
in the Amazon SQS Developer Guide.
MessageBody
The message to send. The minimum size is one character. The maximum size is 256 KiB.
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 (http://www.w3.org/TR/REC-xml/#charsets).
#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to
#xFFFD | #x10000 to #x10FFFF
Amazon SQS does not throw an exception or completely reject the message
if it contains invalid characters. Instead, it replaces those invalid
characters with U+FFFD before storing the message in the queue, as
long as the message body contains at least one valid character.
MessageDeduplicationId
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 MessageDeduplicationId is sent successfully, any messages
sent with the same MessageDeduplicationId are accepted successfully
but aren't delivered during the 5-minute deduplication interval. For
more information, see Exactly-once processing
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html)
in the Amazon SQS Developer Guide.
MessageDeduplicationId,
MessageDeduplicationId explicitly.MessageDeduplicationId and you
enable ContentBasedDeduplication for your queue, Amazon SQS uses a
SHA-256 hash to generate the MessageDeduplicationId using the body
of the message (but not the attributes of the message).MessageDeduplicationId and the queue doesn't
have ContentBasedDeduplication set, the action fails with an error.ContentBasedDeduplication set, your
MessageDeduplicationId overrides the generated one.ContentBasedDeduplication is in effect, messages with identical
content sent within the deduplication interval are treated as
duplicates and only one copy of the message is delivered.ContentBasedDeduplication enabled and
then another message with a MessageDeduplicationId that is the same
as the one generated for the first MessageDeduplicationId, the two
messages are treated as duplicates and only one copy of the message is
delivered. The MessageDeduplicationId is available to the consumer of the
message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and
the message is resent with the same MessageDeduplicationId after the
deduplication interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
The maximum length of MessageDeduplicationId is 128 characters.
MessageDeduplicationId can contain alphanumeric characters (a-z,
A-Z, 0-9) and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
For best practices of using MessageDeduplicationId, see Using the
MessageDeduplicationId Property
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html)
in the Amazon SQS Developer Guide.
MessageGroupId
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 MessageGroupId values (for example, session data
for multiple users). In this scenario, multiple consumers can process
the queue, but the session data of each user is processed in a FIFO
fashion.
MessageGroupId with a message. If you
don't provide a MessageGroupId, the action fails.ReceiveMessage might return messages with multiple MessageGroupId
values. For each MessageGroupId, the messages are sorted by time
sent. The caller can't specify a MessageGroupId. The maximum length of MessageGroupId is 128 characters. Valid
values: alphanumeric characters and punctuation
(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
For best practices of using MessageGroupId, see Using the
MessageGroupId Property
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html)
in the Amazon SQS Developer Guide.
MessageGroupId is required for FIFO queues. You can't use it for
Standard queues.
MessageSystemAttributes
The message system attribute to send. Each message system attribute
consists of a Name, Type, and Value.
AWSTraceHeader. Its type must be String and its value must be a
correctly formatted X-Ray trace header string.QueueUrl
The URL of the Amazon SQS queue to which a message is sent.
Queue URLs and names are case-sensitive.
MD5OfMessageAttributes
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 (https://www.ietf.org/rfc/rfc1321.txt).
MD5OfMessageBody
An MD5 digest of the non-URL-encoded message body 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 (https://www.ietf.org/rfc/rfc1321.txt).
MD5OfMessageSystemAttributes
An MD5 digest of the non-URL-encoded message system 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.
MessageId
An attribute containing the MessageId of the message sent to the
queue. For more information, see Queue and Message Identifiers
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html)
in the Amazon SQS Developer Guide.
SequenceNumber
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 SequenceNumber is 128 bits. SequenceNumber
continues to increase for a particular MessageGroupId.
ERRORS
InvalidMessageContents
The message contains characters outside the allowed set.
UnsupportedOperation
Error code 400. Unsupported operation.
RequestThrottled
The request was denied due to request throttling.
QueueDoesNotExist
Ensure that the QueueUrl is correct and that the queue has not been
deleted.
InvalidSecurity
The request was not made over HTTPS or did not use SigV4 for signing.
KmsDisabled
The request was denied due to request throttling.
KmsInvalidState
The request was rejected because the state of the specified resource is not valid for this request.
KmsNotFound
The request was rejected because the specified entity or resource could not be found.
KmsOptInRequired
The request was rejected because the specified key policy isn't syntactically or semantically correct.
KmsThrottled
Amazon Web Services KMS throttles requests for the following conditions.
KmsAccessDenied
The caller doesn't have the required KMS access.
KmsInvalidKeyUsage
The request was rejected for one of the following reasons:
InvalidAddress
The specified ID is invalid.
METHOD
POST
REQUEST URI
/
You can use SendMessageBatch to send up to 10 messages to the
specified queue by assigning either identical or different values to
each message (or by not assigning values at all). 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 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 (http://www.w3.org/TR/REC-xml/#charsets).
#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to
#xFFFD | #x10000 to #x10FFFF
Amazon SQS does not throw an exception or completely reject the message
if it contains invalid characters. Instead, it replaces those invalid
characters with U+FFFD before storing the message in the queue, as
long as the message body contains at least one valid character.
If you don't specify the DelaySeconds parameter for an entry, Amazon
SQS uses the default value for the queue.
Entries
A list of SendMessageBatchRequestEntry items.
QueueUrl
The URL of the Amazon SQS queue to which batched messages are sent.
Queue URLs and names are case-sensitive.
Failed
A list of BatchResultErrorEntry items with error details about
each message that can't be enqueued.
Successful
A list of SendMessageBatchResultEntry items.
ERRORS
TooManyEntriesInBatchRequest
The batch request contains more entries than permissible. For Amazon SQS, the maximum number of entries you can include in a single SendMessageBatch (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessageBatch.html), DeleteMessageBatch (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_DeleteMessageBatch.html), or ChangeMessageVisibilityBatch (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ChangeMessageVisibilityBatch.html) request is 10.
EmptyBatchRequest
The batch request doesn't contain any entries.
BatchEntryIdsNotDistinct
Two or more batch entries in the request have the same Id.
BatchRequestTooLong
The length of all the messages put together is more than the limit.
InvalidBatchEntryId
The Id of a batch entry in a batch request doesn't abide by the
specification.
UnsupportedOperation
Error code 400. Unsupported operation.
RequestThrottled
The request was denied due to request throttling.
QueueDoesNotExist
Ensure that the QueueUrl is correct and that the queue has not been
deleted.
InvalidSecurity
The request was not made over HTTPS or did not use SigV4 for signing.
KmsDisabled
The request was denied due to request throttling.
KmsInvalidState
The request was rejected because the state of the specified resource is not valid for this request.
KmsNotFound
The request was rejected because the specified entity or resource could not be found.
KmsOptInRequired
The request was rejected because the specified key policy isn't syntactically or semantically correct.
KmsThrottled
Amazon Web Services KMS throttles requests for the following conditions.
KmsAccessDenied
The caller doesn't have the required KMS access.
KmsInvalidKeyUsage
The request was rejected for one of the following reasons:
InvalidAddress
The specified ID is invalid.
METHOD
POST
REQUEST URI
/
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 MessageRetentionPeriod attribute can take up to
15 minutes and will impact existing messages in the queue potentially
causing them to be expired and deleted if the MessageRetentionPeriod
is reduced below the age of existing messages.
To remove the ability to change queue permissions, you must deny
permission to the AddPermission, RemovePermission, and
SetQueueAttributes actions in your IAM policy.
INPUT
Attributes
A map of attributes to set.
The following lists the names, descriptions, and values of the special
request parameters that the SetQueueAttributes action uses:
DelaySeconds – The length of time, in seconds, for which the
delivery of all messages in the queue is delayed. Valid values: An
integer from 0 to 900 (15 minutes). Default: 0.MaximumMessageSize – The limit of how many bytes a message
can contain before Amazon SQS rejects it. Valid values: An integer from
1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144
(256 KiB).MessageRetentionPeriod – The length of time, in seconds, for
which Amazon SQS retains a message. Valid values: An integer
representing seconds, from 60 (1 minute) to 1,209,600 (14 days).
Default: 345,600 (4 days). 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 and will
impact existing messages in the queue potentially causing them to be
expired and deleted if the MessageRetentionPeriod is reduced below
the age of existing messages.Policy – The queue's policy. A valid Amazon Web Services
policy. For more information about policy structure, see Overview of
Amazon Web Services IAM Policies
(https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html)
in the Identity and Access Management User Guide.ReceiveMessageWaitTimeSeconds – The length of time, in
seconds, for which a ReceiveMessage action waits for a message to
arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.VisibilityTimeout – The visibility timeout for the queue, in
seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default:The following attributes apply only to dead-letter queues: (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html)
RedrivePolicy – The string that includes the parameters for
the dead-letter queue functionality of the source queue as a JSON
object. The parameters are as follows:
deadLetterTargetArn – The Amazon Resource Name (ARN) of the
dead-letter queue to which Amazon SQS moves messages after the value of
maxReceiveCount is exceeded.maxReceiveCount – The number of times a message is delivered
to the source queue before being moved to the dead-letter queue.
Default: 10. When the ReceiveCount for a message exceeds the
maxReceiveCount for a queue, Amazon SQS moves the message to the
dead-letter-queue.RedriveAllowPolicy – The string that includes the parameters
for the permissions for the dead-letter queue redrive permission and
which source queues can specify dead-letter queues as a JSON object.
The parameters are as follows:
redrivePermission – The permission type that defines which
source queues can specify the current queue as the dead-letter queue.
Valid values are:
allowAll – (Default) Any source queues in this Amazon Web
Services account in the same Region can specify this queue as the
dead-letter queue.denyAll – No source queues can specify this queue as the
dead-letter queue.byQueue – Only queues specified by the sourceQueueArns
parameter can specify this queue as the dead-letter queue.sourceQueueArns – The Amazon Resource Names (ARN)s of the
source queues that can specify this queue as the dead-letter queue and
redrive messages. You can specify this parameter only when the
redrivePermission parameter is set to byQueue. You can specify up
to 10 source queue ARNs. To allow more than 10 source queues to specify
dead-letter queues, set the redrivePermission parameter to
allowAll.The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
The following attributes apply only to server-side-encryption (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html):
KmsMasterKeyId – The ID of an Amazon Web Services managed
customer master key (CMK) for Amazon SQS or a custom CMK. For more
information, see Key Terms
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms).
While the alias of the AWS-managed CMK for Amazon SQS is always
alias/aws/sqs, the alias of a custom CMK can, for example, be
alias/_MyAlias_. For more examples, see KeyId
(https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters)
in the Key Management Service API Reference.KmsDataKeyReusePeriodSeconds – The length of time, in
seconds, for which Amazon SQS can reuse a data key
(https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys)
to encrypt or decrypt messages before calling KMS again. An integer
representing seconds, between 60 seconds (1 minute) and 86,400 seconds
(24 hours). Default: 300 (5 minutes). A shorter time period provides
better security but results in more calls to KMS which might incur
charges after Free Tier. For more information, see How Does the Data
Key Reuse Period Work?
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work).SqsManagedSseEnabled – Enables server-side queue encryption
using SQS owned encryption keys. Only one server-side encryption option
is supported per queue (for example, SSE-KMS
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html)
or SSE-SQS
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)).The following attribute applies only to FIFO (first-in-first-out) queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html):
ContentBasedDeduplication – Enables content-based
deduplication. For more information, see Exactly-once processing
(https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html)
in the Amazon SQS Developer Guide. Note the following:
MessageDeduplicationId.
MessageDeduplicationId explicitly.MessageDeduplicationId and you
enable ContentBasedDeduplication for your queue, Amazon SQS uses a
SHA-256 hash to generate the MessageDeduplicationId using the body
of the message (but not the attributes of the message).MessageDeduplicationId and the queue doesn't
have ContentBasedDeduplication set, the action fails with an error.ContentBasedDeduplication set, your
MessageDeduplicationId overrides the generated one.ContentBasedDeduplication is in effect, messages with identical
content sent within the deduplication interval are treated as
duplicates and only one copy of the message is delivered.ContentBasedDeduplication enabled and
then another message with a MessageDeduplicationId that is the same
as the one generated for the first MessageDeduplicationId, the two
messages are treated as duplicates and only one copy of the message is
delivered.The following attributes apply only to high throughput for FIFO queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html):
DeduplicationScope – Specifies whether message deduplication
occurs at the message group or queue level. Valid values are
messageGroup and queue.FifoThroughputLimit – Specifies whether the FIFO queue
throughput quota applies to the entire queue or per message group.
Valid values are perQueue and perMessageGroupId. The
perMessageGroupId value is allowed only when the value for
DeduplicationScope is messageGroup.To enable high throughput for FIFO queues, do the following:
DeduplicationScope to messageGroup.FifoThroughputLimit to perMessageGroupId.If you set these attributes to anything other than the values shown for enabling high throughput, normal throughput is in effect and deduplication occurs as specified.
For information on throughput quotas, see Quotas related to messages (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the Amazon SQS Developer Guide.
QueueUrl
The URL of the Amazon SQS queue whose attributes are set.
Queue URLs and names are case-sensitive.
ERRORS
InvalidAttributeName
The specified attribute doesn't exist.
InvalidAttributeValue
A queue attribute value is invalid.
RequestThrottled
The request was denied due to request throttling.
QueueDoesNotExist
Ensure that the QueueUrl is correct and that the queue has not been
deleted.
UnsupportedOperation
Error code 400. Unsupported operation.
OverLimit
The specified action violates a limit. For example, ReceiveMessage
returns this error if the maximum number of in flight messages is
reached and AddPermission returns this error if the maximum number
of permissions for the queue is reached.
InvalidAddress
The specified ID is invalid.
InvalidSecurity
The request was not made over HTTPS or did not use SigV4 for signing.
METHOD
POST
REQUEST URI
/
Starts an asynchronous task to move messages from a specified source queue to a specified destination queue.
StartMessageMoveTask the
source queue is the 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.
INPUT
DestinationArn
The ARN of the queue that receives the moved messages. You can use this field to specify the destination queue where you would like to redrive messages. If this field is left blank, the messages will be redriven back to their respective original source queues.
MaxNumberOfMessagesPerSecond
The number of messages to be moved per second (the message movement rate). You can use this field to define a fixed message movement rate. The maximum value for messages per second is 500. If this field is left blank, the system will optimize the rate based on the queue message backlog size, which may vary throughout the duration of the message movement task.
SourceArn
The ARN of the queue that contains the messages to be moved to another queue. Currently, only ARNs of dead-letter queues (DLQs) whose sources are other Amazon SQS queues are accepted. DLQs whose sources are non-SQS queues, such as Lambda or Amazon SNS topics, are not currently supported.
TaskHandle
An identifier associated with a message movement task. You can use this
identifier to cancel a specified message movement task using the
CancelMessageMoveTask action.
ERRORS
ResourceNotFoundException
One or more specified resources don't exist.
RequestThrottled
The request was denied due to request throttling.
InvalidAddress
The specified ID is invalid.
InvalidSecurity
The request was not made over HTTPS or did not use SigV4 for signing.
UnsupportedOperation
Error code 400. Unsupported operation.
METHOD
POST
REQUEST URI
/
Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html) 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 (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-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 (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) in the Amazon SQS Developer Guide.
QueueUrl
The URL of the queue.
Tags
The list of tags to be added to the specified queue.
ERRORS
InvalidAddress
The specified ID is invalid.
RequestThrottled
The request was denied due to request throttling.
QueueDoesNotExist
Ensure that the QueueUrl is correct and that the queue has not been
deleted.
InvalidSecurity
The request was not made over HTTPS or did not use SigV4 for signing.
UnsupportedOperation
Error code 400. Unsupported operation.
METHOD
POST
REQUEST URI
/
Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html) 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 (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) in the Amazon SQS Developer Guide.
QueueUrl
The URL of the queue.
TagKeys
The list of tags to be removed from the specified queue.
ERRORS
InvalidAddress
The specified ID is invalid.
RequestThrottled
The request was denied due to request throttling.
QueueDoesNotExist
Ensure that the QueueUrl is correct and that the queue has not been
deleted.
InvalidSecurity
The request was not made over HTTPS or did not use SigV4 for signing.
UnsupportedOperation
Error code 400. Unsupported operation.
METHOD
POST
REQUEST URI
/
Autogenerated by /home/rlauer/lib/perl5/Amazon/API/Botocore.pm at Sat Jul 5 07:07:22 2025
This module is free software it may be used, redistributed and/or modified under the same terms as Perl itself.