Class: Aws::ConnectWisdomService::Types::CreateQuickResponseRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-connectwisdomservice/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[:channels]

Instance Attribute Summary collapse

Instance Attribute Details

#channelsArray<String>

The Amazon Connect channels this quick response applies to.

Returns:

  • (Array<String>)


1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
# File 'lib/aws-sdk-connectwisdomservice/types.rb', line 1021

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

#client_tokenString

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.

[1]: aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/

Returns:

  • (String)


1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
# File 'lib/aws-sdk-connectwisdomservice/types.rb', line 1021

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

#contentTypes::QuickResponseDataProvider

The content of the quick response.



1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
# File 'lib/aws-sdk-connectwisdomservice/types.rb', line 1021

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

#content_typeString

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)


1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
# File 'lib/aws-sdk-connectwisdomservice/types.rb', line 1021

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

#descriptionString

The description of the quick response.

Returns:

  • (String)


1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
# File 'lib/aws-sdk-connectwisdomservice/types.rb', line 1021

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

#grouping_configurationTypes::GroupingConfiguration

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



1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
# File 'lib/aws-sdk-connectwisdomservice/types.rb', line 1021

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

#is_activeBoolean

Whether the quick response is active.

Returns:

  • (Boolean)


1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
# File 'lib/aws-sdk-connectwisdomservice/types.rb', line 1021

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

#knowledge_base_idString

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you’re storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

  • (String)


1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
# File 'lib/aws-sdk-connectwisdomservice/types.rb', line 1021

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

#languageString

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)


1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
# File 'lib/aws-sdk-connectwisdomservice/types.rb', line 1021

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

#nameString

The name of the quick response.

Returns:

  • (String)


1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
# File 'lib/aws-sdk-connectwisdomservice/types.rb', line 1021

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

#shortcut_keyString

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

Returns:

  • (String)


1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
# File 'lib/aws-sdk-connectwisdomservice/types.rb', line 1021

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

#tagsHash<String,String>

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

Returns:

  • (Hash<String,String>)


1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
# File 'lib/aws-sdk-connectwisdomservice/types.rb', line 1021

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