Skip to content

EmailTemplateResponse

Source code in docs_src/capo_pinpoint/types/email_template_response.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
class EmailTemplateResponse(TypedDict, closed=True):
    arn: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The Amazon Resource Name (ARN) of the message template.</p>"""
    creation_date: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The date, in ISO 8601 format, when the message template was created.</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>"""
    html_part: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The message body, in HTML format, that's used in email messages that are based on the message template.</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>"""
    subject: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The subject line, or title, that's used in email messages that are based on the message template.</p>"""
    headers: NotRequired[
        "capo_pinpoint.types.list_of_message_header.ListOfMessageHeader"
    ]
    """<p>The list of <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/templates-template-name-email.html#templates-template-name-email-model-messageheader">MessageHeaders</a> for the email. You can have up to 15 Headers.</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 an email template, this value is EMAIL.</p>"""
    text_part: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The message body, in plain text format, that's used in email messages that are based on the message template.</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>"""

arn instance-attribute 

arn: NotRequired[__string]

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

creation_date instance-attribute 

creation_date: NotRequired[__string]

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

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.

headers instance-attribute 

headers: NotRequired[ListOfMessageHeader]

The list of MessageHeaders for the email. You can have up to 15 Headers.

html_part instance-attribute 

html_part: NotRequired[__string]

The message body, in HTML format, that's used in email messages that are based on the message template.

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.

subject instance-attribute 

subject: NotRequired[__string]

The subject line, or title, that's used in email messages that are based on 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 an email template, this value is EMAIL.

text_part instance-attribute 

text_part: NotRequired[__string]

The message body, in plain text format, that's used in email messages that are based on the message template.

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.