Class: Aws::QConnect::Types::CreateMessageTemplateRequest

Inherits:

Struct

• Object
• Struct
• Aws::QConnect::Types::CreateMessageTemplateRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #channel_subtype ⇒ String

  The channel subtype this message template applies to.

• #client_token ⇒ String

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #content ⇒ Types::MessageTemplateContentProvider

  The content of the message template.

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

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

• #name ⇒ String

  The name of the message template.

• #tags ⇒ Hash<String,String>

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

Instance Attribute Details

#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 2891

class CreateMessageTemplateRequest < Struct.new(
  :knowledge_base_id,
  :name,
  :content,
  :description,
  :channel_subtype,
  :language,
  :default_attributes,
  :grouping_configuration,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

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

class CreateMessageTemplateRequest < Struct.new(
  :knowledge_base_id,
  :name,
  :content,
  :description,
  :channel_subtype,
  :language,
  :default_attributes,
  :grouping_configuration,
  :client_token,
  :tags)
  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 2891

class CreateMessageTemplateRequest < Struct.new(
  :knowledge_base_id,
  :name,
  :content,
  :description,
  :channel_subtype,
  :language,
  :default_attributes,
  :grouping_configuration,
  :client_token,
  :tags)
  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 2891

class CreateMessageTemplateRequest < Struct.new(
  :knowledge_base_id,
  :name,
  :content,
  :description,
  :channel_subtype,
  :language,
  :default_attributes,
  :grouping_configuration,
  :client_token,
  :tags)
  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 2891

class CreateMessageTemplateRequest < Struct.new(
  :knowledge_base_id,
  :name,
  :content,
  :description,
  :channel_subtype,
  :language,
  :default_attributes,
  :grouping_configuration,
  :client_token,
  :tags)
  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 2891

class CreateMessageTemplateRequest < Struct.new(
  :knowledge_base_id,
  :name,
  :content,
  :description,
  :channel_subtype,
  :language,
  :default_attributes,
  :grouping_configuration,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#knowledge_base_id ⇒ String

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

• (String)

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

class CreateMessageTemplateRequest < Struct.new(
  :knowledge_base_id,
  :name,
  :content,
  :description,
  :channel_subtype,
  :language,
  :default_attributes,
  :grouping_configuration,
  :client_token,
  :tags)
  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 2891

class CreateMessageTemplateRequest < Struct.new(
  :knowledge_base_id,
  :name,
  :content,
  :description,
  :channel_subtype,
  :language,
  :default_attributes,
  :grouping_configuration,
  :client_token,
  :tags)
  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 2891

class CreateMessageTemplateRequest < Struct.new(
  :knowledge_base_id,
  :name,
  :content,
  :description,
  :channel_subtype,
  :language,
  :default_attributes,
  :grouping_configuration,
  :client_token,
  :tags)
  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 2891

class CreateMessageTemplateRequest < Struct.new(
  :knowledge_base_id,
  :name,
  :content,
  :description,
  :channel_subtype,
  :language,
  :default_attributes,
  :grouping_configuration,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end