SQS *** Client ====== class 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: * Cryptographically sign your service requests * Retry requests * Handle error responses **Additional information** * Amazon SQS Product Page * *Amazon SQS Developer Guide* * Making API Requests * Amazon SQS Message Attributes * Amazon SQS Dead-Letter Queues * Amazon SQS in the Command Line Interface * *Amazon Web Services General Reference* * Regions and Endpoints import boto3 client = boto3.client('sqs') These are the available methods: * add_permission * can_paginate * cancel_message_move_task * 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_message_move_tasks * list_queue_tags * list_queues * purge_queue * receive_message * remove_permission * send_message * send_message_batch * set_queue_attributes * start_message_move_task * tag_queue * untag_queue Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListDeadLetterSourceQueues * ListQueues Resources ========= Resources are available in boto3 via the "resource" method. For more detailed instructions and examples on the usage of resources, see the resources user guide. The available resources are: * Service Resource * Message * Queue Message / Attribute / body body **** SQS.Message.body * *(string) --* The message's contents (not URL-encoded). Message / Action / get_available_subresources get_available_subresources ************************** SQS.Message.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str Message / Action / change_visibility change_visibility ***************** SQS.Message.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, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed since you received the message, and you send a ChangeMessageVisibility call with "VisibilityTimeout" set to 10 seconds, the 10 seconds begin to count from the time that you make the "ChangeMessageVisibility" call. Thus, any attempt to change the visibility timeout or to delete that message 10 seconds after you initially change the visibility timeout (a total of 25 seconds) might result in an error. An Amazon SQS message has three basic states: * Sent to a queue by a producer. * Received from the queue by a consumer. * Deleted from the queue. A message is considered to be *stored* after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages. A message is considered to be *in flight* after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of in flight messages. Limits that apply to in flight messages are unrelated to the *unlimited* number of stored messages. For most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns the "OverLimit" error message. To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages. To request a limit increase, file a support request. For FIFO queues, there can be a maximum of 120,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages. 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 ) Parameters: **VisibilityTimeout** (*integer*) -- **[REQUIRED]** The new value for the message's visibility timeout (in seconds). Values range: "0" to "43200". Maximum: 12 hours. Returns: None Message / Sub-Resource / Queue Queue ***** SQS.Message.Queue() Creates a Queue resource.: queue = message.Queue() Return type: "SQS.Queue" Returns: A Queue resource Message / Attribute / md5_of_body md5_of_body *********** SQS.Message.md5_of_body * *(string) --* An MD5 digest of the non-URL-encoded message body string. Message / Attribute / message_id message_id ********** SQS.Message.message_id * *(string) --* A unique identifier for the message. A >>``<>``<?@[\]^_`{|}~"). For best practices of using "MessageDeduplicationId", see Using the MessageDeduplicationId Property in the *Amazon SQS Developer Guide*. * **MessageGroupId** *(string) --* "MessageGroupId" is an attribute used in Amazon SQS FIFO (First-In-First-Out) and standard queues. In FIFO queues, "MessageGroupId" organizes messages into distinct groups. Messages within the same message group are always processed one at a time, in strict order, ensuring that no two messages from the same group are processed simultaneously. In standard queues, using "MessageGroupId" enables fair queues. It is used to identify the tenant a message belongs to, helping maintain consistent message dwell time across all tenants during noisy neighbor events. Unlike FIFO queues, messages with the same "MessageGroupId" can be processed in parallel, maintaining the high throughput of standard queues. * **FIFO queues:** "MessageGroupId" acts as 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. If you do not provide a "MessageGroupId" when sending a message to a FIFO queue, the action fails. "ReceiveMessage" might return messages with multiple "MessageGroupId" values. For each "MessageGroupId", the messages are sorted by time sent. * >>**<>**<?@[\]^_`{|}~)". For best practices of using "MessageGroupId", see Using the MessageGroupId Property in the *Amazon SQS Developer Guide*. Return type: dict Returns: **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. Queue / Action / get_available_subresources get_available_subresources ************************** SQS.Queue.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str Queue / Action / delete_messages delete_messages *************** SQS.Queue.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". See also: AWS API Documentation **Request Syntax** response = queue.delete_messages( Entries=[ { 'Id': 'string', 'ReceiptHandle': 'string' }, ] ) Parameters: **Entries** (*list*) -- **[REQUIRED]** Lists the receipt handles for the messages to be deleted. * *(dict) --* Encloses a receipt handle and an identifier for it. * **Id** *(string) --* **[REQUIRED]** The identifier for this particular receipt handle. This is used to communicate the result. Note: The >>``<>``<>``<<. 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 (for example, 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: * Every message must have a unique "MessageDeduplicationId". * You may provide a "MessageDeduplicationId" explicitly. * If you aren't able to provide a "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). * If you don't provide a "MessageDeduplicationId" and the queue doesn't have "ContentBasedDeduplication" set, the action fails with an error. * If the queue has "ContentBasedDeduplication" set, your "MessageDeduplicationId" overrides the generated one. * When "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. * If you send one message with "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: * Set "DeduplicationScope" to "messageGroup". * Set "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*. * *(string) --* * *(string) --* Returns: None Queue / Action / change_message_visibility_batch change_message_visibility_batch ******************************* SQS.Queue.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". See also: AWS API Documentation **Request Syntax** response = queue.change_message_visibility_batch( Entries=[ { 'Id': 'string', 'ReceiptHandle': 'string', 'VisibilityTimeout': 123 }, ] ) Parameters: **Entries** (*list*) -- **[REQUIRED]** Lists the receipt handles of the messages for which the visibility timeout must be changed. * *(dict) --* Encloses a receipt handle and an entry ID for each message in "ChangeMessageVisibilityBatch." * **Id** *(string) --* **[REQUIRED]** An identifier for this particular receipt handle used to communicate the result. Note: The >>``<?@[\]^_`{|}~"). For best practices of using "MessageDeduplicationId", see Using the MessageDeduplicationId Property in the *Amazon SQS Developer Guide*. * **MessageGroupId** (*string*) -- "MessageGroupId" is an attribute used in Amazon SQS FIFO (First-In-First-Out) and standard queues. In FIFO queues, "MessageGroupId" organizes messages into distinct groups. Messages within the same message group are always processed one at a time, in strict order, ensuring that no two messages from the same group are processed simultaneously. In standard queues, using "MessageGroupId" enables fair queues. It is used to identify the tenant a message belongs to, helping maintain consistent message dwell time across all tenants during noisy neighbor events. Unlike FIFO queues, messages with the same "MessageGroupId" can be processed in parallel, maintaining the high throughput of standard queues. * **FIFO queues:** "MessageGroupId" acts as 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. If you do not provide a "MessageGroupId" when sending a message to a FIFO queue, the action fails. "ReceiveMessage" might return messages with multiple "MessageGroupId" values. For each "MessageGroupId", the messages are sorted by time sent. * >>**<>**<?@[\]^_`{|}~)". For best practices of using "MessageGroupId", see Using the MessageGroupId Property in the *Amazon SQS Developer Guide*. Return type: dict Returns: **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". SQS / Resource / Queue Queue ***** Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class SQS.Queue(url) A resource representing an Amazon Simple Queue Service (SQS) Queue: import boto3 sqs = boto3.resource('sqs') queue = sqs.Queue('url') Parameters: **url** (*string*) -- The Queue's url identifier. This **must** be set. 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. These are the resource's available identifiers: * url 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. These are the resource's available attributes: * attributes 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. 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 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. These are the resource's available sub-resources: * Message Collections =========== Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide. These are the resource's available collections: * dead_letter_source_queues Queue / Attribute / attributes attributes ********** SQS.Queue.attributes * *(dict) --* A map of attributes to their respective values. * *(string) --* * *(string) --* Queue / Collection / dead_letter_source_queues dead_letter_source_queues ************************* SQS.Queue.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() Return type: list("sqs.Queue") Returns: A list of Queue resources 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 ) Parameters: * **NextToken** (*string*) -- Pagination token to request the next set of results. * **MaxResults** (*integer*) -- Maximum number of results to include in the response. Value range is 1 to 1000. You must set "MaxResults" to receive a value for "NextToken" in the response. Return type: list("sqs.Queue") Returns: 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 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("sqs.Queue") Returns: A list of Queue resources 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 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("sqs.Queue") Returns: A list of Queue resources Queue / Action / purge purge ***** SQS.Queue.purge() Deletes available messages in a queue (including in-flight messages) 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() Returns: None Queue / Sub-Resource / Message Message ******* SQS.Queue.Message(receipt_handle) Creates a Message resource.: message = queue.Message('receipt_handle') Parameters: **receipt_handle** (*string*) -- The Message's receipt_handle identifier. This **must** be set. Return type: "SQS.Message" Returns: A Message resource Queue / Action / remove_permission remove_permission ***************** SQS.Queue.remove_permission(**kwargs) Revokes any permissions in the queue policy that matches the specified "Label" parameter. Note: * Only the owner of a queue can remove permissions from it. * Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the *Amazon SQS Developer Guide*. * To remove the ability to change queue permissions, you must deny permission to the "AddPermission", "RemovePermission", and "SetQueueAttributes" actions in your IAM policy. See also: AWS API Documentation **Request Syntax** response = queue.remove_permission( Label='string' ) Parameters: **Label** (*string*) -- **[REQUIRED]** The identification of the permission to remove. This is the label added using the "AddPermission" action. Returns: None Queue / Action / reload reload ****** SQS.Queue.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() Returns: None Queue / Action / receive_messages receive_messages **************** SQS.Queue.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. Therefore, only the messages on the sampled machines are returned. If the number of messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per "ReceiveMessage" call. If the number of messages in the queue is extremely small, you might not receive any messages in a particular "ReceiveMessage" response. If this happens, repeat the request. For each message returned, the response includes the following: * The message body. * An MD5 digest of the message body. For information about MD5, see RFC1321. * The "MessageId" you received when you sent the message to the queue. * The receipt handle. * The message attributes. * An MD5 digest of the message attributes. The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the *Amazon SQS Developer Guide*. You can provide the "VisibilityTimeout" parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility timeout for the queue is used for the returned messages. The default visibility timeout for a queue is 30 seconds. 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', ], MessageSystemAttributeNames=[ 'All'|'SenderId'|'SentTimestamp'|'ApproximateReceiveCount'|'ApproximateFirstReceiveTimestamp'|'SequenceNumber'|'MessageDeduplicationId'|'MessageGroupId'|'AWSTraceHeader'|'DeadLetterQueueSourceArn', ], MessageAttributeNames=[ 'string', ], MaxNumberOfMessages=123, VisibilityTimeout=123, WaitTimeSeconds=123, ReceiveRequestAttemptId='string' ) Parameters: * **AttributeNames** (*list*) -- Warning: This parameter has been discontinued but will be supported for backward compatibility. To provide attribute names, you are encouraged to use "MessageSystemAttributeNames". A list of attributes that need to be returned along with each message. These attributes include: * "All" – Returns all values. * "ApproximateFirstReceiveTimestamp" – Returns the time the message was first received from the queue ( epoch time in milliseconds). * "ApproximateReceiveCount" – Returns the number of times a message has been received across all queues but not deleted. * "AWSTraceHeader" – Returns the X-Ray trace header string. * "SenderId" * For a user, returns the user ID, for example "ABCDEFGHI1JKLMNOPQ23R". * For an IAM role, returns the IAM role ID, for example "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 (for example, 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. * "SequenceNumber" – Returns the value provided by Amazon SQS. * *(string) --* * **MessageSystemAttributeNames** (*list*) -- 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. * "SenderId" * For a user, returns the user ID, for example "ABCDEFGHI1JKLMNOPQ23R". * For an IAM role, returns the IAM role ID, for example "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 (for example, 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. * "SequenceNumber" – Returns the value provided by Amazon SQS. * *(string) --* * **MessageAttributeNames** (*list*) -- The name of the message attribute, where *N* is the index. * The name can contain alphanumeric characters and the underscore ( "_"), hyphen ( "-"), and period ( "."). * The name is case-sensitive and must be unique among all attribute names for the message. * The name must not start with AWS-reserved prefixes such as "AWS." or "Amazon." (or any casing variants). * The name must not start or end with a period ( "."), and it should not have periods in succession ( ".."). * The name can be up to 256 characters long. 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.*". * *(string) --* * **MaxNumberOfMessages** (*integer*) -- The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10. Default: 1. * **VisibilityTimeout** (*integer*) -- The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a "ReceiveMessage" request. If not specified, the default visibility timeout for the queue is used, which is 30 seconds. Understanding "VisibilityTimeout": * When a message is received from a queue, it becomes temporarily invisible to other consumers for the duration of the visibility timeout. This prevents multiple consumers from processing the same message simultaneously. If the message is not deleted or its visibility timeout is not extended before the timeout expires, it becomes visible again and can be retrieved by other consumers. * Setting an appropriate visibility timeout is crucial. If it's too short, the message might become visible again before processing is complete, leading to duplicate processing. If it's too long, it delays the reprocessing of messages if the initial processing fails. * You can adjust the visibility timeout using the "-- visibility-timeout" parameter in the "receive-message" command to match the processing time required by your application. * 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. For more information, see Visibility Timeout in the *Amazon SQS Developer Guide*. * **WaitTimeSeconds** (*integer*) -- The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than "WaitTimeSeconds". If no messages are available and the wait time expires, the call does not return a message list. If you are using the Java SDK, it returns a "ReceiveMessageResponse" object, which has a empty list instead of a Null object. 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. * **ReceiveRequestAttemptId** (*string*) -- 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. * You can use "ReceiveRequestAttemptId" only for 5 minutes after a "ReceiveMessage" action. * When you set "FifoQueue", a caller of the "ReceiveMessage" action can provide a "ReceiveRequestAttemptId" explicitly. * It is possible to retry the "ReceiveMessage" action with the same "ReceiveRequestAttemptId" if none of the messages have been modified (deleted or had their visibility changes). * During a visibility timeout, subsequent calls with the same "ReceiveRequestAttemptId" return the same messages and receipt handles. If a retry occurs within the deduplication interval, it resets the visibility timeout. For more information, see Visibility Timeout 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. * While messages with a particular "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" from your FIFO queue as long as they are visible. * If a caller of "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*. Return type: list("sqs.Message") Returns: A list of Message resources Queue / Identifier / url url *** SQS.Queue.url *(string)* The Queue's url identifier. This **must** be set. Queue / Action / add_permission add_permission ************** SQS.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*. * An Amazon SQS policy can have a maximum of seven actions per statement. * To remove the ability to change queue permissions, you must deny permission to the "AddPermission", "RemovePermission", and "SetQueueAttributes" actions in your IAM policy. * Amazon SQS "AddPermission" does not support adding a non- account principal. Note: Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the *Amazon SQS Developer Guide*. See also: AWS API Documentation **Request Syntax** response = queue.add_permission( Label='string', AWSAccountIds=[ 'string', ], Actions=[ 'string', ] ) Parameters: * **Label** (*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 ( "_"). * **AWSAccountIds** (*list*) -- **[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*. * *(string) --* * **Actions** (*list*) -- **[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". * *(string) --* Returns: None Queue / Action / delete delete ****** SQS.Queue.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 username in the *Amazon SQS Developer Guide*.The delete operation uses the HTTP "GET" verb. See also: AWS API Documentation **Request Syntax** response = queue.delete() Returns: None ServiceResource / Action / get_available_subresources get_available_subresources ************************** SQS.ServiceResource.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str ServiceResource / Sub-Resource / Queue Queue ***** SQS.ServiceResource.Queue(url) Creates a Queue resource.: queue = sqs.Queue('url') Parameters: **url** (*string*) -- The Queue's url identifier. This **must** be set. Return type: "SQS.Queue" Returns: A Queue resource ServiceResource / Action / get_queue_by_name get_queue_by_name ***************** SQS.ServiceResource.get_queue_by_name(**kwargs) The "GetQueueUrl" API returns the URL of an existing Amazon SQS queue. This is useful when you know the queue's name but need to retrieve its URL for further operations. To access a queue owned by another Amazon Web Services account, use the "QueueOwnerAWSAccountId" parameter to specify the account ID of the queue's owner. Note that the queue owner must grant you the necessary permissions to access the queue. For more information about accessing shared queues, see the "AddPermission" API or Allow developers to write messages to a shared queue in the *Amazon SQS Developer Guide*. See also: AWS API Documentation **Request Syntax** queue = sqs.get_queue_by_name( QueueName='string', QueueOwnerAWSAccountId='string' ) Parameters: * **QueueName** (*string*) -- **[REQUIRED]** (Required) The name of the queue for which you want to fetch the URL. The name can be up to 80 characters long and can include alphanumeric characters, hyphens (-), and underscores (_). Queue URLs and names are case-sensitive. * **QueueOwnerAWSAccountId** (*string*) -- (Optional) The Amazon Web Services account ID of the account that created the queue. This is only required when you are attempting to access a queue owned by another Amazon Web Services account. Return type: "sqs.Queue" Returns: Queue resource SQS / Resource / ServiceResource Service Resource **************** Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class SQS.ServiceResource A resource representing Amazon Simple Queue Service (SQS): import boto3 sqs = boto3.resource('sqs') 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. These are the resource's available actions: * create_queue * get_available_subresources * get_queue_by_name 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. These are the resource's available sub-resources: * Message * Queue Collections =========== Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide. These are the resource's available collections: * queues ServiceResource / Sub-Resource / Message Message ******* SQS.ServiceResource.Message(queue_url, receipt_handle) Creates a Message resource.: message = sqs.Message('queue_url','receipt_handle') Parameters: * **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. Return type: "SQS.Message" Returns: A Message resource ServiceResource / Collection / queues queues ****** SQS.ServiceResource.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() Return type: list("sqs.Queue") Returns: A list of Queue resources 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 ) Parameters: * **QueueNamePrefix** (*string*) -- A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned. Queue URLs and names are case-sensitive. * **NextToken** (*string*) -- Pagination token to request the next set of results. * **MaxResults** (*integer*) -- Maximum number of results to include in the response. Value range is 1 to 1000. You must set "MaxResults" to receive a value for "NextToken" in the response. Return type: list("sqs.Queue") Returns: 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 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("sqs.Queue") Returns: A list of Queue resources 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 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("sqs.Queue") Returns: A list of Queue resources ServiceResource / Action / create_queue create_queue ************ SQS.ServiceResource.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: * If you don't specify the "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*. * If you don't provide a value for an attribute, the queue is created with the default value for the attribute. * If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues. 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 retrieve the URL of a queue, use the GetQueueUrl action. This action only requires the QueueName parameter. When creating queues, keep the following points in mind: * If you specify the name of an existing queue and provide the exact same names and values for all its attributes, the CreateQueue action will return the URL of the existing queue instead of creating a new one. * If you attempt to create a queue with a name that already exists but with different attribute names or values, the "CreateQueue" action will return an error. This ensures that existing queues are not inadvertently altered. Note: Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the *Amazon SQS Developer Guide*. See also: AWS API Documentation **Request Syntax** queue = sqs.create_queue( QueueName='string', Attributes={ 'string': 'string' }, tags={ 'string': 'string' } ) Parameters: * **QueueName** (*string*) -- **[REQUIRED]** The name of the new queue. The following limits apply to this name: * A queue name can have up to 80 characters. * Valid values: alphanumeric characters, hyphens ( "-"), and underscores ( "_"). * A FIFO queue name must end with the ".fifo" suffix. Queue URLs and names are case-sensitive. * **Attributes** (*dict*) -- A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the "CreateQueue" action uses: * "DelaySeconds" – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0. * "MaximumMessageSize" – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). * "MessageRetentionPeriod" – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. Changes made to the "MessageRetentionPeriod" attribute can take up to 15 minutes and will impact existing messages in the queue potentially causing them to be expired and deleted if the "MessageRetentionPeriod" is reduced below the age of existing messages. * "Policy" – The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies in the *IAM User Guide*. * "ReceiveMessageWaitTimeSeconds" – The length of time, in seconds, for which a "ReceiveMessage" action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0. * "VisibilityTimeout" – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the *Amazon SQS Developer Guide*. The following attributes apply only to dead-letter queues: * "RedrivePolicy" – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows: * "deadLetterTargetArn" – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of "maxReceiveCount" is exceeded. * "maxReceiveCount" – The number of times a message is delivered to the source queue before being moved to the dead-letter queue. Default: 10. When the "ReceiveCount" for a message exceeds the "maxReceiveCount" for a queue, Amazon SQS moves the message to the dead-letter-queue. * "RedriveAllowPolicy" – The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead- letter queues as a JSON object. The parameters are as follows: * "redrivePermission" – The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are: * "allowAll" – (Default) Any source queues in this Amazon Web Services account in the same Region can specify this queue as the dead-letter queue. * "denyAll" – No source queues can specify this queue as the dead-letter queue. * "byQueue" – Only queues specified by the "sourceQueueArns" parameter can specify this queue as the dead-letter queue. * "sourceQueueArns" – The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead- letter queue and redrive messages. You can specify this parameter only when the "redrivePermission" parameter is set to "byQueue". You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead- letter queues, set the "redrivePermission" parameter to "allowAll". 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. 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 >>``<>``<<. 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 (for example, 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: * Every message must have a unique "MessageDeduplicationId". * You may provide a "MessageDeduplicationId" explicitly. * If you aren't able to provide a "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). * If you don't provide a "MessageDeduplicationId" and the queue doesn't have "ContentBasedDeduplication" set, the action fails with an error. * If the queue has "ContentBasedDeduplication" set, your "MessageDeduplicationId" overrides the generated one. * When "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. * If you send one message with "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: * Set "DeduplicationScope" to "messageGroup". * Set "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*. * *(string) --* * *(string) --* * **tags** (*dict*) -- 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: * Adding more than 50 tags to a queue isn't recommended. * Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings. * Tags are case-sensitive. * A new tag with a key identical to that of an existing tag overwrites the existing tag. 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 username in the *Amazon SQS Developer Guide*. * *(string) --* * *(string) --* Return type: "sqs.Queue" Returns: Queue resource SQS / Paginator / ListDeadLetterSourceQueues ListDeadLetterSourceQueues ************************** class 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' } ) Parameters: * **QueueUrl** (*string*) -- **[REQUIRED]** The URL of a dead-letter queue. Queue URLs and names are case-sensitive. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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. * *(string) --* SQS / Paginator / ListQueues ListQueues ********** class 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' } ) Parameters: * **QueueNamePrefix** (*string*) -- A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned. Queue URLs and names are case-sensitive. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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. * *(string) --* SQS / Client / send_message_batch send_message_batch ****************** SQS.Client.send_message_batch(**kwargs) You can use "SendMessageBatch" to send up to 10 messages to the specified queue by assigning either identical or different values to each message (or by not assigning values at all). This is a batch version of "SendMessage." For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent. The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of "200". The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144 bytes). Warning: A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters."#x9" | "#xA" | "#xD" | "#x20" to "#xD7FF" | "#xE000" to "#xFFFD" | "#x10000" to "#x10FFFF"Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with U+FFFD before storing the message in the queue, as long as the message body contains at least one valid character. If you don't specify the "DelaySeconds" parameter for an entry, Amazon SQS uses the default value for the queue. 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' }, ] ) Parameters: * **QueueUrl** (*string*) -- **[REQUIRED]** The URL of the Amazon SQS queue to which batched messages are sent. Queue URLs and names are case-sensitive. * **Entries** (*list*) -- **[REQUIRED]** A list of "SendMessageBatchRequestEntry" items. * *(dict) --* Contains the details of a single Amazon SQS message along with an "Id". * **Id** *(string) --* **[REQUIRED]** An identifier for a message in this batch used to communicate the result. Note: The >>``<?@[\]^_`{|}~"). For best practices of using "MessageDeduplicationId", see Using the MessageDeduplicationId Property in the *Amazon SQS Developer Guide*. * **MessageGroupId** *(string) --* "MessageGroupId" is an attribute used in Amazon SQS FIFO (First-In-First-Out) and standard queues. In FIFO queues, "MessageGroupId" organizes messages into distinct groups. Messages within the same message group are always processed one at a time, in strict order, ensuring that no two messages from the same group are processed simultaneously. In standard queues, using "MessageGroupId" enables fair queues. It is used to identify the tenant a message belongs to, helping maintain consistent message dwell time across all tenants during noisy neighbor events. Unlike FIFO queues, messages with the same "MessageGroupId" can be processed in parallel, maintaining the high throughput of standard queues. * **FIFO queues:** "MessageGroupId" acts as 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. If you do not provide a "MessageGroupId" when sending a message to a FIFO queue, the action fails. "ReceiveMessage" might return messages with multiple "MessageGroupId" values. For each "MessageGroupId", the messages are sorted by time sent. * >>**<>**<?@[\]^_`{|}~)". For best practices of using "MessageGroupId", see Using the MessageGroupId Property in the *Amazon SQS Developer Guide*. Return type: dict Returns: **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.TooManyEntriesInBatchRequest" * "SQS.Client.exceptions.EmptyBatchRequest" * "SQS.Client.exceptions.BatchEntryIdsNotDistinct" * "SQS.Client.exceptions.BatchRequestTooLong" * "SQS.Client.exceptions.InvalidBatchEntryId" * "SQS.Client.exceptions.UnsupportedOperation" * "SQS.Client.exceptions.RequestThrottled" * "SQS.Client.exceptions.QueueDoesNotExist" * "SQS.Client.exceptions.InvalidSecurity" * "SQS.Client.exceptions.KmsDisabled" * "SQS.Client.exceptions.KmsInvalidState" * "SQS.Client.exceptions.KmsNotFound" * "SQS.Client.exceptions.KmsOptInRequired" * "SQS.Client.exceptions.KmsThrottled" * "SQS.Client.exceptions.KmsAccessDenied" * "SQS.Client.exceptions.KmsInvalidKeyUsage" * "SQS.Client.exceptions.InvalidAddress" SQS / Client / get_paginator get_paginator ************* SQS.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "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")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. SQS / Client / delete_queue delete_queue ************ SQS.Client.delete_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 username in the *Amazon SQS Developer Guide*.The delete operation uses the HTTP "GET" verb. See also: AWS API Documentation **Request Syntax** response = client.delete_queue( QueueUrl='string' ) Parameters: **QueueUrl** (*string*) -- **[REQUIRED]** The URL of the Amazon SQS queue to delete. Queue URLs and names are case-sensitive. Returns: None **Exceptions** * "SQS.Client.exceptions.RequestThrottled" * "SQS.Client.exceptions.QueueDoesNotExist" * "SQS.Client.exceptions.InvalidAddress" * "SQS.Client.exceptions.UnsupportedOperation" * "SQS.Client.exceptions.InvalidSecurity" SQS / Client / can_paginate can_paginate ************ SQS.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "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")". Returns: "True" if the operation can be paginated, "False" otherwise. SQS / Client / list_dead_letter_source_queues list_dead_letter_source_queues ****************************** SQS.Client.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 ) Parameters: * **QueueUrl** (*string*) -- **[REQUIRED]** The URL of a dead-letter queue. Queue URLs and names are case-sensitive. * **NextToken** (*string*) -- Pagination token to request the next set of results. * **MaxResults** (*integer*) -- Maximum number of results to include in the response. Value range is 1 to 1000. You must set "MaxResults" to receive a value for "NextToken" in the response. Return type: dict Returns: **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. * *(string) --* * **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.QueueDoesNotExist" * "SQS.Client.exceptions.RequestThrottled" * "SQS.Client.exceptions.InvalidSecurity" * "SQS.Client.exceptions.InvalidAddress" * "SQS.Client.exceptions.UnsupportedOperation" SQS / Client / cancel_message_move_task cancel_message_move_task ************************ SQS.Client.cancel_message_move_task(**kwargs) Cancels a specified message movement task. A message movement can only be cancelled when the current status is RUNNING. Cancelling a message movement task does not revert the messages that have already been moved. It can only stop the messages that have not been moved yet. Note: * This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue. * Only one active message movement task is supported per queue at any given time. See also: AWS API Documentation **Request Syntax** response = client.cancel_message_move_task( TaskHandle='string' ) Parameters: **TaskHandle** (*string*) -- **[REQUIRED]** An identifier associated with a message movement task. Return type: dict Returns: **Response Syntax** { 'ApproximateNumberOfMessagesMoved': 123 } **Response Structure** * *(dict) --* * **ApproximateNumberOfMessagesMoved** *(integer) --* The approximate number of messages already moved to the destination queue. **Exceptions** * "SQS.Client.exceptions.ResourceNotFoundException" * "SQS.Client.exceptions.RequestThrottled" * "SQS.Client.exceptions.InvalidAddress" * "SQS.Client.exceptions.InvalidSecurity" * "SQS.Client.exceptions.UnsupportedOperation" SQS / Client / list_message_move_tasks list_message_move_tasks *********************** SQS.Client.list_message_move_tasks(**kwargs) Gets the most recent message movement tasks (up to 10) under a specific source queue. Note: * This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue. * Only one active message movement task is supported per queue at any given time. See also: AWS API Documentation **Request Syntax** response = client.list_message_move_tasks( SourceArn='string', MaxResults=123 ) Parameters: * **SourceArn** (*string*) -- **[REQUIRED]** The ARN of the queue whose message movement tasks are to be listed. * **MaxResults** (*integer*) -- The maximum number of results to include in the response. The default is 1, which provides the most recent message movement task. The upper limit is 10. Return type: dict Returns: **Response Syntax** { 'Results': [ { 'TaskHandle': 'string', 'Status': 'string', 'SourceArn': 'string', 'DestinationArn': 'string', 'MaxNumberOfMessagesPerSecond': 123, 'ApproximateNumberOfMessagesMoved': 123, 'ApproximateNumberOfMessagesToMove': 123, 'FailureReason': 'string', 'StartedTimestamp': 123 }, ] } **Response Structure** * *(dict) --* * **Results** *(list) --* A list of message movement tasks and their attributes. * *(dict) --* Contains the details of a message movement task. * **TaskHandle** *(string) --* An identifier associated with a message movement task. When this field is returned in the response of the "ListMessageMoveTasks" action, it is only populated for tasks that are in RUNNING status. * **Status** *(string) --* The status of the message movement task. Possible values are: RUNNING, COMPLETED, CANCELLING, CANCELLED, and FAILED. * **SourceArn** *(string) --* The ARN of the queue that contains the messages to be moved to another queue. * **DestinationArn** *(string) --* The ARN of the destination queue if it has been specified in the "StartMessageMoveTask" request. If a "DestinationArn" has not been specified in the "StartMessageMoveTask" request, this field value will be NULL. * **MaxNumberOfMessagesPerSecond** *(integer) --* The number of messages to be moved per second (the message movement rate), if it has been specified in the "StartMessageMoveTask" request. If a "MaxNumberOfMessagesPerSecond" has not been specified in the "StartMessageMoveTask" request, this field value will be NULL. * **ApproximateNumberOfMessagesMoved** *(integer) --* The approximate number of messages already moved to the destination queue. * **ApproximateNumberOfMessagesToMove** *(integer) --* The number of messages to be moved from the source queue. This number is obtained at the time of starting the message movement task and is only included after the message movement task is selected to start. * **FailureReason** *(string) --* The task failure reason (only included if the task status is FAILED). * **StartedTimestamp** *(integer) --* The timestamp of starting the message movement task. **Exceptions** * "SQS.Client.exceptions.ResourceNotFoundException" * "SQS.Client.exceptions.RequestThrottled" * "SQS.Client.exceptions.InvalidAddress" * "SQS.Client.exceptions.InvalidSecurity" * "SQS.Client.exceptions.UnsupportedOperation" SQS / Client / get_queue_attributes get_queue_attributes ******************** SQS.Client.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', ] ) Parameters: * **QueueUrl** (*string*) -- **[REQUIRED]** The URL of the Amazon SQS queue whose attribute information is retrieved. Queue URLs and names are case-sensitive. * **AttributeNames** (*list*) -- A list of attributes for which to retrieve information. The "AttributeNames" parameter is optional, but if you don't specify values for this parameter, the request returns empty results. 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 "ApproximateNumberOfMessages" metrics may not achieve consistency until at least 1 minute after the producers stop sending messages. This period is required for the queue metadata to reach eventual consistency. * "All" – Returns all values. * "ApproximateNumberOfMessages" – Returns the approximate number of messages available for retrieval from the queue. * "ApproximateNumberOfMessagesDelayed" – Returns the approximate number of messages in the queue that are delayed and not available for reading immediately. This can happen when the queue is configured as a delay queue or when a message has been sent with a delay parameter. * "ApproximateNumberOfMessagesNotVisible" – Returns the approximate number of messages that are in flight. Messages are considered to be *in flight* if they have been sent to a client but have not yet been deleted or have not yet reached the end of their visibility window. * "CreatedTimestamp" – Returns the time when the queue was created in seconds ( epoch time). * "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. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. Changes made to the "MessageRetentionPeriod" attribute can take up to 15 minutes and will impact existing messages in the queue potentially causing them to be expired and deleted if the "MessageRetentionPeriod" is reduced below the age of existing messages. * "Policy" – Returns the policy of the queue. * "QueueArn" – Returns the Amazon resource name (ARN) of the queue. * "ReceiveMessageWaitTimeSeconds" – Returns the length of time, in seconds, for which the "ReceiveMessage" action waits for a message to arrive. * "VisibilityTimeout" – Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the *Amazon SQS Developer Guide*. The following attributes apply only to dead-letter queues: * "RedrivePolicy" – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows: * "deadLetterTargetArn" – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of "maxReceiveCount" is exceeded. * "maxReceiveCount" – The number of times a message is delivered to the source queue before being moved to the dead-letter queue. Default: 10. When the "ReceiveCount" for a message exceeds the "maxReceiveCount" for a queue, Amazon SQS moves the message to the dead-letter-queue. * "RedriveAllowPolicy" – The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead- letter queues as a JSON object. The parameters are as follows: * "redrivePermission" – The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are: * "allowAll" – (Default) Any source queues in this Amazon Web Services account in the same Region can specify this queue as the dead-letter queue. * "denyAll" – No source queues can specify this queue as the dead-letter queue. * "byQueue" – Only queues specified by the "sourceQueueArns" parameter can specify this queue as the dead-letter queue. * "sourceQueueArns" – The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead- letter queue and redrive messages. You can specify this parameter only when the "redrivePermission" parameter is set to "byQueue". You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead- letter queues, set the "redrivePermission" parameter to "allowAll". 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. 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 (for example, 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: * Set "DeduplicationScope" to "messageGroup". * Set "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*. * *(string) --* Return type: dict Returns: **Response Syntax** { 'Attributes': { 'string': 'string' } } **Response Structure** * *(dict) --* A list of returned queue attributes. * **Attributes** *(dict) --* A map of attributes to their respective values. * *(string) --* * *(string) --* **Exceptions** * "SQS.Client.exceptions.InvalidAttributeName" * "SQS.Client.exceptions.RequestThrottled" * "SQS.Client.exceptions.QueueDoesNotExist" * "SQS.Client.exceptions.UnsupportedOperation" * "SQS.Client.exceptions.InvalidSecurity" * "SQS.Client.exceptions.InvalidAddress" SQS / Client / tag_queue tag_queue ********* SQS.Client.tag_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: * Adding more than 50 tags to a queue isn't recommended. * Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings. * Tags are case-sensitive. * A new tag with a key identical to that of an existing tag overwrites the existing tag. 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 username in the *Amazon SQS Developer Guide*. See also: AWS API Documentation **Request Syntax** response = client.tag_queue( QueueUrl='string', Tags={ 'string': 'string' } ) Parameters: * **QueueUrl** (*string*) -- **[REQUIRED]** The URL of the queue. * **Tags** (*dict*) -- **[REQUIRED]** The list of tags to be added to the specified queue. * *(string) --* * *(string) --* Returns: None **Exceptions** * "SQS.Client.exceptions.InvalidAddress" * "SQS.Client.exceptions.RequestThrottled" * "SQS.Client.exceptions.QueueDoesNotExist" * "SQS.Client.exceptions.InvalidSecurity" * "SQS.Client.exceptions.UnsupportedOperation" SQS / Client / change_message_visibility_batch change_message_visibility_batch ******************************* SQS.Client.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". See also: AWS API Documentation **Request Syntax** response = client.change_message_visibility_batch( QueueUrl='string', Entries=[ { 'Id': 'string', 'ReceiptHandle': 'string', 'VisibilityTimeout': 123 }, ] ) Parameters: * **QueueUrl** (*string*) -- **[REQUIRED]** The URL of the Amazon SQS queue whose messages' visibility is changed. Queue URLs and names are case-sensitive. * **Entries** (*list*) -- **[REQUIRED]** Lists the receipt handles of the messages for which the visibility timeout must be changed. * *(dict) --* Encloses a receipt handle and an entry ID for each message in "ChangeMessageVisibilityBatch." * **Id** *(string) --* **[REQUIRED]** An identifier for this particular receipt handle used to communicate the result. Note: The >>``<?@[\]^_`{|}~"). For best practices of using "MessageDeduplicationId", see Using the MessageDeduplicationId Property in the *Amazon SQS Developer Guide*. * **MessageGroupId** (*string*) -- "MessageGroupId" is an attribute used in Amazon SQS FIFO (First-In-First-Out) and standard queues. In FIFO queues, "MessageGroupId" organizes messages into distinct groups. Messages within the same message group are always processed one at a time, in strict order, ensuring that no two messages from the same group are processed simultaneously. In standard queues, using "MessageGroupId" enables fair queues. It is used to identify the tenant a message belongs to, helping maintain consistent message dwell time across all tenants during noisy neighbor events. Unlike FIFO queues, messages with the same "MessageGroupId" can be processed in parallel, maintaining the high throughput of standard queues. * **FIFO queues:** "MessageGroupId" acts as 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. If you do not provide a "MessageGroupId" when sending a message to a FIFO queue, the action fails. "ReceiveMessage" might return messages with multiple "MessageGroupId" values. For each "MessageGroupId", the messages are sorted by time sent. * >>**<>**<?@[\]^_`{|}~)". For best practices of using "MessageGroupId", see Using the MessageGroupId Property in the *Amazon SQS Developer Guide*. Return type: dict Returns: **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.InvalidMessageContents" * "SQS.Client.exceptions.UnsupportedOperation" * "SQS.Client.exceptions.RequestThrottled" * "SQS.Client.exceptions.QueueDoesNotExist" * "SQS.Client.exceptions.InvalidSecurity" * "SQS.Client.exceptions.KmsDisabled" * "SQS.Client.exceptions.KmsInvalidState" * "SQS.Client.exceptions.KmsNotFound" * "SQS.Client.exceptions.KmsOptInRequired" * "SQS.Client.exceptions.KmsThrottled" * "SQS.Client.exceptions.KmsAccessDenied" * "SQS.Client.exceptions.KmsInvalidKeyUsage" * "SQS.Client.exceptions.InvalidAddress" SQS / Client / get_waiter get_waiter ********** SQS.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" SQS / Client / delete_message_batch delete_message_batch ******************** SQS.Client.delete_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". See also: AWS API Documentation **Request Syntax** response = client.delete_message_batch( QueueUrl='string', Entries=[ { 'Id': 'string', 'ReceiptHandle': 'string' }, ] ) Parameters: * **QueueUrl** (*string*) -- **[REQUIRED]** The URL of the Amazon SQS queue from which messages are deleted. Queue URLs and names are case-sensitive. * **Entries** (*list*) -- **[REQUIRED]** Lists the receipt handles for the messages to be deleted. * *(dict) --* Encloses a receipt handle and an identifier for it. * **Id** *(string) --* **[REQUIRED]** The identifier for this particular receipt handle. This is used to communicate the result. Note: The >>``<