Pinpoint / Client / create_email_template

create_email_template

Pinpoint.Client.create_email_template(**kwargs)

Creates a message template for messages that are sent through the email channel.

See also: AWS API Documentation

Request Syntax

response = client.create_email_template(
    EmailTemplateRequest={
        'DefaultSubstitutions': 'string',
        'HtmlPart': 'string',
        'RecommenderId': 'string',
        'Subject': 'string',
        'Headers': [
            {
                'Name': 'string',
                'Value': 'string'
            },
        ],
        'tags': {
            'string': 'string'
        },
        'TemplateDescription': 'string',
        'TextPart': 'string'
    },
    TemplateName='string'
)

Parameters:

• EmailTemplateRequest (dict) –

  [REQUIRED]

  Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.

  • DefaultSubstitutions (string) –

    A JSON object that specifies the default values to use 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. When you create a message that’s based on the template, you can override these defaults with message-specific and address-specific variables and values.

  • HtmlPart (string) –

    The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.

  • RecommenderId (string) –

    The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

  • Subject (string) –

    The subject line, or title, to use in email messages that are based on the message template.

  • Headers (list) –

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

    • (dict) –

      Contains the name and value pair of an email header to add to your email. You can have up to 15 MessageHeaders. A header can contain information such as the sender, receiver, route, or timestamp.

      • Name (string) –

        The name of the message header. The header name can contain up to 126 characters.

      • Value (string) –

        The value of the message header. The header value can contain up to 870 characters, including the length of any rendered attributes. For example if you add the {CreationDate} attribute, it renders as YYYY-MM-DDTHH:MM:SS.SSSZ and is 24 characters in length.

  • tags (dict) –

    Note

    As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.

    (Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

    • (string) –

      • (string) –

  • TemplateDescription (string) –

    A custom description of the message template.

  • TextPart (string) –

    The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don’t render HTML content and clients that are connected to high-latency networks, such as mobile devices.

• TemplateName (string) –

  [REQUIRED]

  The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Return type:

dict

Returns:

Response Syntax

{
    'CreateTemplateMessageBody': {
        'Arn': 'string',
        'Message': 'string',
        'RequestID': 'string'
    }
}

Response Structure

• (dict) –

  The request succeeded and the specified resource was created.

  • CreateTemplateMessageBody (dict) –

    Provides information about a request to create a message template.

    • Arn (string) –

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

    • Message (string) –

      The message that’s returned from the API for the request to create the message template.

    • RequestID (string) –

      The unique identifier for the request to create the message template.

Exceptions

• Pinpoint.Client.exceptions.MethodNotAllowedException

• Pinpoint.Client.exceptions.TooManyRequestsException

• Pinpoint.Client.exceptions.BadRequestException

• Pinpoint.Client.exceptions.InternalServerErrorException

• Pinpoint.Client.exceptions.ForbiddenException