aws-sdk-qconnect 1.4.0 → 1.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-qconnect/client.rb +244 -120
- data/lib/aws-sdk-qconnect/client_api.rb +56 -0
- data/lib/aws-sdk-qconnect/endpoints.rb +14 -0
- data/lib/aws-sdk-qconnect/plugins/endpoints.rb +3 -0
- data/lib/aws-sdk-qconnect/types.rb +292 -188
- data/lib/aws-sdk-qconnect.rb +1 -1
- data/sig/client.rbs +762 -0
- data/sig/errors.rbs +42 -0
- data/sig/resource.rbs +79 -0
- data/sig/types.rbs +1217 -0
- data/sig/waiters.rbs +13 -0
- metadata +9 -4
@@ -416,13 +416,14 @@ module Aws::QConnect
|
|
416
416
|
# The customer managed key must have a policy that allows
|
417
417
|
# `kms:CreateGrant`, ` kms:DescribeKey`, `kms:Decrypt`, and
|
418
418
|
# `kms:GenerateDataKey*` permissions to the IAM identity using the key
|
419
|
-
# to invoke Amazon Q. To use Amazon Q with chat,
|
420
|
-
# also allow `kms:Decrypt`, `kms:GenerateDataKey*`,
|
421
|
-
# `kms:DescribeKey` permissions to the `connect.amazonaws.com`
|
422
|
-
# principal.
|
419
|
+
# to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat,
|
420
|
+
# the key policy must also allow `kms:Decrypt`, `kms:GenerateDataKey*`,
|
421
|
+
# and `kms:DescribeKey` permissions to the `connect.amazonaws.com`
|
422
|
+
# service principal.
|
423
423
|
#
|
424
424
|
# For more information about setting up a customer managed key for
|
425
|
-
# Amazon Q, see [Enable Amazon Q in Connect for your
|
425
|
+
# Amazon Q in Connect, see [Enable Amazon Q in Connect for your
|
426
|
+
# instance][1].
|
426
427
|
#
|
427
428
|
#
|
428
429
|
#
|
@@ -481,8 +482,8 @@ module Aws::QConnect
|
|
481
482
|
# knowledge base. An assistant can have only a single association.
|
482
483
|
#
|
483
484
|
# @option params [required, String] :assistant_id
|
484
|
-
# The identifier of the Amazon Q assistant. Can be either the
|
485
|
-
# ARN. URLs cannot contain the ARN.
|
485
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
486
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
486
487
|
#
|
487
488
|
# @option params [required, Types::AssistantAssociationInputData] :association
|
488
489
|
# The identifier of the associated resource.
|
@@ -545,7 +546,7 @@ module Aws::QConnect
|
|
545
546
|
req.send_request(options)
|
546
547
|
end
|
547
548
|
|
548
|
-
# Creates Amazon Q content. Before to calling this API, use
|
549
|
+
# Creates Amazon Q in Connect content. Before to calling this API, use
|
549
550
|
# [StartContentUpload][1] to upload an asset.
|
550
551
|
#
|
551
552
|
#
|
@@ -567,15 +568,14 @@ module Aws::QConnect
|
|
567
568
|
#
|
568
569
|
# @option params [required, String] :knowledge_base_id
|
569
570
|
# The identifier of the knowledge base. This should not be a
|
570
|
-
# QUICK\_RESPONSES type knowledge base
|
571
|
-
#
|
572
|
-
# contain the ARN.
|
571
|
+
# QUICK\_RESPONSES type knowledge base. Can be either the ID or the ARN.
|
572
|
+
# URLs cannot contain the ARN.
|
573
573
|
#
|
574
574
|
# @option params [Hash<String,String>] :metadata
|
575
575
|
# A key/value map to store attributes without affecting tagging or
|
576
576
|
# recommendations. For example, when synchronizing data between an
|
577
|
-
# external system and Amazon Q, you can store an external
|
578
|
-
# identifier as metadata to utilize for determining drift.
|
577
|
+
# external system and Amazon Q in Connect, you can store an external
|
578
|
+
# version identifier as metadata to utilize for determining drift.
|
579
579
|
#
|
580
580
|
# @option params [required, String] :name
|
581
581
|
# The name of the content. Each piece of content in a knowledge base
|
@@ -715,10 +715,12 @@ module Aws::QConnect
|
|
715
715
|
#
|
716
716
|
# This KMS key must have a policy that allows `kms:CreateGrant`,
|
717
717
|
# `kms:DescribeKey`, `kms:Decrypt`, and `kms:GenerateDataKey*`
|
718
|
-
# permissions to the IAM identity using the key to invoke Amazon Q
|
718
|
+
# permissions to the IAM identity using the key to invoke Amazon Q in
|
719
|
+
# Connect.
|
719
720
|
#
|
720
721
|
# For more information about setting up a customer managed key for
|
721
|
-
# Amazon Q, see [Enable Amazon Q in Connect for your
|
722
|
+
# Amazon Q in Connect, see [Enable Amazon Q in Connect for your
|
723
|
+
# instance][1].
|
722
724
|
#
|
723
725
|
#
|
724
726
|
#
|
@@ -785,7 +787,7 @@ module Aws::QConnect
|
|
785
787
|
req.send_request(options)
|
786
788
|
end
|
787
789
|
|
788
|
-
# Creates an Amazon Q quick response.
|
790
|
+
# Creates an Amazon Q in Connect quick response.
|
789
791
|
#
|
790
792
|
# @option params [Array<String>] :channels
|
791
793
|
# The Amazon Connect channels this quick response applies to.
|
@@ -826,10 +828,8 @@ module Aws::QConnect
|
|
826
828
|
# Whether the quick response is active.
|
827
829
|
#
|
828
830
|
# @option params [required, String] :knowledge_base_id
|
829
|
-
# The identifier of the knowledge base.
|
830
|
-
#
|
831
|
-
# Content resource to it. Can be either the ID or the ARN. URLs cannot
|
832
|
-
# contain the ARN.
|
831
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
832
|
+
# URLs cannot contain the ARN.
|
833
833
|
#
|
834
834
|
# @option params [String] :language
|
835
835
|
# The language code value for the language in which the quick response
|
@@ -911,12 +911,13 @@ module Aws::QConnect
|
|
911
911
|
end
|
912
912
|
|
913
913
|
# Creates a session. A session is a contextual container used for
|
914
|
-
# generating recommendations. Amazon Connect creates a new Amazon Q
|
915
|
-
# session for each contact on which Amazon Q is
|
914
|
+
# generating recommendations. Amazon Connect creates a new Amazon Q in
|
915
|
+
# Connect session for each contact on which Amazon Q in Connect is
|
916
|
+
# enabled.
|
916
917
|
#
|
917
918
|
# @option params [required, String] :assistant_id
|
918
|
-
# The identifier of the Amazon Q assistant. Can be either the
|
919
|
-
# ARN. URLs cannot contain the ARN.
|
919
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
920
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
920
921
|
#
|
921
922
|
# @option params [String] :client_token
|
922
923
|
# A unique, case-sensitive identifier that you provide to ensure the
|
@@ -937,6 +938,9 @@ module Aws::QConnect
|
|
937
938
|
# @option params [required, String] :name
|
938
939
|
# The name of the session.
|
939
940
|
#
|
941
|
+
# @option params [Types::TagFilter] :tag_filter
|
942
|
+
# An object that can be used to specify Tag conditions.
|
943
|
+
#
|
940
944
|
# @option params [Hash<String,String>] :tags
|
941
945
|
# The tags used to organize, track, or control access for this resource.
|
942
946
|
#
|
@@ -951,6 +955,32 @@ module Aws::QConnect
|
|
951
955
|
# client_token: "ClientToken",
|
952
956
|
# description: "Description",
|
953
957
|
# name: "Name", # required
|
958
|
+
# tag_filter: {
|
959
|
+
# and_conditions: [
|
960
|
+
# {
|
961
|
+
# key: "TagKey", # required
|
962
|
+
# value: "TagValue",
|
963
|
+
# },
|
964
|
+
# ],
|
965
|
+
# or_conditions: [
|
966
|
+
# {
|
967
|
+
# and_conditions: [
|
968
|
+
# {
|
969
|
+
# key: "TagKey", # required
|
970
|
+
# value: "TagValue",
|
971
|
+
# },
|
972
|
+
# ],
|
973
|
+
# tag_condition: {
|
974
|
+
# key: "TagKey", # required
|
975
|
+
# value: "TagValue",
|
976
|
+
# },
|
977
|
+
# },
|
978
|
+
# ],
|
979
|
+
# tag_condition: {
|
980
|
+
# key: "TagKey", # required
|
981
|
+
# value: "TagValue",
|
982
|
+
# },
|
983
|
+
# },
|
954
984
|
# tags: {
|
955
985
|
# "TagKey" => "TagValue",
|
956
986
|
# },
|
@@ -963,6 +993,17 @@ module Aws::QConnect
|
|
963
993
|
# resp.session.name #=> String
|
964
994
|
# resp.session.session_arn #=> String
|
965
995
|
# resp.session.session_id #=> String
|
996
|
+
# resp.session.tag_filter.and_conditions #=> Array
|
997
|
+
# resp.session.tag_filter.and_conditions[0].key #=> String
|
998
|
+
# resp.session.tag_filter.and_conditions[0].value #=> String
|
999
|
+
# resp.session.tag_filter.or_conditions #=> Array
|
1000
|
+
# resp.session.tag_filter.or_conditions[0].and_conditions #=> Array
|
1001
|
+
# resp.session.tag_filter.or_conditions[0].and_conditions[0].key #=> String
|
1002
|
+
# resp.session.tag_filter.or_conditions[0].and_conditions[0].value #=> String
|
1003
|
+
# resp.session.tag_filter.or_conditions[0].tag_condition.key #=> String
|
1004
|
+
# resp.session.tag_filter.or_conditions[0].tag_condition.value #=> String
|
1005
|
+
# resp.session.tag_filter.tag_condition.key #=> String
|
1006
|
+
# resp.session.tag_filter.tag_condition.value #=> String
|
966
1007
|
# resp.session.tags #=> Hash
|
967
1008
|
# resp.session.tags["TagKey"] #=> String
|
968
1009
|
#
|
@@ -978,8 +1019,8 @@ module Aws::QConnect
|
|
978
1019
|
# Deletes an assistant.
|
979
1020
|
#
|
980
1021
|
# @option params [required, String] :assistant_id
|
981
|
-
# The identifier of the Amazon Q assistant. Can be either the
|
982
|
-
# ARN. URLs cannot contain the ARN.
|
1022
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
1023
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
983
1024
|
#
|
984
1025
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
985
1026
|
#
|
@@ -1005,8 +1046,8 @@ module Aws::QConnect
|
|
1005
1046
|
# the ARN. URLs cannot contain the ARN.
|
1006
1047
|
#
|
1007
1048
|
# @option params [required, String] :assistant_id
|
1008
|
-
# The identifier of the Amazon Q assistant. Can be either the
|
1009
|
-
# ARN. URLs cannot contain the ARN.
|
1049
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
1050
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
1010
1051
|
#
|
1011
1052
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1012
1053
|
#
|
@@ -1033,10 +1074,8 @@ module Aws::QConnect
|
|
1033
1074
|
# cannot contain the ARN.
|
1034
1075
|
#
|
1035
1076
|
# @option params [required, String] :knowledge_base_id
|
1036
|
-
# The identifier of the knowledge base.
|
1037
|
-
#
|
1038
|
-
# Content resource to it. Can be either the ID or the ARN. URLs cannot
|
1039
|
-
# contain the ARN.
|
1077
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
1078
|
+
# URLs cannot contain the ARN.
|
1040
1079
|
#
|
1041
1080
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1042
1081
|
#
|
@@ -1062,9 +1101,7 @@ module Aws::QConnect
|
|
1062
1101
|
# The identifier of the import job to be deleted.
|
1063
1102
|
#
|
1064
1103
|
# @option params [required, String] :knowledge_base_id
|
1065
|
-
# The identifier of the knowledge base.
|
1066
|
-
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
1067
|
-
# Content resource to it.
|
1104
|
+
# The identifier of the knowledge base.
|
1068
1105
|
#
|
1069
1106
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1070
1107
|
#
|
@@ -1127,9 +1164,7 @@ module Aws::QConnect
|
|
1127
1164
|
#
|
1128
1165
|
# @option params [required, String] :knowledge_base_id
|
1129
1166
|
# The knowledge base from which the quick response is deleted. The
|
1130
|
-
# identifier of the knowledge base.
|
1131
|
-
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
1132
|
-
# Content resource to it.
|
1167
|
+
# identifier of the knowledge base.
|
1133
1168
|
#
|
1134
1169
|
# @option params [required, String] :quick_response_id
|
1135
1170
|
# The identifier of the quick response to delete.
|
@@ -1155,8 +1190,8 @@ module Aws::QConnect
|
|
1155
1190
|
# Retrieves information about an assistant.
|
1156
1191
|
#
|
1157
1192
|
# @option params [required, String] :assistant_id
|
1158
|
-
# The identifier of the Amazon Q assistant. Can be either the
|
1159
|
-
# ARN. URLs cannot contain the ARN.
|
1193
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
1194
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
1160
1195
|
#
|
1161
1196
|
# @return [Types::GetAssistantResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1162
1197
|
#
|
@@ -1198,8 +1233,8 @@ module Aws::QConnect
|
|
1198
1233
|
# the ARN. URLs cannot contain the ARN.
|
1199
1234
|
#
|
1200
1235
|
# @option params [required, String] :assistant_id
|
1201
|
-
# The identifier of the Amazon Q assistant. Can be either the
|
1202
|
-
# ARN. URLs cannot contain the ARN.
|
1236
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
1237
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
1203
1238
|
#
|
1204
1239
|
# @return [Types::GetAssistantAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1205
1240
|
#
|
@@ -1241,9 +1276,8 @@ module Aws::QConnect
|
|
1241
1276
|
#
|
1242
1277
|
# @option params [required, String] :knowledge_base_id
|
1243
1278
|
# The identifier of the knowledge base. This should not be a
|
1244
|
-
# QUICK\_RESPONSES type knowledge base
|
1245
|
-
#
|
1246
|
-
# contain the ARN.
|
1279
|
+
# QUICK\_RESPONSES type knowledge base. Can be either the ID or the ARN.
|
1280
|
+
# URLs cannot contain the ARN.
|
1247
1281
|
#
|
1248
1282
|
# @return [Types::GetContentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1249
1283
|
#
|
@@ -1291,10 +1325,8 @@ module Aws::QConnect
|
|
1291
1325
|
# cannot contain the ARN.
|
1292
1326
|
#
|
1293
1327
|
# @option params [required, String] :knowledge_base_id
|
1294
|
-
# The identifier of the knowledge base.
|
1295
|
-
#
|
1296
|
-
# Content resource to it. Can be either the ID or the ARN. URLs cannot
|
1297
|
-
# contain the ARN.
|
1328
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
1329
|
+
# URLs cannot contain the ARN.
|
1298
1330
|
#
|
1299
1331
|
# @return [Types::GetContentSummaryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1300
1332
|
#
|
@@ -1381,10 +1413,8 @@ module Aws::QConnect
|
|
1381
1413
|
# Retrieves information about the knowledge base.
|
1382
1414
|
#
|
1383
1415
|
# @option params [required, String] :knowledge_base_id
|
1384
|
-
# The identifier of the knowledge base.
|
1385
|
-
#
|
1386
|
-
# Content resource to it. Can be either the ID or the ARN. URLs cannot
|
1387
|
-
# contain the ARN.
|
1416
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
1417
|
+
# URLs cannot contain the ARN.
|
1388
1418
|
#
|
1389
1419
|
# @return [Types::GetKnowledgeBaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1390
1420
|
#
|
@@ -1477,6 +1507,12 @@ module Aws::QConnect
|
|
1477
1507
|
req.send_request(options)
|
1478
1508
|
end
|
1479
1509
|
|
1510
|
+
# This API will be discontinued starting June 1, 2024. To receive
|
1511
|
+
# generative responses after March 1, 2024, you will need to create a
|
1512
|
+
# new Assistant in the Amazon Connect console and integrate the Amazon Q
|
1513
|
+
# in Connect JavaScript library (amazon-q-connectjs) into your
|
1514
|
+
# applications.
|
1515
|
+
#
|
1480
1516
|
# Retrieves recommendations for the specified session. To avoid
|
1481
1517
|
# retrieving the same recommendations in subsequent calls, use
|
1482
1518
|
# [NotifyRecommendationsReceived][1]. This API supports long-polling
|
@@ -1491,8 +1527,8 @@ module Aws::QConnect
|
|
1491
1527
|
# [2]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_QueryAssistant.html
|
1492
1528
|
#
|
1493
1529
|
# @option params [required, String] :assistant_id
|
1494
|
-
# The identifier of the Amazon Q assistant. Can be either the
|
1495
|
-
# ARN. URLs cannot contain the ARN.
|
1530
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
1531
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
1496
1532
|
#
|
1497
1533
|
# @option params [Integer] :max_results
|
1498
1534
|
# The maximum number of results to return per page.
|
@@ -1594,8 +1630,8 @@ module Aws::QConnect
|
|
1594
1630
|
# Retrieves information for a specified session.
|
1595
1631
|
#
|
1596
1632
|
# @option params [required, String] :assistant_id
|
1597
|
-
# The identifier of the Amazon Q assistant. Can be either the
|
1598
|
-
# ARN. URLs cannot contain the ARN.
|
1633
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
1634
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
1599
1635
|
#
|
1600
1636
|
# @option params [required, String] :session_id
|
1601
1637
|
# The identifier of the session. Can be either the ID or the ARN. URLs
|
@@ -1619,6 +1655,17 @@ module Aws::QConnect
|
|
1619
1655
|
# resp.session.name #=> String
|
1620
1656
|
# resp.session.session_arn #=> String
|
1621
1657
|
# resp.session.session_id #=> String
|
1658
|
+
# resp.session.tag_filter.and_conditions #=> Array
|
1659
|
+
# resp.session.tag_filter.and_conditions[0].key #=> String
|
1660
|
+
# resp.session.tag_filter.and_conditions[0].value #=> String
|
1661
|
+
# resp.session.tag_filter.or_conditions #=> Array
|
1662
|
+
# resp.session.tag_filter.or_conditions[0].and_conditions #=> Array
|
1663
|
+
# resp.session.tag_filter.or_conditions[0].and_conditions[0].key #=> String
|
1664
|
+
# resp.session.tag_filter.or_conditions[0].and_conditions[0].value #=> String
|
1665
|
+
# resp.session.tag_filter.or_conditions[0].tag_condition.key #=> String
|
1666
|
+
# resp.session.tag_filter.or_conditions[0].tag_condition.value #=> String
|
1667
|
+
# resp.session.tag_filter.tag_condition.key #=> String
|
1668
|
+
# resp.session.tag_filter.tag_condition.value #=> String
|
1622
1669
|
# resp.session.tags #=> Hash
|
1623
1670
|
# resp.session.tags["TagKey"] #=> String
|
1624
1671
|
#
|
@@ -1634,8 +1681,8 @@ module Aws::QConnect
|
|
1634
1681
|
# Lists information about assistant associations.
|
1635
1682
|
#
|
1636
1683
|
# @option params [required, String] :assistant_id
|
1637
|
-
# The identifier of the Amazon Q assistant. Can be either the
|
1638
|
-
# ARN. URLs cannot contain the ARN.
|
1684
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
1685
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
1639
1686
|
#
|
1640
1687
|
# @option params [Integer] :max_results
|
1641
1688
|
# The maximum number of results to return per page.
|
@@ -1736,9 +1783,8 @@ module Aws::QConnect
|
|
1736
1783
|
#
|
1737
1784
|
# @option params [required, String] :knowledge_base_id
|
1738
1785
|
# The identifier of the knowledge base. This should not be a
|
1739
|
-
# QUICK\_RESPONSES type knowledge base
|
1740
|
-
#
|
1741
|
-
# contain the ARN.
|
1786
|
+
# QUICK\_RESPONSES type knowledge base. Can be either the ID or the ARN.
|
1787
|
+
# URLs cannot contain the ARN.
|
1742
1788
|
#
|
1743
1789
|
# @option params [Integer] :max_results
|
1744
1790
|
# The maximum number of results to return per page.
|
@@ -1793,10 +1839,8 @@ module Aws::QConnect
|
|
1793
1839
|
# Lists information about import jobs.
|
1794
1840
|
#
|
1795
1841
|
# @option params [required, String] :knowledge_base_id
|
1796
|
-
# The identifier of the knowledge base.
|
1797
|
-
#
|
1798
|
-
# Content resource to it. Can be either the ID or the ARN. URLs cannot
|
1799
|
-
# contain the ARN.
|
1842
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
1843
|
+
# URLs cannot contain the ARN.
|
1800
1844
|
#
|
1801
1845
|
# @option params [Integer] :max_results
|
1802
1846
|
# The maximum number of results to return per page.
|
@@ -1901,10 +1945,8 @@ module Aws::QConnect
|
|
1901
1945
|
# Lists information about quick response.
|
1902
1946
|
#
|
1903
1947
|
# @option params [required, String] :knowledge_base_id
|
1904
|
-
# The identifier of the knowledge base.
|
1905
|
-
#
|
1906
|
-
# Content resource to it. Can be either the ID or the ARN. URLs cannot
|
1907
|
-
# contain the ARN.
|
1948
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
1949
|
+
# URLs cannot contain the ARN.
|
1908
1950
|
#
|
1909
1951
|
# @option params [Integer] :max_results
|
1910
1952
|
# The maximum number of results to return per page.
|
@@ -1998,8 +2040,8 @@ module Aws::QConnect
|
|
1998
2040
|
# [1]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetRecommendations.html
|
1999
2041
|
#
|
2000
2042
|
# @option params [required, String] :assistant_id
|
2001
|
-
# The identifier of the Amazon Q assistant. Can be either the
|
2002
|
-
# ARN. URLs cannot contain the ARN.
|
2043
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
2044
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
2003
2045
|
#
|
2004
2046
|
# @option params [required, Array<String>] :recommendation_ids
|
2005
2047
|
# The identifiers of the recommendations.
|
@@ -2042,7 +2084,7 @@ module Aws::QConnect
|
|
2042
2084
|
# target. This API only supports generative targets.
|
2043
2085
|
#
|
2044
2086
|
# @option params [required, String] :assistant_id
|
2045
|
-
# The identifier of the Amazon Q assistant.
|
2087
|
+
# The identifier of the Amazon Q in Connect assistant.
|
2046
2088
|
#
|
2047
2089
|
# @option params [required, Types::ContentFeedbackData] :content_feedback
|
2048
2090
|
# Information about the feedback provided.
|
@@ -2091,6 +2133,12 @@ module Aws::QConnect
|
|
2091
2133
|
req.send_request(options)
|
2092
2134
|
end
|
2093
2135
|
|
2136
|
+
# This API will be discontinued starting June 1, 2024. To receive
|
2137
|
+
# generative responses after March 1, 2024, you will need to create a
|
2138
|
+
# new Assistant in the Amazon Connect console and integrate the Amazon Q
|
2139
|
+
# in Connect JavaScript library (amazon-q-connectjs) into your
|
2140
|
+
# applications.
|
2141
|
+
#
|
2094
2142
|
# Performs a manual search against the specified assistant. To retrieve
|
2095
2143
|
# recommendations for an assistant, use [GetRecommendations][1].
|
2096
2144
|
#
|
@@ -2099,8 +2147,8 @@ module Aws::QConnect
|
|
2099
2147
|
# [1]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetRecommendations.html
|
2100
2148
|
#
|
2101
2149
|
# @option params [required, String] :assistant_id
|
2102
|
-
# The identifier of the Amazon Q assistant. Can be either the
|
2103
|
-
# ARN. URLs cannot contain the ARN.
|
2150
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
2151
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
2104
2152
|
#
|
2105
2153
|
# @option params [Integer] :max_results
|
2106
2154
|
# The maximum number of results to return per page.
|
@@ -2117,8 +2165,8 @@ module Aws::QConnect
|
|
2117
2165
|
# The text to search for.
|
2118
2166
|
#
|
2119
2167
|
# @option params [String] :session_id
|
2120
|
-
# The identifier of the Amazon Q session. Can be either the
|
2121
|
-
# ARN. URLs cannot contain the ARN.
|
2168
|
+
# The identifier of the Amazon Q in Connect session. Can be either the
|
2169
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
2122
2170
|
#
|
2123
2171
|
# @return [Types::QueryAssistantResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2124
2172
|
#
|
@@ -2211,10 +2259,8 @@ module Aws::QConnect
|
|
2211
2259
|
# Removes a URI template from a knowledge base.
|
2212
2260
|
#
|
2213
2261
|
# @option params [required, String] :knowledge_base_id
|
2214
|
-
# The identifier of the knowledge base.
|
2215
|
-
#
|
2216
|
-
# Content resource to it. Can be either the ID or the ARN. URLs cannot
|
2217
|
-
# contain the ARN.
|
2262
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
2263
|
+
# URLs cannot contain the ARN.
|
2218
2264
|
#
|
2219
2265
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2220
2266
|
#
|
@@ -2238,9 +2284,8 @@ module Aws::QConnect
|
|
2238
2284
|
#
|
2239
2285
|
# @option params [required, String] :knowledge_base_id
|
2240
2286
|
# The identifier of the knowledge base. This should not be a
|
2241
|
-
# QUICK\_RESPONSES type knowledge base
|
2242
|
-
#
|
2243
|
-
# contain the ARN.
|
2287
|
+
# QUICK\_RESPONSES type knowledge base. Can be either the ID or the ARN.
|
2288
|
+
# URLs cannot contain the ARN.
|
2244
2289
|
#
|
2245
2290
|
# @option params [Integer] :max_results
|
2246
2291
|
# The maximum number of results to return per page.
|
@@ -2304,8 +2349,8 @@ module Aws::QConnect
|
|
2304
2349
|
req.send_request(options)
|
2305
2350
|
end
|
2306
2351
|
|
2307
|
-
# Searches existing Amazon Q quick responses in an Amazon Q
|
2308
|
-
# base.
|
2352
|
+
# Searches existing Amazon Q in Connect quick responses in an Amazon Q
|
2353
|
+
# in Connect knowledge base.
|
2309
2354
|
#
|
2310
2355
|
# @option params [Hash<String,String>] :attributes
|
2311
2356
|
# The [user-defined Amazon Connect contact attributes][1] to be resolved
|
@@ -2416,8 +2461,8 @@ module Aws::QConnect
|
|
2416
2461
|
# Searches for sessions.
|
2417
2462
|
#
|
2418
2463
|
# @option params [required, String] :assistant_id
|
2419
|
-
# The identifier of the Amazon Q assistant. Can be either the
|
2420
|
-
# ARN. URLs cannot contain the ARN.
|
2464
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
2465
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
2421
2466
|
#
|
2422
2467
|
# @option params [Integer] :max_results
|
2423
2468
|
# The maximum number of results to return per page.
|
@@ -2488,10 +2533,8 @@ module Aws::QConnect
|
|
2488
2533
|
# The type of content to upload.
|
2489
2534
|
#
|
2490
2535
|
# @option params [required, String] :knowledge_base_id
|
2491
|
-
# The identifier of the knowledge base.
|
2492
|
-
#
|
2493
|
-
# Content resource to it. Can be either the ID or the ARN. URLs cannot
|
2494
|
-
# contain the ARN.
|
2536
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
2537
|
+
# URLs cannot contain the ARN.
|
2495
2538
|
#
|
2496
2539
|
# @option params [Integer] :presigned_url_time_to_live
|
2497
2540
|
# The expected expiration time of the generated presigned URL, specified
|
@@ -2529,15 +2572,15 @@ module Aws::QConnect
|
|
2529
2572
|
req.send_request(options)
|
2530
2573
|
end
|
2531
2574
|
|
2532
|
-
# Start an asynchronous job to import Amazon Q resources from
|
2533
|
-
# uploaded source file. Before calling this API, use
|
2575
|
+
# Start an asynchronous job to import Amazon Q in Connect resources from
|
2576
|
+
# an uploaded source file. Before calling this API, use
|
2534
2577
|
# [StartContentUpload][1] to upload an asset that contains the resource
|
2535
2578
|
# data.
|
2536
2579
|
#
|
2537
|
-
# * For importing Amazon Q quick responses, you need to
|
2538
|
-
# file including the quick responses. For information
|
2539
|
-
# format the csv file for importing quick responses, see
|
2540
|
-
# responses][2].
|
2580
|
+
# * For importing Amazon Q in Connect quick responses, you need to
|
2581
|
+
# upload a csv file including the quick responses. For information
|
2582
|
+
# about how to format the csv file for importing quick responses, see
|
2583
|
+
# [Import quick responses][2].
|
2541
2584
|
#
|
2542
2585
|
# ^
|
2543
2586
|
#
|
@@ -2565,18 +2608,16 @@ module Aws::QConnect
|
|
2565
2608
|
# ^
|
2566
2609
|
#
|
2567
2610
|
# @option params [required, String] :knowledge_base_id
|
2568
|
-
# The identifier of the knowledge base.
|
2569
|
-
#
|
2570
|
-
# Content resource to it. Can be either the ID or the ARN. URLs cannot
|
2571
|
-
# contain the ARN.
|
2611
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
2612
|
+
# URLs cannot contain the ARN.
|
2572
2613
|
#
|
2573
|
-
# * For importing Amazon Q quick responses, this should be a
|
2614
|
+
# * For importing Amazon Q in Connect quick responses, this should be a
|
2574
2615
|
# `QUICK_RESPONSES` type knowledge base.
|
2575
2616
|
#
|
2576
2617
|
# ^
|
2577
2618
|
#
|
2578
2619
|
# @option params [Hash<String,String>] :metadata
|
2579
|
-
# The metadata fields of the imported Amazon Q resources.
|
2620
|
+
# The metadata fields of the imported Amazon Q in Connect resources.
|
2580
2621
|
#
|
2581
2622
|
# @option params [required, String] :upload_id
|
2582
2623
|
# A pointer to the uploaded asset. This value is returned by
|
@@ -2699,14 +2740,13 @@ module Aws::QConnect
|
|
2699
2740
|
#
|
2700
2741
|
# @option params [required, String] :knowledge_base_id
|
2701
2742
|
# The identifier of the knowledge base. This should not be a
|
2702
|
-
# QUICK\_RESPONSES type knowledge base
|
2703
|
-
# Content resource to it. Can be either the ID or the ARN
|
2743
|
+
# QUICK\_RESPONSES type knowledge base. Can be either the ID or the ARN
|
2704
2744
|
#
|
2705
2745
|
# @option params [Hash<String,String>] :metadata
|
2706
2746
|
# A key/value map to store attributes without affecting tagging or
|
2707
2747
|
# recommendations. For example, when synchronizing data between an
|
2708
|
-
# external system and Amazon Q, you can store an external
|
2709
|
-
# identifier as metadata to utilize for determining drift.
|
2748
|
+
# external system and Amazon Q in Connect, you can store an external
|
2749
|
+
# version identifier as metadata to utilize for determining drift.
|
2710
2750
|
#
|
2711
2751
|
# @option params [String] :override_link_out_uri
|
2712
2752
|
# The URI for the article. If the knowledge base has a templateUri,
|
@@ -2784,16 +2824,15 @@ module Aws::QConnect
|
|
2784
2824
|
|
2785
2825
|
# Updates the template URI of a knowledge base. This is only supported
|
2786
2826
|
# for knowledge bases of type EXTERNAL. Include a single variable in
|
2787
|
-
# `$\{variable\}` format; this interpolated by Amazon Q using
|
2788
|
-
# content. For example, if you ingest a Salesforce article, it
|
2789
|
-
# `Id` value, and you can set the template URI to
|
2827
|
+
# `$\{variable\}` format; this interpolated by Amazon Q in Connect using
|
2828
|
+
# ingested content. For example, if you ingest a Salesforce article, it
|
2829
|
+
# has an `Id` value, and you can set the template URI to
|
2790
2830
|
# `https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*$\{Id\}*/view`.
|
2791
2831
|
#
|
2792
2832
|
# @option params [required, String] :knowledge_base_id
|
2793
2833
|
# The identifier of the knowledge base. This should not be a
|
2794
|
-
# QUICK\_RESPONSES type knowledge base
|
2795
|
-
#
|
2796
|
-
# contain the ARN.
|
2834
|
+
# QUICK\_RESPONSES type knowledge base. Can be either the ID or the ARN.
|
2835
|
+
# URLs cannot contain the ARN.
|
2797
2836
|
#
|
2798
2837
|
# @option params [required, String] :template_uri
|
2799
2838
|
# The template URI to update.
|
@@ -2835,7 +2874,7 @@ module Aws::QConnect
|
|
2835
2874
|
req.send_request(options)
|
2836
2875
|
end
|
2837
2876
|
|
2838
|
-
# Updates an existing Amazon Q quick response.
|
2877
|
+
# Updates an existing Amazon Q in Connect quick response.
|
2839
2878
|
#
|
2840
2879
|
# @option params [Array<String>] :channels
|
2841
2880
|
# The Amazon Connect contact channels this quick response applies to.
|
@@ -2863,10 +2902,8 @@ module Aws::QConnect
|
|
2863
2902
|
# Whether the quick response is active.
|
2864
2903
|
#
|
2865
2904
|
# @option params [required, String] :knowledge_base_id
|
2866
|
-
# The identifier of the knowledge base.
|
2867
|
-
#
|
2868
|
-
# Content resource to it. Can be either the ID or the ARN. URLs cannot
|
2869
|
-
# contain the ARN.
|
2905
|
+
# The identifier of the knowledge base. Can be either the ID or the ARN.
|
2906
|
+
# URLs cannot contain the ARN.
|
2870
2907
|
#
|
2871
2908
|
# @option params [String] :language
|
2872
2909
|
# The language code value for the language in which the quick response
|
@@ -2956,6 +2993,93 @@ module Aws::QConnect
|
|
2956
2993
|
req.send_request(options)
|
2957
2994
|
end
|
2958
2995
|
|
2996
|
+
# Updates a session. A session is a contextual container used for
|
2997
|
+
# generating recommendations. Amazon Connect updates the existing Amazon
|
2998
|
+
# Q in Connect session for each contact on which Amazon Q in Connect is
|
2999
|
+
# enabled.
|
3000
|
+
#
|
3001
|
+
# @option params [required, String] :assistant_id
|
3002
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
3003
|
+
# ID or the ARN. URLs cannot contain the ARN.
|
3004
|
+
#
|
3005
|
+
# @option params [String] :description
|
3006
|
+
# The description.
|
3007
|
+
#
|
3008
|
+
# @option params [required, String] :session_id
|
3009
|
+
# The identifier of the session. Can be either the ID or the ARN. URLs
|
3010
|
+
# cannot contain the ARN.
|
3011
|
+
#
|
3012
|
+
# @option params [Types::TagFilter] :tag_filter
|
3013
|
+
# An object that can be used to specify Tag conditions.
|
3014
|
+
#
|
3015
|
+
# @return [Types::UpdateSessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3016
|
+
#
|
3017
|
+
# * {Types::UpdateSessionResponse#session #session} => Types::SessionData
|
3018
|
+
#
|
3019
|
+
# @example Request syntax with placeholder values
|
3020
|
+
#
|
3021
|
+
# resp = client.update_session({
|
3022
|
+
# assistant_id: "UuidOrArn", # required
|
3023
|
+
# description: "Description",
|
3024
|
+
# session_id: "UuidOrArn", # required
|
3025
|
+
# tag_filter: {
|
3026
|
+
# and_conditions: [
|
3027
|
+
# {
|
3028
|
+
# key: "TagKey", # required
|
3029
|
+
# value: "TagValue",
|
3030
|
+
# },
|
3031
|
+
# ],
|
3032
|
+
# or_conditions: [
|
3033
|
+
# {
|
3034
|
+
# and_conditions: [
|
3035
|
+
# {
|
3036
|
+
# key: "TagKey", # required
|
3037
|
+
# value: "TagValue",
|
3038
|
+
# },
|
3039
|
+
# ],
|
3040
|
+
# tag_condition: {
|
3041
|
+
# key: "TagKey", # required
|
3042
|
+
# value: "TagValue",
|
3043
|
+
# },
|
3044
|
+
# },
|
3045
|
+
# ],
|
3046
|
+
# tag_condition: {
|
3047
|
+
# key: "TagKey", # required
|
3048
|
+
# value: "TagValue",
|
3049
|
+
# },
|
3050
|
+
# },
|
3051
|
+
# })
|
3052
|
+
#
|
3053
|
+
# @example Response structure
|
3054
|
+
#
|
3055
|
+
# resp.session.description #=> String
|
3056
|
+
# resp.session.integration_configuration.topic_integration_arn #=> String
|
3057
|
+
# resp.session.name #=> String
|
3058
|
+
# resp.session.session_arn #=> String
|
3059
|
+
# resp.session.session_id #=> String
|
3060
|
+
# resp.session.tag_filter.and_conditions #=> Array
|
3061
|
+
# resp.session.tag_filter.and_conditions[0].key #=> String
|
3062
|
+
# resp.session.tag_filter.and_conditions[0].value #=> String
|
3063
|
+
# resp.session.tag_filter.or_conditions #=> Array
|
3064
|
+
# resp.session.tag_filter.or_conditions[0].and_conditions #=> Array
|
3065
|
+
# resp.session.tag_filter.or_conditions[0].and_conditions[0].key #=> String
|
3066
|
+
# resp.session.tag_filter.or_conditions[0].and_conditions[0].value #=> String
|
3067
|
+
# resp.session.tag_filter.or_conditions[0].tag_condition.key #=> String
|
3068
|
+
# resp.session.tag_filter.or_conditions[0].tag_condition.value #=> String
|
3069
|
+
# resp.session.tag_filter.tag_condition.key #=> String
|
3070
|
+
# resp.session.tag_filter.tag_condition.value #=> String
|
3071
|
+
# resp.session.tags #=> Hash
|
3072
|
+
# resp.session.tags["TagKey"] #=> String
|
3073
|
+
#
|
3074
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateSession AWS API Documentation
|
3075
|
+
#
|
3076
|
+
# @overload update_session(params = {})
|
3077
|
+
# @param [Hash] params ({})
|
3078
|
+
def update_session(params = {}, options = {})
|
3079
|
+
req = build_request(:update_session, params)
|
3080
|
+
req.send_request(options)
|
3081
|
+
end
|
3082
|
+
|
2959
3083
|
# @!endgroup
|
2960
3084
|
|
2961
3085
|
# @param params ({})
|
@@ -2969,7 +3093,7 @@ module Aws::QConnect
|
|
2969
3093
|
params: params,
|
2970
3094
|
config: config)
|
2971
3095
|
context[:gem_name] = 'aws-sdk-qconnect'
|
2972
|
-
context[:gem_version] = '1.
|
3096
|
+
context[:gem_version] = '1.6.0'
|
2973
3097
|
Seahorse::Client::Request.new(handlers, context)
|
2974
3098
|
end
|
2975
3099
|
|