AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Pinpoint::Types::Template

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing Template as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "__string",
  version: "__string",
}

Specifies the name and version of the message template to use for the message.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#nameString

The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

Returns:

  • (String)

    The name of the message template to use for the message.

#versionString

The unique identifier for the version of the message template to use for the message. If specified, this 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.

If you don\'t specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that\'s been most recently reviewed and approved for use, depending on your workflow. It isn\'t necessarily the latest version of a template.

Returns:

  • (String)

    The unique identifier for the version of the message template to use for the message.