Class: Aws::Pinpoint::Types::EmailTemplateResponse

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::EmailTemplateResponse

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 email channel.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

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

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

• #headers ⇒ Array<Types::MessageHeader>
• #html_part ⇒ String

  The message body, in HTML format, that's used in email 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.

• #recommender_id ⇒ String

  The unique identifier for the recommender model that's used by the message template.

• #subject ⇒ String

  The subject line, or title, that's used in email messages that are based on the message template.

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

• #text_part ⇒ String

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

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

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 4543

class EmailTemplateResponse < Struct.new(
  :arn,
  :creation_date,
  :default_substitutions,
  :html_part,
  :last_modified_date,
  :recommender_id,
  :subject,
  :headers,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :text_part,
  :version)
  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 4543

class EmailTemplateResponse < Struct.new(
  :arn,
  :creation_date,
  :default_substitutions,
  :html_part,
  :last_modified_date,
  :recommender_id,
  :subject,
  :headers,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :text_part,
  :version)
  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 4543

class EmailTemplateResponse < Struct.new(
  :arn,
  :creation_date,
  :default_substitutions,
  :html_part,
  :last_modified_date,
  :recommender_id,
  :subject,
  :headers,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :text_part,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#headers ⇒ Array<Types::MessageHeader>

Returns:

• (Array<Types::MessageHeader>)

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

class EmailTemplateResponse < Struct.new(
  :arn,
  :creation_date,
  :default_substitutions,
  :html_part,
  :last_modified_date,
  :recommender_id,
  :subject,
  :headers,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :text_part,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#html_part ⇒ String

The message body, in HTML format, that's used in email messages that are based on the message template.

Returns:

• (String)

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

class EmailTemplateResponse < Struct.new(
  :arn,
  :creation_date,
  :default_substitutions,
  :html_part,
  :last_modified_date,
  :recommender_id,
  :subject,
  :headers,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :text_part,
  :version)
  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 4543

class EmailTemplateResponse < Struct.new(
  :arn,
  :creation_date,
  :default_substitutions,
  :html_part,
  :last_modified_date,
  :recommender_id,
  :subject,
  :headers,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :text_part,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#recommender_id ⇒ String

The unique identifier for the recommender model that's used by the message template.

Returns:

• (String)

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

class EmailTemplateResponse < Struct.new(
  :arn,
  :creation_date,
  :default_substitutions,
  :html_part,
  :last_modified_date,
  :recommender_id,
  :subject,
  :headers,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :text_part,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#subject ⇒ String

The subject line, or title, that's used in email messages that are based on the message template.

Returns:

• (String)

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

class EmailTemplateResponse < Struct.new(
  :arn,
  :creation_date,
  :default_substitutions,
  :html_part,
  :last_modified_date,
  :recommender_id,
  :subject,
  :headers,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :text_part,
  :version)
  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 4543

class EmailTemplateResponse < Struct.new(
  :arn,
  :creation_date,
  :default_substitutions,
  :html_part,
  :last_modified_date,
  :recommender_id,
  :subject,
  :headers,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :text_part,
  :version)
  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 4543

class EmailTemplateResponse < Struct.new(
  :arn,
  :creation_date,
  :default_substitutions,
  :html_part,
  :last_modified_date,
  :recommender_id,
  :subject,
  :headers,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :text_part,
  :version)
  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 4543

class EmailTemplateResponse < Struct.new(
  :arn,
  :creation_date,
  :default_substitutions,
  :html_part,
  :last_modified_date,
  :recommender_id,
  :subject,
  :headers,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :text_part,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#template_type ⇒ String

The type of channel that the message template is designed for. For an email template, this value is EMAIL.

Returns:

• (String)

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

class EmailTemplateResponse < Struct.new(
  :arn,
  :creation_date,
  :default_substitutions,
  :html_part,
  :last_modified_date,
  :recommender_id,
  :subject,
  :headers,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :text_part,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#text_part ⇒ String

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

Returns:

• (String)

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

class EmailTemplateResponse < Struct.new(
  :arn,
  :creation_date,
  :default_substitutions,
  :html_part,
  :last_modified_date,
  :recommender_id,
  :subject,
  :headers,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :text_part,
  :version)
  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 4543

class EmailTemplateResponse < Struct.new(
  :arn,
  :creation_date,
  :default_substitutions,
  :html_part,
  :last_modified_date,
  :recommender_id,
  :subject,
  :headers,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :text_part,
  :version)
  SENSITIVE = []
  include Aws::Structure
end