Class: Aws::Pinpoint::Types::TemplateResponse

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::TemplateResponse

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

Provides information about a message template that’s associated with your Amazon Pinpoint account.

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.

• #last_modified_date ⇒ String

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

• #tags ⇒ Hash<String,String>

  A 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.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the message template. This value isn’t included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.

Returns:

• (String)

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

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

#creation_date ⇒ String

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

Returns:

• (String)

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

class TemplateResponse < Struct.new(
  :arn,
  :creation_date,
  :default_substitutions,
  :last_modified_date,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :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 isn’t included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.

Returns:

• (String)

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

class TemplateResponse < Struct.new(
  :arn,
  :creation_date,
  :default_substitutions,
  :last_modified_date,
  :tags,
  :template_description,
  :template_name,
  :template_type,
  :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 'lib/aws-sdk-pinpoint/types.rb', line 12055

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

#tags ⇒ Hash<String,String>

A map of key-value pairs that identifies the tags that are associated with the message template. This object isn’t included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.

Returns:

• (Hash<String,String>)

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

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

#template_description ⇒ String

The custom description of the message template. This value isn’t included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.

Returns:

• (String)

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

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

#template_name ⇒ String

The name of the message template.

Returns:

• (String)

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

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

#template_type ⇒ String

The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, INAPP, and VOICE.

Returns:

• (String)

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

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

#version ⇒ String

The unique identifier, as an integer, for the active version of the message template.

Returns:

• (String)

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

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