Class: Aws::QConnect::Types::ExtendedMessageTemplateData

Inherits:

Struct

• Object
• Struct
• Aws::QConnect::Types::ExtendedMessageTemplateData

Defined in:

gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb

Overview

The extended data of a message template.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #attachments ⇒ Array<Types::MessageTemplateAttachment>

  The message template attachments.

• #attribute_types ⇒ Array<String>

  The types of attributes contain the message template.

• #channel_subtype ⇒ String

  The channel subtype this message template applies to.

• #content ⇒ Types::MessageTemplateContentProvider

  The content of the message template.

• #created_time ⇒ Time

  The timestamp when the message template was created.

• #default_attributes ⇒ Types::MessageTemplateAttributes

  An object that specifies the default values to use for variables in the message template.

• #description ⇒ String

  The description of the message template.

• #grouping_configuration ⇒ Types::GroupingConfiguration

  The configuration information of the grouping of Amazon Q in Connect users.

• #is_active ⇒ Boolean

  Whether the version of the message template is activated.

• #knowledge_base_arn ⇒ String

  The Amazon Resource Name (ARN) of the knowledge base.

• #knowledge_base_id ⇒ String

  The identifier of the knowledge base.

• #language ⇒ String

  The language code value for the language in which the quick response is written.

• #last_modified_by ⇒ String

  The Amazon Resource Name (ARN) of the user who last updated the message template data.

• #last_modified_time ⇒ Time

  The timestamp when the message template data was last modified.

• #message_template_arn ⇒ String

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

• #message_template_content_sha_256 ⇒ String

  The checksum value of the message template content that is referenced by the $LATEST qualifier.

• #message_template_id ⇒ String

  The identifier of the message template.

• #name ⇒ String

  The name of the message template.

• #tags ⇒ Hash<String,String>

  The tags used to organize, track, or control access for this resource.

• #version_number ⇒ Integer

  The version number of the message template version.

Instance Attribute Details

#attachments ⇒ Array<Types::MessageTemplateAttachment>

The message template attachments.

Returns:

• (Array<Types::MessageTemplateAttachment>)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 4040

class ExtendedMessageTemplateData < Struct.new(
  :attachments,
  :attribute_types,
  :channel_subtype,
  :content,
  :created_time,
  :default_attributes,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :message_template_arn,
  :message_template_content_sha_256,
  :message_template_id,
  :name,
  :tags,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#attribute_types ⇒ Array<String>

The types of attributes contain the message template.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 4040

class ExtendedMessageTemplateData < Struct.new(
  :attachments,
  :attribute_types,
  :channel_subtype,
  :content,
  :created_time,
  :default_attributes,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :message_template_arn,
  :message_template_content_sha_256,
  :message_template_id,
  :name,
  :tags,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#channel_subtype ⇒ String

The channel subtype this message template applies to.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 4040

class ExtendedMessageTemplateData < Struct.new(
  :attachments,
  :attribute_types,
  :channel_subtype,
  :content,
  :created_time,
  :default_attributes,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :message_template_arn,
  :message_template_content_sha_256,
  :message_template_id,
  :name,
  :tags,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#content ⇒ Types::MessageTemplateContentProvider

The content of the message template.

Returns:

• (Types::MessageTemplateContentProvider)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 4040

class ExtendedMessageTemplateData < Struct.new(
  :attachments,
  :attribute_types,
  :channel_subtype,
  :content,
  :created_time,
  :default_attributes,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :message_template_arn,
  :message_template_content_sha_256,
  :message_template_id,
  :name,
  :tags,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#created_time ⇒ Time

The timestamp when the message template was created.

Returns:

• (Time)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 4040

class ExtendedMessageTemplateData < Struct.new(
  :attachments,
  :attribute_types,
  :channel_subtype,
  :content,
  :created_time,
  :default_attributes,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :message_template_arn,
  :message_template_content_sha_256,
  :message_template_id,
  :name,
  :tags,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#default_attributes ⇒ Types::MessageTemplateAttributes

An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.

Returns:

• (Types::MessageTemplateAttributes)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 4040

class ExtendedMessageTemplateData < Struct.new(
  :attachments,
  :attribute_types,
  :channel_subtype,
  :content,
  :created_time,
  :default_attributes,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :message_template_arn,
  :message_template_content_sha_256,
  :message_template_id,
  :name,
  :tags,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the message template.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 4040

class ExtendedMessageTemplateData < Struct.new(
  :attachments,
  :attribute_types,
  :channel_subtype,
  :content,
  :created_time,
  :default_attributes,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :message_template_arn,
  :message_template_content_sha_256,
  :message_template_id,
  :name,
  :tags,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#grouping_configuration ⇒ Types::GroupingConfiguration

The configuration information of the grouping of Amazon Q in Connect users.

Returns:

• (Types::GroupingConfiguration)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 4040

class ExtendedMessageTemplateData < Struct.new(
  :attachments,
  :attribute_types,
  :channel_subtype,
  :content,
  :created_time,
  :default_attributes,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :message_template_arn,
  :message_template_content_sha_256,
  :message_template_id,
  :name,
  :tags,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#is_active ⇒ Boolean

Whether the version of the message template is activated.

Returns:

• (Boolean)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 4040

class ExtendedMessageTemplateData < Struct.new(
  :attachments,
  :attribute_types,
  :channel_subtype,
  :content,
  :created_time,
  :default_attributes,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :message_template_arn,
  :message_template_content_sha_256,
  :message_template_id,
  :name,
  :tags,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#knowledge_base_arn ⇒ String

The Amazon Resource Name (ARN) of the knowledge base.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 4040

class ExtendedMessageTemplateData < Struct.new(
  :attachments,
  :attribute_types,
  :channel_subtype,
  :content,
  :created_time,
  :default_attributes,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :message_template_arn,
  :message_template_content_sha_256,
  :message_template_id,
  :name,
  :tags,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#knowledge_base_id ⇒ String

The identifier of the knowledge base.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 4040

class ExtendedMessageTemplateData < Struct.new(
  :attachments,
  :attribute_types,
  :channel_subtype,
  :content,
  :created_time,
  :default_attributes,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :message_template_arn,
  :message_template_content_sha_256,
  :message_template_id,
  :name,
  :tags,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#language ⇒ String

The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 4040

class ExtendedMessageTemplateData < Struct.new(
  :attachments,
  :attribute_types,
  :channel_subtype,
  :content,
  :created_time,
  :default_attributes,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :message_template_arn,
  :message_template_content_sha_256,
  :message_template_id,
  :name,
  :tags,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_by ⇒ String

The Amazon Resource Name (ARN) of the user who last updated the message template data.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 4040

class ExtendedMessageTemplateData < Struct.new(
  :attachments,
  :attribute_types,
  :channel_subtype,
  :content,
  :created_time,
  :default_attributes,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :message_template_arn,
  :message_template_content_sha_256,
  :message_template_id,
  :name,
  :tags,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_time ⇒ Time

The timestamp when the message template data was last modified.

Returns:

• (Time)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 4040

class ExtendedMessageTemplateData < Struct.new(
  :attachments,
  :attribute_types,
  :channel_subtype,
  :content,
  :created_time,
  :default_attributes,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :message_template_arn,
  :message_template_content_sha_256,
  :message_template_id,
  :name,
  :tags,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#message_template_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 4040

class ExtendedMessageTemplateData < Struct.new(
  :attachments,
  :attribute_types,
  :channel_subtype,
  :content,
  :created_time,
  :default_attributes,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :message_template_arn,
  :message_template_content_sha_256,
  :message_template_id,
  :name,
  :tags,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#message_template_content_sha_256 ⇒ String

The checksum value of the message template content that is referenced by the $LATEST qualifier. It can be returned in MessageTemplateData or ExtendedMessageTemplateData. It’s calculated by content, language, defaultAttributes and Attachments of the message template.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 4040

class ExtendedMessageTemplateData < Struct.new(
  :attachments,
  :attribute_types,
  :channel_subtype,
  :content,
  :created_time,
  :default_attributes,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :message_template_arn,
  :message_template_content_sha_256,
  :message_template_id,
  :name,
  :tags,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#message_template_id ⇒ String

The identifier of the message template.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 4040

class ExtendedMessageTemplateData < Struct.new(
  :attachments,
  :attribute_types,
  :channel_subtype,
  :content,
  :created_time,
  :default_attributes,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :message_template_arn,
  :message_template_content_sha_256,
  :message_template_id,
  :name,
  :tags,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the message template.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 4040

class ExtendedMessageTemplateData < Struct.new(
  :attachments,
  :attribute_types,
  :channel_subtype,
  :content,
  :created_time,
  :default_attributes,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :message_template_arn,
  :message_template_content_sha_256,
  :message_template_id,
  :name,
  :tags,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags used to organize, track, or control access for this resource.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 4040

class ExtendedMessageTemplateData < Struct.new(
  :attachments,
  :attribute_types,
  :channel_subtype,
  :content,
  :created_time,
  :default_attributes,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :message_template_arn,
  :message_template_content_sha_256,
  :message_template_id,
  :name,
  :tags,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end

#version_number ⇒ Integer

The version number of the message template version.

Returns:

• (Integer)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 4040

class ExtendedMessageTemplateData < Struct.new(
  :attachments,
  :attribute_types,
  :channel_subtype,
  :content,
  :created_time,
  :default_attributes,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :message_template_arn,
  :message_template_content_sha_256,
  :message_template_id,
  :name,
  :tags,
  :version_number)
  SENSITIVE = []
  include Aws::Structure
end