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

Class: Aws::Pinpoint::Types::SMSTemplateRequest

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

Overview

Note:

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

{
  body: "__string",
  default_substitutions: "__string",
  recommender_id: "__string",
  tags: {
    "__string" => "__string",
  },
  template_description: "__string",
}

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

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#body ⇒ String

The message body to use in text messages that are based on the message template.

Returns:

  • (String) —

    The message body to use in text messages that are based on the message template.

#default_substitutions ⇒ String

A JSON object that specifies the default values to use 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. When you create a message that\'s based on the template, you can override these defaults with message-specific and address-specific variables and values.

Returns:

  • (String) —

    A JSON object that specifies the default values to use for message variables in the message template.

#recommender_id ⇒ String

The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

Returns:

  • (String) —

    The unique identifier for the recommender model to use for the message template.

#tags ⇒ Hash<String,String>

A string-to-string map of key-value pairs that defines the tags to associate 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 defines the tags to associate with the message template.

#template_description ⇒ String

A custom description of the message template.

Returns:

  • (String) —

    A custom description of the message template.