Class: Aws::Pinpoint::Types::VoiceTemplateRequest

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::VoiceTemplateRequest

Defined in:

gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Note:

When making an API call, you may pass VoiceTemplateRequest data as a 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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #body ⇒ String

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

• #default_substitutions ⇒ String

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

• #language_code ⇒ String

  The code for the language to use when synthesizing the text of the script in messages that are based on 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.

• #template_description ⇒ String

  A custom description of the message template.

• #voice_id ⇒ String

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

Instance Attribute Details

#body ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20308

class VoiceTemplateRequest < Struct.new(
  :body,
  :default_substitutions,
  :language_code,
  :tags,
  :template_description,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20308

class VoiceTemplateRequest < Struct.new(
  :body,
  :default_substitutions,
  :language_code,
  :tags,
  :template_description,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end

#language_code ⇒ String

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)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20308

class VoiceTemplateRequest < Struct.new(
  :body,
  :default_substitutions,
  :language_code,
  :tags,
  :template_description,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end

#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>)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20308

class VoiceTemplateRequest < Struct.new(
  :body,
  :default_substitutions,
  :language_code,
  :tags,
  :template_description,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end

#template_description ⇒ String

A custom description of the message template.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20308

class VoiceTemplateRequest < Struct.new(
  :body,
  :default_substitutions,
  :language_code,
  :tags,
  :template_description,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end

#voice_id ⇒ String

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)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20308

class VoiceTemplateRequest < Struct.new(
  :body,
  :default_substitutions,
  :language_code,
  :tags,
  :template_description,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end