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

Inherits:
Struct
  • Object
show all
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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

Returns:

  • (String)


18554
18555
18556
18557
18558
18559
18560
18561
18562
18563
18564
18565
18566
18567
18568
18569
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 18554

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

#bodyString

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

Returns:

  • (String)


18554
18555
18556
18557
18558
18559
18560
18561
18562
18563
18564
18565
18566
18567
18568
18569
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 18554

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_dateString

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

Returns:

  • (String)


18554
18555
18556
18557
18558
18559
18560
18561
18562
18563
18564
18565
18566
18567
18568
18569
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 18554

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


18554
18555
18556
18557
18558
18559
18560
18561
18562
18563
18564
18565
18566
18567
18568
18569
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 18554

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_codeString

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)


18554
18555
18556
18557
18558
18559
18560
18561
18562
18563
18564
18565
18566
18567
18568
18569
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 18554

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_dateString

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

Returns:

  • (String)


18554
18555
18556
18557
18558
18559
18560
18561
18562
18563
18564
18565
18566
18567
18568
18569
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 18554

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

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


18554
18555
18556
18557
18558
18559
18560
18561
18562
18563
18564
18565
18566
18567
18568
18569
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 18554

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_descriptionString

The custom description of the message template.

Returns:

  • (String)


18554
18555
18556
18557
18558
18559
18560
18561
18562
18563
18564
18565
18566
18567
18568
18569
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 18554

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_nameString

The name of the message template.

Returns:

  • (String)


18554
18555
18556
18557
18558
18559
18560
18561
18562
18563
18564
18565
18566
18567
18568
18569
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 18554

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_typeString

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

Returns:

  • (String)


18554
18555
18556
18557
18558
18559
18560
18561
18562
18563
18564
18565
18566
18567
18568
18569
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 18554

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

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


18554
18555
18556
18557
18558
18559
18560
18561
18562
18563
18564
18565
18566
18567
18568
18569
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 18554

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_idString

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)


18554
18555
18556
18557
18558
18559
18560
18561
18562
18563
18564
18565
18566
18567
18568
18569
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 18554

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