Skip to content

AddressConfiguration

Source code in docs_src/capo_pinpoint/types/address_configuration.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
class AddressConfiguration(TypedDict, closed=True):
    body_override: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The message body to use instead of the default message body. This value overrides the default message body.</p>"""
    channel_type: NotRequired["capo_pinpoint.types.channel_type.ChannelType"]
    """<p>The channel to use when sending the message.</p>"""
    context: NotRequired["capo_pinpoint.types.map_of__string.MapOf__string"]
    """<p>An object that maps custom attributes to attributes for the address and is attached to the message. Attribute names are case sensitive.</p> <p>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>"""
    raw_content: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.</p>"""
    substitutions: NotRequired[
        "capo_pinpoint.types.map_of_list_of__string.MapOfListOf__string"
    ]
    """<p>A map of the message variables to merge with the variables specified by properties of the DefaultMessage object. The variables specified in this map take precedence over all other variables.</p>"""
    title_override: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The message title to use instead of the default message title. This value overrides the default message title.</p>"""

body_override instance-attribute 

body_override: NotRequired[__string]

The message body to use instead of the default message body. This value overrides the default message body.

channel_type instance-attribute 

channel_type: NotRequired[ChannelType]

The channel to use when sending the message.

context instance-attribute 

context: NotRequired[MapOf__string]

An object that maps custom attributes to attributes for the address and is attached to the message. Attribute names are case sensitive.

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.

raw_content instance-attribute 

raw_content: NotRequired[__string]

The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.

substitutions instance-attribute 

substitutions: NotRequired[MapOfListOf__string]

A map of the message variables to merge with the variables specified by properties of the DefaultMessage object. The variables specified in this map take precedence over all other variables.

title_override instance-attribute 

title_override: NotRequired[__string]

The message title to use instead of the default message title. This value overrides the default message title.