Class: Aws::Pinpoint::Types::VoiceTemplateResponse

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::VoiceTemplateResponse

Defined in:

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

Overview

Provides information about 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

• #arn ⇒ String

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

• #body ⇒ String

  The text of the script that's used in messages that are based on the message template, in plain text format.

• #creation_date ⇒ String

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

• #default_substitutions ⇒ String

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

• #language_code ⇒ String

  The code for the language that's used when synthesizing the text of the script in messages that are based on the message template.

• #last_modified_date ⇒ String

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

• #tags ⇒ Hash<String,String>

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

• #template_description ⇒ String

  The custom description of the message template.

• #template_name ⇒ String

  The name of the message template.

• #template_type ⇒ String

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

• #version ⇒ 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.

• #voice_id ⇒ String

  The name of the voice that's used when delivering messages that are based on the message template.

Instance Attribute Details

#arn ⇒ String

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

Returns:

• (String)

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

class VoiceTemplateResponse < Struct.new(
  :arn,
  :body,
  :creation_date,
  :default_substitutions,
  :language_code,
  :last_modified_date,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :version,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end

#body ⇒ String

The text of the script that's used 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 13496

class VoiceTemplateResponse < Struct.new(
  :arn,
  :body,
  :creation_date,
  :default_substitutions,
  :language_code,
  :last_modified_date,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :version,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date ⇒ String

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

Returns:

• (String)

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

class VoiceTemplateResponse < Struct.new(
  :arn,
  :body,
  :creation_date,
  :default_substitutions,
  :language_code,
  :last_modified_date,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :version,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end

#default_substitutions ⇒ String

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)

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

class VoiceTemplateResponse < Struct.new(
  :arn,
  :body,
  :creation_date,
  :default_substitutions,
  :language_code,
  :last_modified_date,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :version,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end

#language_code ⇒ String

The code for the language that's used 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 13496

class VoiceTemplateResponse < Struct.new(
  :arn,
  :body,
  :creation_date,
  :default_substitutions,
  :language_code,
  :last_modified_date,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :version,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_date ⇒ String

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

Returns:

• (String)

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

class VoiceTemplateResponse < Struct.new(
  :arn,
  :body,
  :creation_date,
  :default_substitutions,
  :language_code,
  :last_modified_date,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :version,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<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>)

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

class VoiceTemplateResponse < Struct.new(
  :arn,
  :body,
  :creation_date,
  :default_substitutions,
  :language_code,
  :last_modified_date,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :version,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end

#template_description ⇒ String

The custom description of the message template.

Returns:

• (String)

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

class VoiceTemplateResponse < Struct.new(
  :arn,
  :body,
  :creation_date,
  :default_substitutions,
  :language_code,
  :last_modified_date,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :version,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end

#template_name ⇒ String

The name of the message template.

Returns:

• (String)

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

class VoiceTemplateResponse < Struct.new(
  :arn,
  :body,
  :creation_date,
  :default_substitutions,
  :language_code,
  :last_modified_date,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :version,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end

#template_type ⇒ String

The type of channel that the message template is designed for. For a voice template, this value is VOICE.

Returns:

• (String)

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

class VoiceTemplateResponse < Struct.new(
  :arn,
  :body,
  :creation_date,
  :default_substitutions,
  :language_code,
  :last_modified_date,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :version,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ 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.

Returns:

• (String)

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

class VoiceTemplateResponse < Struct.new(
  :arn,
  :body,
  :creation_date,
  :default_substitutions,
  :language_code,
  :last_modified_date,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :version,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end

#voice_id ⇒ String

The name of the voice that's used 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 13496

class VoiceTemplateResponse < Struct.new(
  :arn,
  :body,
  :creation_date,
  :default_substitutions,
  :language_code,
  :last_modified_date,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :version,
  :voice_id)
  SENSITIVE = []
  include Aws::Structure
end