Skip to content

PushNotificationTemplateResponse

Source code in docs_src/capo_pinpoint/types/push_notification_template_response.py
class PushNotificationTemplateResponse(TypedDict, closed=True):
    adm: NotRequired[
        "capo_pinpoint.types.android_push_notification_template.AndroidPushNotificationTemplate"
    ]
    """<p>The message template that's used for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).</p>"""
    apns: NotRequired[
        "capo_pinpoint.types.apns_push_notification_template.APNSPushNotificationTemplate"
    ]
    """<p>The message template that's used for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).</p>"""
    arn: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The Amazon Resource Name (ARN) of the message template.</p>"""
    baidu: NotRequired[
        "capo_pinpoint.types.android_push_notification_template.AndroidPushNotificationTemplate"
    ]
    """<p>The message template that's used for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).</p>"""
    creation_date: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The date, in ISO 8601 format, when the message template was created.</p>"""
    default: NotRequired[
        "capo_pinpoint.types.default_push_notification_template.DefaultPushNotificationTemplate"
    ]
    """<p>The default message template that's used for push notification channels.</p>"""
    default_substitutions: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.</p>"""
    gcm: NotRequired[
        "capo_pinpoint.types.android_push_notification_template.AndroidPushNotificationTemplate"
    ]
    """<p>The message template that's used for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).</p>"""
    last_modified_date: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The date, in ISO 8601 format, when the message template was last modified.</p>"""
    recommender_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The unique identifier for the recommender model that's used by the message template.</p>"""
    tags: NotRequired["capo_pinpoint.types.map_of__string.MapOf__string"]
    """<p>A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.</p>"""
    template_description: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The custom description of the message template.</p>"""
    template_name: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The name of the message template.</p>"""
    template_type: NotRequired["capo_pinpoint.types.template_type.TemplateType"]
    """<p>The type of channel that the message template is designed for. For a push notification template, this value is PUSH.</p>"""
    version: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.</p>"""

adm instance-attribute

The message template that's used for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

apns instance-attribute

apns: NotRequired[APNSPushNotificationTemplate]

The message template that's used for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

arn instance-attribute

arn: NotRequired[__string]

The Amazon Resource Name (ARN) of the message template.

baidu instance-attribute

baidu: NotRequired[AndroidPushNotificationTemplate]

The message template that's used for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

creation_date instance-attribute

creation_date: NotRequired[__string]

The date, in ISO 8601 format, when the message template was created.

default instance-attribute

default: NotRequired[DefaultPushNotificationTemplate]

The default message template that's used for push notification channels.

default_substitutions instance-attribute

default_substitutions: NotRequired[__string]

The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

gcm instance-attribute

The message template that's used for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

last_modified_date instance-attribute

last_modified_date: NotRequired[__string]

The date, in ISO 8601 format, when the message template was last modified.

recommender_id instance-attribute

recommender_id: NotRequired[__string]

The unique identifier for the recommender model that's used by the message template.

tags instance-attribute

tags: NotRequired[MapOf__string]

A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

template_description instance-attribute

template_description: NotRequired[__string]

The custom description of the message template.

template_name instance-attribute

template_name: NotRequired[__string]

The name of the message template.

template_type instance-attribute

template_type: NotRequired[TemplateType]

The type of channel that the message template is designed for. For a push notification template, this value is PUSH.

version instance-attribute

version: NotRequired[__string]

The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.