aws-sdk-qbusiness 1.2.0 → 1.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-qbusiness/client.rb +305 -228
- data/lib/aws-sdk-qbusiness/client_api.rb +36 -5
- data/lib/aws-sdk-qbusiness/types.rb +709 -457
- data/lib/aws-sdk-qbusiness.rb +1 -1
- data/sig/client.rbs +19 -5
- data/sig/types.rbs +34 -0
- metadata +2 -2
@@ -389,24 +389,24 @@ module Aws::QBusiness
|
|
389
389
|
# @!group API Operations
|
390
390
|
|
391
391
|
# Asynchronously deletes one or more documents added using the
|
392
|
-
# `BatchPutDocument` API from an Amazon Q index.
|
392
|
+
# `BatchPutDocument` API from an Amazon Q Business index.
|
393
393
|
#
|
394
394
|
# You can see the progress of the deletion, and any error messages
|
395
395
|
# related to the process, by using CloudWatch.
|
396
396
|
#
|
397
397
|
# @option params [required, String] :application_id
|
398
|
-
# The identifier of the Amazon Q application.
|
398
|
+
# The identifier of the Amazon Q Business application.
|
399
399
|
#
|
400
400
|
# @option params [String] :data_source_sync_id
|
401
401
|
# The identifier of the data source sync during which the documents were
|
402
402
|
# deleted.
|
403
403
|
#
|
404
404
|
# @option params [required, Array<Types::DeleteDocument>] :documents
|
405
|
-
# Documents deleted from the Amazon Q index.
|
405
|
+
# Documents deleted from the Amazon Q Business index.
|
406
406
|
#
|
407
407
|
# @option params [required, String] :index_id
|
408
|
-
# The identifier of the Amazon Q index that contains the
|
409
|
-
# delete.
|
408
|
+
# The identifier of the Amazon Q Business index that contains the
|
409
|
+
# documents to delete.
|
410
410
|
#
|
411
411
|
# @return [Types::BatchDeleteDocumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
412
412
|
#
|
@@ -442,23 +442,23 @@ module Aws::QBusiness
|
|
442
442
|
req.send_request(options)
|
443
443
|
end
|
444
444
|
|
445
|
-
# Adds one or more documents to an Amazon Q index.
|
445
|
+
# Adds one or more documents to an Amazon Q Business index.
|
446
446
|
#
|
447
447
|
# You use this API to:
|
448
448
|
#
|
449
449
|
# * ingest your structured and unstructured documents and documents
|
450
|
-
# stored in an Amazon S3 bucket into an Amazon Q index.
|
450
|
+
# stored in an Amazon S3 bucket into an Amazon Q Business index.
|
451
451
|
#
|
452
|
-
# * add custom attributes to documents in an Amazon Q index.
|
452
|
+
# * add custom attributes to documents in an Amazon Q Business index.
|
453
453
|
#
|
454
454
|
# * attach an access control list to the documents added to an Amazon Q
|
455
|
-
# index.
|
455
|
+
# Business index.
|
456
456
|
#
|
457
457
|
# You can see the progress of the deletion, and any error messages
|
458
458
|
# related to the process, by using CloudWatch.
|
459
459
|
#
|
460
460
|
# @option params [required, String] :application_id
|
461
|
-
# The identifier of the Amazon Q application.
|
461
|
+
# The identifier of the Amazon Q Business application.
|
462
462
|
#
|
463
463
|
# @option params [String] :data_source_sync_id
|
464
464
|
# The identifier of the data source sync during which the documents were
|
@@ -468,7 +468,7 @@ module Aws::QBusiness
|
|
468
468
|
# One or more documents to add to the index.
|
469
469
|
#
|
470
470
|
# @option params [required, String] :index_id
|
471
|
-
# The identifier of the Amazon Q index to add the documents to.
|
471
|
+
# The identifier of the Amazon Q Business index to add the documents to.
|
472
472
|
#
|
473
473
|
# @option params [String] :role_arn
|
474
474
|
# The Amazon Resource Name (ARN) of an IAM role with permission to
|
@@ -608,22 +608,50 @@ module Aws::QBusiness
|
|
608
608
|
req.send_request(options)
|
609
609
|
end
|
610
610
|
|
611
|
-
# Starts or continues a non-streaming Amazon Q conversation.
|
611
|
+
# Starts or continues a non-streaming Amazon Q Business conversation.
|
612
612
|
#
|
613
613
|
# @option params [Types::ActionExecution] :action_execution
|
614
|
-
# A request from an end user to perform an Amazon Q plugin
|
614
|
+
# A request from an end user to perform an Amazon Q Business plugin
|
615
|
+
# action.
|
615
616
|
#
|
616
617
|
# @option params [required, String] :application_id
|
617
|
-
# The identifier of the Amazon Q application linked to the
|
618
|
-
# conversation.
|
618
|
+
# The identifier of the Amazon Q Business application linked to the
|
619
|
+
# Amazon Q Business conversation.
|
619
620
|
#
|
620
621
|
# @option params [Array<Types::AttachmentInput>] :attachments
|
621
622
|
# A list of files uploaded directly during chat. You can upload a
|
622
623
|
# maximum of 5 files of upto 10 MB each.
|
623
624
|
#
|
624
625
|
# @option params [Types::AttributeFilter] :attribute_filter
|
625
|
-
# Enables filtering of Amazon Q web experience responses based
|
626
|
-
# document attributes or metadata fields.
|
626
|
+
# Enables filtering of Amazon Q Business web experience responses based
|
627
|
+
# on document attributes or metadata fields.
|
628
|
+
#
|
629
|
+
# @option params [String] :chat_mode
|
630
|
+
# The chat modes available in an Amazon Q Business web experience.
|
631
|
+
#
|
632
|
+
# * `RETRIEVAL_MODE` - The default chat mode for an Amazon Q Business
|
633
|
+
# application. When this mode is enabled, Amazon Q Business generates
|
634
|
+
# responses only from data sources connected to an Amazon Q Business
|
635
|
+
# application.
|
636
|
+
#
|
637
|
+
# * `CREATOR_MODE` - By selecting this mode, users can choose to
|
638
|
+
# generate responses only from the LLM knowledge, without consulting
|
639
|
+
# connected data sources, for a chat request.
|
640
|
+
#
|
641
|
+
# * `PLUGIN_MODE` - By selecting this mode, users can choose to use
|
642
|
+
# plugins in chat.
|
643
|
+
#
|
644
|
+
# For more information, see [Admin controls and guardrails][1],
|
645
|
+
# [Plugins][2], and [Conversation settings][3].
|
646
|
+
#
|
647
|
+
#
|
648
|
+
#
|
649
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html
|
650
|
+
# [2]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html
|
651
|
+
# [3]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope
|
652
|
+
#
|
653
|
+
# @option params [Types::ChatModeConfiguration] :chat_mode_configuration
|
654
|
+
# The chat mode configuration for an Amazon Q Business application.
|
627
655
|
#
|
628
656
|
# @option params [String] :client_token
|
629
657
|
# A token that you provide to identify a chat request.
|
@@ -632,7 +660,7 @@ module Aws::QBusiness
|
|
632
660
|
# not need to pass this option.**
|
633
661
|
#
|
634
662
|
# @option params [String] :conversation_id
|
635
|
-
# The identifier of the Amazon Q conversation.
|
663
|
+
# The identifier of the Amazon Q Business conversation.
|
636
664
|
#
|
637
665
|
# @option params [String] :parent_message_id
|
638
666
|
# The identifier of the previous end user text input message in a
|
@@ -641,7 +669,7 @@ module Aws::QBusiness
|
|
641
669
|
# @option params [Array<String>] :user_groups
|
642
670
|
# The groups that a user associated with the chat input belongs to.
|
643
671
|
#
|
644
|
-
# @option params [
|
672
|
+
# @option params [String] :user_id
|
645
673
|
# The identifier of the user attached to the chat input.
|
646
674
|
#
|
647
675
|
# @option params [String] :user_message
|
@@ -755,11 +783,17 @@ module Aws::QBusiness
|
|
755
783
|
# },
|
756
784
|
# ],
|
757
785
|
# },
|
786
|
+
# chat_mode: "RETRIEVAL_MODE", # accepts RETRIEVAL_MODE, CREATOR_MODE, PLUGIN_MODE
|
787
|
+
# chat_mode_configuration: {
|
788
|
+
# plugin_configuration: {
|
789
|
+
# plugin_id: "PluginId", # required
|
790
|
+
# },
|
791
|
+
# },
|
758
792
|
# client_token: "ClientToken",
|
759
793
|
# conversation_id: "ConversationId",
|
760
794
|
# parent_message_id: "MessageId",
|
761
795
|
# user_groups: ["String"],
|
762
|
-
# user_id: "UserId",
|
796
|
+
# user_id: "UserId",
|
763
797
|
# user_message: "UserMessage",
|
764
798
|
# })
|
765
799
|
#
|
@@ -802,27 +836,32 @@ module Aws::QBusiness
|
|
802
836
|
req.send_request(options)
|
803
837
|
end
|
804
838
|
|
805
|
-
# Creates an Amazon Q application.
|
839
|
+
# Creates an Amazon Q Business application.
|
806
840
|
#
|
807
841
|
# @option params [Types::AttachmentsConfiguration] :attachments_configuration
|
808
842
|
# An option to allow end users to upload files directly during chat.
|
809
843
|
#
|
810
844
|
# @option params [String] :client_token
|
811
845
|
# A token that you provide to identify the request to create your Amazon
|
812
|
-
# Q application.
|
846
|
+
# Q Business application.
|
813
847
|
#
|
814
848
|
# **A suitable default value is auto-generated.** You should normally
|
815
849
|
# not need to pass this option.**
|
816
850
|
#
|
817
851
|
# @option params [String] :description
|
818
|
-
# A description for the Amazon Q application.
|
852
|
+
# A description for the Amazon Q Business application.
|
819
853
|
#
|
820
854
|
# @option params [required, String] :display_name
|
821
|
-
# A name for the Amazon Q application.
|
855
|
+
# A name for the Amazon Q Business application.
|
822
856
|
#
|
823
857
|
# @option params [Types::EncryptionConfiguration] :encryption_configuration
|
824
858
|
# The identifier of the KMS key that is used to encrypt your data.
|
825
|
-
# Amazon Q doesn't support asymmetric keys.
|
859
|
+
# Amazon Q Business doesn't support asymmetric keys.
|
860
|
+
#
|
861
|
+
# @option params [String] :identity_center_instance_arn
|
862
|
+
# The Amazon Resource Name (ARN) of the IAM Identity Center instance you
|
863
|
+
# are either creating for—or connecting to—your Amazon Q Business
|
864
|
+
# application.
|
826
865
|
#
|
827
866
|
# @option params [required, String] :role_arn
|
828
867
|
# The Amazon Resource Name (ARN) of an IAM role with permissions to
|
@@ -830,8 +869,8 @@ module Aws::QBusiness
|
|
830
869
|
#
|
831
870
|
# @option params [Array<Types::Tag>] :tags
|
832
871
|
# A list of key-value pairs that identify or categorize your Amazon Q
|
833
|
-
# application. You can also use tags to help control access to
|
834
|
-
# application. Tag keys and values can consist of Unicode letters,
|
872
|
+
# Business application. You can also use tags to help control access to
|
873
|
+
# the application. Tag keys and values can consist of Unicode letters,
|
835
874
|
# digits, white space, and any of the following symbols: \_ . : / = + -
|
836
875
|
# @.
|
837
876
|
#
|
@@ -852,6 +891,7 @@ module Aws::QBusiness
|
|
852
891
|
# encryption_configuration: {
|
853
892
|
# kms_key_id: "KmsKeyId",
|
854
893
|
# },
|
894
|
+
# identity_center_instance_arn: "InstanceArn",
|
855
895
|
# role_arn: "RoleArn", # required
|
856
896
|
# tags: [
|
857
897
|
# {
|
@@ -875,15 +915,15 @@ module Aws::QBusiness
|
|
875
915
|
req.send_request(options)
|
876
916
|
end
|
877
917
|
|
878
|
-
# Creates a data source connector for an Amazon Q application.
|
918
|
+
# Creates a data source connector for an Amazon Q Business application.
|
879
919
|
#
|
880
920
|
# `CreateDataSource` is a synchronous operation. The operation returns
|
881
921
|
# 200 if the data source was successfully created. Otherwise, an
|
882
922
|
# exception is raised.
|
883
923
|
#
|
884
924
|
# @option params [required, String] :application_id
|
885
|
-
# The identifier of the Amazon Q application the data source
|
886
|
-
# attached to.
|
925
|
+
# The identifier of the Amazon Q Business application the data source
|
926
|
+
# will be attached to.
|
887
927
|
#
|
888
928
|
# @option params [String] :client_token
|
889
929
|
# A token you provide to identify a request to create a data source
|
@@ -905,7 +945,7 @@ module Aws::QBusiness
|
|
905
945
|
#
|
906
946
|
#
|
907
947
|
#
|
908
|
-
# [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html
|
948
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html
|
909
949
|
#
|
910
950
|
# @option params [String] :description
|
911
951
|
# A description for the data source connector.
|
@@ -932,9 +972,9 @@ module Aws::QBusiness
|
|
932
972
|
# access the data source and required resources.
|
933
973
|
#
|
934
974
|
# @option params [String] :sync_schedule
|
935
|
-
# Sets the frequency for Amazon Q to check the documents in
|
936
|
-
# source repository and update your index. If you don't set a
|
937
|
-
# Amazon Q won't periodically update the index.
|
975
|
+
# Sets the frequency for Amazon Q Business to check the documents in
|
976
|
+
# your data source repository and update your index. If you don't set a
|
977
|
+
# schedule, Amazon Q Business won't periodically update the index.
|
938
978
|
#
|
939
979
|
# Specify a `cron-` format schedule string or an empty string to
|
940
980
|
# indicate that the index is updated on demand. You can't specify the
|
@@ -951,7 +991,7 @@ module Aws::QBusiness
|
|
951
991
|
# @option params [Types::DataSourceVpcConfiguration] :vpc_configuration
|
952
992
|
# Configuration information for an Amazon VPC (Virtual Private Cloud) to
|
953
993
|
# connect to your data source. For more information, see [Using Amazon
|
954
|
-
# VPC with Amazon Q connectors][1].
|
994
|
+
# VPC with Amazon Q Business connectors][1].
|
955
995
|
#
|
956
996
|
#
|
957
997
|
#
|
@@ -1057,7 +1097,7 @@ module Aws::QBusiness
|
|
1057
1097
|
req.send_request(options)
|
1058
1098
|
end
|
1059
1099
|
|
1060
|
-
# Creates an Amazon Q index.
|
1100
|
+
# Creates an Amazon Q Business index.
|
1061
1101
|
#
|
1062
1102
|
# To determine if index creation has completed, check the `Status` field
|
1063
1103
|
# returned from a call to `DescribeIndex`. The `Status` field is set to
|
@@ -1072,7 +1112,7 @@ module Aws::QBusiness
|
|
1072
1112
|
# [2]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataSource.html
|
1073
1113
|
#
|
1074
1114
|
# @option params [required, String] :application_id
|
1075
|
-
# The identifier of the Amazon Q application using the index.
|
1115
|
+
# The identifier of the Amazon Q Business application using the index.
|
1076
1116
|
#
|
1077
1117
|
# @option params [Types::IndexCapacityConfiguration] :capacity_configuration
|
1078
1118
|
# The capacity units you want to provision for your index. You can add
|
@@ -1087,10 +1127,10 @@ module Aws::QBusiness
|
|
1087
1127
|
# not need to pass this option.**
|
1088
1128
|
#
|
1089
1129
|
# @option params [String] :description
|
1090
|
-
# A description for the Amazon Q index.
|
1130
|
+
# A description for the Amazon Q Business index.
|
1091
1131
|
#
|
1092
1132
|
# @option params [required, String] :display_name
|
1093
|
-
# A name for the Amazon Q index.
|
1133
|
+
# A name for the Amazon Q Business index.
|
1094
1134
|
#
|
1095
1135
|
# @option params [Array<Types::Tag>] :tags
|
1096
1136
|
# A list of key-value pairs that identify or categorize the index. You
|
@@ -1135,17 +1175,18 @@ module Aws::QBusiness
|
|
1135
1175
|
req.send_request(options)
|
1136
1176
|
end
|
1137
1177
|
|
1138
|
-
# Creates an Amazon Q plugin.
|
1178
|
+
# Creates an Amazon Q Business plugin.
|
1139
1179
|
#
|
1140
1180
|
# @option params [required, String] :application_id
|
1141
1181
|
# The identifier of the application that will contain the plugin.
|
1142
1182
|
#
|
1143
1183
|
# @option params [required, Types::PluginAuthConfiguration] :auth_configuration
|
1144
|
-
# Authentication configuration information for an Amazon Q
|
1184
|
+
# Authentication configuration information for an Amazon Q Business
|
1185
|
+
# plugin.
|
1145
1186
|
#
|
1146
1187
|
# @option params [String] :client_token
|
1147
1188
|
# A token that you provide to identify the request to create your Amazon
|
1148
|
-
# Q plugin.
|
1189
|
+
# Q Business plugin.
|
1149
1190
|
#
|
1150
1191
|
# **A suitable default value is auto-generated.** You should normally
|
1151
1192
|
# not need to pass this option.**
|
@@ -1211,27 +1252,27 @@ module Aws::QBusiness
|
|
1211
1252
|
req.send_request(options)
|
1212
1253
|
end
|
1213
1254
|
|
1214
|
-
# Adds a retriever to your Amazon Q application.
|
1255
|
+
# Adds a retriever to your Amazon Q Business application.
|
1215
1256
|
#
|
1216
1257
|
# @option params [required, String] :application_id
|
1217
|
-
# The identifier of your Amazon Q application.
|
1258
|
+
# The identifier of your Amazon Q Business application.
|
1218
1259
|
#
|
1219
1260
|
# @option params [String] :client_token
|
1220
1261
|
# A token that you provide to identify the request to create your Amazon
|
1221
|
-
# Q application retriever.
|
1262
|
+
# Q Business application retriever.
|
1222
1263
|
#
|
1223
1264
|
# **A suitable default value is auto-generated.** You should normally
|
1224
1265
|
# not need to pass this option.**
|
1225
1266
|
#
|
1226
1267
|
# @option params [required, Types::RetrieverConfiguration] :configuration
|
1227
1268
|
# Provides information on how the retriever used for your Amazon Q
|
1228
|
-
# application is configured.
|
1269
|
+
# Business application is configured.
|
1229
1270
|
#
|
1230
1271
|
# @option params [required, String] :display_name
|
1231
1272
|
# The name of your retriever.
|
1232
1273
|
#
|
1233
1274
|
# @option params [String] :role_arn
|
1234
|
-
# The ARN of an IAM role used by Amazon Q to access the basic
|
1275
|
+
# The ARN of an IAM role used by Amazon Q Business to access the basic
|
1235
1276
|
# authentication credentials stored in a Secrets Manager secret.
|
1236
1277
|
#
|
1237
1278
|
# @option params [Array<Types::Tag>] :tags
|
@@ -1316,7 +1357,7 @@ module Aws::QBusiness
|
|
1316
1357
|
#
|
1317
1358
|
# @option params [String] :client_token
|
1318
1359
|
# A token that you provide to identify the request to create your Amazon
|
1319
|
-
# Q user mapping.
|
1360
|
+
# Q Business user mapping.
|
1320
1361
|
#
|
1321
1362
|
# **A suitable default value is auto-generated.** You should normally
|
1322
1363
|
# not need to pass this option.**
|
@@ -1353,38 +1394,42 @@ module Aws::QBusiness
|
|
1353
1394
|
req.send_request(options)
|
1354
1395
|
end
|
1355
1396
|
|
1356
|
-
# Creates an Amazon Q web experience.
|
1397
|
+
# Creates an Amazon Q Business web experience.
|
1357
1398
|
#
|
1358
1399
|
# @option params [required, String] :application_id
|
1359
|
-
# The identifier of the Amazon Q web experience.
|
1400
|
+
# The identifier of the Amazon Q Business web experience.
|
1360
1401
|
#
|
1361
1402
|
# @option params [String] :client_token
|
1362
|
-
# A token you provide to identify a request to create an Amazon Q
|
1363
|
-
# experience.
|
1403
|
+
# A token you provide to identify a request to create an Amazon Q
|
1404
|
+
# Business web experience.
|
1364
1405
|
#
|
1365
1406
|
# **A suitable default value is auto-generated.** You should normally
|
1366
1407
|
# not need to pass this option.**
|
1367
1408
|
#
|
1409
|
+
# @option params [String] :role_arn
|
1410
|
+
# The Amazon Resource Name (ARN) of the service role attached to your
|
1411
|
+
# web experience.
|
1412
|
+
#
|
1368
1413
|
# @option params [String] :sample_prompts_control_mode
|
1369
1414
|
# Determines whether sample prompts are enabled in the web experience
|
1370
1415
|
# for an end user.
|
1371
1416
|
#
|
1372
1417
|
# @option params [String] :subtitle
|
1373
|
-
# A subtitle to personalize your Amazon Q web experience.
|
1418
|
+
# A subtitle to personalize your Amazon Q Business web experience.
|
1374
1419
|
#
|
1375
1420
|
# @option params [Array<Types::Tag>] :tags
|
1376
1421
|
# A list of key-value pairs that identify or categorize your Amazon Q
|
1377
|
-
# web experience. You can also use tags to help control access
|
1378
|
-
# web experience. Tag keys and values can consist of Unicode
|
1379
|
-
# digits, white space, and any of the following symbols: \_ . :
|
1380
|
-
# @.
|
1422
|
+
# Business web experience. You can also use tags to help control access
|
1423
|
+
# to the web experience. Tag keys and values can consist of Unicode
|
1424
|
+
# letters, digits, white space, and any of the following symbols: \_ . :
|
1425
|
+
# / = + - @.
|
1381
1426
|
#
|
1382
1427
|
# @option params [String] :title
|
1383
|
-
# The title for your Amazon Q web experience.
|
1428
|
+
# The title for your Amazon Q Business web experience.
|
1384
1429
|
#
|
1385
1430
|
# @option params [String] :welcome_message
|
1386
|
-
# The customized welcome message for end users of an Amazon Q
|
1387
|
-
# experience.
|
1431
|
+
# The customized welcome message for end users of an Amazon Q Business
|
1432
|
+
# web experience.
|
1388
1433
|
#
|
1389
1434
|
# @return [Types::CreateWebExperienceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1390
1435
|
#
|
@@ -1396,6 +1441,7 @@ module Aws::QBusiness
|
|
1396
1441
|
# resp = client.create_web_experience({
|
1397
1442
|
# application_id: "ApplicationId", # required
|
1398
1443
|
# client_token: "ClientToken",
|
1444
|
+
# role_arn: "RoleArn",
|
1399
1445
|
# sample_prompts_control_mode: "ENABLED", # accepts ENABLED, DISABLED
|
1400
1446
|
# subtitle: "WebExperienceSubtitle",
|
1401
1447
|
# tags: [
|
@@ -1422,10 +1468,10 @@ module Aws::QBusiness
|
|
1422
1468
|
req.send_request(options)
|
1423
1469
|
end
|
1424
1470
|
|
1425
|
-
# Deletes an Amazon Q application.
|
1471
|
+
# Deletes an Amazon Q Business application.
|
1426
1472
|
#
|
1427
1473
|
# @option params [required, String] :application_id
|
1428
|
-
# The identifier of the Amazon Q application.
|
1474
|
+
# The identifier of the Amazon Q Business application.
|
1429
1475
|
#
|
1430
1476
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1431
1477
|
#
|
@@ -1444,7 +1490,8 @@ module Aws::QBusiness
|
|
1444
1490
|
req.send_request(options)
|
1445
1491
|
end
|
1446
1492
|
|
1447
|
-
# Deletes chat controls configured for an existing Amazon Q
|
1493
|
+
# Deletes chat controls configured for an existing Amazon Q Business
|
1494
|
+
# application.
|
1448
1495
|
#
|
1449
1496
|
# @option params [required, String] :application_id
|
1450
1497
|
# The identifier of the application the chat controls have been
|
@@ -1467,17 +1514,17 @@ module Aws::QBusiness
|
|
1467
1514
|
req.send_request(options)
|
1468
1515
|
end
|
1469
1516
|
|
1470
|
-
# Deletes an Amazon Q web experience conversation.
|
1517
|
+
# Deletes an Amazon Q Business web experience conversation.
|
1471
1518
|
#
|
1472
1519
|
# @option params [required, String] :application_id
|
1473
|
-
# The identifier of the Amazon Q application associated with
|
1474
|
-
# conversation.
|
1520
|
+
# The identifier of the Amazon Q Business application associated with
|
1521
|
+
# the conversation.
|
1475
1522
|
#
|
1476
1523
|
# @option params [required, String] :conversation_id
|
1477
|
-
# The identifier of the Amazon Q web experience conversation
|
1478
|
-
# deleted.
|
1524
|
+
# The identifier of the Amazon Q Business web experience conversation
|
1525
|
+
# being deleted.
|
1479
1526
|
#
|
1480
|
-
# @option params [
|
1527
|
+
# @option params [String] :user_id
|
1481
1528
|
# The identifier of the user who is deleting the conversation.
|
1482
1529
|
#
|
1483
1530
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -1487,7 +1534,7 @@ module Aws::QBusiness
|
|
1487
1534
|
# resp = client.delete_conversation({
|
1488
1535
|
# application_id: "ApplicationId", # required
|
1489
1536
|
# conversation_id: "ConversationId", # required
|
1490
|
-
# user_id: "UserId",
|
1537
|
+
# user_id: "UserId",
|
1491
1538
|
# })
|
1492
1539
|
#
|
1493
1540
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteConversation AWS API Documentation
|
@@ -1499,13 +1546,13 @@ module Aws::QBusiness
|
|
1499
1546
|
req.send_request(options)
|
1500
1547
|
end
|
1501
1548
|
|
1502
|
-
# Deletes an Amazon Q data source connector. While the data
|
1503
|
-
# being deleted, the `Status` field returned by a call to the
|
1549
|
+
# Deletes an Amazon Q Business data source connector. While the data
|
1550
|
+
# source is being deleted, the `Status` field returned by a call to the
|
1504
1551
|
# `DescribeDataSource` API is set to `DELETING`.
|
1505
1552
|
#
|
1506
1553
|
# @option params [required, String] :application_id
|
1507
|
-
# The identifier of the Amazon Q application used with the data
|
1508
|
-
# connector.
|
1554
|
+
# The identifier of the Amazon Q Business application used with the data
|
1555
|
+
# source connector.
|
1509
1556
|
#
|
1510
1557
|
# @option params [required, String] :data_source_id
|
1511
1558
|
# The identifier of the data source connector that you want to delete.
|
@@ -1586,14 +1633,14 @@ module Aws::QBusiness
|
|
1586
1633
|
req.send_request(options)
|
1587
1634
|
end
|
1588
1635
|
|
1589
|
-
# Deletes an Amazon Q index.
|
1636
|
+
# Deletes an Amazon Q Business index.
|
1590
1637
|
#
|
1591
1638
|
# @option params [required, String] :application_id
|
1592
|
-
# The identifier of the Amazon Q application the Amazon Q
|
1593
|
-
# linked to.
|
1639
|
+
# The identifier of the Amazon Q Business application the Amazon Q
|
1640
|
+
# Business index is linked to.
|
1594
1641
|
#
|
1595
1642
|
# @option params [required, String] :index_id
|
1596
|
-
# The identifier of the Amazon Q index.
|
1643
|
+
# The identifier of the Amazon Q Business index.
|
1597
1644
|
#
|
1598
1645
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1599
1646
|
#
|
@@ -1613,10 +1660,11 @@ module Aws::QBusiness
|
|
1613
1660
|
req.send_request(options)
|
1614
1661
|
end
|
1615
1662
|
|
1616
|
-
# Deletes an Amazon Q plugin.
|
1663
|
+
# Deletes an Amazon Q Business plugin.
|
1617
1664
|
#
|
1618
1665
|
# @option params [required, String] :application_id
|
1619
|
-
# The identifier the application attached to the Amazon Q
|
1666
|
+
# The identifier the application attached to the Amazon Q Business
|
1667
|
+
# plugin.
|
1620
1668
|
#
|
1621
1669
|
# @option params [required, String] :plugin_id
|
1622
1670
|
# The identifier of the plugin being deleted.
|
@@ -1639,10 +1687,11 @@ module Aws::QBusiness
|
|
1639
1687
|
req.send_request(options)
|
1640
1688
|
end
|
1641
1689
|
|
1642
|
-
# Deletes the retriever used by an Amazon Q application.
|
1690
|
+
# Deletes the retriever used by an Amazon Q Business application.
|
1643
1691
|
#
|
1644
1692
|
# @option params [required, String] :application_id
|
1645
|
-
# The identifier of the Amazon Q application using the
|
1693
|
+
# The identifier of the Amazon Q Business application using the
|
1694
|
+
# retriever.
|
1646
1695
|
#
|
1647
1696
|
# @option params [required, String] :retriever_id
|
1648
1697
|
# The identifier of the retriever being deleted.
|
@@ -1692,14 +1741,14 @@ module Aws::QBusiness
|
|
1692
1741
|
req.send_request(options)
|
1693
1742
|
end
|
1694
1743
|
|
1695
|
-
# Deletes an Amazon Q web experience.
|
1744
|
+
# Deletes an Amazon Q Business web experience.
|
1696
1745
|
#
|
1697
1746
|
# @option params [required, String] :application_id
|
1698
|
-
# The identifier of the Amazon Q application linked to the
|
1699
|
-
# experience.
|
1747
|
+
# The identifier of the Amazon Q Business application linked to the
|
1748
|
+
# Amazon Q Business web experience.
|
1700
1749
|
#
|
1701
1750
|
# @option params [required, String] :web_experience_id
|
1702
|
-
# The identifier of the Amazon Q web experience being deleted.
|
1751
|
+
# The identifier of the Amazon Q Business web experience being deleted.
|
1703
1752
|
#
|
1704
1753
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1705
1754
|
#
|
@@ -1719,10 +1768,10 @@ module Aws::QBusiness
|
|
1719
1768
|
req.send_request(options)
|
1720
1769
|
end
|
1721
1770
|
|
1722
|
-
# Gets information about an existing Amazon Q application.
|
1771
|
+
# Gets information about an existing Amazon Q Business application.
|
1723
1772
|
#
|
1724
1773
|
# @option params [required, String] :application_id
|
1725
|
-
# The identifier of the Amazon Q application.
|
1774
|
+
# The identifier of the Amazon Q Business application.
|
1726
1775
|
#
|
1727
1776
|
# @return [Types::GetApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1728
1777
|
#
|
@@ -1734,6 +1783,7 @@ module Aws::QBusiness
|
|
1734
1783
|
# * {Types::GetApplicationResponse#display_name #display_name} => String
|
1735
1784
|
# * {Types::GetApplicationResponse#encryption_configuration #encryption_configuration} => Types::EncryptionConfiguration
|
1736
1785
|
# * {Types::GetApplicationResponse#error #error} => Types::ErrorDetail
|
1786
|
+
# * {Types::GetApplicationResponse#identity_center_application_arn #identity_center_application_arn} => String
|
1737
1787
|
# * {Types::GetApplicationResponse#role_arn #role_arn} => String
|
1738
1788
|
# * {Types::GetApplicationResponse#status #status} => String
|
1739
1789
|
# * {Types::GetApplicationResponse#updated_at #updated_at} => Time
|
@@ -1755,6 +1805,7 @@ module Aws::QBusiness
|
|
1755
1805
|
# resp.encryption_configuration.kms_key_id #=> String
|
1756
1806
|
# resp.error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
1757
1807
|
# resp.error.error_message #=> String
|
1808
|
+
# resp.identity_center_application_arn #=> String
|
1758
1809
|
# resp.role_arn #=> String
|
1759
1810
|
# resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING"
|
1760
1811
|
# resp.updated_at #=> Time
|
@@ -1769,7 +1820,7 @@ module Aws::QBusiness
|
|
1769
1820
|
end
|
1770
1821
|
|
1771
1822
|
# Gets information about an chat controls configured for an existing
|
1772
|
-
# Amazon Q application.
|
1823
|
+
# Amazon Q Business application.
|
1773
1824
|
#
|
1774
1825
|
# @option params [required, String] :application_id
|
1775
1826
|
# The identifier of the application for which the chat controls are
|
@@ -1780,13 +1831,14 @@ module Aws::QBusiness
|
|
1780
1831
|
#
|
1781
1832
|
# @option params [String] :next_token
|
1782
1833
|
# If the `maxResults` response was incomplete because there is more data
|
1783
|
-
# to retrieve, Amazon Q returns a pagination token in the
|
1784
|
-
# can use this pagination token to retrieve the next set
|
1785
|
-
# chat controls configured.
|
1834
|
+
# to retrieve, Amazon Q Business returns a pagination token in the
|
1835
|
+
# response. You can use this pagination token to retrieve the next set
|
1836
|
+
# of Amazon Q Business chat controls configured.
|
1786
1837
|
#
|
1787
1838
|
# @return [Types::GetChatControlsConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1788
1839
|
#
|
1789
1840
|
# * {Types::GetChatControlsConfigurationResponse#blocked_phrases #blocked_phrases} => Types::BlockedPhrasesConfiguration
|
1841
|
+
# * {Types::GetChatControlsConfigurationResponse#creator_mode_configuration #creator_mode_configuration} => Types::AppliedCreatorModeConfiguration
|
1790
1842
|
# * {Types::GetChatControlsConfigurationResponse#next_token #next_token} => String
|
1791
1843
|
# * {Types::GetChatControlsConfigurationResponse#response_scope #response_scope} => String
|
1792
1844
|
# * {Types::GetChatControlsConfigurationResponse#topic_configurations #topic_configurations} => Array<Types::TopicConfiguration>
|
@@ -1806,6 +1858,7 @@ module Aws::QBusiness
|
|
1806
1858
|
# resp.blocked_phrases.blocked_phrases #=> Array
|
1807
1859
|
# resp.blocked_phrases.blocked_phrases[0] #=> String
|
1808
1860
|
# resp.blocked_phrases.system_message_override #=> String
|
1861
|
+
# resp.creator_mode_configuration.creator_mode_control #=> String, one of "ENABLED", "DISABLED"
|
1809
1862
|
# resp.next_token #=> String
|
1810
1863
|
# resp.response_scope #=> String, one of "ENTERPRISE_CONTENT_ONLY", "EXTENDED_KNOWLEDGE_ENABLED"
|
1811
1864
|
# resp.topic_configurations #=> Array
|
@@ -1837,10 +1890,11 @@ module Aws::QBusiness
|
|
1837
1890
|
req.send_request(options)
|
1838
1891
|
end
|
1839
1892
|
|
1840
|
-
# Gets information about an existing Amazon Q data source
|
1893
|
+
# Gets information about an existing Amazon Q Business data source
|
1894
|
+
# connector.
|
1841
1895
|
#
|
1842
1896
|
# @option params [required, String] :application_id
|
1843
|
-
# The identifier of the Amazon Q application.
|
1897
|
+
# The identifier of the Amazon Q Business application.
|
1844
1898
|
#
|
1845
1899
|
# @option params [required, String] :data_source_id
|
1846
1900
|
# The identifier of the data source connector.
|
@@ -1990,13 +2044,14 @@ module Aws::QBusiness
|
|
1990
2044
|
req.send_request(options)
|
1991
2045
|
end
|
1992
2046
|
|
1993
|
-
# Gets information about an existing Amazon Q index.
|
2047
|
+
# Gets information about an existing Amazon Q Business index.
|
1994
2048
|
#
|
1995
2049
|
# @option params [required, String] :application_id
|
1996
|
-
# The identifier of the Amazon Q application connected to the
|
2050
|
+
# The identifier of the Amazon Q Business application connected to the
|
2051
|
+
# index.
|
1997
2052
|
#
|
1998
2053
|
# @option params [required, String] :index_id
|
1999
|
-
# The identifier of the Amazon Q index you want information on.
|
2054
|
+
# The identifier of the Amazon Q Business index you want information on.
|
2000
2055
|
#
|
2001
2056
|
# @return [Types::GetIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2002
2057
|
#
|
@@ -2049,7 +2104,7 @@ module Aws::QBusiness
|
|
2049
2104
|
req.send_request(options)
|
2050
2105
|
end
|
2051
2106
|
|
2052
|
-
# Gets information about an existing Amazon Q plugin.
|
2107
|
+
# Gets information about an existing Amazon Q Business plugin.
|
2053
2108
|
#
|
2054
2109
|
# @option params [required, String] :application_id
|
2055
2110
|
# The identifier of the application which contains the plugin.
|
@@ -2103,10 +2158,11 @@ module Aws::QBusiness
|
|
2103
2158
|
end
|
2104
2159
|
|
2105
2160
|
# Gets information about an existing retriever used by an Amazon Q
|
2106
|
-
# application.
|
2161
|
+
# Business application.
|
2107
2162
|
#
|
2108
2163
|
# @option params [required, String] :application_id
|
2109
|
-
# The identifier of the Amazon Q application using the
|
2164
|
+
# The identifier of the Amazon Q Business application using the
|
2165
|
+
# retriever.
|
2110
2166
|
#
|
2111
2167
|
# @option params [required, String] :retriever_id
|
2112
2168
|
# The identifier of the retriever.
|
@@ -2199,14 +2255,14 @@ module Aws::QBusiness
|
|
2199
2255
|
req.send_request(options)
|
2200
2256
|
end
|
2201
2257
|
|
2202
|
-
# Gets information about an existing Amazon Q web experience.
|
2258
|
+
# Gets information about an existing Amazon Q Business web experience.
|
2203
2259
|
#
|
2204
2260
|
# @option params [required, String] :application_id
|
2205
|
-
# The identifier of the Amazon Q application linked to the web
|
2261
|
+
# The identifier of the Amazon Q Business application linked to the web
|
2206
2262
|
# experience.
|
2207
2263
|
#
|
2208
2264
|
# @option params [required, String] :web_experience_id
|
2209
|
-
# The identifier of the Amazon Q web experience.
|
2265
|
+
# The identifier of the Amazon Q Business web experience.
|
2210
2266
|
#
|
2211
2267
|
# @return [Types::GetWebExperienceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2212
2268
|
#
|
@@ -2215,6 +2271,7 @@ module Aws::QBusiness
|
|
2215
2271
|
# * {Types::GetWebExperienceResponse#created_at #created_at} => Time
|
2216
2272
|
# * {Types::GetWebExperienceResponse#default_endpoint #default_endpoint} => String
|
2217
2273
|
# * {Types::GetWebExperienceResponse#error #error} => Types::ErrorDetail
|
2274
|
+
# * {Types::GetWebExperienceResponse#role_arn #role_arn} => String
|
2218
2275
|
# * {Types::GetWebExperienceResponse#sample_prompts_control_mode #sample_prompts_control_mode} => String
|
2219
2276
|
# * {Types::GetWebExperienceResponse#status #status} => String
|
2220
2277
|
# * {Types::GetWebExperienceResponse#subtitle #subtitle} => String
|
@@ -2242,6 +2299,7 @@ module Aws::QBusiness
|
|
2242
2299
|
# resp.default_endpoint #=> String
|
2243
2300
|
# resp.error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
2244
2301
|
# resp.error.error_message #=> String
|
2302
|
+
# resp.role_arn #=> String
|
2245
2303
|
# resp.sample_prompts_control_mode #=> String, one of "ENABLED", "DISABLED"
|
2246
2304
|
# resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "PENDING_AUTH_CONFIG"
|
2247
2305
|
# resp.subtitle #=> String
|
@@ -2260,16 +2318,16 @@ module Aws::QBusiness
|
|
2260
2318
|
req.send_request(options)
|
2261
2319
|
end
|
2262
2320
|
|
2263
|
-
# Lists Amazon Q applications.
|
2321
|
+
# Lists Amazon Q Business applications.
|
2264
2322
|
#
|
2265
2323
|
# @option params [Integer] :max_results
|
2266
|
-
# The maximum number of Amazon Q applications to return.
|
2324
|
+
# The maximum number of Amazon Q Business applications to return.
|
2267
2325
|
#
|
2268
2326
|
# @option params [String] :next_token
|
2269
2327
|
# If the `maxResults` response was incomplete because there is more data
|
2270
|
-
# to retrieve, Amazon Q returns a pagination token in the
|
2271
|
-
# can use this pagination token to retrieve the next set
|
2272
|
-
# applications.
|
2328
|
+
# to retrieve, Amazon Q Business returns a pagination token in the
|
2329
|
+
# response. You can use this pagination token to retrieve the next set
|
2330
|
+
# of Amazon Q Business applications.
|
2273
2331
|
#
|
2274
2332
|
# @return [Types::ListApplicationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2275
2333
|
#
|
@@ -2304,23 +2362,23 @@ module Aws::QBusiness
|
|
2304
2362
|
req.send_request(options)
|
2305
2363
|
end
|
2306
2364
|
|
2307
|
-
# Lists one or more Amazon Q conversations.
|
2365
|
+
# Lists one or more Amazon Q Business conversations.
|
2308
2366
|
#
|
2309
2367
|
# @option params [required, String] :application_id
|
2310
|
-
# The identifier of the Amazon Q application.
|
2368
|
+
# The identifier of the Amazon Q Business application.
|
2311
2369
|
#
|
2312
2370
|
# @option params [Integer] :max_results
|
2313
|
-
# The maximum number of Amazon Q conversations to return.
|
2371
|
+
# The maximum number of Amazon Q Business conversations to return.
|
2314
2372
|
#
|
2315
2373
|
# @option params [String] :next_token
|
2316
2374
|
# If the `maxResults` response was incomplete because there is more data
|
2317
|
-
# to retrieve, Amazon Q returns a pagination token in the
|
2318
|
-
# can use this pagination token to retrieve the next set
|
2319
|
-
# conversations.
|
2375
|
+
# to retrieve, Amazon Q Business returns a pagination token in the
|
2376
|
+
# response. You can use this pagination token to retrieve the next set
|
2377
|
+
# of Amazon Q Business conversations.
|
2320
2378
|
#
|
2321
|
-
# @option params [
|
2322
|
-
# The identifier of the user involved in the Amazon Q web
|
2323
|
-
# conversation.
|
2379
|
+
# @option params [String] :user_id
|
2380
|
+
# The identifier of the user involved in the Amazon Q Business web
|
2381
|
+
# experience conversation.
|
2324
2382
|
#
|
2325
2383
|
# @return [Types::ListConversationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2326
2384
|
#
|
@@ -2335,7 +2393,7 @@ module Aws::QBusiness
|
|
2335
2393
|
# application_id: "ApplicationId", # required
|
2336
2394
|
# max_results: 1,
|
2337
2395
|
# next_token: "NextToken",
|
2338
|
-
# user_id: "UserId",
|
2396
|
+
# user_id: "UserId",
|
2339
2397
|
# })
|
2340
2398
|
#
|
2341
2399
|
# @example Response structure
|
@@ -2355,12 +2413,12 @@ module Aws::QBusiness
|
|
2355
2413
|
req.send_request(options)
|
2356
2414
|
end
|
2357
2415
|
|
2358
|
-
# Get information about an Amazon Q data source connector
|
2416
|
+
# Get information about an Amazon Q Business data source connector
|
2359
2417
|
# synchronization.
|
2360
2418
|
#
|
2361
2419
|
# @option params [required, String] :application_id
|
2362
|
-
# The identifier of the Amazon Q application connected to the
|
2363
|
-
# source.
|
2420
|
+
# The identifier of the Amazon Q Business application connected to the
|
2421
|
+
# data source.
|
2364
2422
|
#
|
2365
2423
|
# @option params [required, String] :data_source_id
|
2366
2424
|
# The identifier of the data source connector.
|
@@ -2369,16 +2427,17 @@ module Aws::QBusiness
|
|
2369
2427
|
# The end time of the data source connector sync.
|
2370
2428
|
#
|
2371
2429
|
# @option params [required, String] :index_id
|
2372
|
-
# The identifier of the index used with the Amazon Q data
|
2373
|
-
# connector.
|
2430
|
+
# The identifier of the index used with the Amazon Q Business data
|
2431
|
+
# source connector.
|
2374
2432
|
#
|
2375
2433
|
# @option params [Integer] :max_results
|
2376
2434
|
# The maximum number of synchronization jobs to return in the response.
|
2377
2435
|
#
|
2378
2436
|
# @option params [String] :next_token
|
2379
2437
|
# If the `maxResults` response was incpmplete because there is more data
|
2380
|
-
# to retriever, Amazon Q returns a pagination token in the
|
2381
|
-
# can use this pagination token to retrieve the next set
|
2438
|
+
# to retriever, Amazon Q Business returns a pagination token in the
|
2439
|
+
# response. You can use this pagination token to retrieve the next set
|
2440
|
+
# of responses.
|
2382
2441
|
#
|
2383
2442
|
# @option params [Time,DateTime,Date,Integer,String] :start_time
|
2384
2443
|
# The start time of the data source connector sync.
|
@@ -2433,11 +2492,12 @@ module Aws::QBusiness
|
|
2433
2492
|
req.send_request(options)
|
2434
2493
|
end
|
2435
2494
|
|
2436
|
-
# Lists the Amazon Q data source connectors that you have
|
2495
|
+
# Lists the Amazon Q Business data source connectors that you have
|
2496
|
+
# created.
|
2437
2497
|
#
|
2438
2498
|
# @option params [required, String] :application_id
|
2439
|
-
# The identifier of the Amazon Q application linked to the data
|
2440
|
-
# connectors.
|
2499
|
+
# The identifier of the Amazon Q Business application linked to the data
|
2500
|
+
# source connectors.
|
2441
2501
|
#
|
2442
2502
|
# @option params [required, String] :index_id
|
2443
2503
|
# The identifier of the index used with one or more data source
|
@@ -2448,9 +2508,9 @@ module Aws::QBusiness
|
|
2448
2508
|
#
|
2449
2509
|
# @option params [String] :next_token
|
2450
2510
|
# If the `maxResults` response was incomplete because there is more data
|
2451
|
-
# to retrieve, Amazon Q returns a pagination token in the
|
2452
|
-
# can use this pagination token to retrieve the next set
|
2453
|
-
# data source connectors.
|
2511
|
+
# to retrieve, Amazon Q Business returns a pagination token in the
|
2512
|
+
# response. You can use this pagination token to retrieve the next set
|
2513
|
+
# of Amazon Q Business data source connectors.
|
2454
2514
|
#
|
2455
2515
|
# @return [Types::ListDataSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2456
2516
|
#
|
@@ -2504,8 +2564,9 @@ module Aws::QBusiness
|
|
2504
2564
|
#
|
2505
2565
|
# @option params [String] :next_token
|
2506
2566
|
# If the `maxResults` response was incomplete because there is more data
|
2507
|
-
# to retrieve, Amazon Q returns a pagination token in the
|
2508
|
-
# can use this pagination token to retrieve the next set
|
2567
|
+
# to retrieve, Amazon Q Business returns a pagination token in the
|
2568
|
+
# response. You can use this pagination token to retrieve the next set
|
2569
|
+
# of documents.
|
2509
2570
|
#
|
2510
2571
|
# @return [Types::ListDocumentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2511
2572
|
#
|
@@ -2563,9 +2624,9 @@ module Aws::QBusiness
|
|
2563
2624
|
#
|
2564
2625
|
# @option params [String] :next_token
|
2565
2626
|
# If the previous response was incomplete (because there is more data to
|
2566
|
-
# retrieve), Amazon Q returns a pagination token in the
|
2567
|
-
# can use this pagination token to retrieve the next set
|
2568
|
-
# are mapped to users.
|
2627
|
+
# retrieve), Amazon Q Business returns a pagination token in the
|
2628
|
+
# response. You can use this pagination token to retrieve the next set
|
2629
|
+
# of groups that are mapped to users.
|
2569
2630
|
#
|
2570
2631
|
# @option params [required, Time,DateTime,Date,Integer,String] :updated_earlier_than
|
2571
2632
|
# The timestamp identifier used for the latest `PUT` or `DELETE` action
|
@@ -2604,19 +2665,20 @@ module Aws::QBusiness
|
|
2604
2665
|
req.send_request(options)
|
2605
2666
|
end
|
2606
2667
|
|
2607
|
-
# Lists the Amazon Q indices you have created.
|
2668
|
+
# Lists the Amazon Q Business indices you have created.
|
2608
2669
|
#
|
2609
2670
|
# @option params [required, String] :application_id
|
2610
|
-
# The identifier of the Amazon Q application connected to the
|
2671
|
+
# The identifier of the Amazon Q Business application connected to the
|
2672
|
+
# index.
|
2611
2673
|
#
|
2612
2674
|
# @option params [Integer] :max_results
|
2613
2675
|
# The maximum number of indices to return.
|
2614
2676
|
#
|
2615
2677
|
# @option params [String] :next_token
|
2616
2678
|
# If the maxResults response was incomplete because there is more data
|
2617
|
-
# to retrieve, Amazon Q returns a pagination token in the
|
2618
|
-
# can use this pagination token to retrieve the next set
|
2619
|
-
# indices.
|
2679
|
+
# to retrieve, Amazon Q Business returns a pagination token in the
|
2680
|
+
# response. You can use this pagination token to retrieve the next set
|
2681
|
+
# of Amazon Q Business indices.
|
2620
2682
|
#
|
2621
2683
|
# @return [Types::ListIndicesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2622
2684
|
#
|
@@ -2652,25 +2714,26 @@ module Aws::QBusiness
|
|
2652
2714
|
req.send_request(options)
|
2653
2715
|
end
|
2654
2716
|
|
2655
|
-
# Gets a list of messages associated with an Amazon Q web
|
2717
|
+
# Gets a list of messages associated with an Amazon Q Business web
|
2718
|
+
# experience.
|
2656
2719
|
#
|
2657
2720
|
# @option params [required, String] :application_id
|
2658
|
-
# The identifier for the Amazon Q application.
|
2721
|
+
# The identifier for the Amazon Q Business application.
|
2659
2722
|
#
|
2660
2723
|
# @option params [required, String] :conversation_id
|
2661
|
-
# The identifier of the Amazon Q web experience conversation.
|
2724
|
+
# The identifier of the Amazon Q Business web experience conversation.
|
2662
2725
|
#
|
2663
2726
|
# @option params [Integer] :max_results
|
2664
2727
|
# The maximum number of messages to return.
|
2665
2728
|
#
|
2666
2729
|
# @option params [String] :next_token
|
2667
2730
|
# If the number of retrievers returned exceeds `maxResults`, Amazon Q
|
2668
|
-
# returns a next token as a pagination token to retrieve the
|
2669
|
-
# messages.
|
2731
|
+
# Business returns a next token as a pagination token to retrieve the
|
2732
|
+
# next set of messages.
|
2670
2733
|
#
|
2671
|
-
# @option params [
|
2672
|
-
# The identifier of the user involved in the Amazon Q web
|
2673
|
-
# conversation.
|
2734
|
+
# @option params [String] :user_id
|
2735
|
+
# The identifier of the user involved in the Amazon Q Business web
|
2736
|
+
# experience conversation.
|
2674
2737
|
#
|
2675
2738
|
# @return [Types::ListMessagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2676
2739
|
#
|
@@ -2686,7 +2749,7 @@ module Aws::QBusiness
|
|
2686
2749
|
# conversation_id: "ConversationId", # required
|
2687
2750
|
# max_results: 1,
|
2688
2751
|
# next_token: "NextToken",
|
2689
|
-
# user_id: "UserId",
|
2752
|
+
# user_id: "UserId",
|
2690
2753
|
# })
|
2691
2754
|
#
|
2692
2755
|
# @example Response structure
|
@@ -2733,7 +2796,7 @@ module Aws::QBusiness
|
|
2733
2796
|
req.send_request(options)
|
2734
2797
|
end
|
2735
2798
|
|
2736
|
-
# Lists configured Amazon Q plugins.
|
2799
|
+
# Lists configured Amazon Q Business plugins.
|
2737
2800
|
#
|
2738
2801
|
# @option params [required, String] :application_id
|
2739
2802
|
# The identifier of the application the plugin is attached to.
|
@@ -2743,8 +2806,9 @@ module Aws::QBusiness
|
|
2743
2806
|
#
|
2744
2807
|
# @option params [String] :next_token
|
2745
2808
|
# If the `maxResults` response was incomplete because there is more data
|
2746
|
-
# to retrieve, Amazon Q returns a pagination token in the
|
2747
|
-
# can use this pagination token to retrieve the next set
|
2809
|
+
# to retrieve, Amazon Q Business returns a pagination token in the
|
2810
|
+
# response. You can use this pagination token to retrieve the next set
|
2811
|
+
# of plugins.
|
2748
2812
|
#
|
2749
2813
|
# @return [Types::ListPluginsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2750
2814
|
#
|
@@ -2782,18 +2846,19 @@ module Aws::QBusiness
|
|
2782
2846
|
req.send_request(options)
|
2783
2847
|
end
|
2784
2848
|
|
2785
|
-
# Lists the retriever used by an Amazon Q application.
|
2849
|
+
# Lists the retriever used by an Amazon Q Business application.
|
2786
2850
|
#
|
2787
2851
|
# @option params [required, String] :application_id
|
2788
|
-
# The identifier of the Amazon Q application using the
|
2852
|
+
# The identifier of the Amazon Q Business application using the
|
2853
|
+
# retriever.
|
2789
2854
|
#
|
2790
2855
|
# @option params [Integer] :max_results
|
2791
2856
|
# The maximum number of retrievers returned.
|
2792
2857
|
#
|
2793
2858
|
# @option params [String] :next_token
|
2794
2859
|
# If the number of retrievers returned exceeds `maxResults`, Amazon Q
|
2795
|
-
# returns a next token as a pagination token to retrieve the
|
2796
|
-
# retrievers.
|
2860
|
+
# Business returns a next token as a pagination token to retrieve the
|
2861
|
+
# next set of retrievers.
|
2797
2862
|
#
|
2798
2863
|
# @return [Types::ListRetrieversResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2799
2864
|
#
|
@@ -2830,11 +2895,12 @@ module Aws::QBusiness
|
|
2830
2895
|
end
|
2831
2896
|
|
2832
2897
|
# Gets a list of tags associated with a specified resource. Amazon Q
|
2833
|
-
# applications and data sources can have tags associated with
|
2898
|
+
# Business applications and data sources can have tags associated with
|
2899
|
+
# them.
|
2834
2900
|
#
|
2835
2901
|
# @option params [required, String] :resource_arn
|
2836
|
-
# The Amazon Resource Name (ARN) of the Amazon Q application or
|
2837
|
-
# source to get a list of tags for.
|
2902
|
+
# The Amazon Resource Name (ARN) of the Amazon Q Business application or
|
2903
|
+
# data source to get a list of tags for.
|
2838
2904
|
#
|
2839
2905
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2840
2906
|
#
|
@@ -2861,20 +2927,20 @@ module Aws::QBusiness
|
|
2861
2927
|
req.send_request(options)
|
2862
2928
|
end
|
2863
2929
|
|
2864
|
-
# Lists one or more Amazon Q Web Experiences.
|
2930
|
+
# Lists one or more Amazon Q Business Web Experiences.
|
2865
2931
|
#
|
2866
2932
|
# @option params [required, String] :application_id
|
2867
|
-
# The identifier of the Amazon Q application linked to the
|
2868
|
-
# experiences.
|
2933
|
+
# The identifier of the Amazon Q Business application linked to the
|
2934
|
+
# listed web experiences.
|
2869
2935
|
#
|
2870
2936
|
# @option params [Integer] :max_results
|
2871
|
-
# The maximum number of Amazon Q Web Experiences to return.
|
2937
|
+
# The maximum number of Amazon Q Business Web Experiences to return.
|
2872
2938
|
#
|
2873
2939
|
# @option params [String] :next_token
|
2874
2940
|
# If the `maxResults` response was incomplete because there is more data
|
2875
|
-
# to retrieve, Amazon Q returns a pagination token in the
|
2876
|
-
# can use this pagination token to retrieve the next set
|
2877
|
-
# conversations.
|
2941
|
+
# to retrieve, Amazon Q Business returns a pagination token in the
|
2942
|
+
# response. You can use this pagination token to retrieve the next set
|
2943
|
+
# of Amazon Q Business conversations.
|
2878
2944
|
#
|
2879
2945
|
# @return [Types::ListWebExperiencesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2880
2946
|
#
|
@@ -2910,7 +2976,7 @@ module Aws::QBusiness
|
|
2910
2976
|
req.send_request(options)
|
2911
2977
|
end
|
2912
2978
|
|
2913
|
-
# Enables your end user to
|
2979
|
+
# Enables your end user to provide feedback on their Amazon Q Business
|
2914
2980
|
# generated chat responses.
|
2915
2981
|
#
|
2916
2982
|
# @option params [required, String] :application_id
|
@@ -2928,7 +2994,7 @@ module Aws::QBusiness
|
|
2928
2994
|
# @option params [Types::MessageUsefulnessFeedback] :message_usefulness
|
2929
2995
|
# The feedback usefulness value given by the user to the chat message.
|
2930
2996
|
#
|
2931
|
-
# @option params [
|
2997
|
+
# @option params [String] :user_id
|
2932
2998
|
# The identifier of the user giving the feedback.
|
2933
2999
|
#
|
2934
3000
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -2946,7 +3012,7 @@ module Aws::QBusiness
|
|
2946
3012
|
# submitted_at: Time.now, # required
|
2947
3013
|
# usefulness: "USEFUL", # required, accepts USEFUL, NOT_USEFUL
|
2948
3014
|
# },
|
2949
|
-
# user_id: "UserId",
|
3015
|
+
# user_id: "UserId",
|
2950
3016
|
# })
|
2951
3017
|
#
|
2952
3018
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/PutFeedback AWS API Documentation
|
@@ -2967,7 +3033,7 @@ module Aws::QBusiness
|
|
2967
3033
|
# list of users or people who work in these teams. Only users who work
|
2968
3034
|
# in research and engineering, and therefore belong in the intellectual
|
2969
3035
|
# property group, can see top-secret company documents in their Amazon Q
|
2970
|
-
# chat results.
|
3036
|
+
# Business chat results.
|
2971
3037
|
#
|
2972
3038
|
# @option params [required, String] :application_id
|
2973
3039
|
# The identifier of the application in which the user and group mapping
|
@@ -2985,8 +3051,8 @@ module Aws::QBusiness
|
|
2985
3051
|
#
|
2986
3052
|
# @option params [required, Types::GroupMembers] :group_members
|
2987
3053
|
# A list of users or sub groups that belong to a group. This is for
|
2988
|
-
# generating Amazon Q chat results only from document a user
|
2989
|
-
# to.
|
3054
|
+
# generating Amazon Q Business chat results only from document a user
|
3055
|
+
# has access to.
|
2990
3056
|
#
|
2991
3057
|
# @option params [required, String] :group_name
|
2992
3058
|
# The list that contains your users or sub groups that belong the same
|
@@ -3043,12 +3109,12 @@ module Aws::QBusiness
|
|
3043
3109
|
end
|
3044
3110
|
|
3045
3111
|
# Starts a data source connector synchronization job. If a
|
3046
|
-
# synchronization job is already in progress, Amazon Q returns
|
3047
|
-
# `ConflictException`.
|
3112
|
+
# synchronization job is already in progress, Amazon Q Business returns
|
3113
|
+
# a `ConflictException`.
|
3048
3114
|
#
|
3049
3115
|
# @option params [required, String] :application_id
|
3050
|
-
# The identifier of Amazon Q application the data source is
|
3051
|
-
# to.
|
3116
|
+
# The identifier of Amazon Q Business application the data source is
|
3117
|
+
# connected to.
|
3052
3118
|
#
|
3053
3119
|
# @option params [required, String] :data_source_id
|
3054
3120
|
# The identifier of the data source connector.
|
@@ -3081,19 +3147,19 @@ module Aws::QBusiness
|
|
3081
3147
|
req.send_request(options)
|
3082
3148
|
end
|
3083
3149
|
|
3084
|
-
# Stops an Amazon Q data source connector synchronization job
|
3085
|
-
# progress.
|
3150
|
+
# Stops an Amazon Q Business data source connector synchronization job
|
3151
|
+
# already in progress.
|
3086
3152
|
#
|
3087
3153
|
# @option params [required, String] :application_id
|
3088
|
-
# The identifier of the Amazon Q application that the data
|
3089
|
-
# connected to.
|
3154
|
+
# The identifier of the Amazon Q Business application that the data
|
3155
|
+
# source is connected to.
|
3090
3156
|
#
|
3091
3157
|
# @option params [required, String] :data_source_id
|
3092
3158
|
# The identifier of the data source connector.
|
3093
3159
|
#
|
3094
3160
|
# @option params [required, String] :index_id
|
3095
|
-
# The identifier of the index used with the Amazon Q data
|
3096
|
-
# connector.
|
3161
|
+
# The identifier of the index used with the Amazon Q Business data
|
3162
|
+
# source connector.
|
3097
3163
|
#
|
3098
3164
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3099
3165
|
#
|
@@ -3114,18 +3180,18 @@ module Aws::QBusiness
|
|
3114
3180
|
req.send_request(options)
|
3115
3181
|
end
|
3116
3182
|
|
3117
|
-
# Adds the specified tag to the specified Amazon Q application
|
3118
|
-
# source resource. If the tag already exists, the existing value
|
3119
|
-
# replaced with the new value.
|
3183
|
+
# Adds the specified tag to the specified Amazon Q Business application
|
3184
|
+
# or data source resource. If the tag already exists, the existing value
|
3185
|
+
# is replaced with the new value.
|
3120
3186
|
#
|
3121
3187
|
# @option params [required, String] :resource_arn
|
3122
|
-
# The Amazon Resource Name (ARN) of the Amazon Q application or
|
3123
|
-
# source to tag.
|
3188
|
+
# The Amazon Resource Name (ARN) of the Amazon Q Business application or
|
3189
|
+
# data source to tag.
|
3124
3190
|
#
|
3125
3191
|
# @option params [required, Array<Types::Tag>] :tags
|
3126
|
-
# A list of tag keys to add to the Amazon Q application or data
|
3127
|
-
# If a tag already exists, the existing value is replaced with
|
3128
|
-
# value.
|
3192
|
+
# A list of tag keys to add to the Amazon Q Business application or data
|
3193
|
+
# source. If a tag already exists, the existing value is replaced with
|
3194
|
+
# the new value.
|
3129
3195
|
#
|
3130
3196
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3131
3197
|
#
|
@@ -3150,15 +3216,16 @@ module Aws::QBusiness
|
|
3150
3216
|
req.send_request(options)
|
3151
3217
|
end
|
3152
3218
|
|
3153
|
-
# Removes a tag from an Amazon Q application or a data source.
|
3219
|
+
# Removes a tag from an Amazon Q Business application or a data source.
|
3154
3220
|
#
|
3155
3221
|
# @option params [required, String] :resource_arn
|
3156
|
-
# The Amazon Resource Name (ARN) of the Amazon Q application,
|
3157
|
-
# source to remove the tag from.
|
3222
|
+
# The Amazon Resource Name (ARN) of the Amazon Q Business application,
|
3223
|
+
# or data source to remove the tag from.
|
3158
3224
|
#
|
3159
3225
|
# @option params [required, Array<String>] :tag_keys
|
3160
|
-
# A list of tag keys to remove from the Amazon Q application or
|
3161
|
-
# source. If a tag key does not exist on the resource, it is
|
3226
|
+
# A list of tag keys to remove from the Amazon Q Business application or
|
3227
|
+
# data source. If a tag key does not exist on the resource, it is
|
3228
|
+
# ignored.
|
3162
3229
|
#
|
3163
3230
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3164
3231
|
#
|
@@ -3178,24 +3245,24 @@ module Aws::QBusiness
|
|
3178
3245
|
req.send_request(options)
|
3179
3246
|
end
|
3180
3247
|
|
3181
|
-
# Updates an existing Amazon Q application.
|
3248
|
+
# Updates an existing Amazon Q Business application.
|
3182
3249
|
#
|
3183
3250
|
# @option params [required, String] :application_id
|
3184
|
-
# The identifier of the Amazon Q application.
|
3251
|
+
# The identifier of the Amazon Q Business application.
|
3185
3252
|
#
|
3186
3253
|
# @option params [Types::AttachmentsConfiguration] :attachments_configuration
|
3187
3254
|
# An option to allow end users to upload files directly during chat.
|
3188
3255
|
#
|
3189
3256
|
# @option params [String] :description
|
3190
|
-
# A description for the Amazon Q application.
|
3257
|
+
# A description for the Amazon Q Business application.
|
3191
3258
|
#
|
3192
3259
|
# @option params [String] :display_name
|
3193
|
-
# A name for the Amazon Q application.
|
3260
|
+
# A name for the Amazon Q Business application.
|
3194
3261
|
#
|
3195
3262
|
# @option params [String] :role_arn
|
3196
3263
|
# An Amazon Web Services Identity and Access Management (IAM) role that
|
3197
|
-
# gives Amazon Q permission to access Amazon CloudWatch logs
|
3198
|
-
# metrics.
|
3264
|
+
# gives Amazon Q Business permission to access Amazon CloudWatch logs
|
3265
|
+
# and metrics.
|
3199
3266
|
#
|
3200
3267
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3201
3268
|
#
|
@@ -3221,7 +3288,7 @@ module Aws::QBusiness
|
|
3221
3288
|
end
|
3222
3289
|
|
3223
3290
|
# Updates an set of chat controls configured for an existing Amazon Q
|
3224
|
-
# application.
|
3291
|
+
# Business application.
|
3225
3292
|
#
|
3226
3293
|
# @option params [required, String] :application_id
|
3227
3294
|
# The identifier of the application for which the chat controls are
|
@@ -3232,11 +3299,14 @@ module Aws::QBusiness
|
|
3232
3299
|
#
|
3233
3300
|
# @option params [String] :client_token
|
3234
3301
|
# A token that you provide to identify the request to update a Amazon Q
|
3235
|
-
# application chat configuration.
|
3302
|
+
# Business application chat configuration.
|
3236
3303
|
#
|
3237
3304
|
# **A suitable default value is auto-generated.** You should normally
|
3238
3305
|
# not need to pass this option.**
|
3239
3306
|
#
|
3307
|
+
# @option params [Types::CreatorModeConfiguration] :creator_mode_configuration
|
3308
|
+
# The configuration details for `CREATOR_MODE`.
|
3309
|
+
#
|
3240
3310
|
# @option params [String] :response_scope
|
3241
3311
|
# The response scope configured for your application. This determines
|
3242
3312
|
# whether your application uses its retrieval augmented generation (RAG)
|
@@ -3262,6 +3332,9 @@ module Aws::QBusiness
|
|
3262
3332
|
# system_message_override: "SystemMessageOverride",
|
3263
3333
|
# },
|
3264
3334
|
# client_token: "ClientToken",
|
3335
|
+
# creator_mode_configuration: {
|
3336
|
+
# creator_mode_control: "ENABLED", # required, accepts ENABLED, DISABLED
|
3337
|
+
# },
|
3265
3338
|
# response_scope: "ENTERPRISE_CONTENT_ONLY", # accepts ENTERPRISE_CONTENT_ONLY, EXTENDED_KNOWLEDGE_ENABLED
|
3266
3339
|
# topic_configurations_to_create_or_update: [
|
3267
3340
|
# {
|
@@ -3340,14 +3413,15 @@ module Aws::QBusiness
|
|
3340
3413
|
req.send_request(options)
|
3341
3414
|
end
|
3342
3415
|
|
3343
|
-
# Updates an existing Amazon Q data source connector.
|
3416
|
+
# Updates an existing Amazon Q Business data source connector.
|
3344
3417
|
#
|
3345
3418
|
# @option params [required, String] :application_id
|
3346
|
-
# The identifier of the Amazon Q application the data source is
|
3347
|
-
# to.
|
3419
|
+
# The identifier of the Amazon Q Business application the data source is
|
3420
|
+
# attached to.
|
3348
3421
|
#
|
3349
3422
|
# @option params [Hash,Array,String,Numeric,Boolean] :configuration
|
3350
|
-
# Provides the configuration information for an Amazon Q data
|
3423
|
+
# Provides the configuration information for an Amazon Q Business data
|
3424
|
+
# source.
|
3351
3425
|
#
|
3352
3426
|
# Document type used to carry open content
|
3353
3427
|
# (Hash,Array,String,Numeric,Boolean). A document type value is
|
@@ -3473,20 +3547,22 @@ module Aws::QBusiness
|
|
3473
3547
|
req.send_request(options)
|
3474
3548
|
end
|
3475
3549
|
|
3476
|
-
# Updates an Amazon Q index.
|
3550
|
+
# Updates an Amazon Q Business index.
|
3477
3551
|
#
|
3478
3552
|
# @option params [required, String] :application_id
|
3479
|
-
# The identifier of the Amazon Q application connected to the
|
3553
|
+
# The identifier of the Amazon Q Business application connected to the
|
3554
|
+
# index.
|
3480
3555
|
#
|
3481
3556
|
# @option params [Types::IndexCapacityConfiguration] :capacity_configuration
|
3482
3557
|
# The storage capacity units you want to provision for your Amazon Q
|
3483
|
-
# index. You can add and remove capacity to fit your usage
|
3558
|
+
# Business index. You can add and remove capacity to fit your usage
|
3559
|
+
# needs.
|
3484
3560
|
#
|
3485
3561
|
# @option params [String] :description
|
3486
|
-
# The description of the Amazon Q index.
|
3562
|
+
# The description of the Amazon Q Business index.
|
3487
3563
|
#
|
3488
3564
|
# @option params [String] :display_name
|
3489
|
-
# The name of the Amazon Q index.
|
3565
|
+
# The name of the Amazon Q Business index.
|
3490
3566
|
#
|
3491
3567
|
# @option params [Array<Types::DocumentAttributeConfiguration>] :document_attribute_configurations
|
3492
3568
|
# Configuration information for document metadata or fields. Document
|
@@ -3499,7 +3575,7 @@ module Aws::QBusiness
|
|
3499
3575
|
# [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes
|
3500
3576
|
#
|
3501
3577
|
# @option params [required, String] :index_id
|
3502
|
-
# The identifier of the Amazon Q index.
|
3578
|
+
# The identifier of the Amazon Q Business index.
|
3503
3579
|
#
|
3504
3580
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3505
3581
|
#
|
@@ -3531,7 +3607,7 @@ module Aws::QBusiness
|
|
3531
3607
|
req.send_request(options)
|
3532
3608
|
end
|
3533
3609
|
|
3534
|
-
# Updates an Amazon Q plugin.
|
3610
|
+
# Updates an Amazon Q Business plugin.
|
3535
3611
|
#
|
3536
3612
|
# @option params [required, String] :application_id
|
3537
3613
|
# The identifier of the application the plugin is attached to.
|
@@ -3582,14 +3658,14 @@ module Aws::QBusiness
|
|
3582
3658
|
req.send_request(options)
|
3583
3659
|
end
|
3584
3660
|
|
3585
|
-
# Updates the retriever used for your Amazon Q application.
|
3661
|
+
# Updates the retriever used for your Amazon Q Business application.
|
3586
3662
|
#
|
3587
3663
|
# @option params [required, String] :application_id
|
3588
|
-
# The identifier of your Amazon Q application.
|
3664
|
+
# The identifier of your Amazon Q Business application.
|
3589
3665
|
#
|
3590
3666
|
# @option params [Types::RetrieverConfiguration] :configuration
|
3591
3667
|
# Provides information on how the retriever used for your Amazon Q
|
3592
|
-
# application is configured.
|
3668
|
+
# Business application is configured.
|
3593
3669
|
#
|
3594
3670
|
# @option params [String] :display_name
|
3595
3671
|
# The name of your retriever.
|
@@ -3715,31 +3791,32 @@ module Aws::QBusiness
|
|
3715
3791
|
req.send_request(options)
|
3716
3792
|
end
|
3717
3793
|
|
3718
|
-
# Updates an Amazon Q web experience.
|
3794
|
+
# Updates an Amazon Q Business web experience.
|
3719
3795
|
#
|
3720
3796
|
# @option params [required, String] :application_id
|
3721
|
-
# The identifier of the Amazon Q application attached to the
|
3722
|
-
# experience.
|
3797
|
+
# The identifier of the Amazon Q Business application attached to the
|
3798
|
+
# web experience.
|
3723
3799
|
#
|
3724
3800
|
# @option params [Types::WebExperienceAuthConfiguration] :authentication_configuration
|
3725
|
-
# The authentication configuration of the Amazon Q web
|
3801
|
+
# The authentication configuration of the Amazon Q Business web
|
3802
|
+
# experience.
|
3726
3803
|
#
|
3727
3804
|
# @option params [String] :sample_prompts_control_mode
|
3728
3805
|
# Determines whether sample prompts are enabled in the web experience
|
3729
3806
|
# for an end user.
|
3730
3807
|
#
|
3731
3808
|
# @option params [String] :subtitle
|
3732
|
-
# The subtitle of the Amazon Q web experience.
|
3809
|
+
# The subtitle of the Amazon Q Business web experience.
|
3733
3810
|
#
|
3734
3811
|
# @option params [String] :title
|
3735
|
-
# The title of the Amazon Q web experience.
|
3812
|
+
# The title of the Amazon Q Business web experience.
|
3736
3813
|
#
|
3737
3814
|
# @option params [required, String] :web_experience_id
|
3738
|
-
# The identifier of the Amazon Q web experience.
|
3815
|
+
# The identifier of the Amazon Q Business web experience.
|
3739
3816
|
#
|
3740
3817
|
# @option params [String] :welcome_message
|
3741
|
-
# A customized welcome message for an end user in an Amazon Q
|
3742
|
-
# experience.
|
3818
|
+
# A customized welcome message for an end user in an Amazon Q Business
|
3819
|
+
# web experience.
|
3743
3820
|
#
|
3744
3821
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3745
3822
|
#
|
@@ -3784,7 +3861,7 @@ module Aws::QBusiness
|
|
3784
3861
|
params: params,
|
3785
3862
|
config: config)
|
3786
3863
|
context[:gem_name] = 'aws-sdk-qbusiness'
|
3787
|
-
context[:gem_version] = '1.
|
3864
|
+
context[:gem_version] = '1.3.0'
|
3788
3865
|
Seahorse::Client::Request.new(handlers, context)
|
3789
3866
|
end
|
3790
3867
|
|