Skip to content

MessageRequest

Used by
Source code in docs_src/capo_pinpoint/types/message_request.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class MessageRequest(TypedDict, closed=True):
    addresses: NotRequired[
        "capo_pinpoint.types.map_of_address_configuration.MapOfAddressConfiguration"
    ]
    """<p>A map of key-value pairs, where each key is an address and each value is an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-addressconfiguration">AddressConfiguration</a> object. An address can be a push notification token, a phone number, or an email address. You can use an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-addressconfiguration">AddressConfiguration</a> object to tailor the message for an address by specifying settings such as content overrides and message variables.</p>"""
    context: NotRequired["capo_pinpoint.types.map_of__string.MapOf__string"]
    """<p>A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.</p>"""
    endpoints: NotRequired[
        "capo_pinpoint.types.map_of_endpoint_send_configuration.MapOfEndpointSendConfiguration"
    ]
    """<p>A map of key-value pairs, where each key is an endpoint ID and each value is an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration">EndpointSendConfiguration</a> object. You can use an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration">EndpointSendConfiguration</a> object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.</p>"""
    message_configuration: NotRequired[
        "capo_pinpoint.types.direct_message_configuration.DirectMessageConfiguration"
    ]
    """<p>The settings and content for the default message and any default messages that you defined for specific channels.</p>"""
    template_configuration: NotRequired[
        "capo_pinpoint.types.template_configuration.TemplateConfiguration"
    ]
    """<p>The message template to use for the message.</p>"""
    trace_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The unique identifier for tracing the message. This identifier is visible to message recipients.</p>"""

addresses instance-attribute 

addresses: NotRequired[MapOfAddressConfiguration]

A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables.

context instance-attribute 

context: NotRequired[MapOf__string]

A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.

endpoints instance-attribute 

endpoints: NotRequired[MapOfEndpointSendConfiguration]

A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.

message_configuration instance-attribute 

message_configuration: NotRequired[DirectMessageConfiguration]

The settings and content for the default message and any default messages that you defined for specific channels.

template_configuration instance-attribute 

template_configuration: NotRequired[TemplateConfiguration]

The message template to use for the message.

trace_id instance-attribute 

trace_id: NotRequired[__string]

The unique identifier for tracing the message. This identifier is visible to message recipients.