Skip to content

SendUsersMessageRequest

Used by
Source code in docs_src/capo_pinpoint/types/send_users_message_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class SendUsersMessageRequest(TypedDict, closed=True):
    context: NotRequired["capo_pinpoint.types.map_of__string.MapOf__string"]
    """<p>A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.</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>"""
    users: NotRequired[
        "capo_pinpoint.types.map_of_endpoint_send_configuration.MapOfEndpointSendConfiguration"
    ]
    """<p>A map that associates user IDs with <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration">EndpointSendConfiguration</a> objects. 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 a user by specifying settings such as content overrides and message variables.</p>"""

context instance-attribute 

context: NotRequired[MapOf__string]

A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.

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.

users instance-attribute 

users: NotRequired[MapOfEndpointSendConfiguration]

A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.