Amazon Simple Queue Service

{'AttributeNames': {'All', 'FifoQueue', 'ContentBasedDeduplication'}}

Gets attributes for the specified queue.

Request Syntax

client.get_queue_attributes(
    QueueUrl='string',
    AttributeNames=[
        'All'|'Policy'|'VisibilityTimeout'|'MaximumMessageSize'|'MessageRetentionPeriod'|'ApproximateNumberOfMessages'|'ApproximateNumberOfMessagesNotVisible'|'CreatedTimestamp'|'LastModifiedTimestamp'|'QueueArn'|'ApproximateNumberOfMessagesDelayed'|'DelaySeconds'|'ReceiveMessageWaitTimeSeconds'|'RedrivePolicy'|'FifoQueue'|'ContentBasedDeduplication',
    ]
)

type QueueUrl

string

param QueueUrl

[REQUIRED]

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

type AttributeNames

list

param AttributeNames

A list of attributes for which to retrieve information.

Note

Going forward, new attributes might be added. If you are writing 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:

• All - Returns all values.

• ApproximateNumberOfMessages - Returns the approximate number of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide .

• ApproximateNumberOfMessagesDelayed - Returns the approximate number of messages that are waiting to be added to the queue.

• ApproximateNumberOfMessagesNotVisible - Returns the approximate number of messages that have not timed-out and are not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide .

• 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 number of seconds for which Amazon SQS retains a message.

• Policy - Returns the policy of the queue.

• QueueArn - Returns the Amazon resource name (ARN) of the queue.

• ReceiveMessageWaitTimeSeconds - Returns the number of seconds for which ReceiveMessage call will wait for a message to arrive.

• RedrivePolicy - Returns the parameters for dead letter queue functionality of the source queue. For more information about the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide .

• 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 FIFO (first-in-first-out) queues:

• FifoQueue - Returns whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon SQS Developer Guide .

• ContentBasedDeduplication - Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide .

• (string) --

rtype

dict

returns

Response Syntax

{
    'Attributes': {
        'string': 'string'
    }
}

Response Structure

• (dict) --

  A list of returned queue attributes.

  • Attributes (dict) --

    A map of attributes to the respective values.

    • (string) --

      • (string) --

{'AttributeNames': {'All', 'FifoQueue', 'ContentBasedDeduplication'},
 'ReceiveRequestAttemptId': 'string'}

Retrieves one or more messages, with a maximum limit of 10 messages, from the specified queue. Long poll support is enabled by using the WaitTimeSeconds parameter. For more information, see Amazon SQS Long Poll 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. This means only the messages on the sampled machines are returned. If the number of messages in the queue is small (less than 1000), it is likely you will 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; in which case you should repeat the request.

For each message returned, the response includes the following:

• Message body

• MD5 digest of the message body. For information about MD5, see RFC1321.

• Message ID you received when you sent the message to the queue.

• Receipt handle.

• Message attributes.

• 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, which will be applied to the messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer Guide .

A message that is not deleted or a message whose visibility is not 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.

Request Syntax

client.receive_message(
    QueueUrl='string',
    AttributeNames=[
        'All'|'Policy'|'VisibilityTimeout'|'MaximumMessageSize'|'MessageRetentionPeriod'|'ApproximateNumberOfMessages'|'ApproximateNumberOfMessagesNotVisible'|'CreatedTimestamp'|'LastModifiedTimestamp'|'QueueArn'|'ApproximateNumberOfMessagesDelayed'|'DelaySeconds'|'ReceiveMessageWaitTimeSeconds'|'RedrivePolicy'|'FifoQueue'|'ContentBasedDeduplication',
    ],
    MessageAttributeNames=[
        'string',
    ],
    MaxNumberOfMessages=123,
    VisibilityTimeout=123,
    WaitTimeSeconds=123,
    ReceiveRequestAttemptId='string'
)

type QueueUrl

string

param QueueUrl

[REQUIRED]

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

type AttributeNames

list

param AttributeNames

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 from the queue but not deleted.

• SenderId

  • For an IAM user, returns the IAM 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).

• MessageDeduplicationId - Returns the value provided by the sender that calls the SendMessage action.

• MessageGroupId - Returns the value provided by the sender that calls the SendMessage action. Messages with the same MessageGroupId are returned in sequence.

• SequenceNumber - Returns the value provided by Amazon SQS.

Any other valid special request parameters (such as the following) that are specified are ignored:

• ApproximateNumberOfMessages

• ApproximateNumberOfMessagesDelayed

• ApproximateNumberOfMessagesNotVisible

• CreatedTimestamp

• ContentBasedDeduplication

• DelaySeconds

• LastModifiedTimestamp

• MaximumMessageSize

• MessageRetentionPeriod

• Policy

• QueueArn ,

• ReceiveMessageWaitTimeSeconds

• RedrivePolicy

• FifoQueue

• VisibilityTimeout

• (string) --

type MessageAttributeNames

list

param MessageAttributeNames

The name of the message attribute, where N is the index. The message attribute name can contain the following characters: A-Z, a-z, 0-9, underscore (_), hyphen (-), and period (.). The name must not start or end with a period, and it should not have successive periods. The name is case sensitive and must be unique among all attribute names for the message. The name can be up to 256 characters long. The name can't start with "AWS." or "Amazon." (or any variations in casing), because these prefixes are reserved for use by Amazon Web Services.

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 "bar.*" to return all message attributes starting with the "bar" prefix.

• (string) --

type MaxNumberOfMessages

integer

param MaxNumberOfMessages

The maximum number of messages to return. Amazon SQS never returns more messages than this value but might return fewer. Values can be from 1 to 10. Default is 1.

All of the messages are not necessarily returned.

type VisibilityTimeout

integer

param VisibilityTimeout

The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

type WaitTimeSeconds

integer

param WaitTimeSeconds

The duration (in seconds) for which the call will wait for a message to arrive in the queue before returning. If a message is available, the call will return sooner than WaitTimeSeconds.

type ReceiveRequestAttemptId

string

param ReceiveRequestAttemptId

This parameter applies only to FIFO (first-in-first-out) queues.

The token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, you can 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.

• If a caller of the ReceiveMessage action doesn't provide a ReceiveRequestAttemptId , Amazon SQS generates a ReceiveRequestAttemptId .

• You can 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 Simple Queue Service Developer Guide .

Warning

If a caller of the ReceiveMessage action is still processing messages when the visibility timeout expires and messages become visible, another worker reading from the same queue can receive the same messages and therefore process duplicates. Also, if a reader 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 as long as it is also visible.

• If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId , no retries will work until the original visibility timeout expires. As a result, delays might occur but the messages in the queue will remain in a strict order.

The 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 Simple Queue Service Developer Guide .

rtype

dict

returns

Response Syntax

{
    'Messages': [
        {
            'MessageId': 'string',
            'ReceiptHandle': 'string',
            'MD5OfBody': 'string',
            'Body': 'string',
            'Attributes': {
                'string': 'string'
            },
            'MD5OfMessageAttributes': 'string',
            'MessageAttributes': {
                'string': {
                    'StringValue': 'string',
                    'BinaryValue': b'bytes',
                    'StringListValues': [
                        'string',
                    ],
                    'BinaryListValues': [
                        b'bytes',
                    ],
                    'DataType': 'string'
                }
            }
        },
    ]
}

Response Structure

• (dict) --

  A list of received messages.

  • Messages (list) --

    A list of messages.

    • (dict) --

      An Amazon SQS message.

      • MessageId (string) --

        A unique identifier for the message. Message IDs are considered unique across all AWS accounts for an extended period of time.

      • ReceiptHandle (string) --

        An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.

      • MD5OfBody (string) --

        An MD5 digest of the non-URL-encoded message body string.

      • Body (string) --

        The message's contents (not URL-encoded).

      • Attributes (dict) --

        SenderId , SentTimestamp , ApproximateReceiveCount , and/or ApproximateFirstReceiveTimestamp . SentTimestamp and ApproximateFirstReceiveTimestamp are each returned as an integer representing the epoch time in milliseconds.

        • (string) --

          • (string) --

      • MD5OfMessageAttributes (string) --

        An MD5 digest of the non-URL-encoded message attribute string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

      • MessageAttributes (dict) --

        Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items in the Amazon SQS Developer Guide .

        • (string) --

          • (dict) --

            The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see SendMessage.

            Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes).

            • StringValue (string) --

              Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters.

            • BinaryValue (bytes) --

              Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.

            • StringListValues (list) --

              Not implemented. Reserved for future use.

              • (string) --

            • BinaryListValues (list) --

              Not implemented. Reserved for future use.

              • (bytes) --

            • DataType (string) --

              Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.

              You can also append custom labels. For more information, see Message Attribute Data Types in the Amazon SQS Developer Guide .

{'MessageDeduplicationId': 'string', 'MessageGroupId': 'string'}

{'SequenceNumber': 'string'}

Delivers a message to the specified queue.

Request Syntax

client.send_message(
    QueueUrl='string',
    MessageBody='string',
    DelaySeconds=123,
    MessageAttributes={
        'string': {
            'StringValue': 'string',
            'BinaryValue': b'bytes',
            'StringListValues': [
                'string',
            ],
            'BinaryListValues': [
                b'bytes',
            ],
            'DataType': 'string'
        }
    },
    MessageDeduplicationId='string',
    MessageGroupId='string'
)

type QueueUrl

string

param QueueUrl

[REQUIRED]

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

type MessageBody

string

param MessageBody

[REQUIRED]

The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding note.

type DelaySeconds

integer

param DelaySeconds

The number of seconds (0 to 900 - 15 minutes) to delay a specific message. Messages with a positive DelaySeconds value become available for processing after the delay time is finished. If you don't specify a value, the default value for the queue applies.

Note

When you set FifoQueue , you can't set DelaySeconds per message. You can set this parameter only on a queue level.

type MessageAttributes

dict

param MessageAttributes

Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items in the Amazon SQS Developer Guide .

• (string) --

  • (dict) --

    The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see SendMessage.

    Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes).

    • StringValue (string) --

      Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters.

    • BinaryValue (bytes) --

      Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.

    • StringListValues (list) --

      Not implemented. Reserved for future use.

      • (string) --

    • BinaryListValues (list) --

      Not implemented. Reserved for future use.

      • (bytes) --

    • DataType (string) -- [REQUIRED]

      Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.

      You can also append custom labels. For more information, see Message Attribute Data Types in the Amazon SQS Developer Guide .

type MessageDeduplicationId

string

param MessageDeduplicationId

This parameter applies only to FIFO (first-in-first-out) queues.

The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide .

• 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.

• You can also use ContentBasedDeduplication for messages with identical content to be treated as duplicates.

• 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.

Note

The MessageDeduplicationId is available to the recipient of the message (this can be useful for troubleshooting delivery issues).

If a message is sent successfully but the acknowledgdment is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.

The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters ( a-z , A-Z , 0-9 ) and punctuation ( !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~ ).

For best practices of using MessageDeduplicationId , see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide .

type MessageGroupId

string

param MessageGroupId

This parameter applies only to FIFO (first-in-first-out) queues.

The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple readers can process the queue, but the session data of each user is processed in a FIFO fashion.

• You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId , the action fails.

• ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId , the messages are sorted by time sent. The caller can't specify a MessageGroupId .

The length of MessageGroupId is 128 characters. Valid values are alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) .

For best practices of using MessageGroupId , see Using the MessageGroupId Property in the Amazon Simple Queue Service Developer Guide .

rtype

dict

returns

Response Syntax

{
    'MD5OfMessageBody': 'string',
    'MD5OfMessageAttributes': '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. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first 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. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

  • MessageId (string) --

    An element containing the message ID of the message sent to the queue. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide .

  • SequenceNumber (string) --

    This element applies only to FIFO (first-in-first-out) queues.

    A 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 .

{'Entries': {'MessageDeduplicationId': 'string', 'MessageGroupId': 'string'}}

{'Successful': {'SequenceNumber': 'string'}}

Delivers up to ten messages to the specified queue. This is a batch version of SendMessage . For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.

The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).

If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default for the queue.

Request Syntax

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'
                }
            },
            'MessageDeduplicationId': 'string',
            'MessageGroupId': 'string'
        },
    ]
)

type QueueUrl

string

param QueueUrl

[REQUIRED]

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

type Entries

list

param Entries

[REQUIRED]

A list of SendMessageBatchRequestEntry items.

• (dict) --

  Contains the details of a single Amazon SQS message along with a Id .

  • Id (string) -- [REQUIRED]

    An identifier for the message in this batch. This is used to communicate the result. Note that the Id s of a batch request need to be unique within the request.

  • MessageBody (string) -- [REQUIRED]

    Body of the message.

  • DelaySeconds (integer) --

    The number of seconds (0 to 900 - 15 minutes) to delay a specific message. Messages with a positive DelaySeconds value become available for processing after the delay time is finished. If you don't specify a value, the default value for the queue applies.

    Note

    When you set FifoQueue , you can't set DelaySeconds per message. You can set this parameter only on a queue level.

  • MessageAttributes (dict) --

    Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items in the Amazon SQS Developer Guide .

    • (string) --

      • (dict) --

        The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see SendMessage.

        Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes).

        • StringValue (string) --

          Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters.

        • BinaryValue (bytes) --

          Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.

        • StringListValues (list) --

          Not implemented. Reserved for future use.

          • (string) --

        • BinaryListValues (list) --

          Not implemented. Reserved for future use.

          • (bytes) --

        • DataType (string) -- [REQUIRED]

          Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.

          You can also append custom labels. For more information, see Message Attribute Data Types in the Amazon SQS Developer Guide .

  • MessageDeduplicationId (string) --

    This parameter applies only to FIFO (first-in-first-out) queues.

    The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are accepted successfully but aren't delivered. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide .

    • 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.

    • You can also use ContentBasedDeduplication for messages with identical content to be treated as duplicates.

    • 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.

    Note

    The MessageDeduplicationId is available to the recipient of the message (this can be useful for troubleshooting delivery issues).

    If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.

    The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters ( a-z , A-Z , 0-9 ) and punctuation ( !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~ ).

    For best practices of using MessageDeduplicationId , see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide .

  • MessageGroupId (string) --

    This parameter applies only to FIFO (first-in-first-out) queues.

    The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple readers can process the queue, but the session data of each user is processed in a FIFO fashion.

    • You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId , the action fails.

    • ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId , the messages are sorted by time sent. The caller can't specify a MessageGroupId .

    The length of MessageGroupId is 128 characters. Valid values are alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) .

    For best practices of using MessageGroupId , see Using the MessageGroupId Property in the Amazon Simple Queue Service Developer Guide .

rtype

dict

returns

Response Syntax

{
    'Successful': [
        {
            'Id': 'string',
            'MessageId': 'string',
            'MD5OfMessageBody': 'string',
            'MD5OfMessageAttributes': '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 message ID for successfully enqueued message of 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. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first 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. This can be used to verify that Amazon SQS received the message batch correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

      • SequenceNumber (string) --

        This element applies only to FIFO (first-in-first-out) queues.

        A 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 the error detail about each message that could not be enqueued.

    • (dict) --

      This is used in the responses of batch API to give 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) --

        Whether the error happened due to the sender's fault.

      • 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.