Skip to content

CustomMessageActivity

Source code in docs_src/capo_pinpoint/types/custom_message_activity.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class CustomMessageActivity(TypedDict, closed=True):
    delivery_uri: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The destination to send the campaign or treatment to. This value can be one of the following:</p> <ul><li><p>The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.</p></li> <li><p>The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.</p></li></ul>"""
    endpoint_types: NotRequired[
        "capo_pinpoint.types.list_of__endpoint_types_element.ListOf__EndpointTypesElement"
    ]
    """<p>The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.</p>"""
    message_config: NotRequired[
        "capo_pinpoint.types.journey_custom_message.JourneyCustomMessage"
    ]
    """<p>Specifies the message data included in a custom channel message that's sent to participants in a journey.</p>"""
    next_activity: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.</p>"""
    template_name: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.</p>"""
    template_version: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If you don't specify a value for this property, Amazon Pinpoint uses the <i>active version</i> of the template. The <i>active version</i> is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.</p>"""

delivery_uri instance-attribute 

delivery_uri: NotRequired[__string]

The destination to send the campaign or treatment to. This value can be one of the following:

  • The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.

  • The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.

endpoint_types instance-attribute 

endpoint_types: NotRequired[ListOf__EndpointTypesElement]

The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

message_config instance-attribute 

message_config: NotRequired[JourneyCustomMessage]

Specifies the message data included in a custom channel message that's sent to participants in a journey.

next_activity instance-attribute 

next_activity: NotRequired[__string]

The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.

template_name instance-attribute 

template_name: NotRequired[__string]

The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.

template_version instance-attribute 

template_version: NotRequired[__string]

The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.