update_sms_template

Pinpoint.Client.update_sms_template(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.update_sms_template(
    CreateNewVersion=True|False,
    SMSTemplateRequest={
        'Body': 'string',
        'DefaultSubstitutions': 'string',
        'RecommenderId': 'string',
        'tags': {
            'string': 'string'
        },
        'TemplateDescription': '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.

• SMSTemplateRequest (dict) --

  [REQUIRED]

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

  • Body (string) --

    The message body to use in text messages that are based on the message template.

  • 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.

  • 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.

  • tags (dict) --

    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.

• 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 Versionsresource.

  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