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::TemplateResponse

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

Overview

Provides information about a message template that's associated with your Amazon Pinpoint account.

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the message template. This value isn\'t included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the message template.

#creation_dateString

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

Returns:

  • (String)

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

#default_substitutionsString

The JSON object that specifies the default values that are used for message variables in the message template. This object isn\'t included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.

Returns:

  • (String)

    The JSON object that specifies the default values that are used for message variables in the message template.

#last_modified_dateString

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

Returns:

  • (String)

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

#tagsHash<String,String>

A map of key-value pairs that identifies the tags that are associated with the message template. This object isn\'t included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.

Returns:

  • (Hash<String,String>)

    A map of key-value pairs that identifies the tags that are associated with the message template.

#template_descriptionString

The custom description of the message template. This value isn\'t included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.

Returns:

  • (String)

    The custom description of the message template.

#template_nameString

The name of the message template.

Returns:

  • (String)

    The name of the message template.

#template_typeString

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

Possible values:

  • EMAIL
  • SMS
  • VOICE
  • PUSH

Returns:

  • (String)

    The type of channel that the message template is designed for.

#versionString

The unique identifier, as an integer, for the active version of the message template.

Returns:

  • (String)

    The unique identifier, as an integer, for the active version of the message template.