Class: Aws::QConnect::Types::QuickResponseSearchResultData

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

Overview

The result of quick response search.

Constant Summary collapse

SENSITIVE =
[:attributes_interpolated, :attributes_not_interpolated]

Instance Attribute Summary collapse

Instance Attribute Details

#attributes_interpolatedArray<String>

The user defined contact attributes that are resolved when the search result is returned.

Returns:

  • (Array<String>)


3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3204

class QuickResponseSearchResultData < Struct.new(
  :attributes_interpolated,
  :attributes_not_interpolated,
  :channels,
  :content_type,
  :contents,
  :created_time,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :name,
  :quick_response_arn,
  :quick_response_id,
  :shortcut_key,
  :status,
  :tags)
  SENSITIVE = [:attributes_interpolated, :attributes_not_interpolated]
  include Aws::Structure
end

#attributes_not_interpolatedArray<String>

The user defined contact attributes that are not resolved when the search result is returned.

Returns:

  • (Array<String>)


3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3204

class QuickResponseSearchResultData < Struct.new(
  :attributes_interpolated,
  :attributes_not_interpolated,
  :channels,
  :content_type,
  :contents,
  :created_time,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :name,
  :quick_response_arn,
  :quick_response_id,
  :shortcut_key,
  :status,
  :tags)
  SENSITIVE = [:attributes_interpolated, :attributes_not_interpolated]
  include Aws::Structure
end

#channelsArray<String>

The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.

Returns:

  • (Array<String>)


3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3204

class QuickResponseSearchResultData < Struct.new(
  :attributes_interpolated,
  :attributes_not_interpolated,
  :channels,
  :content_type,
  :contents,
  :created_time,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :name,
  :quick_response_arn,
  :quick_response_id,
  :shortcut_key,
  :status,
  :tags)
  SENSITIVE = [:attributes_interpolated, :attributes_not_interpolated]
  include Aws::Structure
end

#content_typeString

The media type of the quick response content.

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

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

Returns:

  • (String)


3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3204

class QuickResponseSearchResultData < Struct.new(
  :attributes_interpolated,
  :attributes_not_interpolated,
  :channels,
  :content_type,
  :contents,
  :created_time,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :name,
  :quick_response_arn,
  :quick_response_id,
  :shortcut_key,
  :status,
  :tags)
  SENSITIVE = [:attributes_interpolated, :attributes_not_interpolated]
  include Aws::Structure
end

#contentsTypes::QuickResponseContents

The contents of the quick response.



3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3204

class QuickResponseSearchResultData < Struct.new(
  :attributes_interpolated,
  :attributes_not_interpolated,
  :channels,
  :content_type,
  :contents,
  :created_time,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :name,
  :quick_response_arn,
  :quick_response_id,
  :shortcut_key,
  :status,
  :tags)
  SENSITIVE = [:attributes_interpolated, :attributes_not_interpolated]
  include Aws::Structure
end

#created_timeTime

The timestamp when the quick response was created.

Returns:

  • (Time)


3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3204

class QuickResponseSearchResultData < Struct.new(
  :attributes_interpolated,
  :attributes_not_interpolated,
  :channels,
  :content_type,
  :contents,
  :created_time,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :name,
  :quick_response_arn,
  :quick_response_id,
  :shortcut_key,
  :status,
  :tags)
  SENSITIVE = [:attributes_interpolated, :attributes_not_interpolated]
  include Aws::Structure
end

#descriptionString

The description of the quick response.

Returns:

  • (String)


3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3204

class QuickResponseSearchResultData < Struct.new(
  :attributes_interpolated,
  :attributes_not_interpolated,
  :channels,
  :content_type,
  :contents,
  :created_time,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :name,
  :quick_response_arn,
  :quick_response_id,
  :shortcut_key,
  :status,
  :tags)
  SENSITIVE = [:attributes_interpolated, :attributes_not_interpolated]
  include Aws::Structure
end

#grouping_configurationTypes::GroupingConfiguration

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



3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3204

class QuickResponseSearchResultData < Struct.new(
  :attributes_interpolated,
  :attributes_not_interpolated,
  :channels,
  :content_type,
  :contents,
  :created_time,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :name,
  :quick_response_arn,
  :quick_response_id,
  :shortcut_key,
  :status,
  :tags)
  SENSITIVE = [:attributes_interpolated, :attributes_not_interpolated]
  include Aws::Structure
end

#is_activeBoolean

Whether the quick response is active.

Returns:

  • (Boolean)


3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3204

class QuickResponseSearchResultData < Struct.new(
  :attributes_interpolated,
  :attributes_not_interpolated,
  :channels,
  :content_type,
  :contents,
  :created_time,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :name,
  :quick_response_arn,
  :quick_response_id,
  :shortcut_key,
  :status,
  :tags)
  SENSITIVE = [:attributes_interpolated, :attributes_not_interpolated]
  include Aws::Structure
end

#knowledge_base_arnString

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

Returns:

  • (String)


3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3204

class QuickResponseSearchResultData < Struct.new(
  :attributes_interpolated,
  :attributes_not_interpolated,
  :channels,
  :content_type,
  :contents,
  :created_time,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :name,
  :quick_response_arn,
  :quick_response_id,
  :shortcut_key,
  :status,
  :tags)
  SENSITIVE = [:attributes_interpolated, :attributes_not_interpolated]
  include Aws::Structure
end

#knowledge_base_idString

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

Returns:

  • (String)


3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3204

class QuickResponseSearchResultData < Struct.new(
  :attributes_interpolated,
  :attributes_not_interpolated,
  :channels,
  :content_type,
  :contents,
  :created_time,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :name,
  :quick_response_arn,
  :quick_response_id,
  :shortcut_key,
  :status,
  :tags)
  SENSITIVE = [:attributes_interpolated, :attributes_not_interpolated]
  include Aws::Structure
end

#languageString

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

Returns:

  • (String)


3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3204

class QuickResponseSearchResultData < Struct.new(
  :attributes_interpolated,
  :attributes_not_interpolated,
  :channels,
  :content_type,
  :contents,
  :created_time,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :name,
  :quick_response_arn,
  :quick_response_id,
  :shortcut_key,
  :status,
  :tags)
  SENSITIVE = [:attributes_interpolated, :attributes_not_interpolated]
  include Aws::Structure
end

#last_modified_byString

The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.

Returns:

  • (String)


3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3204

class QuickResponseSearchResultData < Struct.new(
  :attributes_interpolated,
  :attributes_not_interpolated,
  :channels,
  :content_type,
  :contents,
  :created_time,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :name,
  :quick_response_arn,
  :quick_response_id,
  :shortcut_key,
  :status,
  :tags)
  SENSITIVE = [:attributes_interpolated, :attributes_not_interpolated]
  include Aws::Structure
end

#last_modified_timeTime

The timestamp when the quick response search result data was last modified.

Returns:

  • (Time)


3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3204

class QuickResponseSearchResultData < Struct.new(
  :attributes_interpolated,
  :attributes_not_interpolated,
  :channels,
  :content_type,
  :contents,
  :created_time,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :name,
  :quick_response_arn,
  :quick_response_id,
  :shortcut_key,
  :status,
  :tags)
  SENSITIVE = [:attributes_interpolated, :attributes_not_interpolated]
  include Aws::Structure
end

#nameString

The name of the quick response.

Returns:

  • (String)


3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3204

class QuickResponseSearchResultData < Struct.new(
  :attributes_interpolated,
  :attributes_not_interpolated,
  :channels,
  :content_type,
  :contents,
  :created_time,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :name,
  :quick_response_arn,
  :quick_response_id,
  :shortcut_key,
  :status,
  :tags)
  SENSITIVE = [:attributes_interpolated, :attributes_not_interpolated]
  include Aws::Structure
end

#quick_response_arnString

The Amazon Resource Name (ARN) of the quick response.

Returns:

  • (String)


3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3204

class QuickResponseSearchResultData < Struct.new(
  :attributes_interpolated,
  :attributes_not_interpolated,
  :channels,
  :content_type,
  :contents,
  :created_time,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :name,
  :quick_response_arn,
  :quick_response_id,
  :shortcut_key,
  :status,
  :tags)
  SENSITIVE = [:attributes_interpolated, :attributes_not_interpolated]
  include Aws::Structure
end

#quick_response_idString

The identifier of the quick response.

Returns:

  • (String)


3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3204

class QuickResponseSearchResultData < Struct.new(
  :attributes_interpolated,
  :attributes_not_interpolated,
  :channels,
  :content_type,
  :contents,
  :created_time,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :name,
  :quick_response_arn,
  :quick_response_id,
  :shortcut_key,
  :status,
  :tags)
  SENSITIVE = [:attributes_interpolated, :attributes_not_interpolated]
  include Aws::Structure
end

#shortcut_keyString

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

Returns:

  • (String)


3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3204

class QuickResponseSearchResultData < Struct.new(
  :attributes_interpolated,
  :attributes_not_interpolated,
  :channels,
  :content_type,
  :contents,
  :created_time,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :name,
  :quick_response_arn,
  :quick_response_id,
  :shortcut_key,
  :status,
  :tags)
  SENSITIVE = [:attributes_interpolated, :attributes_not_interpolated]
  include Aws::Structure
end

#statusString

The resource status of the quick response.

Returns:

  • (String)


3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3204

class QuickResponseSearchResultData < Struct.new(
  :attributes_interpolated,
  :attributes_not_interpolated,
  :channels,
  :content_type,
  :contents,
  :created_time,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :name,
  :quick_response_arn,
  :quick_response_id,
  :shortcut_key,
  :status,
  :tags)
  SENSITIVE = [:attributes_interpolated, :attributes_not_interpolated]
  include Aws::Structure
end

#tagsHash<String,String>

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

Returns:

  • (Hash<String,String>)


3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 3204

class QuickResponseSearchResultData < Struct.new(
  :attributes_interpolated,
  :attributes_not_interpolated,
  :channels,
  :content_type,
  :contents,
  :created_time,
  :description,
  :grouping_configuration,
  :is_active,
  :knowledge_base_arn,
  :knowledge_base_id,
  :language,
  :last_modified_by,
  :last_modified_time,
  :name,
  :quick_response_arn,
  :quick_response_id,
  :shortcut_key,
  :status,
  :tags)
  SENSITIVE = [:attributes_interpolated, :attributes_not_interpolated]
  include Aws::Structure
end