aws-sdk-connectwisdomservice 1.22.0 → 1.23.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -155,7 +155,9 @@ module Aws::ConnectWisdomService
155
155
  # @note AssistantAssociationInputData is a union - when making an API calls you must set exactly one of the members.
156
156
  #
157
157
  # @!attribute [rw] knowledge_base_id
158
- # The identifier of the knowledge base.
158
+ # The identifier of the knowledge base. This should not be a
159
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
160
+ # Content resource to it.
159
161
  # @return [String]
160
162
  #
161
163
  # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/AssistantAssociationInputData AWS API Documentation
@@ -263,11 +265,12 @@ module Aws::ConnectWisdomService
263
265
  # The configuration information for the customer managed key used for
264
266
  # encryption.
265
267
  #
266
- # This KMS key must have a policy that allows `kms:CreateGrant` and
267
- # `kms:DescribeKey` permissions to the IAM identity using the key to
268
- # invoke Wisdom. To use Wisdom with chat, the key policy must also
269
- # allow `kms:Decrypt`, `kms:GenerateDataKey*`, and `kms:DescribeKey`
270
- # permissions to the `connect.amazonaws.com` service principal.
268
+ # This KMS key must have a policy that allows `kms:CreateGrant`,
269
+ # `kms:DescribeKey`, and `kms:Decrypt/kms:GenerateDataKey` permissions
270
+ # to the IAM identity using the key to invoke Wisdom. To use Wisdom
271
+ # with chat, the key policy must also allow `kms:Decrypt`,
272
+ # `kms:GenerateDataKey*`, and `kms:DescribeKey` permissions to the
273
+ # `connect.amazonaws.com` service principal.
271
274
  #
272
275
  # For more information about setting up a customer managed key for
273
276
  # Wisdom, see [Enable Amazon Connect Wisdom for your instance][1].
@@ -347,11 +350,12 @@ module Aws::ConnectWisdomService
347
350
  # The configuration information for the customer managed key used for
348
351
  # encryption.
349
352
  #
350
- # This KMS key must have a policy that allows `kms:CreateGrant` and
351
- # `kms:DescribeKey` permissions to the IAM identity using the key to
352
- # invoke Wisdom. To use Wisdom with chat, the key policy must also
353
- # allow `kms:Decrypt`, `kms:GenerateDataKey*`, and `kms:DescribeKey`
354
- # permissions to the `connect.amazonaws.com` service principal.
353
+ # This KMS key must have a policy that allows `kms:CreateGrant`,
354
+ # `kms:DescribeKey`, and `kms:Decrypt/kms:GenerateDataKey` permissions
355
+ # to the IAM identity using the key to invoke Wisdom. To use Wisdom
356
+ # with chat, the key policy must also allow `kms:Decrypt`,
357
+ # `kms:GenerateDataKey*`, and `kms:DescribeKey` permissions to the
358
+ # `connect.amazonaws.com` service principal.
355
359
  #
356
360
  # For more information about setting up a customer managed key for
357
361
  # Wisdom, see [Enable Amazon Connect Wisdom for your instance][1].
@@ -390,6 +394,29 @@ module Aws::ConnectWisdomService
390
394
  include Aws::Structure
391
395
  end
392
396
 
397
+ # The configuration information of the external data source.
398
+ #
399
+ # @note Configuration is a union - when making an API calls you must set exactly one of the members.
400
+ #
401
+ # @note Configuration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Configuration corresponding to the set member.
402
+ #
403
+ # @!attribute [rw] connect_configuration
404
+ # The configuration information of the Amazon Connect data source.
405
+ # @return [Types::ConnectConfiguration]
406
+ #
407
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/Configuration AWS API Documentation
408
+ #
409
+ class Configuration < Struct.new(
410
+ :connect_configuration,
411
+ :unknown)
412
+ SENSITIVE = []
413
+ include Aws::Structure
414
+ include Aws::Structure::Union
415
+
416
+ class ConnectConfiguration < Configuration; end
417
+ class Unknown < Configuration; end
418
+ end
419
+
393
420
  # The request could not be processed because of conflict in the current
394
421
  # state of the resource. For example, if you're using a `Create` API
395
422
  # (such as `CreateAssistant`) that accepts name, a conflicting resource
@@ -406,6 +433,21 @@ module Aws::ConnectWisdomService
406
433
  include Aws::Structure
407
434
  end
408
435
 
436
+ # The configuration information of the Amazon Connect data source.
437
+ #
438
+ # @!attribute [rw] instance_id
439
+ # The identifier of the Amazon Connect instance. You can find the
440
+ # instanceId in the ARN of the instance.
441
+ # @return [String]
442
+ #
443
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ConnectConfiguration AWS API Documentation
444
+ #
445
+ class ConnectConfiguration < Struct.new(
446
+ :instance_id)
447
+ SENSITIVE = []
448
+ include Aws::Structure
449
+ end
450
+
409
451
  # Information about the content.
410
452
  #
411
453
  # @!attribute [rw] content_arn
@@ -425,7 +467,9 @@ module Aws::ConnectWisdomService
425
467
  # @return [String]
426
468
  #
427
469
  # @!attribute [rw] knowledge_base_id
428
- # The identifier of the knowledge base.
470
+ # The identifier of the knowledge base. This should not be a
471
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
472
+ # Content resource to it.
429
473
  # @return [String]
430
474
  #
431
475
  # @!attribute [rw] link_out_uri
@@ -504,7 +548,9 @@ module Aws::ConnectWisdomService
504
548
  # @return [String]
505
549
  #
506
550
  # @!attribute [rw] knowledge_base_id
507
- # The identifier of the knowledge base.
551
+ # The identifier of the knowledge base. This should not be a
552
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
553
+ # Content resource to it.
508
554
  # @return [String]
509
555
  #
510
556
  # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ContentReference AWS API Documentation
@@ -537,7 +583,9 @@ module Aws::ConnectWisdomService
537
583
  # @return [String]
538
584
  #
539
585
  # @!attribute [rw] knowledge_base_id
540
- # The identifier of the knowledge base.
586
+ # The identifier of the knowledge base. This should not be a
587
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
588
+ # Content resource to it.
541
589
  # @return [String]
542
590
  #
543
591
  # @!attribute [rw] metadata
@@ -669,11 +717,12 @@ module Aws::ConnectWisdomService
669
717
  # encryption.
670
718
  #
671
719
  # The customer managed key must have a policy that allows
672
- # `kms:CreateGrant` and ` kms:DescribeKey` permissions to the IAM
673
- # identity using the key to invoke Wisdom. To use Wisdom with chat,
674
- # the key policy must also allow `kms:Decrypt`,
675
- # `kms:GenerateDataKey*`, and `kms:DescribeKey` permissions to the
676
- # `connect.amazonaws.com` service principal.
720
+ # `kms:CreateGrant`, ` kms:DescribeKey`, and
721
+ # `kms:Decrypt/kms:GenerateDataKey` permissions to the IAM identity
722
+ # using the key to invoke Wisdom. To use Wisdom with chat, the key
723
+ # policy must also allow `kms:Decrypt`, `kms:GenerateDataKey*`, and
724
+ # `kms:DescribeKey` permissions to the `connect.amazonaws.com` service
725
+ # principal.
677
726
  #
678
727
  # For more information about setting up a customer managed key for
679
728
  # Wisdom, see [Enable Amazon Connect Wisdom for your instance][1].
@@ -732,8 +781,10 @@ module Aws::ConnectWisdomService
732
781
  # @return [String]
733
782
  #
734
783
  # @!attribute [rw] knowledge_base_id
735
- # The identifier of the knowledge base. Can be either the ID or the
736
- # ARN. URLs cannot contain the ARN.
784
+ # The identifier of the knowledge base. This should not be a
785
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
786
+ # Content resource to it. Can be either the ID or the ARN. URLs cannot
787
+ # contain the ARN.
737
788
  # @return [String]
738
789
  #
739
790
  # @!attribute [rw] metadata
@@ -843,9 +894,9 @@ module Aws::ConnectWisdomService
843
894
  # The configuration information for the customer managed key used for
844
895
  # encryption.
845
896
  #
846
- # This KMS key must have a policy that allows `kms:CreateGrant` and
847
- # `kms:DescribeKey` permissions to the IAM identity using the key to
848
- # invoke Wisdom.
897
+ # This KMS key must have a policy that allows `kms:CreateGrant`,
898
+ # `kms:DescribeKey`, and `kms:Decrypt/kms:GenerateDataKey` permissions
899
+ # to the IAM identity using the key to invoke Wisdom.
849
900
  #
850
901
  # For more information about setting up a customer managed key for
851
902
  # Wisdom, see [Enable Amazon Connect Wisdom for your instance][1].
@@ -892,6 +943,110 @@ module Aws::ConnectWisdomService
892
943
  include Aws::Structure
893
944
  end
894
945
 
946
+ # @!attribute [rw] channels
947
+ # The Amazon Connect channels this quick response applies to.
948
+ # @return [Array<String>]
949
+ #
950
+ # @!attribute [rw] client_token
951
+ # A unique, case-sensitive identifier that you provide to ensure the
952
+ # idempotency of the request. If not provided, the Amazon Web Services
953
+ # SDK populates this field. For more information about idempotency,
954
+ # see [Making retries safe with idempotent APIs][1].
955
+ #
956
+ # **A suitable default value is auto-generated.** You should normally
957
+ # not need to pass this option.
958
+ #
959
+ #
960
+ #
961
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
962
+ # @return [String]
963
+ #
964
+ # @!attribute [rw] content
965
+ # The content of the quick response.
966
+ # @return [Types::QuickResponseDataProvider]
967
+ #
968
+ # @!attribute [rw] content_type
969
+ # The media type of the quick response content.
970
+ #
971
+ # * Use `application/x.quickresponse;format=plain` for a quick
972
+ # response written in plain text.
973
+ #
974
+ # * Use `application/x.quickresponse;format=markdown` for a quick
975
+ # response written in richtext.
976
+ # @return [String]
977
+ #
978
+ # @!attribute [rw] description
979
+ # The description of the quick response.
980
+ # @return [String]
981
+ #
982
+ # @!attribute [rw] grouping_configuration
983
+ # The configuration information of the user groups that the quick
984
+ # response is accessible to.
985
+ # @return [Types::GroupingConfiguration]
986
+ #
987
+ # @!attribute [rw] is_active
988
+ # Whether the quick response is active.
989
+ # @return [Boolean]
990
+ #
991
+ # @!attribute [rw] knowledge_base_id
992
+ # The identifier of the knowledge base. This should not be a
993
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
994
+ # Content resource to it. Can be either the ID or the ARN. URLs cannot
995
+ # contain the ARN.
996
+ # @return [String]
997
+ #
998
+ # @!attribute [rw] language
999
+ # The language code value for the language in which the quick response
1000
+ # is written. The supported language codes include `de_DE`, `en_US`,
1001
+ # `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`,
1002
+ # `zh_CN`, `zh_TW`
1003
+ # @return [String]
1004
+ #
1005
+ # @!attribute [rw] name
1006
+ # The name of the quick response.
1007
+ # @return [String]
1008
+ #
1009
+ # @!attribute [rw] shortcut_key
1010
+ # The shortcut key of the quick response. The value should be unique
1011
+ # across the knowledge base.
1012
+ # @return [String]
1013
+ #
1014
+ # @!attribute [rw] tags
1015
+ # The tags used to organize, track, or control access for this
1016
+ # resource.
1017
+ # @return [Hash<String,String>]
1018
+ #
1019
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateQuickResponseRequest AWS API Documentation
1020
+ #
1021
+ class CreateQuickResponseRequest < Struct.new(
1022
+ :channels,
1023
+ :client_token,
1024
+ :content,
1025
+ :content_type,
1026
+ :description,
1027
+ :grouping_configuration,
1028
+ :is_active,
1029
+ :knowledge_base_id,
1030
+ :language,
1031
+ :name,
1032
+ :shortcut_key,
1033
+ :tags)
1034
+ SENSITIVE = []
1035
+ include Aws::Structure
1036
+ end
1037
+
1038
+ # @!attribute [rw] quick_response
1039
+ # The quick response.
1040
+ # @return [Types::QuickResponseData]
1041
+ #
1042
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateQuickResponseResponse AWS API Documentation
1043
+ #
1044
+ class CreateQuickResponseResponse < Struct.new(
1045
+ :quick_response)
1046
+ SENSITIVE = []
1047
+ include Aws::Structure
1048
+ end
1049
+
895
1050
  # @!attribute [rw] assistant_id
896
1051
  # The identifier of the Wisdom assistant. Can be either the ID or the
897
1052
  # ARN. URLs cannot contain the ARN.
@@ -994,8 +1149,10 @@ module Aws::ConnectWisdomService
994
1149
  # @return [String]
995
1150
  #
996
1151
  # @!attribute [rw] knowledge_base_id
997
- # The identifier of the knowledge base. Can be either the ID or the
998
- # ARN. URLs cannot contain the ARN.
1152
+ # The identifier of the knowledge base. This should not be a
1153
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
1154
+ # Content resource to it. Can be either the ID or the ARN. URLs cannot
1155
+ # contain the ARN.
999
1156
  # @return [String]
1000
1157
  #
1001
1158
  # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteContentRequest AWS API Documentation
@@ -1011,6 +1168,29 @@ module Aws::ConnectWisdomService
1011
1168
  #
1012
1169
  class DeleteContentResponse < Aws::EmptyStructure; end
1013
1170
 
1171
+ # @!attribute [rw] import_job_id
1172
+ # The identifier of the import job to be deleted.
1173
+ # @return [String]
1174
+ #
1175
+ # @!attribute [rw] knowledge_base_id
1176
+ # The identifier of the knowledge base. This should not be a
1177
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
1178
+ # Content resource to it.
1179
+ # @return [String]
1180
+ #
1181
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteImportJobRequest AWS API Documentation
1182
+ #
1183
+ class DeleteImportJobRequest < Struct.new(
1184
+ :import_job_id,
1185
+ :knowledge_base_id)
1186
+ SENSITIVE = []
1187
+ include Aws::Structure
1188
+ end
1189
+
1190
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteImportJobResponse AWS API Documentation
1191
+ #
1192
+ class DeleteImportJobResponse < Aws::EmptyStructure; end
1193
+
1014
1194
  # @!attribute [rw] knowledge_base_id
1015
1195
  # The knowledge base to delete content from. Can be either the ID or
1016
1196
  # the ARN. URLs cannot contain the ARN.
@@ -1028,6 +1208,30 @@ module Aws::ConnectWisdomService
1028
1208
  #
1029
1209
  class DeleteKnowledgeBaseResponse < Aws::EmptyStructure; end
1030
1210
 
1211
+ # @!attribute [rw] knowledge_base_id
1212
+ # The knowledge base from which the quick response is deleted. The
1213
+ # identifier of the knowledge base. This should not be a
1214
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
1215
+ # Content resource to it.
1216
+ # @return [String]
1217
+ #
1218
+ # @!attribute [rw] quick_response_id
1219
+ # The identifier of the quick response to delete.
1220
+ # @return [String]
1221
+ #
1222
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteQuickResponseRequest AWS API Documentation
1223
+ #
1224
+ class DeleteQuickResponseRequest < Struct.new(
1225
+ :knowledge_base_id,
1226
+ :quick_response_id)
1227
+ SENSITIVE = []
1228
+ include Aws::Structure
1229
+ end
1230
+
1231
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteQuickResponseResponse AWS API Documentation
1232
+ #
1233
+ class DeleteQuickResponseResponse < Aws::EmptyStructure; end
1234
+
1031
1235
  # The document.
1032
1236
  #
1033
1237
  # @!attribute [rw] content_reference
@@ -1071,6 +1275,25 @@ module Aws::ConnectWisdomService
1071
1275
  include Aws::Structure
1072
1276
  end
1073
1277
 
1278
+ # The configuration information of the external data source.
1279
+ #
1280
+ # @!attribute [rw] configuration
1281
+ # The configuration information of the external data source.
1282
+ # @return [Types::Configuration]
1283
+ #
1284
+ # @!attribute [rw] source
1285
+ # The type of the external data source.
1286
+ # @return [String]
1287
+ #
1288
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ExternalSourceConfiguration AWS API Documentation
1289
+ #
1290
+ class ExternalSourceConfiguration < Struct.new(
1291
+ :configuration,
1292
+ :source)
1293
+ SENSITIVE = []
1294
+ include Aws::Structure
1295
+ end
1296
+
1074
1297
  # A search filter.
1075
1298
  #
1076
1299
  # @!attribute [rw] field
@@ -1158,8 +1381,10 @@ module Aws::ConnectWisdomService
1158
1381
  # @return [String]
1159
1382
  #
1160
1383
  # @!attribute [rw] knowledge_base_id
1161
- # The identifier of the knowledge base. Can be either the ID or the
1162
- # ARN. URLs cannot contain the ARN.
1384
+ # The identifier of the knowledge base. This should not be a
1385
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
1386
+ # Content resource to it. Can be either the ID or the ARN. URLs cannot
1387
+ # contain the ARN.
1163
1388
  # @return [String]
1164
1389
  #
1165
1390
  # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetContentRequest AWS API Documentation
@@ -1189,8 +1414,10 @@ module Aws::ConnectWisdomService
1189
1414
  # @return [String]
1190
1415
  #
1191
1416
  # @!attribute [rw] knowledge_base_id
1192
- # The identifier of the knowledge base. Can be either the ID or the
1193
- # ARN. URLs cannot contain the ARN.
1417
+ # The identifier of the knowledge base. This should not be a
1418
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
1419
+ # Content resource to it. Can be either the ID or the ARN. URLs cannot
1420
+ # contain the ARN.
1194
1421
  # @return [String]
1195
1422
  #
1196
1423
  # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetContentSummaryRequest AWS API Documentation
@@ -1214,9 +1441,40 @@ module Aws::ConnectWisdomService
1214
1441
  include Aws::Structure
1215
1442
  end
1216
1443
 
1444
+ # @!attribute [rw] import_job_id
1445
+ # The identifier of the import job to retrieve.
1446
+ # @return [String]
1447
+ #
1448
+ # @!attribute [rw] knowledge_base_id
1449
+ # The identifier of the knowledge base that the import job belongs to.
1450
+ # @return [String]
1451
+ #
1452
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetImportJobRequest AWS API Documentation
1453
+ #
1454
+ class GetImportJobRequest < Struct.new(
1455
+ :import_job_id,
1456
+ :knowledge_base_id)
1457
+ SENSITIVE = []
1458
+ include Aws::Structure
1459
+ end
1460
+
1461
+ # @!attribute [rw] import_job
1462
+ # The import job.
1463
+ # @return [Types::ImportJobData]
1464
+ #
1465
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetImportJobResponse AWS API Documentation
1466
+ #
1467
+ class GetImportJobResponse < Struct.new(
1468
+ :import_job)
1469
+ SENSITIVE = []
1470
+ include Aws::Structure
1471
+ end
1472
+
1217
1473
  # @!attribute [rw] knowledge_base_id
1218
- # The identifier of the knowledge base. Can be either the ID or the
1219
- # ARN. URLs cannot contain the ARN.
1474
+ # The identifier of the knowledge base. This should not be a
1475
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
1476
+ # Content resource to it. Can be either the ID or the ARN. URLs cannot
1477
+ # contain the ARN.
1220
1478
  # @return [String]
1221
1479
  #
1222
1480
  # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetKnowledgeBaseRequest AWS API Documentation
@@ -1239,6 +1497,36 @@ module Aws::ConnectWisdomService
1239
1497
  include Aws::Structure
1240
1498
  end
1241
1499
 
1500
+ # @!attribute [rw] knowledge_base_id
1501
+ # The identifier of the knowledge base. This should be a
1502
+ # QUICK\_RESPONSES type knowledge base.
1503
+ # @return [String]
1504
+ #
1505
+ # @!attribute [rw] quick_response_id
1506
+ # The identifier of the quick response.
1507
+ # @return [String]
1508
+ #
1509
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetQuickResponseRequest AWS API Documentation
1510
+ #
1511
+ class GetQuickResponseRequest < Struct.new(
1512
+ :knowledge_base_id,
1513
+ :quick_response_id)
1514
+ SENSITIVE = []
1515
+ include Aws::Structure
1516
+ end
1517
+
1518
+ # @!attribute [rw] quick_response
1519
+ # The quick response.
1520
+ # @return [Types::QuickResponseData]
1521
+ #
1522
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetQuickResponseResponse AWS API Documentation
1523
+ #
1524
+ class GetQuickResponseResponse < Struct.new(
1525
+ :quick_response)
1526
+ SENSITIVE = []
1527
+ include Aws::Structure
1528
+ end
1529
+
1242
1530
  # @!attribute [rw] assistant_id
1243
1531
  # The identifier of the Wisdom assistant. Can be either the ID or the
1244
1532
  # ARN. URLs cannot contain the ARN.
@@ -1320,6 +1608,50 @@ module Aws::ConnectWisdomService
1320
1608
  include Aws::Structure
1321
1609
  end
1322
1610
 
1611
+ # The configuration information of the grouping of Wisdom users.
1612
+ #
1613
+ # @!attribute [rw] criteria
1614
+ # The criteria used for grouping Wisdom users.
1615
+ #
1616
+ # The following is the list of supported criteria values.
1617
+ #
1618
+ # * `RoutingProfileArn`: Grouping the users by their [Amazon Connect
1619
+ # routing profile ARN][1]. User should have
1620
+ # [SearchRoutingProfile][2] and [DescribeRoutingProfile][3]
1621
+ # permissions when setting criteria to this value.
1622
+ #
1623
+ # ^
1624
+ #
1625
+ #
1626
+ #
1627
+ # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html
1628
+ # [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchRoutingProfiles.html
1629
+ # [3]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html
1630
+ # @return [String]
1631
+ #
1632
+ # @!attribute [rw] values
1633
+ # The list of values that define different groups of Wisdom users.
1634
+ #
1635
+ # * When setting `criteria` to `RoutingProfileArn`, you need to
1636
+ # provide a list of ARNs of [Amazon Connect routing profiles][1] as
1637
+ # values of this parameter.
1638
+ #
1639
+ # ^
1640
+ #
1641
+ #
1642
+ #
1643
+ # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html
1644
+ # @return [Array<String>]
1645
+ #
1646
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GroupingConfiguration AWS API Documentation
1647
+ #
1648
+ class GroupingConfiguration < Struct.new(
1649
+ :criteria,
1650
+ :values)
1651
+ SENSITIVE = [:criteria]
1652
+ include Aws::Structure
1653
+ end
1654
+
1323
1655
  # Offset specification to describe highlighting of document excerpts for
1324
1656
  # rendering search results and recommendations.
1325
1657
  #
@@ -1340,29 +1672,27 @@ module Aws::ConnectWisdomService
1340
1672
  include Aws::Structure
1341
1673
  end
1342
1674
 
1343
- # Association information about the knowledge base.
1675
+ # Summary information about the import job.
1344
1676
  #
1345
- # @!attribute [rw] knowledge_base_arn
1346
- # The Amazon Resource Name (ARN) of the knowledge base.
1347
- # @return [String]
1677
+ # @!attribute [rw] created_time
1678
+ # The timestamp when the import job was created.
1679
+ # @return [Time]
1348
1680
  #
1349
- # @!attribute [rw] knowledge_base_id
1350
- # The identifier of the knowledge base.
1351
- # @return [String]
1681
+ # @!attribute [rw] external_source_configuration
1682
+ # The configuration information of the external data source.
1683
+ # @return [Types::ExternalSourceConfiguration]
1352
1684
  #
1353
- # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/KnowledgeBaseAssociationData AWS API Documentation
1685
+ # @!attribute [rw] failed_record_report
1686
+ # The link to donwload the information of resource data that failed to
1687
+ # be imported.
1688
+ # @return [String]
1354
1689
  #
1355
- class KnowledgeBaseAssociationData < Struct.new(
1356
- :knowledge_base_arn,
1357
- :knowledge_base_id)
1358
- SENSITIVE = []
1359
- include Aws::Structure
1360
- end
1361
-
1362
- # Information about the knowledge base.
1690
+ # @!attribute [rw] import_job_id
1691
+ # The identifier of the import job.
1692
+ # @return [String]
1363
1693
  #
1364
- # @!attribute [rw] description
1365
- # The description.
1694
+ # @!attribute [rw] import_job_type
1695
+ # The type of the import job.
1366
1696
  # @return [String]
1367
1697
  #
1368
1698
  # @!attribute [rw] knowledge_base_arn
@@ -1370,67 +1700,223 @@ module Aws::ConnectWisdomService
1370
1700
  # @return [String]
1371
1701
  #
1372
1702
  # @!attribute [rw] knowledge_base_id
1373
- # The identifier of the knowledge base.
1374
- # @return [String]
1375
- #
1376
- # @!attribute [rw] knowledge_base_type
1377
- # The type of knowledge base.
1703
+ # The identifier of the knowledge base. This should not be a
1704
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
1705
+ # Content resource to it.
1378
1706
  # @return [String]
1379
1707
  #
1380
- # @!attribute [rw] last_content_modification_time
1381
- # An epoch timestamp indicating the most recent content modification
1382
- # inside the knowledge base. If no content exists in a knowledge base,
1383
- # this value is unset.
1708
+ # @!attribute [rw] last_modified_time
1709
+ # The timestamp when the import job data was last modified.
1384
1710
  # @return [Time]
1385
1711
  #
1386
- # @!attribute [rw] name
1387
- # The name of the knowledge base.
1388
- # @return [String]
1389
- #
1390
- # @!attribute [rw] rendering_configuration
1391
- # Information about how to render the content.
1392
- # @return [Types::RenderingConfiguration]
1393
- #
1394
- # @!attribute [rw] server_side_encryption_configuration
1395
- # The configuration information for the customer managed key used for
1396
- # encryption.
1397
- #
1398
- # This KMS key must have a policy that allows `kms:CreateGrant` and
1399
- # `kms:DescribeKey` permissions to the IAM identity using the key to
1400
- # invoke Wisdom.
1712
+ # @!attribute [rw] metadata
1713
+ # The metadata fields of the imported Wisdom resources.
1714
+ # @return [Hash<String,String>]
1401
1715
  #
1402
- # For more information about setting up a customer managed key for
1403
- # Wisdom, see [Enable Amazon Connect Wisdom for your instance][1].
1716
+ # @!attribute [rw] status
1717
+ # The status of the import job.
1718
+ # @return [String]
1404
1719
  #
1720
+ # @!attribute [rw] upload_id
1721
+ # A pointer to the uploaded asset. This value is returned by
1722
+ # [StartContentUpload][1].
1405
1723
  #
1406
1724
  #
1407
- # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html
1408
- # @return [Types::ServerSideEncryptionConfiguration]
1409
1725
  #
1410
- # @!attribute [rw] source_configuration
1411
- # Source configuration information about the knowledge base.
1412
- # @return [Types::SourceConfiguration]
1726
+ # [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html
1727
+ # @return [String]
1413
1728
  #
1414
- # @!attribute [rw] status
1415
- # The status of the knowledge base.
1729
+ # @!attribute [rw] url
1730
+ # The download link to the resource file that is uploaded to the
1731
+ # import job.
1416
1732
  # @return [String]
1417
1733
  #
1418
- # @!attribute [rw] tags
1419
- # The tags used to organize, track, or control access for this
1420
- # resource.
1421
- # @return [Hash<String,String>]
1734
+ # @!attribute [rw] url_expiry
1735
+ # The expiration time of the URL as an epoch timestamp.
1736
+ # @return [Time]
1422
1737
  #
1423
- # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/KnowledgeBaseData AWS API Documentation
1738
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ImportJobData AWS API Documentation
1424
1739
  #
1425
- class KnowledgeBaseData < Struct.new(
1426
- :description,
1740
+ class ImportJobData < Struct.new(
1741
+ :created_time,
1742
+ :external_source_configuration,
1743
+ :failed_record_report,
1744
+ :import_job_id,
1745
+ :import_job_type,
1427
1746
  :knowledge_base_arn,
1428
1747
  :knowledge_base_id,
1429
- :knowledge_base_type,
1430
- :last_content_modification_time,
1431
- :name,
1432
- :rendering_configuration,
1433
- :server_side_encryption_configuration,
1748
+ :last_modified_time,
1749
+ :metadata,
1750
+ :status,
1751
+ :upload_id,
1752
+ :url,
1753
+ :url_expiry)
1754
+ SENSITIVE = [:failed_record_report, :url]
1755
+ include Aws::Structure
1756
+ end
1757
+
1758
+ # Summary information about the import job.
1759
+ #
1760
+ # @!attribute [rw] created_time
1761
+ # The timestamp when the import job was created.
1762
+ # @return [Time]
1763
+ #
1764
+ # @!attribute [rw] external_source_configuration
1765
+ # The configuration information of the external source that the
1766
+ # resource data are imported from.
1767
+ # @return [Types::ExternalSourceConfiguration]
1768
+ #
1769
+ # @!attribute [rw] import_job_id
1770
+ # The identifier of the import job.
1771
+ # @return [String]
1772
+ #
1773
+ # @!attribute [rw] import_job_type
1774
+ # The type of import job.
1775
+ # @return [String]
1776
+ #
1777
+ # @!attribute [rw] knowledge_base_arn
1778
+ # The Amazon Resource Name (ARN) of the knowledge base.
1779
+ # @return [String]
1780
+ #
1781
+ # @!attribute [rw] knowledge_base_id
1782
+ # The identifier of the knowledge base. This should not be a
1783
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
1784
+ # Content resource to it.
1785
+ # @return [String]
1786
+ #
1787
+ # @!attribute [rw] last_modified_time
1788
+ # The timestamp when the import job was last modified.
1789
+ # @return [Time]
1790
+ #
1791
+ # @!attribute [rw] metadata
1792
+ # The metadata fields of the imported Wisdom resources.
1793
+ # @return [Hash<String,String>]
1794
+ #
1795
+ # @!attribute [rw] status
1796
+ # The status of the import job.
1797
+ # @return [String]
1798
+ #
1799
+ # @!attribute [rw] upload_id
1800
+ # A pointer to the uploaded asset. This value is returned by
1801
+ # [StartContentUpload][1].
1802
+ #
1803
+ #
1804
+ #
1805
+ # [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html
1806
+ # @return [String]
1807
+ #
1808
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ImportJobSummary AWS API Documentation
1809
+ #
1810
+ class ImportJobSummary < Struct.new(
1811
+ :created_time,
1812
+ :external_source_configuration,
1813
+ :import_job_id,
1814
+ :import_job_type,
1815
+ :knowledge_base_arn,
1816
+ :knowledge_base_id,
1817
+ :last_modified_time,
1818
+ :metadata,
1819
+ :status,
1820
+ :upload_id)
1821
+ SENSITIVE = []
1822
+ include Aws::Structure
1823
+ end
1824
+
1825
+ # Association information about the knowledge base.
1826
+ #
1827
+ # @!attribute [rw] knowledge_base_arn
1828
+ # The Amazon Resource Name (ARN) of the knowledge base.
1829
+ # @return [String]
1830
+ #
1831
+ # @!attribute [rw] knowledge_base_id
1832
+ # The identifier of the knowledge base. This should not be a
1833
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
1834
+ # Content resource to it.
1835
+ # @return [String]
1836
+ #
1837
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/KnowledgeBaseAssociationData AWS API Documentation
1838
+ #
1839
+ class KnowledgeBaseAssociationData < Struct.new(
1840
+ :knowledge_base_arn,
1841
+ :knowledge_base_id)
1842
+ SENSITIVE = []
1843
+ include Aws::Structure
1844
+ end
1845
+
1846
+ # Information about the knowledge base.
1847
+ #
1848
+ # @!attribute [rw] description
1849
+ # The description.
1850
+ # @return [String]
1851
+ #
1852
+ # @!attribute [rw] knowledge_base_arn
1853
+ # The Amazon Resource Name (ARN) of the knowledge base.
1854
+ # @return [String]
1855
+ #
1856
+ # @!attribute [rw] knowledge_base_id
1857
+ # The identifier of the knowledge base. This should not be a
1858
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
1859
+ # Content resource to it.
1860
+ # @return [String]
1861
+ #
1862
+ # @!attribute [rw] knowledge_base_type
1863
+ # The type of knowledge base.
1864
+ # @return [String]
1865
+ #
1866
+ # @!attribute [rw] last_content_modification_time
1867
+ # An epoch timestamp indicating the most recent content modification
1868
+ # inside the knowledge base. If no content exists in a knowledge base,
1869
+ # this value is unset.
1870
+ # @return [Time]
1871
+ #
1872
+ # @!attribute [rw] name
1873
+ # The name of the knowledge base.
1874
+ # @return [String]
1875
+ #
1876
+ # @!attribute [rw] rendering_configuration
1877
+ # Information about how to render the content.
1878
+ # @return [Types::RenderingConfiguration]
1879
+ #
1880
+ # @!attribute [rw] server_side_encryption_configuration
1881
+ # The configuration information for the customer managed key used for
1882
+ # encryption.
1883
+ #
1884
+ # This KMS key must have a policy that allows `kms:CreateGrant`,
1885
+ # `kms:DescribeKey`, and `kms:Decrypt/kms:GenerateDataKey` permissions
1886
+ # to the IAM identity using the key to invoke Wisdom.
1887
+ #
1888
+ # For more information about setting up a customer managed key for
1889
+ # Wisdom, see [Enable Amazon Connect Wisdom for your instance][1].
1890
+ #
1891
+ #
1892
+ #
1893
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html
1894
+ # @return [Types::ServerSideEncryptionConfiguration]
1895
+ #
1896
+ # @!attribute [rw] source_configuration
1897
+ # Source configuration information about the knowledge base.
1898
+ # @return [Types::SourceConfiguration]
1899
+ #
1900
+ # @!attribute [rw] status
1901
+ # The status of the knowledge base.
1902
+ # @return [String]
1903
+ #
1904
+ # @!attribute [rw] tags
1905
+ # The tags used to organize, track, or control access for this
1906
+ # resource.
1907
+ # @return [Hash<String,String>]
1908
+ #
1909
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/KnowledgeBaseData AWS API Documentation
1910
+ #
1911
+ class KnowledgeBaseData < Struct.new(
1912
+ :description,
1913
+ :knowledge_base_arn,
1914
+ :knowledge_base_id,
1915
+ :knowledge_base_type,
1916
+ :last_content_modification_time,
1917
+ :name,
1918
+ :rendering_configuration,
1919
+ :server_side_encryption_configuration,
1434
1920
  :source_configuration,
1435
1921
  :status,
1436
1922
  :tags)
@@ -1449,7 +1935,9 @@ module Aws::ConnectWisdomService
1449
1935
  # @return [String]
1450
1936
  #
1451
1937
  # @!attribute [rw] knowledge_base_id
1452
- # The identifier of the knowledge base.
1938
+ # The identifier of the knowledge base. This should not be a
1939
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
1940
+ # Content resource to it.
1453
1941
  # @return [String]
1454
1942
  #
1455
1943
  # @!attribute [rw] knowledge_base_type
@@ -1468,9 +1956,9 @@ module Aws::ConnectWisdomService
1468
1956
  # The configuration information for the customer managed key used for
1469
1957
  # encryption.
1470
1958
  #
1471
- # This KMS key must have a policy that allows `kms:CreateGrant` and
1472
- # `kms:DescribeKey` permissions to the IAM identity using the key to
1473
- # invoke Wisdom.
1959
+ # This KMS key must have a policy that allows `kms:CreateGrant`,
1960
+ # `kms:DescribeKey`, `kms:Decrypt/kms:GenerateDataKey` permissions to
1961
+ # the IAM identity using the key to invoke Wisdom.
1474
1962
  #
1475
1963
  # For more information about setting up a customer managed key for
1476
1964
  # Wisdom, see [Enable Amazon Connect Wisdom for your instance][1].
@@ -1591,8 +2079,10 @@ module Aws::ConnectWisdomService
1591
2079
  end
1592
2080
 
1593
2081
  # @!attribute [rw] knowledge_base_id
1594
- # The identifier of the knowledge base. Can be either the ID or the
1595
- # ARN. URLs cannot contain the ARN.
2082
+ # The identifier of the knowledge base. This should not be a
2083
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
2084
+ # Content resource to it. Can be either the ID or the ARN. URLs cannot
2085
+ # contain the ARN.
1596
2086
  # @return [String]
1597
2087
  #
1598
2088
  # @!attribute [rw] max_results
@@ -1633,6 +2123,52 @@ module Aws::ConnectWisdomService
1633
2123
  include Aws::Structure
1634
2124
  end
1635
2125
 
2126
+ # @!attribute [rw] knowledge_base_id
2127
+ # The identifier of the knowledge base. This should not be a
2128
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
2129
+ # Content resource to it. Can be either the ID or the ARN. URLs cannot
2130
+ # contain the ARN.
2131
+ # @return [String]
2132
+ #
2133
+ # @!attribute [rw] max_results
2134
+ # The maximum number of results to return per page.
2135
+ # @return [Integer]
2136
+ #
2137
+ # @!attribute [rw] next_token
2138
+ # The token for the next set of results. Use the value returned in the
2139
+ # previous response in the next request to retrieve the next set of
2140
+ # results.
2141
+ # @return [String]
2142
+ #
2143
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListImportJobsRequest AWS API Documentation
2144
+ #
2145
+ class ListImportJobsRequest < Struct.new(
2146
+ :knowledge_base_id,
2147
+ :max_results,
2148
+ :next_token)
2149
+ SENSITIVE = []
2150
+ include Aws::Structure
2151
+ end
2152
+
2153
+ # @!attribute [rw] import_job_summaries
2154
+ # Summary information about the import jobs.
2155
+ # @return [Array<Types::ImportJobSummary>]
2156
+ #
2157
+ # @!attribute [rw] next_token
2158
+ # The token for the next set of results. Use the value returned in the
2159
+ # previous response in the next request to retrieve the next set of
2160
+ # results.
2161
+ # @return [String]
2162
+ #
2163
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListImportJobsResponse AWS API Documentation
2164
+ #
2165
+ class ListImportJobsResponse < Struct.new(
2166
+ :import_job_summaries,
2167
+ :next_token)
2168
+ SENSITIVE = []
2169
+ include Aws::Structure
2170
+ end
2171
+
1636
2172
  # @!attribute [rw] max_results
1637
2173
  # The maximum number of results to return per page.
1638
2174
  # @return [Integer]
@@ -1670,6 +2206,52 @@ module Aws::ConnectWisdomService
1670
2206
  include Aws::Structure
1671
2207
  end
1672
2208
 
2209
+ # @!attribute [rw] knowledge_base_id
2210
+ # The identifier of the knowledge base. This should not be a
2211
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
2212
+ # Content resource to it. Can be either the ID or the ARN. URLs cannot
2213
+ # contain the ARN.
2214
+ # @return [String]
2215
+ #
2216
+ # @!attribute [rw] max_results
2217
+ # The maximum number of results to return per page.
2218
+ # @return [Integer]
2219
+ #
2220
+ # @!attribute [rw] next_token
2221
+ # The token for the next set of results. Use the value returned in the
2222
+ # previous response in the next request to retrieve the next set of
2223
+ # results.
2224
+ # @return [String]
2225
+ #
2226
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListQuickResponsesRequest AWS API Documentation
2227
+ #
2228
+ class ListQuickResponsesRequest < Struct.new(
2229
+ :knowledge_base_id,
2230
+ :max_results,
2231
+ :next_token)
2232
+ SENSITIVE = []
2233
+ include Aws::Structure
2234
+ end
2235
+
2236
+ # @!attribute [rw] next_token
2237
+ # The token for the next set of results. Use the value returned in the
2238
+ # previous response in the next request to retrieve the next set of
2239
+ # results.
2240
+ # @return [String]
2241
+ #
2242
+ # @!attribute [rw] quick_response_summaries
2243
+ # Summary information about the quick responses.
2244
+ # @return [Array<Types::QuickResponseSummary>]
2245
+ #
2246
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListQuickResponsesResponse AWS API Documentation
2247
+ #
2248
+ class ListQuickResponsesResponse < Struct.new(
2249
+ :next_token,
2250
+ :quick_response_summaries)
2251
+ SENSITIVE = []
2252
+ include Aws::Structure
2253
+ end
2254
+
1673
2255
  # @!attribute [rw] resource_arn
1674
2256
  # The Amazon Resource Name (ARN) of the resource.
1675
2257
  # @return [String]
@@ -1738,96 +2320,666 @@ module Aws::ConnectWisdomService
1738
2320
  include Aws::Structure
1739
2321
  end
1740
2322
 
1741
- # @!attribute [rw] errors
1742
- # The identifiers of recommendations that are causing errors.
1743
- # @return [Array<Types::NotifyRecommendationsReceivedError>]
2323
+ # @!attribute [rw] errors
2324
+ # The identifiers of recommendations that are causing errors.
2325
+ # @return [Array<Types::NotifyRecommendationsReceivedError>]
2326
+ #
2327
+ # @!attribute [rw] recommendation_ids
2328
+ # The identifiers of the recommendations.
2329
+ # @return [Array<String>]
2330
+ #
2331
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/NotifyRecommendationsReceivedResponse AWS API Documentation
2332
+ #
2333
+ class NotifyRecommendationsReceivedResponse < Struct.new(
2334
+ :errors,
2335
+ :recommendation_ids)
2336
+ SENSITIVE = []
2337
+ include Aws::Structure
2338
+ end
2339
+
2340
+ # The provided `revisionId` does not match, indicating the content has
2341
+ # been modified since it was last read.
2342
+ #
2343
+ # @!attribute [rw] message
2344
+ # @return [String]
2345
+ #
2346
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/PreconditionFailedException AWS API Documentation
2347
+ #
2348
+ class PreconditionFailedException < Struct.new(
2349
+ :message)
2350
+ SENSITIVE = []
2351
+ include Aws::Structure
2352
+ end
2353
+
2354
+ # @!attribute [rw] assistant_id
2355
+ # The identifier of the Wisdom assistant. Can be either the ID or the
2356
+ # ARN. URLs cannot contain the ARN.
2357
+ # @return [String]
2358
+ #
2359
+ # @!attribute [rw] max_results
2360
+ # The maximum number of results to return per page.
2361
+ # @return [Integer]
2362
+ #
2363
+ # @!attribute [rw] next_token
2364
+ # The token for the next set of results. Use the value returned in the
2365
+ # previous response in the next request to retrieve the next set of
2366
+ # results.
2367
+ # @return [String]
2368
+ #
2369
+ # @!attribute [rw] query_text
2370
+ # The text to search for.
2371
+ # @return [String]
2372
+ #
2373
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QueryAssistantRequest AWS API Documentation
2374
+ #
2375
+ class QueryAssistantRequest < Struct.new(
2376
+ :assistant_id,
2377
+ :max_results,
2378
+ :next_token,
2379
+ :query_text)
2380
+ SENSITIVE = [:query_text]
2381
+ include Aws::Structure
2382
+ end
2383
+
2384
+ # @!attribute [rw] next_token
2385
+ # If there are additional results, this is the token for the next set
2386
+ # of results.
2387
+ # @return [String]
2388
+ #
2389
+ # @!attribute [rw] results
2390
+ # The results of the query.
2391
+ # @return [Array<Types::ResultData>]
2392
+ #
2393
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QueryAssistantResponse AWS API Documentation
2394
+ #
2395
+ class QueryAssistantResponse < Struct.new(
2396
+ :next_token,
2397
+ :results)
2398
+ SENSITIVE = []
2399
+ include Aws::Structure
2400
+ end
2401
+
2402
+ # Data associated with the QUERY RecommendationTriggerType.
2403
+ #
2404
+ # @!attribute [rw] text
2405
+ # The text associated with the recommendation trigger.
2406
+ # @return [String]
2407
+ #
2408
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QueryRecommendationTriggerData AWS API Documentation
2409
+ #
2410
+ class QueryRecommendationTriggerData < Struct.new(
2411
+ :text)
2412
+ SENSITIVE = [:text]
2413
+ include Aws::Structure
2414
+ end
2415
+
2416
+ # The container quick response content.
2417
+ #
2418
+ # @note QuickResponseContentProvider is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of QuickResponseContentProvider corresponding to the set member.
2419
+ #
2420
+ # @!attribute [rw] content
2421
+ # The content of the quick response.
2422
+ # @return [String]
2423
+ #
2424
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QuickResponseContentProvider AWS API Documentation
2425
+ #
2426
+ class QuickResponseContentProvider < Struct.new(
2427
+ :content,
2428
+ :unknown)
2429
+ SENSITIVE = [:content]
2430
+ include Aws::Structure
2431
+ include Aws::Structure::Union
2432
+
2433
+ class Content < QuickResponseContentProvider; end
2434
+ class Unknown < QuickResponseContentProvider; end
2435
+ end
2436
+
2437
+ # The content of the quick response stored in different media types.
2438
+ #
2439
+ # @!attribute [rw] markdown
2440
+ # The container quick response content.
2441
+ # @return [Types::QuickResponseContentProvider]
2442
+ #
2443
+ # @!attribute [rw] plain_text
2444
+ # The container quick response content.
2445
+ # @return [Types::QuickResponseContentProvider]
2446
+ #
2447
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QuickResponseContents AWS API Documentation
2448
+ #
2449
+ class QuickResponseContents < Struct.new(
2450
+ :markdown,
2451
+ :plain_text)
2452
+ SENSITIVE = []
2453
+ include Aws::Structure
2454
+ end
2455
+
2456
+ # Information about the quick response.
2457
+ #
2458
+ # @!attribute [rw] channels
2459
+ # The Amazon Connect contact channels this quick response applies to.
2460
+ # The supported contact channel types include `Chat`.
2461
+ # @return [Array<String>]
2462
+ #
2463
+ # @!attribute [rw] content_type
2464
+ # The media type of the quick response content.
2465
+ #
2466
+ # * Use `application/x.quickresponse;format=plain` for quick response
2467
+ # written in plain text.
2468
+ #
2469
+ # * Use `application/x.quickresponse;format=markdown` for quick
2470
+ # response written in richtext.
2471
+ # @return [String]
2472
+ #
2473
+ # @!attribute [rw] contents
2474
+ # The contents of the quick response.
2475
+ # @return [Types::QuickResponseContents]
2476
+ #
2477
+ # @!attribute [rw] created_time
2478
+ # The timestamp when the quick response was created.
2479
+ # @return [Time]
2480
+ #
2481
+ # @!attribute [rw] description
2482
+ # The description of the quick response.
2483
+ # @return [String]
2484
+ #
2485
+ # @!attribute [rw] grouping_configuration
2486
+ # The configuration information of the user groups that the quick
2487
+ # response is accessible to.
2488
+ # @return [Types::GroupingConfiguration]
2489
+ #
2490
+ # @!attribute [rw] is_active
2491
+ # Whether the quick response is active.
2492
+ # @return [Boolean]
2493
+ #
2494
+ # @!attribute [rw] knowledge_base_arn
2495
+ # The Amazon Resource Name (ARN) of the knowledge base.
2496
+ # @return [String]
2497
+ #
2498
+ # @!attribute [rw] knowledge_base_id
2499
+ # The identifier of the knowledge base. This should not be a
2500
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
2501
+ # Content resource to it. Can be either the ID or the ARN. URLs cannot
2502
+ # contain the ARN.
2503
+ # @return [String]
2504
+ #
2505
+ # @!attribute [rw] language
2506
+ # The language code value for the language in which the quick response
2507
+ # is written.
2508
+ # @return [String]
2509
+ #
2510
+ # @!attribute [rw] last_modified_by
2511
+ # The Amazon Resource Name (ARN) of the user who last updated the
2512
+ # quick response data.
2513
+ # @return [String]
2514
+ #
2515
+ # @!attribute [rw] last_modified_time
2516
+ # The timestamp when the quick response data was last modified.
2517
+ # @return [Time]
2518
+ #
2519
+ # @!attribute [rw] name
2520
+ # The name of the quick response.
2521
+ # @return [String]
2522
+ #
2523
+ # @!attribute [rw] quick_response_arn
2524
+ # The Amazon Resource Name (ARN) of the quick response.
2525
+ # @return [String]
2526
+ #
2527
+ # @!attribute [rw] quick_response_id
2528
+ # The identifier of the quick response.
2529
+ # @return [String]
2530
+ #
2531
+ # @!attribute [rw] shortcut_key
2532
+ # The shortcut key of the quick response. The value should be unique
2533
+ # across the knowledge base.
2534
+ # @return [String]
2535
+ #
2536
+ # @!attribute [rw] status
2537
+ # The status of the quick response data.
2538
+ # @return [String]
2539
+ #
2540
+ # @!attribute [rw] tags
2541
+ # The tags used to organize, track, or control access for this
2542
+ # resource.
2543
+ # @return [Hash<String,String>]
2544
+ #
2545
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QuickResponseData AWS API Documentation
2546
+ #
2547
+ class QuickResponseData < Struct.new(
2548
+ :channels,
2549
+ :content_type,
2550
+ :contents,
2551
+ :created_time,
2552
+ :description,
2553
+ :grouping_configuration,
2554
+ :is_active,
2555
+ :knowledge_base_arn,
2556
+ :knowledge_base_id,
2557
+ :language,
2558
+ :last_modified_by,
2559
+ :last_modified_time,
2560
+ :name,
2561
+ :quick_response_arn,
2562
+ :quick_response_id,
2563
+ :shortcut_key,
2564
+ :status,
2565
+ :tags)
2566
+ SENSITIVE = []
2567
+ include Aws::Structure
2568
+ end
2569
+
2570
+ # The container of quick response data.
2571
+ #
2572
+ # @note QuickResponseDataProvider is a union - when making an API calls you must set exactly one of the members.
2573
+ #
2574
+ # @!attribute [rw] content
2575
+ # The content of the quick response.
2576
+ # @return [String]
2577
+ #
2578
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QuickResponseDataProvider AWS API Documentation
2579
+ #
2580
+ class QuickResponseDataProvider < Struct.new(
2581
+ :content,
2582
+ :unknown)
2583
+ SENSITIVE = [:content]
2584
+ include Aws::Structure
2585
+ include Aws::Structure::Union
2586
+
2587
+ class Content < QuickResponseDataProvider; end
2588
+ class Unknown < QuickResponseDataProvider; end
2589
+ end
2590
+
2591
+ # The quick response fields to filter the quick response query results
2592
+ # by.
2593
+ #
2594
+ # The following is the list of supported field names.
2595
+ #
2596
+ # * name
2597
+ #
2598
+ # * description
2599
+ #
2600
+ # * shortcutKey
2601
+ #
2602
+ # * isActive
2603
+ #
2604
+ # * channels
2605
+ #
2606
+ # * language
2607
+ #
2608
+ # * contentType
2609
+ #
2610
+ # * createdTime
2611
+ #
2612
+ # * lastModifiedTime
2613
+ #
2614
+ # * lastModifiedBy
2615
+ #
2616
+ # * groupingConfiguration.criteria
2617
+ #
2618
+ # * groupingConfiguration.values
2619
+ #
2620
+ # @!attribute [rw] include_no_existence
2621
+ # Whether to treat null value as a match for the attribute field.
2622
+ # @return [Boolean]
2623
+ #
2624
+ # @!attribute [rw] name
2625
+ # The name of the attribute field to filter the quick responses by.
2626
+ # @return [String]
2627
+ #
2628
+ # @!attribute [rw] operator
2629
+ # The operator to use for filtering.
2630
+ # @return [String]
2631
+ #
2632
+ # @!attribute [rw] values
2633
+ # The values of attribute field to filter the quick response by.
2634
+ # @return [Array<String>]
2635
+ #
2636
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QuickResponseFilterField AWS API Documentation
2637
+ #
2638
+ class QuickResponseFilterField < Struct.new(
2639
+ :include_no_existence,
2640
+ :name,
2641
+ :operator,
2642
+ :values)
2643
+ SENSITIVE = []
2644
+ include Aws::Structure
2645
+ end
2646
+
2647
+ # The quick response fields to order the quick response query results
2648
+ # by.
2649
+ #
2650
+ # The following is the list of supported field names.
2651
+ #
2652
+ # * name
2653
+ #
2654
+ # * description
2655
+ #
2656
+ # * shortcutKey
2657
+ #
2658
+ # * isActive
2659
+ #
2660
+ # * channels
2661
+ #
2662
+ # * language
2663
+ #
2664
+ # * contentType
2665
+ #
2666
+ # * createdTime
2667
+ #
2668
+ # * lastModifiedTime
2669
+ #
2670
+ # * lastModifiedBy
2671
+ #
2672
+ # * groupingConfiguration.criteria
2673
+ #
2674
+ # * groupingConfiguration.values
2675
+ #
2676
+ # @!attribute [rw] name
2677
+ # The name of the attribute to order the quick response query results
2678
+ # by.
2679
+ # @return [String]
2680
+ #
2681
+ # @!attribute [rw] order
2682
+ # The order at which the quick responses are sorted by.
2683
+ # @return [String]
2684
+ #
2685
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QuickResponseOrderField AWS API Documentation
2686
+ #
2687
+ class QuickResponseOrderField < Struct.new(
2688
+ :name,
2689
+ :order)
2690
+ SENSITIVE = []
2691
+ include Aws::Structure
2692
+ end
2693
+
2694
+ # The quick response fields to query quick responses by.
2695
+ #
2696
+ # The following is the list of supported field names.
2697
+ #
2698
+ # * content
2699
+ #
2700
+ # * name
2701
+ #
2702
+ # * description
2703
+ #
2704
+ # * shortcutKey
2705
+ #
2706
+ # @!attribute [rw] allow_fuzziness
2707
+ # Whether the query expects only exact matches on the attribute field
2708
+ # values. The results of the query will only include exact matches if
2709
+ # this parameter is set to false.
2710
+ # @return [Boolean]
2711
+ #
2712
+ # @!attribute [rw] name
2713
+ # The name of the attribute to query the quick responses by.
2714
+ # @return [String]
2715
+ #
2716
+ # @!attribute [rw] operator
2717
+ # The operator to use for matching attribute field values in the
2718
+ # query.
2719
+ # @return [String]
2720
+ #
2721
+ # @!attribute [rw] priority
2722
+ # The importance of the attribute field when calculating query result
2723
+ # relevancy scores. The value set for this parameter affects the
2724
+ # ordering of search results.
2725
+ # @return [String]
2726
+ #
2727
+ # @!attribute [rw] values
2728
+ # The values of the attribute to query the quick responses by.
2729
+ # @return [Array<String>]
2730
+ #
2731
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QuickResponseQueryField AWS API Documentation
2732
+ #
2733
+ class QuickResponseQueryField < Struct.new(
2734
+ :allow_fuzziness,
2735
+ :name,
2736
+ :operator,
2737
+ :priority,
2738
+ :values)
2739
+ SENSITIVE = []
2740
+ include Aws::Structure
2741
+ end
2742
+
2743
+ # Information about the import job.
2744
+ #
2745
+ # @!attribute [rw] filters
2746
+ # The configuration of filtering rules applied to quick response query
2747
+ # results.
2748
+ # @return [Array<Types::QuickResponseFilterField>]
2749
+ #
2750
+ # @!attribute [rw] order_on_field
2751
+ # The quick response attribute fields on which the query results are
2752
+ # ordered.
2753
+ # @return [Types::QuickResponseOrderField]
2754
+ #
2755
+ # @!attribute [rw] queries
2756
+ # The quick response query expressions.
2757
+ # @return [Array<Types::QuickResponseQueryField>]
2758
+ #
2759
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QuickResponseSearchExpression AWS API Documentation
2760
+ #
2761
+ class QuickResponseSearchExpression < Struct.new(
2762
+ :filters,
2763
+ :order_on_field,
2764
+ :queries)
2765
+ SENSITIVE = []
2766
+ include Aws::Structure
2767
+ end
2768
+
2769
+ # The result of quick response search.
2770
+ #
2771
+ # @!attribute [rw] attributes_interpolated
2772
+ # The user defined contact attributes that are resolved when the
2773
+ # search result is returned.
2774
+ # @return [Array<String>]
2775
+ #
2776
+ # @!attribute [rw] attributes_not_interpolated
2777
+ # The user defined contact attributes that are not resolved when the
2778
+ # search result is returned.
2779
+ # @return [Array<String>]
2780
+ #
2781
+ # @!attribute [rw] channels
2782
+ # The Amazon Connect contact channels this quick response applies to.
2783
+ # The supported contact channel types include `Chat`.
2784
+ # @return [Array<String>]
2785
+ #
2786
+ # @!attribute [rw] content_type
2787
+ # The media type of the quick response content.
2788
+ #
2789
+ # * Use `application/x.quickresponse;format=plain` for quick response
2790
+ # written in plain text.
2791
+ #
2792
+ # * Use `application/x.quickresponse;format=markdown` for quick
2793
+ # response written in richtext.
2794
+ # @return [String]
2795
+ #
2796
+ # @!attribute [rw] contents
2797
+ # The contents of the quick response.
2798
+ # @return [Types::QuickResponseContents]
2799
+ #
2800
+ # @!attribute [rw] created_time
2801
+ # The timestamp when the quick response was created.
2802
+ # @return [Time]
2803
+ #
2804
+ # @!attribute [rw] description
2805
+ # The description of the quick response.
2806
+ # @return [String]
2807
+ #
2808
+ # @!attribute [rw] grouping_configuration
2809
+ # The configuration information of the user groups that the quick
2810
+ # response is accessible to.
2811
+ # @return [Types::GroupingConfiguration]
2812
+ #
2813
+ # @!attribute [rw] is_active
2814
+ # Whether the quick response is active.
2815
+ # @return [Boolean]
2816
+ #
2817
+ # @!attribute [rw] knowledge_base_arn
2818
+ # The Amazon Resource Name (ARN) of the knowledge base.
2819
+ # @return [String]
2820
+ #
2821
+ # @!attribute [rw] knowledge_base_id
2822
+ # The identifier of the knowledge base. This should not be a
2823
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
2824
+ # Content resource to it. Can be either the ID or the ARN. URLs cannot
2825
+ # contain the ARN.
2826
+ # @return [String]
2827
+ #
2828
+ # @!attribute [rw] language
2829
+ # The language code value for the language in which the quick response
2830
+ # is written.
2831
+ # @return [String]
2832
+ #
2833
+ # @!attribute [rw] last_modified_by
2834
+ # The Amazon Resource Name (ARN) of the user who last updated the
2835
+ # quick response search result data.
2836
+ # @return [String]
2837
+ #
2838
+ # @!attribute [rw] last_modified_time
2839
+ # The timestamp when the quick response search result data was last
2840
+ # modified.
2841
+ # @return [Time]
2842
+ #
2843
+ # @!attribute [rw] name
2844
+ # The name of the quick response.
2845
+ # @return [String]
2846
+ #
2847
+ # @!attribute [rw] quick_response_arn
2848
+ # The Amazon Resource Name (ARN) of the quick response.
2849
+ # @return [String]
2850
+ #
2851
+ # @!attribute [rw] quick_response_id
2852
+ # The identifier of the quick response.
2853
+ # @return [String]
2854
+ #
2855
+ # @!attribute [rw] shortcut_key
2856
+ # The shortcut key of the quick response. The value should be unique
2857
+ # across the knowledge base.
2858
+ # @return [String]
2859
+ #
2860
+ # @!attribute [rw] status
2861
+ # The resource status of the quick response.
2862
+ # @return [String]
2863
+ #
2864
+ # @!attribute [rw] tags
2865
+ # The tags used to organize, track, or control access for this
2866
+ # resource.
2867
+ # @return [Hash<String,String>]
2868
+ #
2869
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QuickResponseSearchResultData AWS API Documentation
2870
+ #
2871
+ class QuickResponseSearchResultData < Struct.new(
2872
+ :attributes_interpolated,
2873
+ :attributes_not_interpolated,
2874
+ :channels,
2875
+ :content_type,
2876
+ :contents,
2877
+ :created_time,
2878
+ :description,
2879
+ :grouping_configuration,
2880
+ :is_active,
2881
+ :knowledge_base_arn,
2882
+ :knowledge_base_id,
2883
+ :language,
2884
+ :last_modified_by,
2885
+ :last_modified_time,
2886
+ :name,
2887
+ :quick_response_arn,
2888
+ :quick_response_id,
2889
+ :shortcut_key,
2890
+ :status,
2891
+ :tags)
2892
+ SENSITIVE = [:attributes_interpolated, :attributes_not_interpolated]
2893
+ include Aws::Structure
2894
+ end
2895
+
2896
+ # The summary information about the quick response.
1744
2897
  #
1745
- # @!attribute [rw] recommendation_ids
1746
- # The identifiers of the recommendations.
2898
+ # @!attribute [rw] channels
2899
+ # The Amazon Connect contact channels this quick response applies to.
2900
+ # The supported contact channel types include `Chat`.
1747
2901
  # @return [Array<String>]
1748
2902
  #
1749
- # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/NotifyRecommendationsReceivedResponse AWS API Documentation
2903
+ # @!attribute [rw] content_type
2904
+ # The media type of the quick response content.
1750
2905
  #
1751
- class NotifyRecommendationsReceivedResponse < Struct.new(
1752
- :errors,
1753
- :recommendation_ids)
1754
- SENSITIVE = []
1755
- include Aws::Structure
1756
- end
1757
-
1758
- # The provided `revisionId` does not match, indicating the content has
1759
- # been modified since it was last read.
2906
+ # * Use `application/x.quickresponse;format=plain` for quick response
2907
+ # written in plain text.
1760
2908
  #
1761
- # @!attribute [rw] message
2909
+ # * Use `application/x.quickresponse;format=markdown` for quick
2910
+ # response written in richtext.
1762
2911
  # @return [String]
1763
2912
  #
1764
- # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/PreconditionFailedException AWS API Documentation
2913
+ # @!attribute [rw] created_time
2914
+ # The timestamp when the quick response was created.
2915
+ # @return [Time]
1765
2916
  #
1766
- class PreconditionFailedException < Struct.new(
1767
- :message)
1768
- SENSITIVE = []
1769
- include Aws::Structure
1770
- end
1771
-
1772
- # @!attribute [rw] assistant_id
1773
- # The identifier of the Wisdom assistant. Can be either the ID or the
1774
- # ARN. URLs cannot contain the ARN.
2917
+ # @!attribute [rw] description
2918
+ # The description of the quick response.
1775
2919
  # @return [String]
1776
2920
  #
1777
- # @!attribute [rw] max_results
1778
- # The maximum number of results to return per page.
1779
- # @return [Integer]
2921
+ # @!attribute [rw] is_active
2922
+ # Whether the quick response is active.
2923
+ # @return [Boolean]
1780
2924
  #
1781
- # @!attribute [rw] next_token
1782
- # The token for the next set of results. Use the value returned in the
1783
- # previous response in the next request to retrieve the next set of
1784
- # results.
2925
+ # @!attribute [rw] knowledge_base_arn
2926
+ # The Amazon Resource Name (ARN) of the knowledge base.
1785
2927
  # @return [String]
1786
2928
  #
1787
- # @!attribute [rw] query_text
1788
- # The text to search for.
2929
+ # @!attribute [rw] knowledge_base_id
2930
+ # The identifier of the knowledge base. This should not be a
2931
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
2932
+ # Content resource to it.
1789
2933
  # @return [String]
1790
2934
  #
1791
- # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QueryAssistantRequest AWS API Documentation
1792
- #
1793
- class QueryAssistantRequest < Struct.new(
1794
- :assistant_id,
1795
- :max_results,
1796
- :next_token,
1797
- :query_text)
1798
- SENSITIVE = [:query_text]
1799
- include Aws::Structure
1800
- end
1801
-
1802
- # @!attribute [rw] next_token
1803
- # If there are additional results, this is the token for the next set
1804
- # of results.
2935
+ # @!attribute [rw] last_modified_by
2936
+ # The Amazon Resource Name (ARN) of the user who last updated the
2937
+ # quick response data.
1805
2938
  # @return [String]
1806
2939
  #
1807
- # @!attribute [rw] results
1808
- # The results of the query.
1809
- # @return [Array<Types::ResultData>]
2940
+ # @!attribute [rw] last_modified_time
2941
+ # The timestamp when the quick response summary was last modified.
2942
+ # @return [Time]
1810
2943
  #
1811
- # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QueryAssistantResponse AWS API Documentation
2944
+ # @!attribute [rw] name
2945
+ # The name of the quick response.
2946
+ # @return [String]
1812
2947
  #
1813
- class QueryAssistantResponse < Struct.new(
1814
- :next_token,
1815
- :results)
1816
- SENSITIVE = []
1817
- include Aws::Structure
1818
- end
1819
-
1820
- # Data associated with the QUERY RecommendationTriggerType.
2948
+ # @!attribute [rw] quick_response_arn
2949
+ # The Amazon Resource Name (ARN) of the quick response.
2950
+ # @return [String]
1821
2951
  #
1822
- # @!attribute [rw] text
1823
- # The text associated with the recommendation trigger.
2952
+ # @!attribute [rw] quick_response_id
2953
+ # The identifier of the quick response.
1824
2954
  # @return [String]
1825
2955
  #
1826
- # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QueryRecommendationTriggerData AWS API Documentation
2956
+ # @!attribute [rw] status
2957
+ # The resource status of the quick response.
2958
+ # @return [String]
1827
2959
  #
1828
- class QueryRecommendationTriggerData < Struct.new(
1829
- :text)
1830
- SENSITIVE = [:text]
2960
+ # @!attribute [rw] tags
2961
+ # The tags used to organize, track, or control access for this
2962
+ # resource.
2963
+ # @return [Hash<String,String>]
2964
+ #
2965
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QuickResponseSummary AWS API Documentation
2966
+ #
2967
+ class QuickResponseSummary < Struct.new(
2968
+ :channels,
2969
+ :content_type,
2970
+ :created_time,
2971
+ :description,
2972
+ :is_active,
2973
+ :knowledge_base_arn,
2974
+ :knowledge_base_id,
2975
+ :last_modified_by,
2976
+ :last_modified_time,
2977
+ :name,
2978
+ :quick_response_arn,
2979
+ :quick_response_id,
2980
+ :status,
2981
+ :tags)
2982
+ SENSITIVE = []
1831
2983
  include Aws::Structure
1832
2984
  end
1833
2985
 
@@ -1929,8 +3081,10 @@ module Aws::ConnectWisdomService
1929
3081
  end
1930
3082
 
1931
3083
  # @!attribute [rw] knowledge_base_id
1932
- # The identifier of the knowledge base. Can be either the ID or the
1933
- # ARN. URLs cannot contain the ARN.
3084
+ # The identifier of the knowledge base. This should not be a
3085
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
3086
+ # Content resource to it. Can be either the ID or the ARN. URLs cannot
3087
+ # contain the ARN.
1934
3088
  # @return [String]
1935
3089
  #
1936
3090
  # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/RemoveKnowledgeBaseTemplateUriRequest AWS API Documentation
@@ -1977,6 +3131,22 @@ module Aws::ConnectWisdomService
1977
3131
  include Aws::Structure
1978
3132
  end
1979
3133
 
3134
+ # The request reached the service more than 15 minutes after the date
3135
+ # stamp on the request or more than 15 minutes after the request
3136
+ # expiration date (such as for pre-signed URLs), or the date stamp on
3137
+ # the request is more than 15 minutes in the future.
3138
+ #
3139
+ # @!attribute [rw] message
3140
+ # @return [String]
3141
+ #
3142
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/RequestTimeoutException AWS API Documentation
3143
+ #
3144
+ class RequestTimeoutException < Struct.new(
3145
+ :message)
3146
+ SENSITIVE = []
3147
+ include Aws::Structure
3148
+ end
3149
+
1980
3150
  # The specified resource does not exist.
1981
3151
  #
1982
3152
  # @!attribute [rw] message
@@ -2020,8 +3190,10 @@ module Aws::ConnectWisdomService
2020
3190
  end
2021
3191
 
2022
3192
  # @!attribute [rw] knowledge_base_id
2023
- # The identifier of the knowledge base. Can be either the ID or the
2024
- # ARN. URLs cannot contain the ARN.
3193
+ # The identifier of the knowledge base. This should not be a
3194
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
3195
+ # Content resource to it. Can be either the ID or the ARN. URLs cannot
3196
+ # contain the ARN.
2025
3197
  # @return [String]
2026
3198
  #
2027
3199
  # @!attribute [rw] max_results
@@ -2081,6 +3253,66 @@ module Aws::ConnectWisdomService
2081
3253
  include Aws::Structure
2082
3254
  end
2083
3255
 
3256
+ # @!attribute [rw] attributes
3257
+ # The [user-defined Amazon Connect contact attributes][1] to be
3258
+ # resolved when search results are returned.
3259
+ #
3260
+ #
3261
+ #
3262
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/connect-attrib-list.html#user-defined-attributes
3263
+ # @return [Hash<String,String>]
3264
+ #
3265
+ # @!attribute [rw] knowledge_base_id
3266
+ # The identifier of the knowledge base. This should be a
3267
+ # QUICK\_RESPONSES type knowledge base. Can be either the ID or the
3268
+ # ARN. URLs cannot contain the ARN.
3269
+ # @return [String]
3270
+ #
3271
+ # @!attribute [rw] max_results
3272
+ # The maximum number of results to return per page.
3273
+ # @return [Integer]
3274
+ #
3275
+ # @!attribute [rw] next_token
3276
+ # The token for the next set of results. Use the value returned in the
3277
+ # previous response in the next request to retrieve the next set of
3278
+ # results.
3279
+ # @return [String]
3280
+ #
3281
+ # @!attribute [rw] search_expression
3282
+ # The search expression for querying the quick response.
3283
+ # @return [Types::QuickResponseSearchExpression]
3284
+ #
3285
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/SearchQuickResponsesRequest AWS API Documentation
3286
+ #
3287
+ class SearchQuickResponsesRequest < Struct.new(
3288
+ :attributes,
3289
+ :knowledge_base_id,
3290
+ :max_results,
3291
+ :next_token,
3292
+ :search_expression)
3293
+ SENSITIVE = [:attributes]
3294
+ include Aws::Structure
3295
+ end
3296
+
3297
+ # @!attribute [rw] next_token
3298
+ # The token for the next set of results. Use the value returned in the
3299
+ # previous response in the next request to retrieve the next set of
3300
+ # results.
3301
+ # @return [String]
3302
+ #
3303
+ # @!attribute [rw] results
3304
+ # The results of the quick response search.
3305
+ # @return [Array<Types::QuickResponseSearchResultData>]
3306
+ #
3307
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/SearchQuickResponsesResponse AWS API Documentation
3308
+ #
3309
+ class SearchQuickResponsesResponse < Struct.new(
3310
+ :next_token,
3311
+ :results)
3312
+ SENSITIVE = []
3313
+ include Aws::Structure
3314
+ end
3315
+
2084
3316
  # @!attribute [rw] assistant_id
2085
3317
  # The identifier of the Wisdom assistant. Can be either the ID or the
2086
3318
  # ARN. URLs cannot contain the ARN.
@@ -2280,15 +3512,23 @@ module Aws::ConnectWisdomService
2280
3512
  # @return [String]
2281
3513
  #
2282
3514
  # @!attribute [rw] knowledge_base_id
2283
- # The identifier of the knowledge base. Can be either the ID or the
2284
- # ARN. URLs cannot contain the ARN.
3515
+ # The identifier of the knowledge base. This should not be a
3516
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
3517
+ # Content resource to it. Can be either the ID or the ARN. URLs cannot
3518
+ # contain the ARN.
2285
3519
  # @return [String]
2286
3520
  #
3521
+ # @!attribute [rw] presigned_url_time_to_live
3522
+ # The expected expiration time of the generated presigned URL,
3523
+ # specified in minutes.
3524
+ # @return [Integer]
3525
+ #
2287
3526
  # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/StartContentUploadRequest AWS API Documentation
2288
3527
  #
2289
3528
  class StartContentUploadRequest < Struct.new(
2290
3529
  :content_type,
2291
- :knowledge_base_id)
3530
+ :knowledge_base_id,
3531
+ :presigned_url_time_to_live)
2292
3532
  SENSITIVE = []
2293
3533
  include Aws::Structure
2294
3534
  end
@@ -2320,6 +3560,78 @@ module Aws::ConnectWisdomService
2320
3560
  include Aws::Structure
2321
3561
  end
2322
3562
 
3563
+ # @!attribute [rw] client_token
3564
+ # The tags used to organize, track, or control access for this
3565
+ # resource.
3566
+ #
3567
+ # **A suitable default value is auto-generated.** You should normally
3568
+ # not need to pass this option.
3569
+ # @return [String]
3570
+ #
3571
+ # @!attribute [rw] external_source_configuration
3572
+ # The configuration information of the external source that the
3573
+ # resource data are imported from.
3574
+ # @return [Types::ExternalSourceConfiguration]
3575
+ #
3576
+ # @!attribute [rw] import_job_type
3577
+ # The type of the import job.
3578
+ #
3579
+ # * For importing quick response resource, set the value to
3580
+ # `QUICK_RESPONSES`.
3581
+ #
3582
+ # ^
3583
+ # @return [String]
3584
+ #
3585
+ # @!attribute [rw] knowledge_base_id
3586
+ # The identifier of the knowledge base. This should not be a
3587
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
3588
+ # Content resource to it. Can be either the ID or the ARN. URLs cannot
3589
+ # contain the ARN.
3590
+ #
3591
+ # * For importing Wisdom quick responses, this should be a
3592
+ # `QUICK_RESPONSES` type knowledge base.
3593
+ #
3594
+ # ^
3595
+ # @return [String]
3596
+ #
3597
+ # @!attribute [rw] metadata
3598
+ # The metadata fields of the imported Wisdom resources.
3599
+ # @return [Hash<String,String>]
3600
+ #
3601
+ # @!attribute [rw] upload_id
3602
+ # A pointer to the uploaded asset. This value is returned by
3603
+ # [StartContentUpload][1].
3604
+ #
3605
+ #
3606
+ #
3607
+ # [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html
3608
+ # @return [String]
3609
+ #
3610
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/StartImportJobRequest AWS API Documentation
3611
+ #
3612
+ class StartImportJobRequest < Struct.new(
3613
+ :client_token,
3614
+ :external_source_configuration,
3615
+ :import_job_type,
3616
+ :knowledge_base_id,
3617
+ :metadata,
3618
+ :upload_id)
3619
+ SENSITIVE = []
3620
+ include Aws::Structure
3621
+ end
3622
+
3623
+ # @!attribute [rw] import_job
3624
+ # The import job.
3625
+ # @return [Types::ImportJobData]
3626
+ #
3627
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/StartImportJobResponse AWS API Documentation
3628
+ #
3629
+ class StartImportJobResponse < Struct.new(
3630
+ :import_job)
3631
+ SENSITIVE = []
3632
+ include Aws::Structure
3633
+ end
3634
+
2323
3635
  # @!attribute [rw] resource_arn
2324
3636
  # The Amazon Resource Name (ARN) of the resource.
2325
3637
  # @return [String]
@@ -2388,8 +3700,9 @@ module Aws::ConnectWisdomService
2388
3700
  # @return [String]
2389
3701
  #
2390
3702
  # @!attribute [rw] knowledge_base_id
2391
- # The identifier of the knowledge base. Can be either the ID or the
2392
- # ARN
3703
+ # The identifier of the knowledge base. This should not be a
3704
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
3705
+ # Content resource to it. Can be either the ID or the ARN
2393
3706
  # @return [String]
2394
3707
  #
2395
3708
  # @!attribute [rw] metadata
@@ -2460,8 +3773,10 @@ module Aws::ConnectWisdomService
2460
3773
  end
2461
3774
 
2462
3775
  # @!attribute [rw] knowledge_base_id
2463
- # The identifier of the knowledge base. Can be either the ID or the
2464
- # ARN. URLs cannot contain the ARN.
3776
+ # The identifier of the knowledge base. This should not be a
3777
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
3778
+ # Content resource to it. Can be either the ID or the ARN. URLs cannot
3779
+ # contain the ARN.
2465
3780
  # @return [String]
2466
3781
  #
2467
3782
  # @!attribute [rw] template_uri
@@ -2489,6 +3804,109 @@ module Aws::ConnectWisdomService
2489
3804
  include Aws::Structure
2490
3805
  end
2491
3806
 
3807
+ # @!attribute [rw] channels
3808
+ # The Amazon Connect contact channels this quick response applies to.
3809
+ # The supported contact channel types include `Chat`.
3810
+ # @return [Array<String>]
3811
+ #
3812
+ # @!attribute [rw] content
3813
+ # The updated content of the quick response.
3814
+ # @return [Types::QuickResponseDataProvider]
3815
+ #
3816
+ # @!attribute [rw] content_type
3817
+ # The media type of the quick response content.
3818
+ #
3819
+ # * Use `application/x.quickresponse;format=plain` for quick response
3820
+ # written in plain text.
3821
+ #
3822
+ # * Use `application/x.quickresponse;format=markdown` for quick
3823
+ # response written in richtext.
3824
+ # @return [String]
3825
+ #
3826
+ # @!attribute [rw] description
3827
+ # The updated description of the quick response.
3828
+ # @return [String]
3829
+ #
3830
+ # @!attribute [rw] grouping_configuration
3831
+ # The updated grouping configuration of the quick response.
3832
+ # @return [Types::GroupingConfiguration]
3833
+ #
3834
+ # @!attribute [rw] is_active
3835
+ # Whether the quick response is active.
3836
+ # @return [Boolean]
3837
+ #
3838
+ # @!attribute [rw] knowledge_base_id
3839
+ # The identifier of the knowledge base. This should not be a
3840
+ # QUICK\_RESPONSES type knowledge base if you're storing Wisdom
3841
+ # Content resource to it. Can be either the ID or the ARN. URLs cannot
3842
+ # contain the ARN.
3843
+ # @return [String]
3844
+ #
3845
+ # @!attribute [rw] language
3846
+ # The language code value for the language in which the quick response
3847
+ # is written. The supported language codes include `de_DE`, `en_US`,
3848
+ # `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`,
3849
+ # `zh_CN`, `zh_TW`
3850
+ # @return [String]
3851
+ #
3852
+ # @!attribute [rw] name
3853
+ # The name of the quick response.
3854
+ # @return [String]
3855
+ #
3856
+ # @!attribute [rw] quick_response_id
3857
+ # The identifier of the quick response.
3858
+ # @return [String]
3859
+ #
3860
+ # @!attribute [rw] remove_description
3861
+ # Whether to remove the description from the quick response.
3862
+ # @return [Boolean]
3863
+ #
3864
+ # @!attribute [rw] remove_grouping_configuration
3865
+ # Whether to remove the grouping configuration of the quick response.
3866
+ # @return [Boolean]
3867
+ #
3868
+ # @!attribute [rw] remove_shortcut_key
3869
+ # Whether to remove the shortcut key of the quick response.
3870
+ # @return [Boolean]
3871
+ #
3872
+ # @!attribute [rw] shortcut_key
3873
+ # The shortcut key of the quick response. The value should be unique
3874
+ # across the knowledge base.
3875
+ # @return [String]
3876
+ #
3877
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/UpdateQuickResponseRequest AWS API Documentation
3878
+ #
3879
+ class UpdateQuickResponseRequest < Struct.new(
3880
+ :channels,
3881
+ :content,
3882
+ :content_type,
3883
+ :description,
3884
+ :grouping_configuration,
3885
+ :is_active,
3886
+ :knowledge_base_id,
3887
+ :language,
3888
+ :name,
3889
+ :quick_response_id,
3890
+ :remove_description,
3891
+ :remove_grouping_configuration,
3892
+ :remove_shortcut_key,
3893
+ :shortcut_key)
3894
+ SENSITIVE = []
3895
+ include Aws::Structure
3896
+ end
3897
+
3898
+ # @!attribute [rw] quick_response
3899
+ # The quick response.
3900
+ # @return [Types::QuickResponseData]
3901
+ #
3902
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/UpdateQuickResponseResponse AWS API Documentation
3903
+ #
3904
+ class UpdateQuickResponseResponse < Struct.new(
3905
+ :quick_response)
3906
+ SENSITIVE = []
3907
+ include Aws::Structure
3908
+ end
3909
+
2492
3910
  # The input fails to satisfy the constraints specified by a service.
2493
3911
  #
2494
3912
  # @!attribute [rw] message