Table of Contents
SQS.Client¶A low-level client representing Amazon Simple Queue Service (SQS)
Welcome to the Amazon SQS API Reference .
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.
For information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer Guide.
You can use Amazon Web Services SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:
Additional information
import boto3
client = boto3.client('sqs')
These are the available methods:
add_permission()can_paginate()change_message_visibility()change_message_visibility_batch()close()create_queue()delete_message()delete_message_batch()delete_queue()get_paginator()get_queue_attributes()get_queue_url()get_waiter()list_dead_letter_source_queues()list_queue_tags()list_queues()purge_queue()receive_message()remove_permission()send_message()send_message_batch()set_queue_attributes()tag_queue()untag_queue()add_permission(**kwargs)¶Adds a permission to a queue for a specific principal. This allows sharing access to the queue.
When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide .
Note
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 in the Amazon SQS Developer Guide .AddPermission , RemovePermission , and SetQueueAttributes actions in your IAM policy.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:
&AttributeName.1=first
&AttributeName.2=second
Note
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.add_permission(
QueueUrl='string',
Label='string',
AWSAccountIds=[
'string',
],
Actions=[
'string',
]
)
[REQUIRED]
The URL of the Amazon SQS queue to which permissions are added.
Queue URLs and names are case-sensitive.
[REQUIRED]
The unique identification of the permission you're setting (for example, AliceSendMessage ). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens ( - ), and underscores ( _ ).
[REQUIRED]
The Amazon Web Services account numbers of the principals who are to receive permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide .
[REQUIRED]
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 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 .
None
Exceptions
SQS.Client.exceptions.OverLimitcan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.change_message_visibility(**kwargs)¶Changes the visibility timeout of a specified message in a queue to a new value. The default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer Guide .
For example, 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 the maximum allowed time. If you try to extend the visibility timeout beyond the maximum, your request is rejected.
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 inflight messages.
Limits that apply to inflight 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 inflight 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.
For FIFO queues, there can be a maximum of 20,000 inflight 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.
Warning
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.
See also: AWS API Documentation
Request Syntax
response = client.change_message_visibility(
QueueUrl='string',
ReceiptHandle='string',
VisibilityTimeout=123
)
[REQUIRED]
The URL of the Amazon SQS queue whose message's visibility is changed.
Queue URLs and names are case-sensitive.
[REQUIRED]
The receipt handle associated with the message whose visibility timeout is changed. This parameter is returned by the ReceiveMessage action.
[REQUIRED]
The new value for the message's visibility timeout (in seconds). Values range: 0 to 43200 . Maximum: 12 hours.
None
Exceptions
SQS.Client.exceptions.MessageNotInflightSQS.Client.exceptions.ReceiptHandleIsInvalidchange_message_visibility_batch(**kwargs)¶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.
Warning
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:
&AttributeName.1=first
&AttributeName.2=second
See also: AWS API Documentation
Request Syntax
response = client.change_message_visibility_batch(
QueueUrl='string',
Entries=[
{
'Id': 'string',
'ReceiptHandle': 'string',
'VisibilityTimeout': 123
},
]
)
[REQUIRED]
The URL of the Amazon SQS queue whose messages' visibility is changed.
Queue URLs and names are case-sensitive.
[REQUIRED]
A list of receipt handles of the messages for which the visibility timeout must be changed.
Encloses a receipt handle and an entry id for each message in ChangeMessageVisibilityBatch.
Warning
All of the following list parameters must be prefixed withChangeMessageVisibilityBatchRequestEntry.n, wherenis an integer value starting with1. 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
An identifier for this particular receipt handle used to communicate the result.
Note
The Id s of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
A receipt handle.
The new value (in seconds) for the message's visibility timeout.
dict
Response Syntax
{
'Successful': [
{
'Id': 'string'
},
],
'Failed': [
{
'Id': 'string',
'SenderFault': True|False,
'Code': 'string',
'Message': 'string'
},
]
}
Response Structure
(dict) --
For each message in the batch, the response contains a ChangeMessageVisibilityBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.
Successful (list) --
A list of ChangeMessageVisibilityBatchResultEntry items.
(dict) --
Encloses the Id of an entry in ChangeMessageVisibilityBatch.
Id (string) --
Represents a message whose visibility timeout has been changed successfully.
Failed (list) --
A list of BatchResultErrorEntry items.
(dict) --
Gives a detailed description of the result of an action on each entry in the request.
Id (string) --
The Id of an entry in a batch request.
SenderFault (boolean) --
Specifies whether the error happened due to the caller of the batch API action.
Code (string) --
An error code representing why the action failed on this entry.
Message (string) --
A message explaining why the action failed on this entry.
Exceptions
SQS.Client.exceptions.TooManyEntriesInBatchRequestSQS.Client.exceptions.EmptyBatchRequestSQS.Client.exceptions.BatchEntryIdsNotDistinctSQS.Client.exceptions.InvalidBatchEntryIdclose()¶Closes underlying endpoint connections.
create_queue(**kwargs)¶Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following in mind:
FifoQueue attribute, Amazon SQS creates a standard queue.Note
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 SQS Developer Guide .
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.
Note
After you create a queue, you must wait at least one second after the queue is created to be able to use the queue.
To get the queue URL, use the GetQueueUrl action. GetQueueUrl requires only the QueueName parameter. be aware of existing queue names:
CreateQueue returns the queue URL for the 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:
&AttributeName.1=first
&AttributeName.2=second
Note
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_queue(
QueueName='string',
Attributes={
'string': 'string'
},
tags={
'string': 'string'
}
)
[REQUIRED]
The name of the new queue. The following limits apply to this name:
- ), and underscores ( _ )..fifo suffix.Queue URLs and names are case-sensitive.
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).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 in the Amazon 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.RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer Guide .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. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.Note
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.
VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide .The following attributes apply only to server-side-encryption:
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. 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 in the Key Management Service API Reference .KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key 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?.SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS ).The following attributes apply only to FIFO (first-in-first-out) queues:
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 in the Amazon SQS Developer Guide .ContentBasedDeduplication – Enables content-based deduplication. Valid values are true and false . For more information, see Exactly-once processing 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:
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 in the Amazon SQS Developer Guide .
Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide .
When you use queue tags, keep the following guidelines in mind:
For a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer Guide .
Note
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 user name in the Amazon SQS Developer Guide .
dict
Response Syntax
{
'QueueUrl': 'string'
}
Response Structure
(dict) --
Returns the QueueUrl attribute of the created queue.
QueueUrl (string) --
The URL of the created Amazon SQS queue.
Exceptions
SQS.Client.exceptions.QueueDeletedRecentlySQS.Client.exceptions.QueueNameExistsdelete_message(**kwargs)¶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.
Note
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.
See also: AWS API Documentation
Request Syntax
response = client.delete_message(
QueueUrl='string',
ReceiptHandle='string'
)
[REQUIRED]
The URL of the Amazon SQS queue from which messages are deleted.
Queue URLs and names are case-sensitive.
[REQUIRED]
The receipt handle associated with the message to delete.
None
Exceptions
SQS.Client.exceptions.InvalidIdFormatSQS.Client.exceptions.ReceiptHandleIsInvaliddelete_message_batch(**kwargs)¶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.
Warning
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:
&AttributeName.1=first
&AttributeName.2=second
See also: AWS API Documentation
Request Syntax
response = client.delete_message_batch(
QueueUrl='string',
Entries=[
{
'Id': 'string',
'ReceiptHandle': 'string'
},
]
)
[REQUIRED]
The URL of the Amazon SQS queue from which messages are deleted.
Queue URLs and names are case-sensitive.
[REQUIRED]
A list of receipt handles for the messages to be deleted.
Encloses a receipt handle and an identifier for it.
An identifier for this particular receipt handle. This is used to communicate the result.
Note
The Id s of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
A receipt handle.
dict
Response Syntax
{
'Successful': [
{
'Id': 'string'
},
],
'Failed': [
{
'Id': 'string',
'SenderFault': True|False,
'Code': 'string',
'Message': 'string'
},
]
}
Response Structure
(dict) --
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.
Successful (list) --
A list of DeleteMessageBatchResultEntry items.
(dict) --
Encloses the Id of an entry in DeleteMessageBatch.
Id (string) --
Represents a successfully deleted message.
Failed (list) --
A list of BatchResultErrorEntry items.
(dict) --
Gives a detailed description of the result of an action on each entry in the request.
Id (string) --
The Id of an entry in a batch request.
SenderFault (boolean) --
Specifies whether the error happened due to the caller of the batch API action.
Code (string) --
An error code representing why the action failed on this entry.
Message (string) --
A message explaining why the action failed on this entry.
Exceptions
SQS.Client.exceptions.TooManyEntriesInBatchRequestSQS.Client.exceptions.EmptyBatchRequestSQS.Client.exceptions.BatchEntryIdsNotDistinctSQS.Client.exceptions.InvalidBatchEntryIddelete_queue(**kwargs)¶Deletes the queue specified by the QueueUrl , regardless of the queue's contents.
Warning
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.
Note
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.delete_queue(
QueueUrl='string'
)
[REQUIRED]
The URL of the Amazon SQS queue to delete.
Queue URLs and names are case-sensitive.
get_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_queue_attributes(**kwargs)¶Gets attributes for the specified queue.
Note
To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.
See also: AWS API Documentation
Request Syntax
response = client.get_queue_attributes(
QueueUrl='string',
AttributeNames=[
'All'|'Policy'|'VisibilityTimeout'|'MaximumMessageSize'|'MessageRetentionPeriod'|'ApproximateNumberOfMessages'|'ApproximateNumberOfMessagesNotVisible'|'CreatedTimestamp'|'LastModifiedTimestamp'|'QueueArn'|'ApproximateNumberOfMessagesDelayed'|'DelaySeconds'|'ReceiveMessageWaitTimeSeconds'|'RedrivePolicy'|'FifoQueue'|'ContentBasedDeduplication'|'KmsMasterKeyId'|'KmsDataKeyReusePeriodSeconds'|'DeduplicationScope'|'FifoThroughputLimit'|'RedriveAllowPolicy'|'SqsManagedSseEnabled',
]
)
[REQUIRED]
The URL of the Amazon SQS queue whose attribute information is retrieved.
Queue URLs and names are case-sensitive.
A list of attributes for which to retrieve information.
The AttributeName.N parameter is optional, but if you don't specify values for this parameter, the request returns empty results.
Note
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:
Warning
The ApproximateNumberOfMessagesDelayed , ApproximateNumberOfMessagesNotVisible , and ApproximateNumberOfMessagesVisible 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 ).DelaySeconds – Returns the default delay on the queue in seconds.LastModifiedTimestamp – Returns the time when the queue was last changed in seconds ( epoch 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.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.RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer Guide .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. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.VisibilityTimeout – Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide .The following attributes apply only to server-side-encryption:
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.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?.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 (e.g. SSE-KMS or SSE-SQS ).The following attributes apply only to FIFO (first-in-first-out) queues:
FifoQueue – Returns information about whether the queue is FIFO. For more information, see FIFO queue logic in the Amazon SQS Developer Guide .Note
To determine whether a queue is FIFO, 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 in the Amazon SQS Developer Guide .The following attributes apply only to high throughput for FIFO queues:
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 in the Amazon SQS Developer Guide .
dict
Response Syntax
{
'Attributes': {
'string': 'string'
}
}
Response Structure
(dict) --
A list of returned queue attributes.
Attributes (dict) --
A map of attributes to their respective values.
Exceptions
SQS.Client.exceptions.InvalidAttributeNameget_queue_url(**kwargs)¶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 SQS Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.get_queue_url(
QueueName='string',
QueueOwnerAWSAccountId='string'
)
[REQUIRED]
The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values: alphanumeric characters, hyphens ( - ), and underscores ( _ ).
Queue URLs and names are case-sensitive.
dict
Response Syntax
{
'QueueUrl': 'string'
}
Response Structure
(dict) --
For more information, see Interpreting Responses in the Amazon SQS Developer Guide .
QueueUrl (string) --
The URL of the queue.
Exceptions
SQS.Client.exceptions.QueueDoesNotExistget_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_dead_letter_source_queues(**kwargs)¶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 in the Amazon SQS Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.list_dead_letter_source_queues(
QueueUrl='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The URL of a dead-letter queue.
Queue URLs and names are case-sensitive.
MaxResults to receive a value for NextToken in the response.dict
Response Syntax
{
'queueUrls': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
A list of your dead letter source queues.
queueUrls (list) --
A list of source queue URLs that have the RedrivePolicy queue attribute configured with a dead-letter queue.
NextToken (string) --
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.
Exceptions
SQS.Client.exceptions.QueueDoesNotExistList all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide .
Note
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.list_queue_tags(
QueueUrl='string'
)
[REQUIRED]
The URL of the queue.
{
'Tags': {
'string': 'string'
}
}
Response Structure
The list of all tags added to the specified queue.
list_queues(**kwargs)¶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.
Note
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.list_queues(
QueueNamePrefix='string',
NextToken='string',
MaxResults=123
)
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.
MaxResults to receive a value for NextToken in the response.dict
Response Syntax
{
'QueueUrls': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
A list of your queues.
QueueUrls (list) --
A list of queue URLs, up to 1,000 entries, or the value of MaxResults that you sent in the request.
NextToken (string) --
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.
purge_queue(**kwargs)¶Deletes the messages in a queue specified by the QueueURL parameter.
Warning
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.
See also: AWS API Documentation
Request Syntax
response = client.purge_queue(
QueueUrl='string'
)
[REQUIRED]
The URL of the queue from which the PurgeQueue action deletes messages.
Queue URLs and names are case-sensitive.
Exceptions
SQS.Client.exceptions.QueueDoesNotExistSQS.Client.exceptions.PurgeQueueInProgressreceive_message(**kwargs)¶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 SQS 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:
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 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. For more information, see Visibility Timeout in the Amazon SQS 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.
Note
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.
See also: AWS API Documentation
Request Syntax
response = client.receive_message(
QueueUrl='string',
AttributeNames=[
'All'|'Policy'|'VisibilityTimeout'|'MaximumMessageSize'|'MessageRetentionPeriod'|'ApproximateNumberOfMessages'|'ApproximateNumberOfMessagesNotVisible'|'CreatedTimestamp'|'LastModifiedTimestamp'|'QueueArn'|'ApproximateNumberOfMessagesDelayed'|'DelaySeconds'|'ReceiveMessageWaitTimeSeconds'|'RedrivePolicy'|'FifoQueue'|'ContentBasedDeduplication'|'KmsMasterKeyId'|'KmsDataKeyReusePeriodSeconds'|'DeduplicationScope'|'FifoThroughputLimit'|'RedriveAllowPolicy'|'SqsManagedSseEnabled',
],
MessageAttributeNames=[
'string',
],
MaxNumberOfMessages=123,
VisibilityTimeout=123,
WaitTimeSeconds=123,
ReceiveRequestAttemptId='string'
)
[REQUIRED]
The URL of the Amazon SQS queue from which messages are received.
Queue URLs and names are case-sensitive.
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 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.SenderIdABCDEFGHI1JKLMNOPQ23R .ABCDE1F2GH3I4JK5LMNOP:i-a123b456 .SentTimestamp – Returns the time the message was sent to the queue ( epoch time in milliseconds).SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS ).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.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.* .
ReceiveMessage request.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 returns successfully with an empty list of messages.
Warning
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 for asynchronous clients, or the ApacheHttpClient for synchronous clients.
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 doesn't provide a ReceiveRequestAttemptId , Amazon SQS generates a ReceiveRequestAttemptId .ReceiveMessage action with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted or had their visibility changes).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 in the Amazon SQS Developer Guide .Warning
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 in the Amazon SQS Developer Guide .
dict
Response Syntax
{
'Messages': [
{
'MessageId': 'string',
'ReceiptHandle': 'string',
'MD5OfBody': 'string',
'Body': 'string',
'Attributes': {
'string': 'string'
},
'MD5OfMessageAttributes': 'string',
'MessageAttributes': {
'string': {
'StringValue': 'string',
'BinaryValue': b'bytes',
'StringListValues': [
'string',
],
'BinaryListValues': [
b'bytes',
],
'DataType': 'string'
}
}
},
]
}
Response Structure
(dict) --
A list of received messages.
Messages (list) --
A list of messages.
(dict) --
An Amazon SQS message.
MessageId (string) --
A unique identifier for the message. A MessageId is considered unique across all Amazon Web Services accounts for an extended period of time.
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.
MD5OfBody (string) --
An MD5 digest of the non-URL-encoded message body string.
Body (string) --
The message's contents (not URL-encoded).
Attributes (dict) --
A map of the attributes requested in ReceiveMessage to their respective values. Supported attributes:
ApproximateReceiveCountApproximateFirstReceiveTimestampMessageDeduplicationIdMessageGroupIdSenderIdSentTimestampSequenceNumber
ApproximateFirstReceiveTimestampandSentTimestampare each returned as an integer representing the epoch time in milliseconds.
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.
MessageAttributes (dict) --
Each message attribute consists of a Name , Type , and Value . For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide .
(string) --
(dict) --
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,valueand the message body must not be empty or null. All parts of the message attribute, includingName,Type, andValue, are part of the message size restriction (256 KB or 262,144 bytes).
StringValue (string) --
Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
BinaryValue (bytes) --
Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
StringListValues (list) --
Not implemented. Reserved for future use.
BinaryListValues (list) --
Not implemented. Reserved for future use.
DataType (string) --
Amazon SQS supports the following logical data types: String , Number , and Binary . For the Number data type, you must use StringValue .
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide .
Exceptions
SQS.Client.exceptions.OverLimitremove_permission(**kwargs)¶Revokes any permissions in the queue policy that matches the specified Label parameter.
Note
AddPermission , RemovePermission , and SetQueueAttributes actions in your IAM policy.See also: AWS API Documentation
Request Syntax
response = client.remove_permission(
QueueUrl='string',
Label='string'
)
[REQUIRED]
The URL of the Amazon SQS queue from which permissions are removed.
Queue URLs and names are case-sensitive.
[REQUIRED]
The identification of the permission to remove. This is the label added using the AddPermission action.
None
send_message(**kwargs)¶Delivers a message to the specified queue.
Warning
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9|#xA|#xD|#x20to#xD7FF|#xE000to#xFFFD|#x10000to#x10FFFF
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
See also: AWS API Documentation
Request Syntax
response = client.send_message(
QueueUrl='string',
MessageBody='string',
DelaySeconds=123,
MessageAttributes={
'string': {
'StringValue': 'string',
'BinaryValue': b'bytes',
'StringListValues': [
'string',
],
'BinaryListValues': [
b'bytes',
],
'DataType': 'string'
}
},
MessageSystemAttributes={
'string': {
'StringValue': 'string',
'BinaryValue': b'bytes',
'StringListValues': [
'string',
],
'BinaryListValues': [
b'bytes',
],
'DataType': 'string'
}
},
MessageDeduplicationId='string',
MessageGroupId='string'
)
[REQUIRED]
The URL of the Amazon SQS queue to which a message is sent.
Queue URLs and names are case-sensitive.
[REQUIRED]
The message to send. The minimum size is one character. The maximum size is 256 KB.
Warning
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9|#xA|#xD|#x20to#xD7FF|#xE000to#xFFFD|#x10000to#x10FFFF
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
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.
Note
When you set FifoQueue , you can't set DelaySeconds per message. You can set this parameter only on a queue level.
Each message attribute consists of a Name , Type , and Value . For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide .
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,valueand the message body must not be empty or null. All parts of the message attribute, includingName,Type, andValue, are part of the message size restriction (256 KB or 262,144 bytes).
Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
Not implemented. Reserved for future use.
Not implemented. Reserved for future use.
Amazon SQS supports the following logical data types: String , Number , and Binary . For the Number data type, you must use StringValue .
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide .
The message system attribute to send. Each message system attribute consists of a Name , Type , and Value .
Warning
AWSTraceHeader . Its type must be String and its value must be a correctly formatted X-Ray trace header string.The user-specified message system 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,valueand the message body must not be empty or null.
Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
Not implemented. Reserved for future use.
Not implemented. Reserved for future use.
Amazon SQS supports the following logical data types: String , Number , and Binary . For the Number data type, you must use StringValue .
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide .
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 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.Note
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 in the Amazon SQS Developer Guide .
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 length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) .
For best practices of using MessageGroupId , see Using the MessageGroupId Property in the Amazon SQS Developer Guide .
Warning
MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
dict
Response Syntax
{
'MD5OfMessageBody': 'string',
'MD5OfMessageAttributes': 'string',
'MD5OfMessageSystemAttributes': 'string',
'MessageId': 'string',
'SequenceNumber': 'string'
}
Response Structure
(dict) --
The MD5OfMessageBody and MessageId elements.
MD5OfMessageBody (string) --
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.
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.
MD5OfMessageSystemAttributes (string) --
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 (string) --
An attribute containing the MessageId of the message sent to the queue. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide .
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 SequenceNumber is 128 bits. SequenceNumber continues to increase for a particular MessageGroupId .
Exceptions
SQS.Client.exceptions.InvalidMessageContentsSQS.Client.exceptions.UnsupportedOperationsend_message_batch(**kwargs)¶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).
Warning
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9|#xA|#xD|#x20to#xD7FF|#xE000to#xFFFD|#x10000to#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:
&AttributeName.1=first
&AttributeName.2=second
See also: AWS API Documentation
Request Syntax
response = client.send_message_batch(
QueueUrl='string',
Entries=[
{
'Id': 'string',
'MessageBody': 'string',
'DelaySeconds': 123,
'MessageAttributes': {
'string': {
'StringValue': 'string',
'BinaryValue': b'bytes',
'StringListValues': [
'string',
],
'BinaryListValues': [
b'bytes',
],
'DataType': 'string'
}
},
'MessageSystemAttributes': {
'string': {
'StringValue': 'string',
'BinaryValue': b'bytes',
'StringListValues': [
'string',
],
'BinaryListValues': [
b'bytes',
],
'DataType': 'string'
}
},
'MessageDeduplicationId': 'string',
'MessageGroupId': 'string'
},
]
)
[REQUIRED]
The URL of the Amazon SQS queue to which batched messages are sent.
Queue URLs and names are case-sensitive.
[REQUIRED]
A list of SendMessageBatchRequestEntry items.
Contains the details of a single Amazon SQS message along with an Id .
An identifier for a message in this batch used to communicate the result.
Note
The Id s of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
The body of the message.
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 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 is applied.
Note
When you set FifoQueue , you can't set DelaySeconds per message. You can set this parameter only on a queue level.
Each message attribute consists of a Name , Type , and Value . For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide .
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,valueand the message body must not be empty or null. All parts of the message attribute, includingName,Type, andValue, are part of the message size restriction (256 KB or 262,144 bytes).
Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
Not implemented. Reserved for future use.
Not implemented. Reserved for future use.
Amazon SQS supports the following logical data types: String , Number , and Binary . For the Number data type, you must use StringValue .
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide .
The message system attribute to send Each message system attribute consists of a Name , Type , and Value .
Warning
AWSTraceHeader . Its type must be String and its value must be a correctly formatted X-Ray trace header string.The user-specified message system 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,valueand the message body must not be empty or null.
Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
Not implemented. Reserved for future use.
Not implemented. Reserved for future use.
Amazon SQS supports the following logical data types: String , Number , and Binary . For the Number data type, you must use StringValue .
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide .
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 MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are accepted successfully but aren't delivered. For more information, see Exactly-once processing 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.Note
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 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 in the Amazon SQS Developer Guide .
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 length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) .
For best practices of using MessageGroupId , see Using the MessageGroupId Property in the Amazon SQS Developer Guide .
Warning
MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
dict
Response Syntax
{
'Successful': [
{
'Id': 'string',
'MessageId': 'string',
'MD5OfMessageBody': 'string',
'MD5OfMessageAttributes': 'string',
'MD5OfMessageSystemAttributes': 'string',
'SequenceNumber': 'string'
},
],
'Failed': [
{
'Id': 'string',
'SenderFault': True|False,
'Code': 'string',
'Message': 'string'
},
]
}
Response Structure
(dict) --
For each message in the batch, the response contains a SendMessageBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.
Successful (list) --
A list of SendMessageBatchResultEntry items.
(dict) --
Encloses a MessageId for a successfully-enqueued message in a SendMessageBatch.
Id (string) --
An identifier for the message in this batch.
MessageId (string) --
An identifier for the message.
MD5OfMessageBody (string) --
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.
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.
MD5OfMessageSystemAttributes (string) --
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. For information about MD5, see RFC1321.
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 SequenceNumber is 128 bits. As SequenceNumber continues to increase for a particular MessageGroupId .
Failed (list) --
A list of BatchResultErrorEntry items with error details about each message that can't be enqueued.
(dict) --
Gives a detailed description of the result of an action on each entry in the request.
Id (string) --
The Id of an entry in a batch request.
SenderFault (boolean) --
Specifies whether the error happened due to the caller of the batch API action.
Code (string) --
An error code representing why the action failed on this entry.
Message (string) --
A message explaining why the action failed on this entry.
Exceptions
SQS.Client.exceptions.TooManyEntriesInBatchRequestSQS.Client.exceptions.EmptyBatchRequestSQS.Client.exceptions.BatchEntryIdsNotDistinctSQS.Client.exceptions.BatchRequestTooLongSQS.Client.exceptions.InvalidBatchEntryIdSQS.Client.exceptions.UnsupportedOperationset_queue_attributes(**kwargs)¶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.
Note
AddPermission , RemovePermission , and SetQueueAttributes actions in your IAM policy.See also: AWS API Documentation
Request Syntax
response = client.set_queue_attributes(
QueueUrl='string',
Attributes={
'string': 'string'
}
)
[REQUIRED]
The URL of the Amazon SQS queue whose attributes are set.
Queue URLs and names are case-sensitive.
[REQUIRED]
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).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 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.RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer Guide .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. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.Note
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.
VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide .The following attributes apply only to server-side-encryption:
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. 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 in the Key Management Service API Reference .KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key 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?.SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS ).The following attribute applies only to FIFO (first-in-first-out) queues:
ContentBasedDeduplication – Enables content-based deduplication. For more information, see Exactly-once processing 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:
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 in the Amazon SQS Developer Guide .
None
Exceptions
SQS.Client.exceptions.InvalidAttributeNametag_queue(**kwargs)¶Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide .
When you use queue tags, keep the following guidelines in mind:
For a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer Guide .
Note
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.tag_queue(
QueueUrl='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The URL of the queue.
[REQUIRED]
The list of tags to be added to the specified queue.
None
untag_queue(**kwargs)¶Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide .
Note
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.untag_queue(
QueueUrl='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The URL of the queue.
[REQUIRED]
The list of tags to be removed from the specified queue.
None
The available paginators are:
SQS.Paginator.ListDeadLetterSourceQueues¶paginator = client.get_paginator('list_dead_letter_source_queues')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SQS.Client.list_dead_letter_source_queues().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
QueueUrl='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The URL of a dead-letter queue.
Queue URLs and names are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'queueUrls': [
'string',
],
}
Response Structure
(dict) --
A list of your dead letter source queues.
queueUrls (list) --
A list of source queue URLs that have the RedrivePolicy queue attribute configured with a dead-letter queue.
SQS.Paginator.ListQueues¶paginator = client.get_paginator('list_queues')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SQS.Client.list_queues().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
QueueNamePrefix='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': '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 dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'QueueUrls': [
'string',
],
}
Response Structure
(dict) --
A list of your queues.
QueueUrls (list) --
A list of queue URLs, up to 1,000 entries, or the value of MaxResults that you sent in the request.
SQS.ServiceResource¶A resource representing Amazon Simple Queue Service (SQS):
import boto3
sqs = boto3.resource('sqs')
These are the resource's available actions:
These are the resource's available sub-resources:
These are the resource's available collections:
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
create_queue(**kwargs)¶Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following in mind:
FifoQueue attribute, Amazon SQS creates a standard queue.Note
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 SQS Developer Guide .
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.
Note
After you create a queue, you must wait at least one second after the queue is created to be able to use the queue.
To get the queue URL, use the GetQueueUrl action. GetQueueUrl requires only the QueueName parameter. be aware of existing queue names:
CreateQueue returns the queue URL for the 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:
&AttributeName.1=first
&AttributeName.2=second
Note
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide .
See also: AWS API Documentation
Request Syntax
queue = sqs.create_queue(
QueueName='string',
Attributes={
'string': 'string'
},
tags={
'string': 'string'
}
)
[REQUIRED]
The name of the new queue. The following limits apply to this name:
- ), and underscores ( _ )..fifo suffix.Queue URLs and names are case-sensitive.
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).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 in the Amazon 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.RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer Guide .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. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.Note
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.
VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide .The following attributes apply only to server-side-encryption:
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. 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 in the Key Management Service API Reference .KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key 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?.SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS ).The following attributes apply only to FIFO (first-in-first-out) queues:
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 in the Amazon SQS Developer Guide .ContentBasedDeduplication – Enables content-based deduplication. Valid values are true and false . For more information, see Exactly-once processing 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:
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 in the Amazon SQS Developer Guide .
Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide .
When you use queue tags, keep the following guidelines in mind:
For a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer Guide .
Note
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 user name in the Amazon SQS Developer Guide .
sqs.Queue
Queue resource
get_available_subresources()¶Returns a list of all the available sub-resources for this Resource.
get_queue_by_name(**kwargs)¶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 SQS Developer Guide .
See also: AWS API Documentation
Request Syntax
queue = sqs.get_queue_by_name(
QueueName='string',
QueueOwnerAWSAccountId='string'
)
[REQUIRED]
The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values: alphanumeric characters, hyphens ( - ), and underscores ( _ ).
Queue URLs and names are case-sensitive.
sqs.Queue
Queue resource
Sub-resources
Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child. For more information about sub-resources refer to the Resources Introduction Guide.
Message(queue_url, receipt_handle)¶Creates a Message resource.:
message = sqs.Message('queue_url','receipt_handle')
A Message resource
Queue(url)¶Creates a Queue resource.:
queue = sqs.Queue('url')
SQS.QueueCollections
Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide.
queues¶A collection of Queue resources.A Queue Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
all()¶Creates an iterable of all Queue resources in the collection.
See also: AWS API Documentation
Request Syntax
queue_iterator = sqs.queues.all()
sqs.Queue)filter(**kwargs)¶Creates an iterable of all Queue resources in the collection filtered by kwargs passed to method. A Queue collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
queue_iterator = sqs.queues.filter(
QueueNamePrefix='string',
NextToken='string',
MaxResults=123
)
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.
MaxResults to receive a value for NextToken in the response.list(sqs.Queue)
A list of Queue resources
limit(**kwargs)¶Creates an iterable up to a specified amount of Queue resources in the collection.
See also: AWS API Documentation
Request Syntax
queue_iterator = sqs.queues.limit(
count=123
)
sqs.Queue)page_size(**kwargs)¶Creates an iterable of all Queue resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
queue_iterator = sqs.queues.page_size(
count=123
)
sqs.Queue)SQS.Message(queue_url, receipt_handle)¶A resource representing an Amazon Simple Queue Service (SQS) Message:
import boto3
sqs = boto3.resource('sqs')
message = sqs.Message('queue_url','receipt_handle')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available actions:
These are the resource's available sub-resources:
Identifiers
Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
queue_url¶(string) The Message's queue_url identifier. This must be set.
receipt_handle¶(string) The Message's receipt_handle identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method.
For more information about attributes refer to the Resources Introduction Guide.
attributes¶(dict) --
A map of the attributes requested in ReceiveMessage to their respective values. Supported attributes:
ApproximateReceiveCountApproximateFirstReceiveTimestampMessageDeduplicationIdMessageGroupIdSenderIdSentTimestampSequenceNumber
ApproximateFirstReceiveTimestampandSentTimestampare each returned as an integer representing the epoch time in milliseconds.
body¶(string) --
The message's contents (not URL-encoded).
md5_of_body¶(string) --
An MD5 digest of the non-URL-encoded message body string.
md5_of_message_attributes¶(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.
message_attributes¶(dict) --
Each message attribute consists of a Name , Type , and Value . For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide .
(string) --
(dict) --
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,valueand the message body must not be empty or null. All parts of the message attribute, includingName,Type, andValue, are part of the message size restriction (256 KB or 262,144 bytes).
StringValue (string) --
Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
BinaryValue (bytes) --
Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
StringListValues (list) --
Not implemented. Reserved for future use.
BinaryListValues (list) --
Not implemented. Reserved for future use.
DataType (string) --
Amazon SQS supports the following logical data types: String , Number , and Binary . For the Number data type, you must use StringValue .
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide .
message_id¶(string) --
A unique identifier for the message. A MessageId is considered unique across all Amazon Web Services accounts for an extended period of time.
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
change_visibility(**kwargs)¶Changes the visibility timeout of a specified message in a queue to a new value. The default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer Guide .
For example, 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 the maximum allowed time. If you try to extend the visibility timeout beyond the maximum, your request is rejected.
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 inflight messages.
Limits that apply to inflight 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 inflight 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.
For FIFO queues, there can be a maximum of 20,000 inflight 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.
Warning
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.
See also: AWS API Documentation
Request Syntax
response = message.change_visibility(
VisibilityTimeout=123
)
[REQUIRED]
The new value for the message's visibility timeout (in seconds). Values range: 0 to 43200 . Maximum: 12 hours.
delete()¶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.
Note
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.
See also: AWS API Documentation
Request Syntax
response = message.delete()
get_available_subresources()¶Returns a list of all the available sub-resources for this Resource.
Sub-resources
Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child. For more information about sub-resources refer to the Resources Introduction Guide.
SQS.Queue(url)¶A resource representing an Amazon Simple Queue Service (SQS) Queue:
import boto3
sqs = boto3.resource('sqs')
queue = sqs.Queue('url')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available actions:
add_permission()change_message_visibility_batch()delete()delete_messages()get_available_subresources()load()purge()receive_messages()reload()remove_permission()send_message()send_messages()set_attributes()These are the resource's available sub-resources:
These are the resource's available collections:
Identifiers
Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
url¶(string) The Queue's url identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method.
For more information about attributes refer to the Resources Introduction Guide.
attributes¶(dict) --
A map of attributes to their respective values.
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
add_permission(**kwargs)¶Adds a permission to a queue for a specific principal. This allows sharing access to the queue.
When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide .
Note
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 in the Amazon SQS Developer Guide .AddPermission , RemovePermission , and SetQueueAttributes actions in your IAM policy.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:
&AttributeName.1=first
&AttributeName.2=second
Note
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide .
See also: AWS API Documentation
Request Syntax
response = queue.add_permission(
Label='string',
AWSAccountIds=[
'string',
],
Actions=[
'string',
]
)
[REQUIRED]
The unique identification of the permission you're setting (for example, AliceSendMessage ). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens ( - ), and underscores ( _ ).
[REQUIRED]
The Amazon Web Services account numbers of the principals who are to receive permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide .
[REQUIRED]
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 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 .
None
change_message_visibility_batch(**kwargs)¶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.
Warning
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:
&AttributeName.1=first
&AttributeName.2=second
See also: AWS API Documentation
Request Syntax
response = queue.change_message_visibility_batch(
Entries=[
{
'Id': 'string',
'ReceiptHandle': 'string',
'VisibilityTimeout': 123
},
]
)
[REQUIRED]
A list of receipt handles of the messages for which the visibility timeout must be changed.
Encloses a receipt handle and an entry id for each message in ChangeMessageVisibilityBatch.
Warning
All of the following list parameters must be prefixed withChangeMessageVisibilityBatchRequestEntry.n, wherenis an integer value starting with1. 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
An identifier for this particular receipt handle used to communicate the result.
Note
The Id s of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
A receipt handle.
The new value (in seconds) for the message's visibility timeout.
{
'Successful': [
{
'Id': 'string'
},
],
'Failed': [
{
'Id': 'string',
'SenderFault': True|False,
'Code': 'string',
'Message': 'string'
},
]
}
Response Structure
For each message in the batch, the response contains a ChangeMessageVisibilityBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.
A list of ChangeMessageVisibilityBatchResultEntry items.
Encloses the Id of an entry in ChangeMessageVisibilityBatch.
Represents a message whose visibility timeout has been changed successfully.
A list of BatchResultErrorEntry items.
Gives a detailed description of the result of an action on each entry in the request.
The Id of an entry in a batch request.
Specifies whether the error happened due to the caller of the batch API action.
An error code representing why the action failed on this entry.
A message explaining why the action failed on this entry.
delete()¶Deletes the queue specified by the QueueUrl , regardless of the queue's contents.
Warning
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.
Note
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide .
See also: AWS API Documentation
Request Syntax
response = queue.delete()
delete_messages(**kwargs)¶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.
Warning
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:
&AttributeName.1=first
&AttributeName.2=second
See also: AWS API Documentation
Request Syntax
response = queue.delete_messages(
Entries=[
{
'Id': 'string',
'ReceiptHandle': 'string'
},
]
)
[REQUIRED]
A list of receipt handles for the messages to be deleted.
Encloses a receipt handle and an identifier for it.
An identifier for this particular receipt handle. This is used to communicate the result.
Note
The Id s of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
A receipt handle.
{
'Successful': [
{
'Id': 'string'
},
],
'Failed': [
{
'Id': 'string',
'SenderFault': True|False,
'Code': 'string',
'Message': 'string'
},
]
}
Response Structure
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.
A list of DeleteMessageBatchResultEntry items.
Encloses the Id of an entry in DeleteMessageBatch.
Represents a successfully deleted message.
A list of BatchResultErrorEntry items.
Gives a detailed description of the result of an action on each entry in the request.
The Id of an entry in a batch request.
Specifies whether the error happened due to the caller of the batch API action.
An error code representing why the action failed on this entry.
A message explaining why the action failed on this entry.
get_available_subresources()¶Returns a list of all the available sub-resources for this Resource.
load()¶Calls SQS.Client.get_queue_attributes() to update the attributes of the Queue resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
queue.load()
purge()¶Deletes the messages in a queue specified by the QueueURL parameter.
Warning
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.
See also: AWS API Documentation
Request Syntax
response = queue.purge()
receive_messages(**kwargs)¶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 SQS 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:
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 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. For more information, see Visibility Timeout in the Amazon SQS 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.
Note
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.
See also: AWS API Documentation
Request Syntax
message = queue.receive_messages(
AttributeNames=[
'All'|'Policy'|'VisibilityTimeout'|'MaximumMessageSize'|'MessageRetentionPeriod'|'ApproximateNumberOfMessages'|'ApproximateNumberOfMessagesNotVisible'|'CreatedTimestamp'|'LastModifiedTimestamp'|'QueueArn'|'ApproximateNumberOfMessagesDelayed'|'DelaySeconds'|'ReceiveMessageWaitTimeSeconds'|'RedrivePolicy'|'FifoQueue'|'ContentBasedDeduplication'|'KmsMasterKeyId'|'KmsDataKeyReusePeriodSeconds'|'DeduplicationScope'|'FifoThroughputLimit'|'RedriveAllowPolicy'|'SqsManagedSseEnabled',
],
MessageAttributeNames=[
'string',
],
MaxNumberOfMessages=123,
VisibilityTimeout=123,
WaitTimeSeconds=123,
ReceiveRequestAttemptId='string'
)
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 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.SenderIdABCDEFGHI1JKLMNOPQ23R .ABCDE1F2GH3I4JK5LMNOP:i-a123b456 .SentTimestamp – Returns the time the message was sent to the queue ( epoch time in milliseconds).SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS ).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.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.* .
ReceiveMessage request.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 returns successfully with an empty list of messages.
Warning
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 for asynchronous clients, or the ApacheHttpClient for synchronous clients.
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 doesn't provide a ReceiveRequestAttemptId , Amazon SQS generates a ReceiveRequestAttemptId .ReceiveMessage action with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted or had their visibility changes).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 in the Amazon SQS Developer Guide .Warning
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 in the Amazon SQS Developer Guide .
list(sqs.Message)
A list of Message resources
reload()¶Calls SQS.Client.get_queue_attributes() to update the attributes of the Queue resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
queue.reload()
remove_permission(**kwargs)¶Revokes any permissions in the queue policy that matches the specified Label parameter.
Note
AddPermission , RemovePermission , and SetQueueAttributes actions in your IAM policy.See also: AWS API Documentation
Request Syntax
response = queue.remove_permission(
Label='string'
)
[REQUIRED]
The identification of the permission to remove. This is the label added using the AddPermission action.
send_message(**kwargs)¶Delivers a message to the specified queue.
Warning
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9|#xA|#xD|#x20to#xD7FF|#xE000to#xFFFD|#x10000to#x10FFFF
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
See also: AWS API Documentation
Request Syntax
response = queue.send_message(
MessageBody='string',
DelaySeconds=123,
MessageAttributes={
'string': {
'StringValue': 'string',
'BinaryValue': b'bytes',
'StringListValues': [
'string',
],
'BinaryListValues': [
b'bytes',
],
'DataType': 'string'
}
},
MessageSystemAttributes={
'string': {
'StringValue': 'string',
'BinaryValue': b'bytes',
'StringListValues': [
'string',
],
'BinaryListValues': [
b'bytes',
],
'DataType': 'string'
}
},
MessageDeduplicationId='string',
MessageGroupId='string'
)
[REQUIRED]
The message to send. The minimum size is one character. The maximum size is 256 KB.
Warning
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9|#xA|#xD|#x20to#xD7FF|#xE000to#xFFFD|#x10000to#x10FFFF
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
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.
Note
When you set FifoQueue , you can't set DelaySeconds per message. You can set this parameter only on a queue level.
Each message attribute consists of a Name , Type , and Value . For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide .
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,valueand the message body must not be empty or null. All parts of the message attribute, includingName,Type, andValue, are part of the message size restriction (256 KB or 262,144 bytes).
Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
Not implemented. Reserved for future use.
Not implemented. Reserved for future use.
Amazon SQS supports the following logical data types: String , Number , and Binary . For the Number data type, you must use StringValue .
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide .
The message system attribute to send. Each message system attribute consists of a Name , Type , and Value .
Warning
AWSTraceHeader . Its type must be String and its value must be a correctly formatted X-Ray trace header string.The user-specified message system 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,valueand the message body must not be empty or null.
Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
Not implemented. Reserved for future use.
Not implemented. Reserved for future use.
Amazon SQS supports the following logical data types: String , Number , and Binary . For the Number data type, you must use StringValue .
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide .
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 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.Note
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 in the Amazon SQS Developer Guide .
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 length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) .
For best practices of using MessageGroupId , see Using the MessageGroupId Property in the Amazon SQS Developer Guide .
Warning
MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
dict
Response Syntax
{
'MD5OfMessageBody': 'string',
'MD5OfMessageAttributes': 'string',
'MD5OfMessageSystemAttributes': 'string',
'MessageId': 'string',
'SequenceNumber': 'string'
}
Response Structure
(dict) --
The MD5OfMessageBody and MessageId elements.
MD5OfMessageBody (string) --
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.
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.
MD5OfMessageSystemAttributes (string) --
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 (string) --
An attribute containing the MessageId of the message sent to the queue. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide .
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 SequenceNumber is 128 bits. SequenceNumber continues to increase for a particular MessageGroupId .
send_messages(**kwargs)¶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).
Warning
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9|#xA|#xD|#x20to#xD7FF|#xE000to#xFFFD|#x10000to#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:
&AttributeName.1=first
&AttributeName.2=second
See also: AWS API Documentation
Request Syntax
response = queue.send_messages(
Entries=[
{
'Id': 'string',
'MessageBody': 'string',
'DelaySeconds': 123,
'MessageAttributes': {
'string': {
'StringValue': 'string',
'BinaryValue': b'bytes',
'StringListValues': [
'string',
],
'BinaryListValues': [
b'bytes',
],
'DataType': 'string'
}
},
'MessageSystemAttributes': {
'string': {
'StringValue': 'string',
'BinaryValue': b'bytes',
'StringListValues': [
'string',
],
'BinaryListValues': [
b'bytes',
],
'DataType': 'string'
}
},
'MessageDeduplicationId': 'string',
'MessageGroupId': 'string'
},
]
)
[REQUIRED]
A list of SendMessageBatchRequestEntry items.
Contains the details of a single Amazon SQS message along with an Id .
An identifier for a message in this batch used to communicate the result.
Note
The Id s of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
The body of the message.
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 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 is applied.
Note
When you set FifoQueue , you can't set DelaySeconds per message. You can set this parameter only on a queue level.
Each message attribute consists of a Name , Type , and Value . For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide .
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,valueand the message body must not be empty or null. All parts of the message attribute, includingName,Type, andValue, are part of the message size restriction (256 KB or 262,144 bytes).
Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
Not implemented. Reserved for future use.
Not implemented. Reserved for future use.
Amazon SQS supports the following logical data types: String , Number , and Binary . For the Number data type, you must use StringValue .
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide .
The message system attribute to send Each message system attribute consists of a Name , Type , and Value .
Warning
AWSTraceHeader . Its type must be String and its value must be a correctly formatted X-Ray trace header string.The user-specified message system 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,valueand the message body must not be empty or null.
Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
Not implemented. Reserved for future use.
Not implemented. Reserved for future use.
Amazon SQS supports the following logical data types: String , Number , and Binary . For the Number data type, you must use StringValue .
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide .
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 MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are accepted successfully but aren't delivered. For more information, see Exactly-once processing 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.Note
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 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 in the Amazon SQS Developer Guide .
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 length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) .
For best practices of using MessageGroupId , see Using the MessageGroupId Property in the Amazon SQS Developer Guide .
Warning
MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
{
'Successful': [
{
'Id': 'string',
'MessageId': 'string',
'MD5OfMessageBody': 'string',
'MD5OfMessageAttributes': 'string',
'MD5OfMessageSystemAttributes': 'string',
'SequenceNumber': 'string'
},
],
'Failed': [
{
'Id': 'string',
'SenderFault': True|False,
'Code': 'string',
'Message': 'string'
},
]
}
Response Structure
For each message in the batch, the response contains a SendMessageBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.
A list of SendMessageBatchResultEntry items.
Encloses a MessageId for a successfully-enqueued message in a SendMessageBatch.
An identifier for the message in this batch.
An identifier for the message.
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.
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.
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. For information about MD5, see RFC1321.
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. As SequenceNumber continues to increase for a particular MessageGroupId .
A list of BatchResultErrorEntry items with error details about each message that can't be enqueued.
Gives a detailed description of the result of an action on each entry in the request.
The Id of an entry in a batch request.
Specifies whether the error happened due to the caller of the batch API action.
An error code representing why the action failed on this entry.
A message explaining why the action failed on this entry.
set_attributes(**kwargs)¶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.
Note
AddPermission , RemovePermission , and SetQueueAttributes actions in your IAM policy.See also: AWS API Documentation
Request Syntax
response = queue.set_attributes(
Attributes={
'string': 'string'
}
)
[REQUIRED]
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).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 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.RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer Guide .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. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.Note
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.
VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide .The following attributes apply only to server-side-encryption:
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. 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 in the Key Management Service API Reference .KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key 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?.SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS ).The following attribute applies only to FIFO (first-in-first-out) queues:
ContentBasedDeduplication – Enables content-based deduplication. For more information, see Exactly-once processing 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:
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 in the Amazon SQS Developer Guide .
Sub-resources
Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child. For more information about sub-resources refer to the Resources Introduction Guide.
Message(receipt_handle)¶Creates a Message resource.:
message = queue.Message('receipt_handle')
SQS.MessageCollections
Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide.
dead_letter_source_queues¶A collection of Queue resources.A Queue Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
all()¶Creates an iterable of all Queue resources in the collection.
See also: AWS API Documentation
Request Syntax
queue_iterator = queue.dead_letter_source_queues.all()
sqs.Queue)filter(**kwargs)¶Creates an iterable of all Queue resources in the collection filtered by kwargs passed to method. A Queue collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
queue_iterator = queue.dead_letter_source_queues.filter(
NextToken='string',
MaxResults=123
)
MaxResults to receive a value for NextToken in the response.list(sqs.Queue)
A list of Queue resources
limit(**kwargs)¶Creates an iterable up to a specified amount of Queue resources in the collection.
See also: AWS API Documentation
Request Syntax
queue_iterator = queue.dead_letter_source_queues.limit(
count=123
)
sqs.Queue)page_size(**kwargs)¶Creates an iterable of all Queue resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
queue_iterator = queue.dead_letter_source_queues.page_size(
count=123
)
sqs.Queue)