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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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)


15879
15880
15881
15882
15883
15884
15885
15886
15887
15888
15889
15890
15891
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 15879

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_dateString

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

Returns:

  • (String)


15879
15880
15881
15882
15883
15884
15885
15886
15887
15888
15889
15890
15891
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 15879

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_substitutionsString

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)


15879
15880
15881
15882
15883
15884
15885
15886
15887
15888
15889
15890
15891
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 15879

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_dateString

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

Returns:

  • (String)


15879
15880
15881
15882
15883
15884
15885
15886
15887
15888
15889
15890
15891
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 15879

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

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


15879
15880
15881
15882
15883
15884
15885
15886
15887
15888
15889
15890
15891
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 15879

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_descriptionString

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)


15879
15880
15881
15882
15883
15884
15885
15886
15887
15888
15889
15890
15891
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 15879

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_nameString

The name of the message template.

Returns:

  • (String)


15879
15880
15881
15882
15883
15884
15885
15886
15887
15888
15889
15890
15891
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 15879

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_typeString

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

Returns:

  • (String)


15879
15880
15881
15882
15883
15884
15885
15886
15887
15888
15889
15890
15891
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 15879

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

#versionString

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

Returns:

  • (String)


15879
15880
15881
15882
15883
15884
15885
15886
15887
15888
15889
15890
15891
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 15879

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