Skip to content

Message

Source code in docs_src/capo_sqs/types/message.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class Message(TypedDict, closed=True):
    message_id: NotRequired["capo_sqs.types.string.String"]
    """<p>A unique identifier for the message. A <code>MessageId</code>is considered unique across all Amazon Web Services accounts for an extended period of time.</p>"""
    receipt_handle: NotRequired["capo_sqs.types.string.String"]
    """<p>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.</p>"""
    md5_of_body: NotRequired["capo_sqs.types.string.String"]
    """<p>An MD5 digest of the non-URL-encoded message body string.</p>"""
    body: NotRequired["capo_sqs.types.string.String"]
    """<p>The message's contents (not URL-encoded).</p>"""
    attributes: NotRequired[
        "capo_sqs.types.message_system_attribute_map.MessageSystemAttributeMap"
    ]
    """<p>A map of the attributes requested in <code> <a>ReceiveMessage</a> </code> to their respective values. Supported attributes:</p> <ul> <li> <p> <code>ApproximateReceiveCount</code> </p> </li> <li> <p> <code>ApproximateFirstReceiveTimestamp</code> </p> </li> <li> <p> <code>MessageDeduplicationId</code> </p> </li> <li> <p> <code>MessageGroupId</code> </p> </li> <li> <p> <code>SenderId</code> </p> </li> <li> <p> <code>SentTimestamp</code> </p> </li> <li> <p> <code>SequenceNumber</code> </p> </li> </ul> <p> <code>ApproximateFirstReceiveTimestamp</code> and <code>SentTimestamp</code> are each returned as an integer representing the <a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a> in milliseconds.</p>"""
    md5_of_message_attributes: NotRequired["capo_sqs.types.string.String"]
    """<p>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 <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>.</p>"""
    message_attributes: NotRequired[
        "capo_sqs.types.message_body_attribute_map.MessageBodyAttributeMap"
    ]
    """<p>Each message attribute consists of a <code>Name</code>, <code>Type</code>, and <code>Value</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes">Amazon SQS message attributes</a> in the <i>Amazon SQS Developer Guide</i>.</p>"""

attributes instance-attribute 

attributes: NotRequired[MessageSystemAttributeMap]

A map of the attributes requested in ReceiveMessage to their respective values. Supported attributes:

  • ApproximateReceiveCount

  • ApproximateFirstReceiveTimestamp

  • MessageDeduplicationId

  • MessageGroupId

  • SenderId

  • SentTimestamp

  • SequenceNumber

ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an integer representing the epoch time in milliseconds.

body instance-attribute 

body: NotRequired[String]

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

md5_of_body instance-attribute 

md5_of_body: NotRequired[String]

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

md5_of_message_attributes instance-attribute 

md5_of_message_attributes: NotRequired[String]

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

message_attributes instance-attribute 

message_attributes: NotRequired[MessageBodyAttributeMap]

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

message_id instance-attribute 

message_id: NotRequired[String]

A unique identifier for the message. A MessageIdis considered unique across all Amazon Web Services accounts for an extended period of time.

receipt_handle instance-attribute 

receipt_handle: NotRequired[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.