Class: Aws::QConnect::Types::CreateQuickResponseRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[:channels]

Instance Attribute Summary collapse

Instance Attribute Details

#channels ⇒ Array<String>

The Connect Customer channels this quick response applies to.

Returns:

  • (Array<String>)


3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3457

class CreateQuickResponseRequest < Struct.new(
  :knowledge_base_id,
  :name,
  :content,
  :content_type,
  :grouping_configuration,
  :description,
  :shortcut_key,
  :is_active,
  :channels,
  :language,
  :client_token,
  :tags)
  SENSITIVE = [:channels]
  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)


3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3457

class CreateQuickResponseRequest < Struct.new(
  :knowledge_base_id,
  :name,
  :content,
  :content_type,
  :grouping_configuration,
  :description,
  :shortcut_key,
  :is_active,
  :channels,
  :language,
  :client_token,
  :tags)
  SENSITIVE = [:channels]
  include Aws::Structure
end

#content ⇒ Types::QuickResponseDataProvider

The content of the quick response.



3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3457

class CreateQuickResponseRequest < Struct.new(
  :knowledge_base_id,
  :name,
  :content,
  :content_type,
  :grouping_configuration,
  :description,
  :shortcut_key,
  :is_active,
  :channels,
  :language,
  :client_token,
  :tags)
  SENSITIVE = [:channels]
  include Aws::Structure
end

#content_type ⇒ String

The media type of the quick response content.

  • Use application/x.quickresponse;format=plain for a quick response written in plain text.

  • Use application/x.quickresponse;format=markdown for a quick response written in richtext.

Returns:

  • (String)


3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3457

class CreateQuickResponseRequest < Struct.new(
  :knowledge_base_id,
  :name,
  :content,
  :content_type,
  :grouping_configuration,
  :description,
  :shortcut_key,
  :is_active,
  :channels,
  :language,
  :client_token,
  :tags)
  SENSITIVE = [:channels]
  include Aws::Structure
end

#description ⇒ String

The description of the quick response.

Returns:

  • (String)


3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3457

class CreateQuickResponseRequest < Struct.new(
  :knowledge_base_id,
  :name,
  :content,
  :content_type,
  :grouping_configuration,
  :description,
  :shortcut_key,
  :is_active,
  :channels,
  :language,
  :client_token,
  :tags)
  SENSITIVE = [:channels]
  include Aws::Structure
end

#grouping_configuration ⇒ Types::GroupingConfiguration

The configuration information of the user groups that the quick response is accessible to.



3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3457

class CreateQuickResponseRequest < Struct.new(
  :knowledge_base_id,
  :name,
  :content,
  :content_type,
  :grouping_configuration,
  :description,
  :shortcut_key,
  :is_active,
  :channels,
  :language,
  :client_token,
  :tags)
  SENSITIVE = [:channels]
  include Aws::Structure
end

#is_active ⇒ Boolean

Whether the quick response is active.

Returns:

  • (Boolean)


3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3457

class CreateQuickResponseRequest < Struct.new(
  :knowledge_base_id,
  :name,
  :content,
  :content_type,
  :grouping_configuration,
  :description,
  :shortcut_key,
  :is_active,
  :channels,
  :language,
  :client_token,
  :tags)
  SENSITIVE = [:channels]
  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)


3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3457

class CreateQuickResponseRequest < Struct.new(
  :knowledge_base_id,
  :name,
  :content,
  :content_type,
  :grouping_configuration,
  :description,
  :shortcut_key,
  :is_active,
  :channels,
  :language,
  :client_token,
  :tags)
  SENSITIVE = [:channels]
  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)


3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3457

class CreateQuickResponseRequest < Struct.new(
  :knowledge_base_id,
  :name,
  :content,
  :content_type,
  :grouping_configuration,
  :description,
  :shortcut_key,
  :is_active,
  :channels,
  :language,
  :client_token,
  :tags)
  SENSITIVE = [:channels]
  include Aws::Structure
end

#name ⇒ String

The name of the quick response.

Returns:

  • (String)


3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3457

class CreateQuickResponseRequest < Struct.new(
  :knowledge_base_id,
  :name,
  :content,
  :content_type,
  :grouping_configuration,
  :description,
  :shortcut_key,
  :is_active,
  :channels,
  :language,
  :client_token,
  :tags)
  SENSITIVE = [:channels]
  include Aws::Structure
end

#shortcut_key ⇒ String

The shortcut key of the quick response. The value should be unique across the knowledge base.

Returns:

  • (String)


3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3457

class CreateQuickResponseRequest < Struct.new(
  :knowledge_base_id,
  :name,
  :content,
  :content_type,
  :grouping_configuration,
  :description,
  :shortcut_key,
  :is_active,
  :channels,
  :language,
  :client_token,
  :tags)
  SENSITIVE = [:channels]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>)


3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3457

class CreateQuickResponseRequest < Struct.new(
  :knowledge_base_id,
  :name,
  :content,
  :content_type,
  :grouping_configuration,
  :description,
  :shortcut_key,
  :is_active,
  :channels,
  :language,
  :client_token,
  :tags)
  SENSITIVE = [:channels]
  include Aws::Structure
end