Pinpoint / Client / update_email_template

update_email_template#

Pinpoint.Client.update_email_template(**kwargs)#

Updates an existing message template for messages that are sent through the email channel.

Request Syntax

response = client.update_email_template(
    CreateNewVersion=True|False,
    EmailTemplateRequest={
        'DefaultSubstitutions': 'string',
        'HtmlPart': 'string',
        'RecommenderId': 'string',
        'Subject': 'string',
        'Headers': [
            {
                'Name': 'string',
                'Value': 'string'
            },
        ],
        'tags': {
            'string': 'string'
        },
        'TemplateDescription': 'string',
        'TextPart': 'string'
    },
    TemplateName='string',
    Version='string'
)

Parameters:

CreateNewVersion (boolean) –
Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

If you don’t specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don’t specify a value for the version parameter. Otherwise, an error will occur.
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.
Version (string) –
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don’t occur.

If you don’t specify a value for this parameter, Amazon Pinpoint does the following:
- For a get operation, retrieves information about the active version of the template.
- For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn’t used or is set to false.
- For a delete operation, deletes the template, including all versions of the template.

Return type:

dict

Returns:

Response Syntax

{
    'MessageBody': {
        'Message': 'string',
        'RequestID': 'string'
    }
}

Response Structure

(dict) –

The request was accepted for processing. Processing may not be complete.
- MessageBody (dict) –
  
  Provides information about an API request or response.
  - Message (string) –
    
    The message that’s returned from the API.
  - RequestID (string) –
    
    The unique identifier for the request or response.

Exceptions

Pinpoint.Client.exceptions.BadRequestException
Pinpoint.Client.exceptions.InternalServerErrorException
Pinpoint.Client.exceptions.PayloadTooLargeException
Pinpoint.Client.exceptions.ForbiddenException
Pinpoint.Client.exceptions.NotFoundException
Pinpoint.Client.exceptions.MethodNotAllowedException
Pinpoint.Client.exceptions.TooManyRequestsException