Skip to content

PushMessageActivity

Source code in docs_src/capo_pinpoint/types/push_message_activity.py
class PushMessageActivity(TypedDict, closed=True):
    message_config: NotRequired[
        "capo_pinpoint.types.journey_push_message.JourneyPushMessage"
    ]
    """<p>Specifies the time to live (TTL) value for push notifications that are 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 the message is sent.</p>"""
    template_name: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The name of the push notification 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 push notification 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>"""

message_config instance-attribute

message_config: NotRequired[JourneyPushMessage]

Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.

next_activity instance-attribute

next_activity: NotRequired[__string]

The unique identifier for the next activity to perform, after the message is sent.

template_name instance-attribute

template_name: NotRequired[__string]

The name of the push notification 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 push notification 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.