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

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

Overview

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

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

Returns:

  • (String)

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

#bodyString

The message body that\'s used in text messages that are based on the message template.

Returns:

  • (String)

    The message body that\'s used in text messages that are based on 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 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.

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.

#recommender_idString

The unique identifier for the recommender model that\'s used by the message template.

Returns:

  • (String)

    The unique identifier for the recommender model that\'s used by the message template.

#tagsHash<String,String>

A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

Returns:

  • (Hash<String,String>)

    A string-to-string 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.

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. For an SMS template, this value is SMS.

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, or the version of the template that you specified by using the version parameter in your request.

Returns:

  • (String)

    The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.