Skip to content

MessageResult

Source code in docs_src/capo_pinpoint/types/message_result.py 
13
14
15
16
17
18
19
20
21
22
23
class MessageResult(TypedDict, closed=True):
    delivery_status: NotRequired["capo_pinpoint.types.delivery_status.DeliveryStatus"]
    """<p>The delivery status of the message. Possible values are:</p> <ul> <li><p>DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>SUCCESSFUL - The message was successfully delivered to the endpoint address.</p></li> <li><p>TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.</p></li> <li><p>UNKNOWN_FAILURE - An unknown error occurred.</p></li></ul>"""
    message_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The unique identifier for the message that was sent.</p>"""
    status_code: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The downstream service status code for delivering the message.</p>"""
    status_message: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The status message for delivering the message.</p>"""
    updated_token: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.</p>"""

delivery_status instance-attribute 

delivery_status: NotRequired[DeliveryStatus]

The delivery status of the message. Possible values are:

  • DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.

  • OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.

  • PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.

  • SUCCESSFUL - The message was successfully delivered to the endpoint address.

  • TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.

  • THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.

  • UNKNOWN_FAILURE - An unknown error occurred.

message_id instance-attribute 

message_id: NotRequired[__string]

The unique identifier for the message that was sent.

status_code instance-attribute 

status_code: NotRequired[__integer]

The downstream service status code for delivering the message.

status_message instance-attribute 

status_message: NotRequired[__string]

The status message for delivering the message.

updated_token instance-attribute 

updated_token: NotRequired[__string]

For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.