Skip to content

Template

Source code in docs_src/capo_pinpoint/types/template.py 
11
12
13
14
15
class Template(TypedDict, closed=True):
    name: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The name of the message template to use for the message. If specified, this value must match the name of an existing message template.</p>"""
    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>"""

name instance-attribute 

name: NotRequired[__string]

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

version instance-attribute 

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.