Pinpoint / Client / update_template_active_version

update_template_active_version

Pinpoint.Client.update_template_active_version(**kwargs)

Changes the status of a specific version of a message template to active.

See also: AWS API Documentation

Request Syntax

response = client.update_template_active_version(
    TemplateActiveVersionRequest={
        'Version': 'string'
    },
    TemplateName='string',
    TemplateType='string'
)

Parameters:

• TemplateActiveVersionRequest (dict) –

  [REQUIRED]

  Specifies which version of a message template to use as the active version of the template.

  • Version (string) –

    The version of the message template to use as the active version of the template. Valid values are: latest, for the most recent version of the template; or, the unique identifier for any existing version of the template. If you specify an identifier, the 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.

• 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

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

Response Structure

• (dict) –

  The request succeeded.

  • 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