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

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

Returns:

  • (String)


6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6454

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

#creation_dateString

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

Returns:

  • (String)


6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6454

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


6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6454

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

#html_partString

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

Returns:

  • (String)


6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6454

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

#last_modified_dateString

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

Returns:

  • (String)


6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6454

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

#recommender_idString

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

Returns:

  • (String)


6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6454

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

#subjectString

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

Returns:

  • (String)


6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6454

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


6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6454

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

#template_descriptionString

The custom description of the message template.

Returns:

  • (String)


6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6454

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

#template_nameString

The name of the message template.

Returns:

  • (String)


6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6454

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

#template_typeString

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

Returns:

  • (String)


6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6454

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

#text_partString

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

Returns:

  • (String)


6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6454

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


6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6454

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