aws-sdk-connectwisdomservice 1.22.0 → 1.23.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connectwisdomservice/client.rb +798 -33
- data/lib/aws-sdk-connectwisdomservice/client_api.rb +475 -0
- data/lib/aws-sdk-connectwisdomservice/endpoints.rb +140 -0
- data/lib/aws-sdk-connectwisdomservice/errors.rb +20 -0
- data/lib/aws-sdk-connectwisdomservice/plugins/endpoints.rb +20 -0
- data/lib/aws-sdk-connectwisdomservice/types.rb +1597 -179
- data/lib/aws-sdk-connectwisdomservice.rb +1 -1
- metadata +2 -2
@@ -414,9 +414,10 @@ module Aws::ConnectWisdomService
|
|
414
414
|
# encryption.
|
415
415
|
#
|
416
416
|
# The customer managed key must have a policy that allows
|
417
|
-
# `kms:CreateGrant
|
418
|
-
#
|
419
|
-
# key
|
417
|
+
# `kms:CreateGrant`, ` kms:DescribeKey`, and
|
418
|
+
# `kms:Decrypt/kms:GenerateDataKey` permissions to the IAM identity
|
419
|
+
# using the key to invoke Wisdom. To use Wisdom with chat, the key
|
420
|
+
# policy must also allow `kms:Decrypt`, `kms:GenerateDataKey*`, and
|
420
421
|
# `kms:DescribeKey` permissions to the `connect.amazonaws.com` service
|
421
422
|
# principal.
|
422
423
|
#
|
@@ -564,8 +565,10 @@ module Aws::ConnectWisdomService
|
|
564
565
|
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
565
566
|
#
|
566
567
|
# @option params [required, String] :knowledge_base_id
|
567
|
-
# The identifier of the knowledge base.
|
568
|
-
#
|
568
|
+
# The identifier of the knowledge base. This should not be a
|
569
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Wisdom Content
|
570
|
+
# resource to it. Can be either the ID or the ARN. URLs cannot contain
|
571
|
+
# the ARN.
|
569
572
|
#
|
570
573
|
# @option params [Hash<String,String>] :metadata
|
571
574
|
# A key/value map to store attributes without affecting tagging or
|
@@ -709,9 +712,9 @@ module Aws::ConnectWisdomService
|
|
709
712
|
# The configuration information for the customer managed key used for
|
710
713
|
# encryption.
|
711
714
|
#
|
712
|
-
# This KMS key must have a policy that allows `kms:CreateGrant
|
713
|
-
# `kms:DescribeKey` permissions
|
714
|
-
# invoke Wisdom.
|
715
|
+
# This KMS key must have a policy that allows `kms:CreateGrant`,
|
716
|
+
# `kms:DescribeKey`, and `kms:Decrypt/kms:GenerateDataKey` permissions
|
717
|
+
# to the IAM identity using the key to invoke Wisdom.
|
715
718
|
#
|
716
719
|
# For more information about setting up a customer managed key for
|
717
720
|
# Wisdom, see [Enable Amazon Connect Wisdom for your instance][1].
|
@@ -736,7 +739,7 @@ module Aws::ConnectWisdomService
|
|
736
739
|
# resp = client.create_knowledge_base({
|
737
740
|
# client_token: "NonEmptyString",
|
738
741
|
# description: "Description",
|
739
|
-
# knowledge_base_type: "EXTERNAL", # required, accepts EXTERNAL, CUSTOM
|
742
|
+
# knowledge_base_type: "EXTERNAL", # required, accepts EXTERNAL, CUSTOM, QUICK_RESPONSES
|
740
743
|
# name: "Name", # required
|
741
744
|
# rendering_configuration: {
|
742
745
|
# template_uri: "Uri",
|
@@ -760,7 +763,7 @@ module Aws::ConnectWisdomService
|
|
760
763
|
# resp.knowledge_base.description #=> String
|
761
764
|
# resp.knowledge_base.knowledge_base_arn #=> String
|
762
765
|
# resp.knowledge_base.knowledge_base_id #=> String
|
763
|
-
# resp.knowledge_base.knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM"
|
766
|
+
# resp.knowledge_base.knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM", "QUICK_RESPONSES"
|
764
767
|
# resp.knowledge_base.last_content_modification_time #=> Time
|
765
768
|
# resp.knowledge_base.name #=> String
|
766
769
|
# resp.knowledge_base.rendering_configuration.template_uri #=> String
|
@@ -781,6 +784,131 @@ module Aws::ConnectWisdomService
|
|
781
784
|
req.send_request(options)
|
782
785
|
end
|
783
786
|
|
787
|
+
# Creates a Wisdom quick response.
|
788
|
+
#
|
789
|
+
# @option params [Array<String>] :channels
|
790
|
+
# The Amazon Connect channels this quick response applies to.
|
791
|
+
#
|
792
|
+
# @option params [String] :client_token
|
793
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
794
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
795
|
+
# SDK populates this field. For more information about idempotency, see
|
796
|
+
# [Making retries safe with idempotent APIs][1].
|
797
|
+
#
|
798
|
+
# **A suitable default value is auto-generated.** You should normally
|
799
|
+
# not need to pass this option.**
|
800
|
+
#
|
801
|
+
#
|
802
|
+
#
|
803
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
804
|
+
#
|
805
|
+
# @option params [required, Types::QuickResponseDataProvider] :content
|
806
|
+
# The content of the quick response.
|
807
|
+
#
|
808
|
+
# @option params [String] :content_type
|
809
|
+
# The media type of the quick response content.
|
810
|
+
#
|
811
|
+
# * Use `application/x.quickresponse;format=plain` for a quick response
|
812
|
+
# written in plain text.
|
813
|
+
#
|
814
|
+
# * Use `application/x.quickresponse;format=markdown` for a quick
|
815
|
+
# response written in richtext.
|
816
|
+
#
|
817
|
+
# @option params [String] :description
|
818
|
+
# The description of the quick response.
|
819
|
+
#
|
820
|
+
# @option params [Types::GroupingConfiguration] :grouping_configuration
|
821
|
+
# The configuration information of the user groups that the quick
|
822
|
+
# response is accessible to.
|
823
|
+
#
|
824
|
+
# @option params [Boolean] :is_active
|
825
|
+
# Whether the quick response is active.
|
826
|
+
#
|
827
|
+
# @option params [required, String] :knowledge_base_id
|
828
|
+
# The identifier of the knowledge base. This should not be a
|
829
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Wisdom Content
|
830
|
+
# resource to it. Can be either the ID or the ARN. URLs cannot contain
|
831
|
+
# the ARN.
|
832
|
+
#
|
833
|
+
# @option params [String] :language
|
834
|
+
# The language code value for the language in which the quick response
|
835
|
+
# is written. The supported language codes include `de_DE`, `en_US`,
|
836
|
+
# `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`,
|
837
|
+
# `zh_CN`, `zh_TW`
|
838
|
+
#
|
839
|
+
# @option params [required, String] :name
|
840
|
+
# The name of the quick response.
|
841
|
+
#
|
842
|
+
# @option params [String] :shortcut_key
|
843
|
+
# The shortcut key of the quick response. The value should be unique
|
844
|
+
# across the knowledge base.
|
845
|
+
#
|
846
|
+
# @option params [Hash<String,String>] :tags
|
847
|
+
# The tags used to organize, track, or control access for this resource.
|
848
|
+
#
|
849
|
+
# @return [Types::CreateQuickResponseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
850
|
+
#
|
851
|
+
# * {Types::CreateQuickResponseResponse#quick_response #quick_response} => Types::QuickResponseData
|
852
|
+
#
|
853
|
+
# @example Request syntax with placeholder values
|
854
|
+
#
|
855
|
+
# resp = client.create_quick_response({
|
856
|
+
# channels: ["Channel"],
|
857
|
+
# client_token: "NonEmptyString",
|
858
|
+
# content: { # required
|
859
|
+
# content: "QuickResponseContent",
|
860
|
+
# },
|
861
|
+
# content_type: "QuickResponseType",
|
862
|
+
# description: "QuickResponseDescription",
|
863
|
+
# grouping_configuration: {
|
864
|
+
# criteria: "GroupingCriteria",
|
865
|
+
# values: ["GroupingValue"],
|
866
|
+
# },
|
867
|
+
# is_active: false,
|
868
|
+
# knowledge_base_id: "UuidOrArn", # required
|
869
|
+
# language: "LanguageCode",
|
870
|
+
# name: "QuickResponseName", # required
|
871
|
+
# shortcut_key: "ShortCutKey",
|
872
|
+
# tags: {
|
873
|
+
# "TagKey" => "TagValue",
|
874
|
+
# },
|
875
|
+
# })
|
876
|
+
#
|
877
|
+
# @example Response structure
|
878
|
+
#
|
879
|
+
# resp.quick_response.channels #=> Array
|
880
|
+
# resp.quick_response.channels[0] #=> String
|
881
|
+
# resp.quick_response.content_type #=> String
|
882
|
+
# resp.quick_response.contents.markdown.content #=> String
|
883
|
+
# resp.quick_response.contents.plain_text.content #=> String
|
884
|
+
# resp.quick_response.created_time #=> Time
|
885
|
+
# resp.quick_response.description #=> String
|
886
|
+
# resp.quick_response.grouping_configuration.criteria #=> String
|
887
|
+
# resp.quick_response.grouping_configuration.values #=> Array
|
888
|
+
# resp.quick_response.grouping_configuration.values[0] #=> String
|
889
|
+
# resp.quick_response.is_active #=> Boolean
|
890
|
+
# resp.quick_response.knowledge_base_arn #=> String
|
891
|
+
# resp.quick_response.knowledge_base_id #=> String
|
892
|
+
# resp.quick_response.language #=> String
|
893
|
+
# resp.quick_response.last_modified_by #=> String
|
894
|
+
# resp.quick_response.last_modified_time #=> Time
|
895
|
+
# resp.quick_response.name #=> String
|
896
|
+
# resp.quick_response.quick_response_arn #=> String
|
897
|
+
# resp.quick_response.quick_response_id #=> String
|
898
|
+
# resp.quick_response.shortcut_key #=> String
|
899
|
+
# resp.quick_response.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
|
900
|
+
# resp.quick_response.tags #=> Hash
|
901
|
+
# resp.quick_response.tags["TagKey"] #=> String
|
902
|
+
#
|
903
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateQuickResponse AWS API Documentation
|
904
|
+
#
|
905
|
+
# @overload create_quick_response(params = {})
|
906
|
+
# @param [Hash] params ({})
|
907
|
+
def create_quick_response(params = {}, options = {})
|
908
|
+
req = build_request(:create_quick_response, params)
|
909
|
+
req.send_request(options)
|
910
|
+
end
|
911
|
+
|
784
912
|
# Creates a session. A session is a contextual container used for
|
785
913
|
# generating recommendations. Amazon Connect creates a new Wisdom
|
786
914
|
# session for each contact on which Wisdom is enabled.
|
@@ -904,8 +1032,10 @@ module Aws::ConnectWisdomService
|
|
904
1032
|
# cannot contain the ARN.
|
905
1033
|
#
|
906
1034
|
# @option params [required, String] :knowledge_base_id
|
907
|
-
# The identifier of the knowledge base.
|
908
|
-
#
|
1035
|
+
# The identifier of the knowledge base. This should not be a
|
1036
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Wisdom Content
|
1037
|
+
# resource to it. Can be either the ID or the ARN. URLs cannot contain
|
1038
|
+
# the ARN.
|
909
1039
|
#
|
910
1040
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
911
1041
|
#
|
@@ -925,6 +1055,34 @@ module Aws::ConnectWisdomService
|
|
925
1055
|
req.send_request(options)
|
926
1056
|
end
|
927
1057
|
|
1058
|
+
# Deletes the quick response import job.
|
1059
|
+
#
|
1060
|
+
# @option params [required, String] :import_job_id
|
1061
|
+
# The identifier of the import job to be deleted.
|
1062
|
+
#
|
1063
|
+
# @option params [required, String] :knowledge_base_id
|
1064
|
+
# The identifier of the knowledge base. This should not be a
|
1065
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Wisdom Content
|
1066
|
+
# resource to it.
|
1067
|
+
#
|
1068
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1069
|
+
#
|
1070
|
+
# @example Request syntax with placeholder values
|
1071
|
+
#
|
1072
|
+
# resp = client.delete_import_job({
|
1073
|
+
# import_job_id: "Uuid", # required
|
1074
|
+
# knowledge_base_id: "UuidOrArn", # required
|
1075
|
+
# })
|
1076
|
+
#
|
1077
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteImportJob AWS API Documentation
|
1078
|
+
#
|
1079
|
+
# @overload delete_import_job(params = {})
|
1080
|
+
# @param [Hash] params ({})
|
1081
|
+
def delete_import_job(params = {}, options = {})
|
1082
|
+
req = build_request(:delete_import_job, params)
|
1083
|
+
req.send_request(options)
|
1084
|
+
end
|
1085
|
+
|
928
1086
|
# Deletes the knowledge base.
|
929
1087
|
#
|
930
1088
|
# <note markdown="1"> When you use this API to delete an external knowledge base such as
|
@@ -964,6 +1122,35 @@ module Aws::ConnectWisdomService
|
|
964
1122
|
req.send_request(options)
|
965
1123
|
end
|
966
1124
|
|
1125
|
+
# Deletes a quick response.
|
1126
|
+
#
|
1127
|
+
# @option params [required, String] :knowledge_base_id
|
1128
|
+
# The knowledge base from which the quick response is deleted. The
|
1129
|
+
# identifier of the knowledge base. This should not be a
|
1130
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Wisdom Content
|
1131
|
+
# resource to it.
|
1132
|
+
#
|
1133
|
+
# @option params [required, String] :quick_response_id
|
1134
|
+
# The identifier of the quick response to delete.
|
1135
|
+
#
|
1136
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1137
|
+
#
|
1138
|
+
# @example Request syntax with placeholder values
|
1139
|
+
#
|
1140
|
+
# resp = client.delete_quick_response({
|
1141
|
+
# knowledge_base_id: "UuidOrArn", # required
|
1142
|
+
# quick_response_id: "UuidOrArn", # required
|
1143
|
+
# })
|
1144
|
+
#
|
1145
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteQuickResponse AWS API Documentation
|
1146
|
+
#
|
1147
|
+
# @overload delete_quick_response(params = {})
|
1148
|
+
# @param [Hash] params ({})
|
1149
|
+
def delete_quick_response(params = {}, options = {})
|
1150
|
+
req = build_request(:delete_quick_response, params)
|
1151
|
+
req.send_request(options)
|
1152
|
+
end
|
1153
|
+
|
967
1154
|
# Retrieves information about an assistant.
|
968
1155
|
#
|
969
1156
|
# @option params [required, String] :assistant_id
|
@@ -1051,8 +1238,10 @@ module Aws::ConnectWisdomService
|
|
1051
1238
|
# cannot contain the ARN.
|
1052
1239
|
#
|
1053
1240
|
# @option params [required, String] :knowledge_base_id
|
1054
|
-
# The identifier of the knowledge base.
|
1055
|
-
#
|
1241
|
+
# The identifier of the knowledge base. This should not be a
|
1242
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Wisdom Content
|
1243
|
+
# resource to it. Can be either the ID or the ARN. URLs cannot contain
|
1244
|
+
# the ARN.
|
1056
1245
|
#
|
1057
1246
|
# @return [Types::GetContentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1058
1247
|
#
|
@@ -1100,8 +1289,10 @@ module Aws::ConnectWisdomService
|
|
1100
1289
|
# cannot contain the ARN.
|
1101
1290
|
#
|
1102
1291
|
# @option params [required, String] :knowledge_base_id
|
1103
|
-
# The identifier of the knowledge base.
|
1104
|
-
#
|
1292
|
+
# The identifier of the knowledge base. This should not be a
|
1293
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Wisdom Content
|
1294
|
+
# resource to it. Can be either the ID or the ARN. URLs cannot contain
|
1295
|
+
# the ARN.
|
1105
1296
|
#
|
1106
1297
|
# @return [Types::GetContentSummaryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1107
1298
|
#
|
@@ -1139,11 +1330,59 @@ module Aws::ConnectWisdomService
|
|
1139
1330
|
req.send_request(options)
|
1140
1331
|
end
|
1141
1332
|
|
1333
|
+
# Retrieves the started import job.
|
1334
|
+
#
|
1335
|
+
# @option params [required, String] :import_job_id
|
1336
|
+
# The identifier of the import job to retrieve.
|
1337
|
+
#
|
1338
|
+
# @option params [required, String] :knowledge_base_id
|
1339
|
+
# The identifier of the knowledge base that the import job belongs to.
|
1340
|
+
#
|
1341
|
+
# @return [Types::GetImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1342
|
+
#
|
1343
|
+
# * {Types::GetImportJobResponse#import_job #import_job} => Types::ImportJobData
|
1344
|
+
#
|
1345
|
+
# @example Request syntax with placeholder values
|
1346
|
+
#
|
1347
|
+
# resp = client.get_import_job({
|
1348
|
+
# import_job_id: "Uuid", # required
|
1349
|
+
# knowledge_base_id: "UuidOrArn", # required
|
1350
|
+
# })
|
1351
|
+
#
|
1352
|
+
# @example Response structure
|
1353
|
+
#
|
1354
|
+
# resp.import_job.created_time #=> Time
|
1355
|
+
# resp.import_job.external_source_configuration.configuration.connect_configuration.instance_id #=> String
|
1356
|
+
# resp.import_job.external_source_configuration.source #=> String, one of "AMAZON_CONNECT"
|
1357
|
+
# resp.import_job.failed_record_report #=> String
|
1358
|
+
# resp.import_job.import_job_id #=> String
|
1359
|
+
# resp.import_job.import_job_type #=> String, one of "QUICK_RESPONSES"
|
1360
|
+
# resp.import_job.knowledge_base_arn #=> String
|
1361
|
+
# resp.import_job.knowledge_base_id #=> String
|
1362
|
+
# resp.import_job.last_modified_time #=> Time
|
1363
|
+
# resp.import_job.metadata #=> Hash
|
1364
|
+
# resp.import_job.metadata["NonEmptyString"] #=> String
|
1365
|
+
# resp.import_job.status #=> String, one of "START_IN_PROGRESS", "FAILED", "COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
1366
|
+
# resp.import_job.upload_id #=> String
|
1367
|
+
# resp.import_job.url #=> String
|
1368
|
+
# resp.import_job.url_expiry #=> Time
|
1369
|
+
#
|
1370
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetImportJob AWS API Documentation
|
1371
|
+
#
|
1372
|
+
# @overload get_import_job(params = {})
|
1373
|
+
# @param [Hash] params ({})
|
1374
|
+
def get_import_job(params = {}, options = {})
|
1375
|
+
req = build_request(:get_import_job, params)
|
1376
|
+
req.send_request(options)
|
1377
|
+
end
|
1378
|
+
|
1142
1379
|
# Retrieves information about the knowledge base.
|
1143
1380
|
#
|
1144
1381
|
# @option params [required, String] :knowledge_base_id
|
1145
|
-
# The identifier of the knowledge base.
|
1146
|
-
#
|
1382
|
+
# The identifier of the knowledge base. This should not be a
|
1383
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Wisdom Content
|
1384
|
+
# resource to it. Can be either the ID or the ARN. URLs cannot contain
|
1385
|
+
# the ARN.
|
1147
1386
|
#
|
1148
1387
|
# @return [Types::GetKnowledgeBaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1149
1388
|
#
|
@@ -1160,7 +1399,7 @@ module Aws::ConnectWisdomService
|
|
1160
1399
|
# resp.knowledge_base.description #=> String
|
1161
1400
|
# resp.knowledge_base.knowledge_base_arn #=> String
|
1162
1401
|
# resp.knowledge_base.knowledge_base_id #=> String
|
1163
|
-
# resp.knowledge_base.knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM"
|
1402
|
+
# resp.knowledge_base.knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM", "QUICK_RESPONSES"
|
1164
1403
|
# resp.knowledge_base.last_content_modification_time #=> Time
|
1165
1404
|
# resp.knowledge_base.name #=> String
|
1166
1405
|
# resp.knowledge_base.rendering_configuration.template_uri #=> String
|
@@ -1181,6 +1420,61 @@ module Aws::ConnectWisdomService
|
|
1181
1420
|
req.send_request(options)
|
1182
1421
|
end
|
1183
1422
|
|
1423
|
+
# Retrieves the quick response.
|
1424
|
+
#
|
1425
|
+
# @option params [required, String] :knowledge_base_id
|
1426
|
+
# The identifier of the knowledge base. This should be a
|
1427
|
+
# QUICK\_RESPONSES type knowledge base.
|
1428
|
+
#
|
1429
|
+
# @option params [required, String] :quick_response_id
|
1430
|
+
# The identifier of the quick response.
|
1431
|
+
#
|
1432
|
+
# @return [Types::GetQuickResponseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1433
|
+
#
|
1434
|
+
# * {Types::GetQuickResponseResponse#quick_response #quick_response} => Types::QuickResponseData
|
1435
|
+
#
|
1436
|
+
# @example Request syntax with placeholder values
|
1437
|
+
#
|
1438
|
+
# resp = client.get_quick_response({
|
1439
|
+
# knowledge_base_id: "UuidOrArn", # required
|
1440
|
+
# quick_response_id: "UuidOrArn", # required
|
1441
|
+
# })
|
1442
|
+
#
|
1443
|
+
# @example Response structure
|
1444
|
+
#
|
1445
|
+
# resp.quick_response.channels #=> Array
|
1446
|
+
# resp.quick_response.channels[0] #=> String
|
1447
|
+
# resp.quick_response.content_type #=> String
|
1448
|
+
# resp.quick_response.contents.markdown.content #=> String
|
1449
|
+
# resp.quick_response.contents.plain_text.content #=> String
|
1450
|
+
# resp.quick_response.created_time #=> Time
|
1451
|
+
# resp.quick_response.description #=> String
|
1452
|
+
# resp.quick_response.grouping_configuration.criteria #=> String
|
1453
|
+
# resp.quick_response.grouping_configuration.values #=> Array
|
1454
|
+
# resp.quick_response.grouping_configuration.values[0] #=> String
|
1455
|
+
# resp.quick_response.is_active #=> Boolean
|
1456
|
+
# resp.quick_response.knowledge_base_arn #=> String
|
1457
|
+
# resp.quick_response.knowledge_base_id #=> String
|
1458
|
+
# resp.quick_response.language #=> String
|
1459
|
+
# resp.quick_response.last_modified_by #=> String
|
1460
|
+
# resp.quick_response.last_modified_time #=> Time
|
1461
|
+
# resp.quick_response.name #=> String
|
1462
|
+
# resp.quick_response.quick_response_arn #=> String
|
1463
|
+
# resp.quick_response.quick_response_id #=> String
|
1464
|
+
# resp.quick_response.shortcut_key #=> String
|
1465
|
+
# resp.quick_response.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
|
1466
|
+
# resp.quick_response.tags #=> Hash
|
1467
|
+
# resp.quick_response.tags["TagKey"] #=> String
|
1468
|
+
#
|
1469
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetQuickResponse AWS API Documentation
|
1470
|
+
#
|
1471
|
+
# @overload get_quick_response(params = {})
|
1472
|
+
# @param [Hash] params ({})
|
1473
|
+
def get_quick_response(params = {}, options = {})
|
1474
|
+
req = build_request(:get_quick_response, params)
|
1475
|
+
req.send_request(options)
|
1476
|
+
end
|
1477
|
+
|
1184
1478
|
# Retrieves recommendations for the specified session. To avoid
|
1185
1479
|
# retrieving the same recommendations in subsequent calls, use
|
1186
1480
|
# [NotifyRecommendationsReceived][1]. This API supports long-polling
|
@@ -1405,8 +1699,10 @@ module Aws::ConnectWisdomService
|
|
1405
1699
|
# Lists the content.
|
1406
1700
|
#
|
1407
1701
|
# @option params [required, String] :knowledge_base_id
|
1408
|
-
# The identifier of the knowledge base.
|
1409
|
-
#
|
1702
|
+
# The identifier of the knowledge base. This should not be a
|
1703
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Wisdom Content
|
1704
|
+
# resource to it. Can be either the ID or the ARN. URLs cannot contain
|
1705
|
+
# the ARN.
|
1410
1706
|
#
|
1411
1707
|
# @option params [Integer] :max_results
|
1412
1708
|
# The maximum number of results to return per page.
|
@@ -1458,6 +1754,63 @@ module Aws::ConnectWisdomService
|
|
1458
1754
|
req.send_request(options)
|
1459
1755
|
end
|
1460
1756
|
|
1757
|
+
# Lists information about import jobs.
|
1758
|
+
#
|
1759
|
+
# @option params [required, String] :knowledge_base_id
|
1760
|
+
# The identifier of the knowledge base. This should not be a
|
1761
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Wisdom Content
|
1762
|
+
# resource to it. Can be either the ID or the ARN. URLs cannot contain
|
1763
|
+
# the ARN.
|
1764
|
+
#
|
1765
|
+
# @option params [Integer] :max_results
|
1766
|
+
# The maximum number of results to return per page.
|
1767
|
+
#
|
1768
|
+
# @option params [String] :next_token
|
1769
|
+
# The token for the next set of results. Use the value returned in the
|
1770
|
+
# previous response in the next request to retrieve the next set of
|
1771
|
+
# results.
|
1772
|
+
#
|
1773
|
+
# @return [Types::ListImportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1774
|
+
#
|
1775
|
+
# * {Types::ListImportJobsResponse#import_job_summaries #import_job_summaries} => Array<Types::ImportJobSummary>
|
1776
|
+
# * {Types::ListImportJobsResponse#next_token #next_token} => String
|
1777
|
+
#
|
1778
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1779
|
+
#
|
1780
|
+
# @example Request syntax with placeholder values
|
1781
|
+
#
|
1782
|
+
# resp = client.list_import_jobs({
|
1783
|
+
# knowledge_base_id: "UuidOrArn", # required
|
1784
|
+
# max_results: 1,
|
1785
|
+
# next_token: "NonEmptyString",
|
1786
|
+
# })
|
1787
|
+
#
|
1788
|
+
# @example Response structure
|
1789
|
+
#
|
1790
|
+
# resp.import_job_summaries #=> Array
|
1791
|
+
# resp.import_job_summaries[0].created_time #=> Time
|
1792
|
+
# resp.import_job_summaries[0].external_source_configuration.configuration.connect_configuration.instance_id #=> String
|
1793
|
+
# resp.import_job_summaries[0].external_source_configuration.source #=> String, one of "AMAZON_CONNECT"
|
1794
|
+
# resp.import_job_summaries[0].import_job_id #=> String
|
1795
|
+
# resp.import_job_summaries[0].import_job_type #=> String, one of "QUICK_RESPONSES"
|
1796
|
+
# resp.import_job_summaries[0].knowledge_base_arn #=> String
|
1797
|
+
# resp.import_job_summaries[0].knowledge_base_id #=> String
|
1798
|
+
# resp.import_job_summaries[0].last_modified_time #=> Time
|
1799
|
+
# resp.import_job_summaries[0].metadata #=> Hash
|
1800
|
+
# resp.import_job_summaries[0].metadata["NonEmptyString"] #=> String
|
1801
|
+
# resp.import_job_summaries[0].status #=> String, one of "START_IN_PROGRESS", "FAILED", "COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
1802
|
+
# resp.import_job_summaries[0].upload_id #=> String
|
1803
|
+
# resp.next_token #=> String
|
1804
|
+
#
|
1805
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListImportJobs AWS API Documentation
|
1806
|
+
#
|
1807
|
+
# @overload list_import_jobs(params = {})
|
1808
|
+
# @param [Hash] params ({})
|
1809
|
+
def list_import_jobs(params = {}, options = {})
|
1810
|
+
req = build_request(:list_import_jobs, params)
|
1811
|
+
req.send_request(options)
|
1812
|
+
end
|
1813
|
+
|
1461
1814
|
# Lists the knowledge bases.
|
1462
1815
|
#
|
1463
1816
|
# @option params [Integer] :max_results
|
@@ -1488,7 +1841,7 @@ module Aws::ConnectWisdomService
|
|
1488
1841
|
# resp.knowledge_base_summaries[0].description #=> String
|
1489
1842
|
# resp.knowledge_base_summaries[0].knowledge_base_arn #=> String
|
1490
1843
|
# resp.knowledge_base_summaries[0].knowledge_base_id #=> String
|
1491
|
-
# resp.knowledge_base_summaries[0].knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM"
|
1844
|
+
# resp.knowledge_base_summaries[0].knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM", "QUICK_RESPONSES"
|
1492
1845
|
# resp.knowledge_base_summaries[0].name #=> String
|
1493
1846
|
# resp.knowledge_base_summaries[0].rendering_configuration.template_uri #=> String
|
1494
1847
|
# resp.knowledge_base_summaries[0].server_side_encryption_configuration.kms_key_id #=> String
|
@@ -1509,6 +1862,67 @@ module Aws::ConnectWisdomService
|
|
1509
1862
|
req.send_request(options)
|
1510
1863
|
end
|
1511
1864
|
|
1865
|
+
# Lists information about quick response.
|
1866
|
+
#
|
1867
|
+
# @option params [required, String] :knowledge_base_id
|
1868
|
+
# The identifier of the knowledge base. This should not be a
|
1869
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Wisdom Content
|
1870
|
+
# resource to it. Can be either the ID or the ARN. URLs cannot contain
|
1871
|
+
# the ARN.
|
1872
|
+
#
|
1873
|
+
# @option params [Integer] :max_results
|
1874
|
+
# The maximum number of results to return per page.
|
1875
|
+
#
|
1876
|
+
# @option params [String] :next_token
|
1877
|
+
# The token for the next set of results. Use the value returned in the
|
1878
|
+
# previous response in the next request to retrieve the next set of
|
1879
|
+
# results.
|
1880
|
+
#
|
1881
|
+
# @return [Types::ListQuickResponsesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1882
|
+
#
|
1883
|
+
# * {Types::ListQuickResponsesResponse#next_token #next_token} => String
|
1884
|
+
# * {Types::ListQuickResponsesResponse#quick_response_summaries #quick_response_summaries} => Array<Types::QuickResponseSummary>
|
1885
|
+
#
|
1886
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1887
|
+
#
|
1888
|
+
# @example Request syntax with placeholder values
|
1889
|
+
#
|
1890
|
+
# resp = client.list_quick_responses({
|
1891
|
+
# knowledge_base_id: "UuidOrArn", # required
|
1892
|
+
# max_results: 1,
|
1893
|
+
# next_token: "NonEmptyString",
|
1894
|
+
# })
|
1895
|
+
#
|
1896
|
+
# @example Response structure
|
1897
|
+
#
|
1898
|
+
# resp.next_token #=> String
|
1899
|
+
# resp.quick_response_summaries #=> Array
|
1900
|
+
# resp.quick_response_summaries[0].channels #=> Array
|
1901
|
+
# resp.quick_response_summaries[0].channels[0] #=> String
|
1902
|
+
# resp.quick_response_summaries[0].content_type #=> String
|
1903
|
+
# resp.quick_response_summaries[0].created_time #=> Time
|
1904
|
+
# resp.quick_response_summaries[0].description #=> String
|
1905
|
+
# resp.quick_response_summaries[0].is_active #=> Boolean
|
1906
|
+
# resp.quick_response_summaries[0].knowledge_base_arn #=> String
|
1907
|
+
# resp.quick_response_summaries[0].knowledge_base_id #=> String
|
1908
|
+
# resp.quick_response_summaries[0].last_modified_by #=> String
|
1909
|
+
# resp.quick_response_summaries[0].last_modified_time #=> Time
|
1910
|
+
# resp.quick_response_summaries[0].name #=> String
|
1911
|
+
# resp.quick_response_summaries[0].quick_response_arn #=> String
|
1912
|
+
# resp.quick_response_summaries[0].quick_response_id #=> String
|
1913
|
+
# resp.quick_response_summaries[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
|
1914
|
+
# resp.quick_response_summaries[0].tags #=> Hash
|
1915
|
+
# resp.quick_response_summaries[0].tags["TagKey"] #=> String
|
1916
|
+
#
|
1917
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListQuickResponses AWS API Documentation
|
1918
|
+
#
|
1919
|
+
# @overload list_quick_responses(params = {})
|
1920
|
+
# @param [Hash] params ({})
|
1921
|
+
def list_quick_responses(params = {}, options = {})
|
1922
|
+
req = build_request(:list_quick_responses, params)
|
1923
|
+
req.send_request(options)
|
1924
|
+
end
|
1925
|
+
|
1512
1926
|
# Lists the tags for the specified resource.
|
1513
1927
|
#
|
1514
1928
|
# @option params [required, String] :resource_arn
|
@@ -1657,8 +2071,10 @@ module Aws::ConnectWisdomService
|
|
1657
2071
|
# Removes a URI template from a knowledge base.
|
1658
2072
|
#
|
1659
2073
|
# @option params [required, String] :knowledge_base_id
|
1660
|
-
# The identifier of the knowledge base.
|
1661
|
-
#
|
2074
|
+
# The identifier of the knowledge base. This should not be a
|
2075
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Wisdom Content
|
2076
|
+
# resource to it. Can be either the ID or the ARN. URLs cannot contain
|
2077
|
+
# the ARN.
|
1662
2078
|
#
|
1663
2079
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1664
2080
|
#
|
@@ -1681,8 +2097,10 @@ module Aws::ConnectWisdomService
|
|
1681
2097
|
# a specific content resource by its name.
|
1682
2098
|
#
|
1683
2099
|
# @option params [required, String] :knowledge_base_id
|
1684
|
-
# The identifier of the knowledge base.
|
1685
|
-
#
|
2100
|
+
# The identifier of the knowledge base. This should not be a
|
2101
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Wisdom Content
|
2102
|
+
# resource to it. Can be either the ID or the ARN. URLs cannot contain
|
2103
|
+
# the ARN.
|
1686
2104
|
#
|
1687
2105
|
# @option params [Integer] :max_results
|
1688
2106
|
# The maximum number of results to return per page.
|
@@ -1746,6 +2164,114 @@ module Aws::ConnectWisdomService
|
|
1746
2164
|
req.send_request(options)
|
1747
2165
|
end
|
1748
2166
|
|
2167
|
+
# Searches existing Wisdom quick responses in a Wisdom knowledge base.
|
2168
|
+
#
|
2169
|
+
# @option params [Hash<String,String>] :attributes
|
2170
|
+
# The [user-defined Amazon Connect contact attributes][1] to be resolved
|
2171
|
+
# when search results are returned.
|
2172
|
+
#
|
2173
|
+
#
|
2174
|
+
#
|
2175
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/connect-attrib-list.html#user-defined-attributes
|
2176
|
+
#
|
2177
|
+
# @option params [required, String] :knowledge_base_id
|
2178
|
+
# The identifier of the knowledge base. This should be a
|
2179
|
+
# QUICK\_RESPONSES type knowledge base. Can be either the ID or the ARN.
|
2180
|
+
# URLs cannot contain the ARN.
|
2181
|
+
#
|
2182
|
+
# @option params [Integer] :max_results
|
2183
|
+
# The maximum number of results to return per page.
|
2184
|
+
#
|
2185
|
+
# @option params [String] :next_token
|
2186
|
+
# The token for the next set of results. Use the value returned in the
|
2187
|
+
# previous response in the next request to retrieve the next set of
|
2188
|
+
# results.
|
2189
|
+
#
|
2190
|
+
# @option params [required, Types::QuickResponseSearchExpression] :search_expression
|
2191
|
+
# The search expression for querying the quick response.
|
2192
|
+
#
|
2193
|
+
# @return [Types::SearchQuickResponsesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2194
|
+
#
|
2195
|
+
# * {Types::SearchQuickResponsesResponse#next_token #next_token} => String
|
2196
|
+
# * {Types::SearchQuickResponsesResponse#results #results} => Array<Types::QuickResponseSearchResultData>
|
2197
|
+
#
|
2198
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2199
|
+
#
|
2200
|
+
# @example Request syntax with placeholder values
|
2201
|
+
#
|
2202
|
+
# resp = client.search_quick_responses({
|
2203
|
+
# attributes: {
|
2204
|
+
# "ContactAttributeKey" => "ContactAttributeValue",
|
2205
|
+
# },
|
2206
|
+
# knowledge_base_id: "UuidOrArn", # required
|
2207
|
+
# max_results: 1,
|
2208
|
+
# next_token: "NonEmptyString",
|
2209
|
+
# search_expression: { # required
|
2210
|
+
# filters: [
|
2211
|
+
# {
|
2212
|
+
# include_no_existence: false,
|
2213
|
+
# name: "NonEmptyString", # required
|
2214
|
+
# operator: "EQUALS", # required, accepts EQUALS, PREFIX
|
2215
|
+
# values: ["QuickResponseFilterValue"],
|
2216
|
+
# },
|
2217
|
+
# ],
|
2218
|
+
# order_on_field: {
|
2219
|
+
# name: "NonEmptyString", # required
|
2220
|
+
# order: "ASC", # accepts ASC, DESC
|
2221
|
+
# },
|
2222
|
+
# queries: [
|
2223
|
+
# {
|
2224
|
+
# allow_fuzziness: false,
|
2225
|
+
# name: "NonEmptyString", # required
|
2226
|
+
# operator: "CONTAINS", # required, accepts CONTAINS, CONTAINS_AND_PREFIX
|
2227
|
+
# priority: "HIGH", # accepts HIGH, MEDIUM, LOW
|
2228
|
+
# values: ["QuickResponseQueryValue"], # required
|
2229
|
+
# },
|
2230
|
+
# ],
|
2231
|
+
# },
|
2232
|
+
# })
|
2233
|
+
#
|
2234
|
+
# @example Response structure
|
2235
|
+
#
|
2236
|
+
# resp.next_token #=> String
|
2237
|
+
# resp.results #=> Array
|
2238
|
+
# resp.results[0].attributes_interpolated #=> Array
|
2239
|
+
# resp.results[0].attributes_interpolated[0] #=> String
|
2240
|
+
# resp.results[0].attributes_not_interpolated #=> Array
|
2241
|
+
# resp.results[0].attributes_not_interpolated[0] #=> String
|
2242
|
+
# resp.results[0].channels #=> Array
|
2243
|
+
# resp.results[0].channels[0] #=> String
|
2244
|
+
# resp.results[0].content_type #=> String
|
2245
|
+
# resp.results[0].contents.markdown.content #=> String
|
2246
|
+
# resp.results[0].contents.plain_text.content #=> String
|
2247
|
+
# resp.results[0].created_time #=> Time
|
2248
|
+
# resp.results[0].description #=> String
|
2249
|
+
# resp.results[0].grouping_configuration.criteria #=> String
|
2250
|
+
# resp.results[0].grouping_configuration.values #=> Array
|
2251
|
+
# resp.results[0].grouping_configuration.values[0] #=> String
|
2252
|
+
# resp.results[0].is_active #=> Boolean
|
2253
|
+
# resp.results[0].knowledge_base_arn #=> String
|
2254
|
+
# resp.results[0].knowledge_base_id #=> String
|
2255
|
+
# resp.results[0].language #=> String
|
2256
|
+
# resp.results[0].last_modified_by #=> String
|
2257
|
+
# resp.results[0].last_modified_time #=> Time
|
2258
|
+
# resp.results[0].name #=> String
|
2259
|
+
# resp.results[0].quick_response_arn #=> String
|
2260
|
+
# resp.results[0].quick_response_id #=> String
|
2261
|
+
# resp.results[0].shortcut_key #=> String
|
2262
|
+
# resp.results[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
|
2263
|
+
# resp.results[0].tags #=> Hash
|
2264
|
+
# resp.results[0].tags["TagKey"] #=> String
|
2265
|
+
#
|
2266
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/SearchQuickResponses AWS API Documentation
|
2267
|
+
#
|
2268
|
+
# @overload search_quick_responses(params = {})
|
2269
|
+
# @param [Hash] params ({})
|
2270
|
+
def search_quick_responses(params = {}, options = {})
|
2271
|
+
req = build_request(:search_quick_responses, params)
|
2272
|
+
req.send_request(options)
|
2273
|
+
end
|
2274
|
+
|
1749
2275
|
# Searches for sessions.
|
1750
2276
|
#
|
1751
2277
|
# @option params [required, String] :assistant_id
|
@@ -1821,8 +2347,14 @@ module Aws::ConnectWisdomService
|
|
1821
2347
|
# The type of content to upload.
|
1822
2348
|
#
|
1823
2349
|
# @option params [required, String] :knowledge_base_id
|
1824
|
-
# The identifier of the knowledge base.
|
1825
|
-
#
|
2350
|
+
# The identifier of the knowledge base. This should not be a
|
2351
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Wisdom Content
|
2352
|
+
# resource to it. Can be either the ID or the ARN. URLs cannot contain
|
2353
|
+
# the ARN.
|
2354
|
+
#
|
2355
|
+
# @option params [Integer] :presigned_url_time_to_live
|
2356
|
+
# The expected expiration time of the generated presigned URL, specified
|
2357
|
+
# in minutes.
|
1826
2358
|
#
|
1827
2359
|
# @return [Types::StartContentUploadResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1828
2360
|
#
|
@@ -1836,6 +2368,7 @@ module Aws::ConnectWisdomService
|
|
1836
2368
|
# resp = client.start_content_upload({
|
1837
2369
|
# content_type: "ContentType", # required
|
1838
2370
|
# knowledge_base_id: "UuidOrArn", # required
|
2371
|
+
# presigned_url_time_to_live: 1,
|
1839
2372
|
# })
|
1840
2373
|
#
|
1841
2374
|
# @example Response structure
|
@@ -1855,6 +2388,113 @@ module Aws::ConnectWisdomService
|
|
1855
2388
|
req.send_request(options)
|
1856
2389
|
end
|
1857
2390
|
|
2391
|
+
# Start an asynchronous job to import Wisdom resources from an uploaded
|
2392
|
+
# source file. Before calling this API, use [StartContentUpload][1] to
|
2393
|
+
# upload an asset that contains the resource data.
|
2394
|
+
#
|
2395
|
+
# * For importing Wisdom quick responses, you need to upload a csv file
|
2396
|
+
# including the quick responses. For information about how to format
|
2397
|
+
# the csv file for importing quick responses, see [Import quick
|
2398
|
+
# responses][2].
|
2399
|
+
#
|
2400
|
+
# ^
|
2401
|
+
#
|
2402
|
+
#
|
2403
|
+
#
|
2404
|
+
# [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html
|
2405
|
+
# [2]: https://docs.aws.amazon.com/console/connect/quick-responses/add-data
|
2406
|
+
#
|
2407
|
+
# @option params [String] :client_token
|
2408
|
+
# The tags used to organize, track, or control access for this resource.
|
2409
|
+
#
|
2410
|
+
# **A suitable default value is auto-generated.** You should normally
|
2411
|
+
# not need to pass this option.**
|
2412
|
+
#
|
2413
|
+
# @option params [Types::ExternalSourceConfiguration] :external_source_configuration
|
2414
|
+
# The configuration information of the external source that the resource
|
2415
|
+
# data are imported from.
|
2416
|
+
#
|
2417
|
+
# @option params [required, String] :import_job_type
|
2418
|
+
# The type of the import job.
|
2419
|
+
#
|
2420
|
+
# * For importing quick response resource, set the value to
|
2421
|
+
# `QUICK_RESPONSES`.
|
2422
|
+
#
|
2423
|
+
# ^
|
2424
|
+
#
|
2425
|
+
# @option params [required, String] :knowledge_base_id
|
2426
|
+
# The identifier of the knowledge base. This should not be a
|
2427
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Wisdom Content
|
2428
|
+
# resource to it. Can be either the ID or the ARN. URLs cannot contain
|
2429
|
+
# the ARN.
|
2430
|
+
#
|
2431
|
+
# * For importing Wisdom quick responses, this should be a
|
2432
|
+
# `QUICK_RESPONSES` type knowledge base.
|
2433
|
+
#
|
2434
|
+
# ^
|
2435
|
+
#
|
2436
|
+
# @option params [Hash<String,String>] :metadata
|
2437
|
+
# The metadata fields of the imported Wisdom resources.
|
2438
|
+
#
|
2439
|
+
# @option params [required, String] :upload_id
|
2440
|
+
# A pointer to the uploaded asset. This value is returned by
|
2441
|
+
# [StartContentUpload][1].
|
2442
|
+
#
|
2443
|
+
#
|
2444
|
+
#
|
2445
|
+
# [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html
|
2446
|
+
#
|
2447
|
+
# @return [Types::StartImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2448
|
+
#
|
2449
|
+
# * {Types::StartImportJobResponse#import_job #import_job} => Types::ImportJobData
|
2450
|
+
#
|
2451
|
+
# @example Request syntax with placeholder values
|
2452
|
+
#
|
2453
|
+
# resp = client.start_import_job({
|
2454
|
+
# client_token: "NonEmptyString",
|
2455
|
+
# external_source_configuration: {
|
2456
|
+
# configuration: { # required
|
2457
|
+
# connect_configuration: {
|
2458
|
+
# instance_id: "NonEmptyString",
|
2459
|
+
# },
|
2460
|
+
# },
|
2461
|
+
# source: "AMAZON_CONNECT", # required, accepts AMAZON_CONNECT
|
2462
|
+
# },
|
2463
|
+
# import_job_type: "QUICK_RESPONSES", # required, accepts QUICK_RESPONSES
|
2464
|
+
# knowledge_base_id: "UuidOrArn", # required
|
2465
|
+
# metadata: {
|
2466
|
+
# "NonEmptyString" => "NonEmptyString",
|
2467
|
+
# },
|
2468
|
+
# upload_id: "UploadId", # required
|
2469
|
+
# })
|
2470
|
+
#
|
2471
|
+
# @example Response structure
|
2472
|
+
#
|
2473
|
+
# resp.import_job.created_time #=> Time
|
2474
|
+
# resp.import_job.external_source_configuration.configuration.connect_configuration.instance_id #=> String
|
2475
|
+
# resp.import_job.external_source_configuration.source #=> String, one of "AMAZON_CONNECT"
|
2476
|
+
# resp.import_job.failed_record_report #=> String
|
2477
|
+
# resp.import_job.import_job_id #=> String
|
2478
|
+
# resp.import_job.import_job_type #=> String, one of "QUICK_RESPONSES"
|
2479
|
+
# resp.import_job.knowledge_base_arn #=> String
|
2480
|
+
# resp.import_job.knowledge_base_id #=> String
|
2481
|
+
# resp.import_job.last_modified_time #=> Time
|
2482
|
+
# resp.import_job.metadata #=> Hash
|
2483
|
+
# resp.import_job.metadata["NonEmptyString"] #=> String
|
2484
|
+
# resp.import_job.status #=> String, one of "START_IN_PROGRESS", "FAILED", "COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
|
2485
|
+
# resp.import_job.upload_id #=> String
|
2486
|
+
# resp.import_job.url #=> String
|
2487
|
+
# resp.import_job.url_expiry #=> Time
|
2488
|
+
#
|
2489
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/StartImportJob AWS API Documentation
|
2490
|
+
#
|
2491
|
+
# @overload start_import_job(params = {})
|
2492
|
+
# @param [Hash] params ({})
|
2493
|
+
def start_import_job(params = {}, options = {})
|
2494
|
+
req = build_request(:start_import_job, params)
|
2495
|
+
req.send_request(options)
|
2496
|
+
end
|
2497
|
+
|
1858
2498
|
# Adds the specified tags to the specified resource.
|
1859
2499
|
#
|
1860
2500
|
# @option params [required, String] :resource_arn
|
@@ -1916,7 +2556,9 @@ module Aws::ConnectWisdomService
|
|
1916
2556
|
# cannot contain the ARN.
|
1917
2557
|
#
|
1918
2558
|
# @option params [required, String] :knowledge_base_id
|
1919
|
-
# The identifier of the knowledge base.
|
2559
|
+
# The identifier of the knowledge base. This should not be a
|
2560
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Wisdom Content
|
2561
|
+
# resource to it. Can be either the ID or the ARN
|
1920
2562
|
#
|
1921
2563
|
# @option params [Hash<String,String>] :metadata
|
1922
2564
|
# A key/value map to store attributes without affecting tagging or
|
@@ -2006,8 +2648,10 @@ module Aws::ConnectWisdomService
|
|
2006
2648
|
# `https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*$\{Id\}*/view`.
|
2007
2649
|
#
|
2008
2650
|
# @option params [required, String] :knowledge_base_id
|
2009
|
-
# The identifier of the knowledge base.
|
2010
|
-
#
|
2651
|
+
# The identifier of the knowledge base. This should not be a
|
2652
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Wisdom Content
|
2653
|
+
# resource to it. Can be either the ID or the ARN. URLs cannot contain
|
2654
|
+
# the ARN.
|
2011
2655
|
#
|
2012
2656
|
# @option params [required, String] :template_uri
|
2013
2657
|
# The template URI to update.
|
@@ -2028,7 +2672,7 @@ module Aws::ConnectWisdomService
|
|
2028
2672
|
# resp.knowledge_base.description #=> String
|
2029
2673
|
# resp.knowledge_base.knowledge_base_arn #=> String
|
2030
2674
|
# resp.knowledge_base.knowledge_base_id #=> String
|
2031
|
-
# resp.knowledge_base.knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM"
|
2675
|
+
# resp.knowledge_base.knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM", "QUICK_RESPONSES"
|
2032
2676
|
# resp.knowledge_base.last_content_modification_time #=> Time
|
2033
2677
|
# resp.knowledge_base.name #=> String
|
2034
2678
|
# resp.knowledge_base.rendering_configuration.template_uri #=> String
|
@@ -2049,6 +2693,127 @@ module Aws::ConnectWisdomService
|
|
2049
2693
|
req.send_request(options)
|
2050
2694
|
end
|
2051
2695
|
|
2696
|
+
# Updates an existing Wisdom quick response.
|
2697
|
+
#
|
2698
|
+
# @option params [Array<String>] :channels
|
2699
|
+
# The Amazon Connect contact channels this quick response applies to.
|
2700
|
+
# The supported contact channel types include `Chat`.
|
2701
|
+
#
|
2702
|
+
# @option params [Types::QuickResponseDataProvider] :content
|
2703
|
+
# The updated content of the quick response.
|
2704
|
+
#
|
2705
|
+
# @option params [String] :content_type
|
2706
|
+
# The media type of the quick response content.
|
2707
|
+
#
|
2708
|
+
# * Use `application/x.quickresponse;format=plain` for quick response
|
2709
|
+
# written in plain text.
|
2710
|
+
#
|
2711
|
+
# * Use `application/x.quickresponse;format=markdown` for quick response
|
2712
|
+
# written in richtext.
|
2713
|
+
#
|
2714
|
+
# @option params [String] :description
|
2715
|
+
# The updated description of the quick response.
|
2716
|
+
#
|
2717
|
+
# @option params [Types::GroupingConfiguration] :grouping_configuration
|
2718
|
+
# The updated grouping configuration of the quick response.
|
2719
|
+
#
|
2720
|
+
# @option params [Boolean] :is_active
|
2721
|
+
# Whether the quick response is active.
|
2722
|
+
#
|
2723
|
+
# @option params [required, String] :knowledge_base_id
|
2724
|
+
# The identifier of the knowledge base. This should not be a
|
2725
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Wisdom Content
|
2726
|
+
# resource to it. Can be either the ID or the ARN. URLs cannot contain
|
2727
|
+
# the ARN.
|
2728
|
+
#
|
2729
|
+
# @option params [String] :language
|
2730
|
+
# The language code value for the language in which the quick response
|
2731
|
+
# is written. The supported language codes include `de_DE`, `en_US`,
|
2732
|
+
# `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`,
|
2733
|
+
# `zh_CN`, `zh_TW`
|
2734
|
+
#
|
2735
|
+
# @option params [String] :name
|
2736
|
+
# The name of the quick response.
|
2737
|
+
#
|
2738
|
+
# @option params [required, String] :quick_response_id
|
2739
|
+
# The identifier of the quick response.
|
2740
|
+
#
|
2741
|
+
# @option params [Boolean] :remove_description
|
2742
|
+
# Whether to remove the description from the quick response.
|
2743
|
+
#
|
2744
|
+
# @option params [Boolean] :remove_grouping_configuration
|
2745
|
+
# Whether to remove the grouping configuration of the quick response.
|
2746
|
+
#
|
2747
|
+
# @option params [Boolean] :remove_shortcut_key
|
2748
|
+
# Whether to remove the shortcut key of the quick response.
|
2749
|
+
#
|
2750
|
+
# @option params [String] :shortcut_key
|
2751
|
+
# The shortcut key of the quick response. The value should be unique
|
2752
|
+
# across the knowledge base.
|
2753
|
+
#
|
2754
|
+
# @return [Types::UpdateQuickResponseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2755
|
+
#
|
2756
|
+
# * {Types::UpdateQuickResponseResponse#quick_response #quick_response} => Types::QuickResponseData
|
2757
|
+
#
|
2758
|
+
# @example Request syntax with placeholder values
|
2759
|
+
#
|
2760
|
+
# resp = client.update_quick_response({
|
2761
|
+
# channels: ["Channel"],
|
2762
|
+
# content: {
|
2763
|
+
# content: "QuickResponseContent",
|
2764
|
+
# },
|
2765
|
+
# content_type: "QuickResponseType",
|
2766
|
+
# description: "QuickResponseDescription",
|
2767
|
+
# grouping_configuration: {
|
2768
|
+
# criteria: "GroupingCriteria",
|
2769
|
+
# values: ["GroupingValue"],
|
2770
|
+
# },
|
2771
|
+
# is_active: false,
|
2772
|
+
# knowledge_base_id: "UuidOrArn", # required
|
2773
|
+
# language: "LanguageCode",
|
2774
|
+
# name: "QuickResponseName",
|
2775
|
+
# quick_response_id: "UuidOrArn", # required
|
2776
|
+
# remove_description: false,
|
2777
|
+
# remove_grouping_configuration: false,
|
2778
|
+
# remove_shortcut_key: false,
|
2779
|
+
# shortcut_key: "ShortCutKey",
|
2780
|
+
# })
|
2781
|
+
#
|
2782
|
+
# @example Response structure
|
2783
|
+
#
|
2784
|
+
# resp.quick_response.channels #=> Array
|
2785
|
+
# resp.quick_response.channels[0] #=> String
|
2786
|
+
# resp.quick_response.content_type #=> String
|
2787
|
+
# resp.quick_response.contents.markdown.content #=> String
|
2788
|
+
# resp.quick_response.contents.plain_text.content #=> String
|
2789
|
+
# resp.quick_response.created_time #=> Time
|
2790
|
+
# resp.quick_response.description #=> String
|
2791
|
+
# resp.quick_response.grouping_configuration.criteria #=> String
|
2792
|
+
# resp.quick_response.grouping_configuration.values #=> Array
|
2793
|
+
# resp.quick_response.grouping_configuration.values[0] #=> String
|
2794
|
+
# resp.quick_response.is_active #=> Boolean
|
2795
|
+
# resp.quick_response.knowledge_base_arn #=> String
|
2796
|
+
# resp.quick_response.knowledge_base_id #=> String
|
2797
|
+
# resp.quick_response.language #=> String
|
2798
|
+
# resp.quick_response.last_modified_by #=> String
|
2799
|
+
# resp.quick_response.last_modified_time #=> Time
|
2800
|
+
# resp.quick_response.name #=> String
|
2801
|
+
# resp.quick_response.quick_response_arn #=> String
|
2802
|
+
# resp.quick_response.quick_response_id #=> String
|
2803
|
+
# resp.quick_response.shortcut_key #=> String
|
2804
|
+
# resp.quick_response.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
|
2805
|
+
# resp.quick_response.tags #=> Hash
|
2806
|
+
# resp.quick_response.tags["TagKey"] #=> String
|
2807
|
+
#
|
2808
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/UpdateQuickResponse AWS API Documentation
|
2809
|
+
#
|
2810
|
+
# @overload update_quick_response(params = {})
|
2811
|
+
# @param [Hash] params ({})
|
2812
|
+
def update_quick_response(params = {}, options = {})
|
2813
|
+
req = build_request(:update_quick_response, params)
|
2814
|
+
req.send_request(options)
|
2815
|
+
end
|
2816
|
+
|
2052
2817
|
# @!endgroup
|
2053
2818
|
|
2054
2819
|
# @param params ({})
|
@@ -2062,7 +2827,7 @@ module Aws::ConnectWisdomService
|
|
2062
2827
|
params: params,
|
2063
2828
|
config: config)
|
2064
2829
|
context[:gem_name] = 'aws-sdk-connectwisdomservice'
|
2065
|
-
context[:gem_version] = '1.
|
2830
|
+
context[:gem_version] = '1.23.0'
|
2066
2831
|
Seahorse::Client::Request.new(handlers, context)
|
2067
2832
|
end
|
2068
2833
|
|