Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

list_template_versions

list_template_versions(**kwargs)

Retrieves information about all the versions of a specific message template.

See also: AWS API Documentation

Request Syntax

response = client.list_template_versions(
    NextToken='string',
    PageSize='string',
    TemplateName='string',
    TemplateType='string'
)
Parameters
  • NextToken (string) -- The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
  • PageSize (string) -- The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
  • 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.

  • TemplateType (string) --

    [REQUIRED]

    The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.

Return type

dict

Returns

Response Syntax

{
    'TemplateVersionsResponse': {
        'Item': [
            {
                'CreationDate': 'string',
                'DefaultSubstitutions': 'string',
                'LastModifiedDate': 'string',
                'TemplateDescription': 'string',
                'TemplateName': 'string',
                'TemplateType': 'string',
                'Version': 'string'
            },
        ],
        'Message': 'string',
        'NextToken': 'string',
        'RequestID': 'string'
    }
}

Response Structure

  • (dict) --

    The request succeeded.

    • TemplateVersionsResponse (dict) --

      Provides information about all the versions of a specific message template.

      • Item (list) --

        An array of responses, one for each version of the message template.

        • (dict) --

          Provides information about a specific version of a message template.

          • CreationDate (string) --

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

          • DefaultSubstitutions (string) --

            A JSON object that specifies the default values that are used for message variables in the version of 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.

          • LastModifiedDate (string) --

            The date, in ISO 8601 format, when the version of the message template was last modified.

          • TemplateDescription (string) --

            The custom description of the version of the message template.

          • TemplateName (string) --

            The name of the message template.

          • TemplateType (string) --

            The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.

          • Version (string) --

            The unique identifier for the version of the message template. This value is an integer that Amazon Pinpoint automatically increments and assigns to each new version of a template.

      • Message (string) --

        The message that's returned from the API for the request to retrieve information about all the versions of the message template.

      • NextToken (string) --

        The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

      • RequestID (string) --

        The unique identifier for the request to retrieve information about all the versions of the message template.

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