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

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

Overview

Note:

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

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

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

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#bodyString

The text of the script to use in messages that are based on the message template, in plain text format.

Returns:

  • (String)

    The text of the script to use in messages that are based on the message template, in plain text format.

#default_substitutionsString

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.

#language_codeString

The code for the language to use when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

Returns:

  • (String)

    The code for the language to use when synthesizing the text of the script in messages that are based on the message template.

#tagsHash<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_descriptionString

A custom description of the message template.

Returns:

  • (String)

    A custom description of the message template.

#voice_idString

The name of the voice to use when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.

Returns:

  • (String)

    The name of the voice to use when delivering messages that are based on the message template.