aws-sdk-qbusiness 1.1.0 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-qbusiness/client.rb +359 -231
- data/lib/aws-sdk-qbusiness/client_api.rb +81 -5
- data/lib/aws-sdk-qbusiness/types.rb +908 -462
- data/lib/aws-sdk-qbusiness.rb +1 -1
- data/sig/client.rbs +54 -6
- data/sig/types.rbs +79 -1
- 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
|
@@ -1068,11 +1108,11 @@ module Aws::QBusiness
|
|
1068
1108
|
#
|
1069
1109
|
#
|
1070
1110
|
#
|
1071
|
-
# [1]: https://docs.aws.amazon.com/
|
1072
|
-
# [2]: https://docs.aws.amazon.com/
|
1111
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_BatchPutDocument.html
|
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
|
@@ -1258,6 +1299,27 @@ module Aws::QBusiness
|
|
1258
1299
|
# index_id: "KendraIndexId", # required
|
1259
1300
|
# },
|
1260
1301
|
# native_index_configuration: {
|
1302
|
+
# boosting_override: {
|
1303
|
+
# "DocumentAttributeKey" => {
|
1304
|
+
# date_configuration: {
|
1305
|
+
# boosting_duration_in_seconds: 1,
|
1306
|
+
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
1307
|
+
# },
|
1308
|
+
# number_configuration: {
|
1309
|
+
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
1310
|
+
# boosting_type: "PRIORITIZE_LARGER_VALUES", # accepts PRIORITIZE_LARGER_VALUES, PRIORITIZE_SMALLER_VALUES
|
1311
|
+
# },
|
1312
|
+
# string_configuration: {
|
1313
|
+
# attribute_value_boosting: {
|
1314
|
+
# "String" => "LOW", # accepts LOW, MEDIUM, HIGH, VERY_HIGH
|
1315
|
+
# },
|
1316
|
+
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
1317
|
+
# },
|
1318
|
+
# string_list_configuration: {
|
1319
|
+
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
1320
|
+
# },
|
1321
|
+
# },
|
1322
|
+
# },
|
1261
1323
|
# index_id: "IndexId", # required
|
1262
1324
|
# },
|
1263
1325
|
# },
|
@@ -1295,7 +1357,7 @@ module Aws::QBusiness
|
|
1295
1357
|
#
|
1296
1358
|
# @option params [String] :client_token
|
1297
1359
|
# A token that you provide to identify the request to create your Amazon
|
1298
|
-
# Q user mapping.
|
1360
|
+
# Q Business user mapping.
|
1299
1361
|
#
|
1300
1362
|
# **A suitable default value is auto-generated.** You should normally
|
1301
1363
|
# not need to pass this option.**
|
@@ -1332,38 +1394,42 @@ module Aws::QBusiness
|
|
1332
1394
|
req.send_request(options)
|
1333
1395
|
end
|
1334
1396
|
|
1335
|
-
# Creates an Amazon Q web experience.
|
1397
|
+
# Creates an Amazon Q Business web experience.
|
1336
1398
|
#
|
1337
1399
|
# @option params [required, String] :application_id
|
1338
|
-
# The identifier of the Amazon Q web experience.
|
1400
|
+
# The identifier of the Amazon Q Business web experience.
|
1339
1401
|
#
|
1340
1402
|
# @option params [String] :client_token
|
1341
|
-
# A token you provide to identify a request to create an Amazon Q
|
1342
|
-
# experience.
|
1403
|
+
# A token you provide to identify a request to create an Amazon Q
|
1404
|
+
# Business web experience.
|
1343
1405
|
#
|
1344
1406
|
# **A suitable default value is auto-generated.** You should normally
|
1345
1407
|
# not need to pass this option.**
|
1346
1408
|
#
|
1409
|
+
# @option params [String] :role_arn
|
1410
|
+
# The Amazon Resource Name (ARN) of the service role attached to your
|
1411
|
+
# web experience.
|
1412
|
+
#
|
1347
1413
|
# @option params [String] :sample_prompts_control_mode
|
1348
1414
|
# Determines whether sample prompts are enabled in the web experience
|
1349
1415
|
# for an end user.
|
1350
1416
|
#
|
1351
1417
|
# @option params [String] :subtitle
|
1352
|
-
# A subtitle to personalize your Amazon Q web experience.
|
1418
|
+
# A subtitle to personalize your Amazon Q Business web experience.
|
1353
1419
|
#
|
1354
1420
|
# @option params [Array<Types::Tag>] :tags
|
1355
1421
|
# A list of key-value pairs that identify or categorize your Amazon Q
|
1356
|
-
# web experience. You can also use tags to help control access
|
1357
|
-
# web experience. Tag keys and values can consist of Unicode
|
1358
|
-
# digits, white space, and any of the following symbols: \_ . :
|
1359
|
-
# @.
|
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
|
+
# / = + - @.
|
1360
1426
|
#
|
1361
1427
|
# @option params [String] :title
|
1362
|
-
# The title for your Amazon Q web experience.
|
1428
|
+
# The title for your Amazon Q Business web experience.
|
1363
1429
|
#
|
1364
1430
|
# @option params [String] :welcome_message
|
1365
|
-
# The customized welcome message for end users of an Amazon Q
|
1366
|
-
# experience.
|
1431
|
+
# The customized welcome message for end users of an Amazon Q Business
|
1432
|
+
# web experience.
|
1367
1433
|
#
|
1368
1434
|
# @return [Types::CreateWebExperienceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1369
1435
|
#
|
@@ -1375,6 +1441,7 @@ module Aws::QBusiness
|
|
1375
1441
|
# resp = client.create_web_experience({
|
1376
1442
|
# application_id: "ApplicationId", # required
|
1377
1443
|
# client_token: "ClientToken",
|
1444
|
+
# role_arn: "RoleArn",
|
1378
1445
|
# sample_prompts_control_mode: "ENABLED", # accepts ENABLED, DISABLED
|
1379
1446
|
# subtitle: "WebExperienceSubtitle",
|
1380
1447
|
# tags: [
|
@@ -1401,10 +1468,10 @@ module Aws::QBusiness
|
|
1401
1468
|
req.send_request(options)
|
1402
1469
|
end
|
1403
1470
|
|
1404
|
-
# Deletes an Amazon Q application.
|
1471
|
+
# Deletes an Amazon Q Business application.
|
1405
1472
|
#
|
1406
1473
|
# @option params [required, String] :application_id
|
1407
|
-
# The identifier of the Amazon Q application.
|
1474
|
+
# The identifier of the Amazon Q Business application.
|
1408
1475
|
#
|
1409
1476
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1410
1477
|
#
|
@@ -1423,7 +1490,8 @@ module Aws::QBusiness
|
|
1423
1490
|
req.send_request(options)
|
1424
1491
|
end
|
1425
1492
|
|
1426
|
-
# Deletes chat controls configured for an existing Amazon Q
|
1493
|
+
# Deletes chat controls configured for an existing Amazon Q Business
|
1494
|
+
# application.
|
1427
1495
|
#
|
1428
1496
|
# @option params [required, String] :application_id
|
1429
1497
|
# The identifier of the application the chat controls have been
|
@@ -1446,17 +1514,17 @@ module Aws::QBusiness
|
|
1446
1514
|
req.send_request(options)
|
1447
1515
|
end
|
1448
1516
|
|
1449
|
-
# Deletes an Amazon Q web experience conversation.
|
1517
|
+
# Deletes an Amazon Q Business web experience conversation.
|
1450
1518
|
#
|
1451
1519
|
# @option params [required, String] :application_id
|
1452
|
-
# The identifier of the Amazon Q application associated with
|
1453
|
-
# conversation.
|
1520
|
+
# The identifier of the Amazon Q Business application associated with
|
1521
|
+
# the conversation.
|
1454
1522
|
#
|
1455
1523
|
# @option params [required, String] :conversation_id
|
1456
|
-
# The identifier of the Amazon Q web experience conversation
|
1457
|
-
# deleted.
|
1524
|
+
# The identifier of the Amazon Q Business web experience conversation
|
1525
|
+
# being deleted.
|
1458
1526
|
#
|
1459
|
-
# @option params [
|
1527
|
+
# @option params [String] :user_id
|
1460
1528
|
# The identifier of the user who is deleting the conversation.
|
1461
1529
|
#
|
1462
1530
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -1466,7 +1534,7 @@ module Aws::QBusiness
|
|
1466
1534
|
# resp = client.delete_conversation({
|
1467
1535
|
# application_id: "ApplicationId", # required
|
1468
1536
|
# conversation_id: "ConversationId", # required
|
1469
|
-
# user_id: "UserId",
|
1537
|
+
# user_id: "UserId",
|
1470
1538
|
# })
|
1471
1539
|
#
|
1472
1540
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteConversation AWS API Documentation
|
@@ -1478,13 +1546,13 @@ module Aws::QBusiness
|
|
1478
1546
|
req.send_request(options)
|
1479
1547
|
end
|
1480
1548
|
|
1481
|
-
# Deletes an Amazon Q data source connector. While the data
|
1482
|
-
# 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
|
1483
1551
|
# `DescribeDataSource` API is set to `DELETING`.
|
1484
1552
|
#
|
1485
1553
|
# @option params [required, String] :application_id
|
1486
|
-
# The identifier of the Amazon Q application used with the data
|
1487
|
-
# connector.
|
1554
|
+
# The identifier of the Amazon Q Business application used with the data
|
1555
|
+
# source connector.
|
1488
1556
|
#
|
1489
1557
|
# @option params [required, String] :data_source_id
|
1490
1558
|
# The identifier of the data source connector that you want to delete.
|
@@ -1565,14 +1633,14 @@ module Aws::QBusiness
|
|
1565
1633
|
req.send_request(options)
|
1566
1634
|
end
|
1567
1635
|
|
1568
|
-
# Deletes an Amazon Q index.
|
1636
|
+
# Deletes an Amazon Q Business index.
|
1569
1637
|
#
|
1570
1638
|
# @option params [required, String] :application_id
|
1571
|
-
# The identifier of the Amazon Q application the Amazon Q
|
1572
|
-
# linked to.
|
1639
|
+
# The identifier of the Amazon Q Business application the Amazon Q
|
1640
|
+
# Business index is linked to.
|
1573
1641
|
#
|
1574
1642
|
# @option params [required, String] :index_id
|
1575
|
-
# The identifier of the Amazon Q index.
|
1643
|
+
# The identifier of the Amazon Q Business index.
|
1576
1644
|
#
|
1577
1645
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1578
1646
|
#
|
@@ -1592,10 +1660,11 @@ module Aws::QBusiness
|
|
1592
1660
|
req.send_request(options)
|
1593
1661
|
end
|
1594
1662
|
|
1595
|
-
# Deletes an Amazon Q plugin.
|
1663
|
+
# Deletes an Amazon Q Business plugin.
|
1596
1664
|
#
|
1597
1665
|
# @option params [required, String] :application_id
|
1598
|
-
# The identifier the application attached to the Amazon Q
|
1666
|
+
# The identifier the application attached to the Amazon Q Business
|
1667
|
+
# plugin.
|
1599
1668
|
#
|
1600
1669
|
# @option params [required, String] :plugin_id
|
1601
1670
|
# The identifier of the plugin being deleted.
|
@@ -1618,10 +1687,11 @@ module Aws::QBusiness
|
|
1618
1687
|
req.send_request(options)
|
1619
1688
|
end
|
1620
1689
|
|
1621
|
-
# Deletes the retriever used by an Amazon Q application.
|
1690
|
+
# Deletes the retriever used by an Amazon Q Business application.
|
1622
1691
|
#
|
1623
1692
|
# @option params [required, String] :application_id
|
1624
|
-
# The identifier of the Amazon Q application using the
|
1693
|
+
# The identifier of the Amazon Q Business application using the
|
1694
|
+
# retriever.
|
1625
1695
|
#
|
1626
1696
|
# @option params [required, String] :retriever_id
|
1627
1697
|
# The identifier of the retriever being deleted.
|
@@ -1671,14 +1741,14 @@ module Aws::QBusiness
|
|
1671
1741
|
req.send_request(options)
|
1672
1742
|
end
|
1673
1743
|
|
1674
|
-
# Deletes an Amazon Q web experience.
|
1744
|
+
# Deletes an Amazon Q Business web experience.
|
1675
1745
|
#
|
1676
1746
|
# @option params [required, String] :application_id
|
1677
|
-
# The identifier of the Amazon Q application linked to the
|
1678
|
-
# experience.
|
1747
|
+
# The identifier of the Amazon Q Business application linked to the
|
1748
|
+
# Amazon Q Business web experience.
|
1679
1749
|
#
|
1680
1750
|
# @option params [required, String] :web_experience_id
|
1681
|
-
# The identifier of the Amazon Q web experience being deleted.
|
1751
|
+
# The identifier of the Amazon Q Business web experience being deleted.
|
1682
1752
|
#
|
1683
1753
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1684
1754
|
#
|
@@ -1698,10 +1768,10 @@ module Aws::QBusiness
|
|
1698
1768
|
req.send_request(options)
|
1699
1769
|
end
|
1700
1770
|
|
1701
|
-
# Gets information about an existing Amazon Q application.
|
1771
|
+
# Gets information about an existing Amazon Q Business application.
|
1702
1772
|
#
|
1703
1773
|
# @option params [required, String] :application_id
|
1704
|
-
# The identifier of the Amazon Q application.
|
1774
|
+
# The identifier of the Amazon Q Business application.
|
1705
1775
|
#
|
1706
1776
|
# @return [Types::GetApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1707
1777
|
#
|
@@ -1713,6 +1783,7 @@ module Aws::QBusiness
|
|
1713
1783
|
# * {Types::GetApplicationResponse#display_name #display_name} => String
|
1714
1784
|
# * {Types::GetApplicationResponse#encryption_configuration #encryption_configuration} => Types::EncryptionConfiguration
|
1715
1785
|
# * {Types::GetApplicationResponse#error #error} => Types::ErrorDetail
|
1786
|
+
# * {Types::GetApplicationResponse#identity_center_application_arn #identity_center_application_arn} => String
|
1716
1787
|
# * {Types::GetApplicationResponse#role_arn #role_arn} => String
|
1717
1788
|
# * {Types::GetApplicationResponse#status #status} => String
|
1718
1789
|
# * {Types::GetApplicationResponse#updated_at #updated_at} => Time
|
@@ -1734,6 +1805,7 @@ module Aws::QBusiness
|
|
1734
1805
|
# resp.encryption_configuration.kms_key_id #=> String
|
1735
1806
|
# resp.error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
1736
1807
|
# resp.error.error_message #=> String
|
1808
|
+
# resp.identity_center_application_arn #=> String
|
1737
1809
|
# resp.role_arn #=> String
|
1738
1810
|
# resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING"
|
1739
1811
|
# resp.updated_at #=> Time
|
@@ -1748,7 +1820,7 @@ module Aws::QBusiness
|
|
1748
1820
|
end
|
1749
1821
|
|
1750
1822
|
# Gets information about an chat controls configured for an existing
|
1751
|
-
# Amazon Q application.
|
1823
|
+
# Amazon Q Business application.
|
1752
1824
|
#
|
1753
1825
|
# @option params [required, String] :application_id
|
1754
1826
|
# The identifier of the application for which the chat controls are
|
@@ -1759,13 +1831,14 @@ module Aws::QBusiness
|
|
1759
1831
|
#
|
1760
1832
|
# @option params [String] :next_token
|
1761
1833
|
# If the `maxResults` response was incomplete because there is more data
|
1762
|
-
# to retrieve, Amazon Q returns a pagination token in the
|
1763
|
-
# can use this pagination token to retrieve the next set
|
1764
|
-
# 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.
|
1765
1837
|
#
|
1766
1838
|
# @return [Types::GetChatControlsConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1767
1839
|
#
|
1768
1840
|
# * {Types::GetChatControlsConfigurationResponse#blocked_phrases #blocked_phrases} => Types::BlockedPhrasesConfiguration
|
1841
|
+
# * {Types::GetChatControlsConfigurationResponse#creator_mode_configuration #creator_mode_configuration} => Types::AppliedCreatorModeConfiguration
|
1769
1842
|
# * {Types::GetChatControlsConfigurationResponse#next_token #next_token} => String
|
1770
1843
|
# * {Types::GetChatControlsConfigurationResponse#response_scope #response_scope} => String
|
1771
1844
|
# * {Types::GetChatControlsConfigurationResponse#topic_configurations #topic_configurations} => Array<Types::TopicConfiguration>
|
@@ -1785,6 +1858,7 @@ module Aws::QBusiness
|
|
1785
1858
|
# resp.blocked_phrases.blocked_phrases #=> Array
|
1786
1859
|
# resp.blocked_phrases.blocked_phrases[0] #=> String
|
1787
1860
|
# resp.blocked_phrases.system_message_override #=> String
|
1861
|
+
# resp.creator_mode_configuration.creator_mode_control #=> String, one of "ENABLED", "DISABLED"
|
1788
1862
|
# resp.next_token #=> String
|
1789
1863
|
# resp.response_scope #=> String, one of "ENTERPRISE_CONTENT_ONLY", "EXTENDED_KNOWLEDGE_ENABLED"
|
1790
1864
|
# resp.topic_configurations #=> Array
|
@@ -1816,10 +1890,11 @@ module Aws::QBusiness
|
|
1816
1890
|
req.send_request(options)
|
1817
1891
|
end
|
1818
1892
|
|
1819
|
-
# Gets information about an existing Amazon Q data source
|
1893
|
+
# Gets information about an existing Amazon Q Business data source
|
1894
|
+
# connector.
|
1820
1895
|
#
|
1821
1896
|
# @option params [required, String] :application_id
|
1822
|
-
# The identifier of the Amazon Q application.
|
1897
|
+
# The identifier of the Amazon Q Business application.
|
1823
1898
|
#
|
1824
1899
|
# @option params [required, String] :data_source_id
|
1825
1900
|
# The identifier of the data source connector.
|
@@ -1969,13 +2044,14 @@ module Aws::QBusiness
|
|
1969
2044
|
req.send_request(options)
|
1970
2045
|
end
|
1971
2046
|
|
1972
|
-
# Gets information about an existing Amazon Q index.
|
2047
|
+
# Gets information about an existing Amazon Q Business index.
|
1973
2048
|
#
|
1974
2049
|
# @option params [required, String] :application_id
|
1975
|
-
# The identifier of the Amazon Q application connected to the
|
2050
|
+
# The identifier of the Amazon Q Business application connected to the
|
2051
|
+
# index.
|
1976
2052
|
#
|
1977
2053
|
# @option params [required, String] :index_id
|
1978
|
-
# The identifier of the Amazon Q index you want information on.
|
2054
|
+
# The identifier of the Amazon Q Business index you want information on.
|
1979
2055
|
#
|
1980
2056
|
# @return [Types::GetIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1981
2057
|
#
|
@@ -2028,7 +2104,7 @@ module Aws::QBusiness
|
|
2028
2104
|
req.send_request(options)
|
2029
2105
|
end
|
2030
2106
|
|
2031
|
-
# Gets information about an existing Amazon Q plugin.
|
2107
|
+
# Gets information about an existing Amazon Q Business plugin.
|
2032
2108
|
#
|
2033
2109
|
# @option params [required, String] :application_id
|
2034
2110
|
# The identifier of the application which contains the plugin.
|
@@ -2082,10 +2158,11 @@ module Aws::QBusiness
|
|
2082
2158
|
end
|
2083
2159
|
|
2084
2160
|
# Gets information about an existing retriever used by an Amazon Q
|
2085
|
-
# application.
|
2161
|
+
# Business application.
|
2086
2162
|
#
|
2087
2163
|
# @option params [required, String] :application_id
|
2088
|
-
# The identifier of the Amazon Q application using the
|
2164
|
+
# The identifier of the Amazon Q Business application using the
|
2165
|
+
# retriever.
|
2089
2166
|
#
|
2090
2167
|
# @option params [required, String] :retriever_id
|
2091
2168
|
# The identifier of the retriever.
|
@@ -2114,6 +2191,15 @@ module Aws::QBusiness
|
|
2114
2191
|
#
|
2115
2192
|
# resp.application_id #=> String
|
2116
2193
|
# resp.configuration.kendra_index_configuration.index_id #=> String
|
2194
|
+
# resp.configuration.native_index_configuration.boosting_override #=> Hash
|
2195
|
+
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].date_configuration.boosting_duration_in_seconds #=> Integer
|
2196
|
+
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].date_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
|
2197
|
+
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].number_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
|
2198
|
+
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].number_configuration.boosting_type #=> String, one of "PRIORITIZE_LARGER_VALUES", "PRIORITIZE_SMALLER_VALUES"
|
2199
|
+
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].string_configuration.attribute_value_boosting #=> Hash
|
2200
|
+
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].string_configuration.attribute_value_boosting["String"] #=> String, one of "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
|
2201
|
+
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].string_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
|
2202
|
+
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].string_list_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
|
2117
2203
|
# resp.configuration.native_index_configuration.index_id #=> String
|
2118
2204
|
# resp.created_at #=> Time
|
2119
2205
|
# resp.display_name #=> String
|
@@ -2169,14 +2255,14 @@ module Aws::QBusiness
|
|
2169
2255
|
req.send_request(options)
|
2170
2256
|
end
|
2171
2257
|
|
2172
|
-
# Gets information about an existing Amazon Q web experience.
|
2258
|
+
# Gets information about an existing Amazon Q Business web experience.
|
2173
2259
|
#
|
2174
2260
|
# @option params [required, String] :application_id
|
2175
|
-
# The identifier of the Amazon Q application linked to the web
|
2261
|
+
# The identifier of the Amazon Q Business application linked to the web
|
2176
2262
|
# experience.
|
2177
2263
|
#
|
2178
2264
|
# @option params [required, String] :web_experience_id
|
2179
|
-
# The identifier of the Amazon Q web experience.
|
2265
|
+
# The identifier of the Amazon Q Business web experience.
|
2180
2266
|
#
|
2181
2267
|
# @return [Types::GetWebExperienceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2182
2268
|
#
|
@@ -2185,6 +2271,7 @@ module Aws::QBusiness
|
|
2185
2271
|
# * {Types::GetWebExperienceResponse#created_at #created_at} => Time
|
2186
2272
|
# * {Types::GetWebExperienceResponse#default_endpoint #default_endpoint} => String
|
2187
2273
|
# * {Types::GetWebExperienceResponse#error #error} => Types::ErrorDetail
|
2274
|
+
# * {Types::GetWebExperienceResponse#role_arn #role_arn} => String
|
2188
2275
|
# * {Types::GetWebExperienceResponse#sample_prompts_control_mode #sample_prompts_control_mode} => String
|
2189
2276
|
# * {Types::GetWebExperienceResponse#status #status} => String
|
2190
2277
|
# * {Types::GetWebExperienceResponse#subtitle #subtitle} => String
|
@@ -2212,6 +2299,7 @@ module Aws::QBusiness
|
|
2212
2299
|
# resp.default_endpoint #=> String
|
2213
2300
|
# resp.error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
2214
2301
|
# resp.error.error_message #=> String
|
2302
|
+
# resp.role_arn #=> String
|
2215
2303
|
# resp.sample_prompts_control_mode #=> String, one of "ENABLED", "DISABLED"
|
2216
2304
|
# resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "PENDING_AUTH_CONFIG"
|
2217
2305
|
# resp.subtitle #=> String
|
@@ -2230,16 +2318,16 @@ module Aws::QBusiness
|
|
2230
2318
|
req.send_request(options)
|
2231
2319
|
end
|
2232
2320
|
|
2233
|
-
# Lists Amazon Q applications.
|
2321
|
+
# Lists Amazon Q Business applications.
|
2234
2322
|
#
|
2235
2323
|
# @option params [Integer] :max_results
|
2236
|
-
# The maximum number of Amazon Q applications to return.
|
2324
|
+
# The maximum number of Amazon Q Business applications to return.
|
2237
2325
|
#
|
2238
2326
|
# @option params [String] :next_token
|
2239
2327
|
# If the `maxResults` response was incomplete because there is more data
|
2240
|
-
# to retrieve, Amazon Q returns a pagination token in the
|
2241
|
-
# can use this pagination token to retrieve the next set
|
2242
|
-
# 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.
|
2243
2331
|
#
|
2244
2332
|
# @return [Types::ListApplicationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2245
2333
|
#
|
@@ -2274,23 +2362,23 @@ module Aws::QBusiness
|
|
2274
2362
|
req.send_request(options)
|
2275
2363
|
end
|
2276
2364
|
|
2277
|
-
# Lists one or more Amazon Q conversations.
|
2365
|
+
# Lists one or more Amazon Q Business conversations.
|
2278
2366
|
#
|
2279
2367
|
# @option params [required, String] :application_id
|
2280
|
-
# The identifier of the Amazon Q application.
|
2368
|
+
# The identifier of the Amazon Q Business application.
|
2281
2369
|
#
|
2282
2370
|
# @option params [Integer] :max_results
|
2283
|
-
# The maximum number of Amazon Q conversations to return.
|
2371
|
+
# The maximum number of Amazon Q Business conversations to return.
|
2284
2372
|
#
|
2285
2373
|
# @option params [String] :next_token
|
2286
2374
|
# If the `maxResults` response was incomplete because there is more data
|
2287
|
-
# to retrieve, Amazon Q returns a pagination token in the
|
2288
|
-
# can use this pagination token to retrieve the next set
|
2289
|
-
# 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.
|
2290
2378
|
#
|
2291
|
-
# @option params [
|
2292
|
-
# The identifier of the user involved in the Amazon Q web
|
2293
|
-
# conversation.
|
2379
|
+
# @option params [String] :user_id
|
2380
|
+
# The identifier of the user involved in the Amazon Q Business web
|
2381
|
+
# experience conversation.
|
2294
2382
|
#
|
2295
2383
|
# @return [Types::ListConversationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2296
2384
|
#
|
@@ -2305,7 +2393,7 @@ module Aws::QBusiness
|
|
2305
2393
|
# application_id: "ApplicationId", # required
|
2306
2394
|
# max_results: 1,
|
2307
2395
|
# next_token: "NextToken",
|
2308
|
-
# user_id: "UserId",
|
2396
|
+
# user_id: "UserId",
|
2309
2397
|
# })
|
2310
2398
|
#
|
2311
2399
|
# @example Response structure
|
@@ -2325,12 +2413,12 @@ module Aws::QBusiness
|
|
2325
2413
|
req.send_request(options)
|
2326
2414
|
end
|
2327
2415
|
|
2328
|
-
# Get information about an Amazon Q data source connector
|
2416
|
+
# Get information about an Amazon Q Business data source connector
|
2329
2417
|
# synchronization.
|
2330
2418
|
#
|
2331
2419
|
# @option params [required, String] :application_id
|
2332
|
-
# The identifier of the Amazon Q application connected to the
|
2333
|
-
# source.
|
2420
|
+
# The identifier of the Amazon Q Business application connected to the
|
2421
|
+
# data source.
|
2334
2422
|
#
|
2335
2423
|
# @option params [required, String] :data_source_id
|
2336
2424
|
# The identifier of the data source connector.
|
@@ -2339,16 +2427,17 @@ module Aws::QBusiness
|
|
2339
2427
|
# The end time of the data source connector sync.
|
2340
2428
|
#
|
2341
2429
|
# @option params [required, String] :index_id
|
2342
|
-
# The identifier of the index used with the Amazon Q data
|
2343
|
-
# connector.
|
2430
|
+
# The identifier of the index used with the Amazon Q Business data
|
2431
|
+
# source connector.
|
2344
2432
|
#
|
2345
2433
|
# @option params [Integer] :max_results
|
2346
2434
|
# The maximum number of synchronization jobs to return in the response.
|
2347
2435
|
#
|
2348
2436
|
# @option params [String] :next_token
|
2349
2437
|
# If the `maxResults` response was incpmplete because there is more data
|
2350
|
-
# to retriever, Amazon Q returns a pagination token in the
|
2351
|
-
# 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.
|
2352
2441
|
#
|
2353
2442
|
# @option params [Time,DateTime,Date,Integer,String] :start_time
|
2354
2443
|
# The start time of the data source connector sync.
|
@@ -2403,11 +2492,12 @@ module Aws::QBusiness
|
|
2403
2492
|
req.send_request(options)
|
2404
2493
|
end
|
2405
2494
|
|
2406
|
-
# Lists the Amazon Q data source connectors that you have
|
2495
|
+
# Lists the Amazon Q Business data source connectors that you have
|
2496
|
+
# created.
|
2407
2497
|
#
|
2408
2498
|
# @option params [required, String] :application_id
|
2409
|
-
# The identifier of the Amazon Q application linked to the data
|
2410
|
-
# connectors.
|
2499
|
+
# The identifier of the Amazon Q Business application linked to the data
|
2500
|
+
# source connectors.
|
2411
2501
|
#
|
2412
2502
|
# @option params [required, String] :index_id
|
2413
2503
|
# The identifier of the index used with one or more data source
|
@@ -2418,9 +2508,9 @@ module Aws::QBusiness
|
|
2418
2508
|
#
|
2419
2509
|
# @option params [String] :next_token
|
2420
2510
|
# If the `maxResults` response was incomplete because there is more data
|
2421
|
-
# to retrieve, Amazon Q returns a pagination token in the
|
2422
|
-
# can use this pagination token to retrieve the next set
|
2423
|
-
# 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.
|
2424
2514
|
#
|
2425
2515
|
# @return [Types::ListDataSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2426
2516
|
#
|
@@ -2474,8 +2564,9 @@ module Aws::QBusiness
|
|
2474
2564
|
#
|
2475
2565
|
# @option params [String] :next_token
|
2476
2566
|
# If the `maxResults` response was incomplete because there is more data
|
2477
|
-
# to retrieve, Amazon Q returns a pagination token in the
|
2478
|
-
# 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.
|
2479
2570
|
#
|
2480
2571
|
# @return [Types::ListDocumentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2481
2572
|
#
|
@@ -2533,9 +2624,9 @@ module Aws::QBusiness
|
|
2533
2624
|
#
|
2534
2625
|
# @option params [String] :next_token
|
2535
2626
|
# If the previous response was incomplete (because there is more data to
|
2536
|
-
# retrieve), Amazon Q returns a pagination token in the
|
2537
|
-
# can use this pagination token to retrieve the next set
|
2538
|
-
# 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.
|
2539
2630
|
#
|
2540
2631
|
# @option params [required, Time,DateTime,Date,Integer,String] :updated_earlier_than
|
2541
2632
|
# The timestamp identifier used for the latest `PUT` or `DELETE` action
|
@@ -2574,19 +2665,20 @@ module Aws::QBusiness
|
|
2574
2665
|
req.send_request(options)
|
2575
2666
|
end
|
2576
2667
|
|
2577
|
-
# Lists the Amazon Q indices you have created.
|
2668
|
+
# Lists the Amazon Q Business indices you have created.
|
2578
2669
|
#
|
2579
2670
|
# @option params [required, String] :application_id
|
2580
|
-
# The identifier of the Amazon Q application connected to the
|
2671
|
+
# The identifier of the Amazon Q Business application connected to the
|
2672
|
+
# index.
|
2581
2673
|
#
|
2582
2674
|
# @option params [Integer] :max_results
|
2583
2675
|
# The maximum number of indices to return.
|
2584
2676
|
#
|
2585
2677
|
# @option params [String] :next_token
|
2586
2678
|
# If the maxResults response was incomplete because there is more data
|
2587
|
-
# to retrieve, Amazon Q returns a pagination token in the
|
2588
|
-
# can use this pagination token to retrieve the next set
|
2589
|
-
# 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.
|
2590
2682
|
#
|
2591
2683
|
# @return [Types::ListIndicesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2592
2684
|
#
|
@@ -2622,25 +2714,26 @@ module Aws::QBusiness
|
|
2622
2714
|
req.send_request(options)
|
2623
2715
|
end
|
2624
2716
|
|
2625
|
-
# 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.
|
2626
2719
|
#
|
2627
2720
|
# @option params [required, String] :application_id
|
2628
|
-
# The identifier for the Amazon Q application.
|
2721
|
+
# The identifier for the Amazon Q Business application.
|
2629
2722
|
#
|
2630
2723
|
# @option params [required, String] :conversation_id
|
2631
|
-
# The identifier of the Amazon Q web experience conversation.
|
2724
|
+
# The identifier of the Amazon Q Business web experience conversation.
|
2632
2725
|
#
|
2633
2726
|
# @option params [Integer] :max_results
|
2634
2727
|
# The maximum number of messages to return.
|
2635
2728
|
#
|
2636
2729
|
# @option params [String] :next_token
|
2637
2730
|
# If the number of retrievers returned exceeds `maxResults`, Amazon Q
|
2638
|
-
# returns a next token as a pagination token to retrieve the
|
2639
|
-
# messages.
|
2731
|
+
# Business returns a next token as a pagination token to retrieve the
|
2732
|
+
# next set of messages.
|
2640
2733
|
#
|
2641
|
-
# @option params [
|
2642
|
-
# The identifier of the user involved in the Amazon Q web
|
2643
|
-
# conversation.
|
2734
|
+
# @option params [String] :user_id
|
2735
|
+
# The identifier of the user involved in the Amazon Q Business web
|
2736
|
+
# experience conversation.
|
2644
2737
|
#
|
2645
2738
|
# @return [Types::ListMessagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2646
2739
|
#
|
@@ -2656,7 +2749,7 @@ module Aws::QBusiness
|
|
2656
2749
|
# conversation_id: "ConversationId", # required
|
2657
2750
|
# max_results: 1,
|
2658
2751
|
# next_token: "NextToken",
|
2659
|
-
# user_id: "UserId",
|
2752
|
+
# user_id: "UserId",
|
2660
2753
|
# })
|
2661
2754
|
#
|
2662
2755
|
# @example Response structure
|
@@ -2703,7 +2796,7 @@ module Aws::QBusiness
|
|
2703
2796
|
req.send_request(options)
|
2704
2797
|
end
|
2705
2798
|
|
2706
|
-
# Lists configured Amazon Q plugins.
|
2799
|
+
# Lists configured Amazon Q Business plugins.
|
2707
2800
|
#
|
2708
2801
|
# @option params [required, String] :application_id
|
2709
2802
|
# The identifier of the application the plugin is attached to.
|
@@ -2713,8 +2806,9 @@ module Aws::QBusiness
|
|
2713
2806
|
#
|
2714
2807
|
# @option params [String] :next_token
|
2715
2808
|
# If the `maxResults` response was incomplete because there is more data
|
2716
|
-
# to retrieve, Amazon Q returns a pagination token in the
|
2717
|
-
# 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.
|
2718
2812
|
#
|
2719
2813
|
# @return [Types::ListPluginsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2720
2814
|
#
|
@@ -2752,18 +2846,19 @@ module Aws::QBusiness
|
|
2752
2846
|
req.send_request(options)
|
2753
2847
|
end
|
2754
2848
|
|
2755
|
-
# Lists the retriever used by an Amazon Q application.
|
2849
|
+
# Lists the retriever used by an Amazon Q Business application.
|
2756
2850
|
#
|
2757
2851
|
# @option params [required, String] :application_id
|
2758
|
-
# The identifier of the Amazon Q application using the
|
2852
|
+
# The identifier of the Amazon Q Business application using the
|
2853
|
+
# retriever.
|
2759
2854
|
#
|
2760
2855
|
# @option params [Integer] :max_results
|
2761
2856
|
# The maximum number of retrievers returned.
|
2762
2857
|
#
|
2763
2858
|
# @option params [String] :next_token
|
2764
2859
|
# If the number of retrievers returned exceeds `maxResults`, Amazon Q
|
2765
|
-
# returns a next token as a pagination token to retrieve the
|
2766
|
-
# retrievers.
|
2860
|
+
# Business returns a next token as a pagination token to retrieve the
|
2861
|
+
# next set of retrievers.
|
2767
2862
|
#
|
2768
2863
|
# @return [Types::ListRetrieversResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2769
2864
|
#
|
@@ -2800,11 +2895,12 @@ module Aws::QBusiness
|
|
2800
2895
|
end
|
2801
2896
|
|
2802
2897
|
# Gets a list of tags associated with a specified resource. Amazon Q
|
2803
|
-
# applications and data sources can have tags associated with
|
2898
|
+
# Business applications and data sources can have tags associated with
|
2899
|
+
# them.
|
2804
2900
|
#
|
2805
2901
|
# @option params [required, String] :resource_arn
|
2806
|
-
# The Amazon Resource Name (ARN) of the Amazon Q application or
|
2807
|
-
# 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.
|
2808
2904
|
#
|
2809
2905
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2810
2906
|
#
|
@@ -2831,20 +2927,20 @@ module Aws::QBusiness
|
|
2831
2927
|
req.send_request(options)
|
2832
2928
|
end
|
2833
2929
|
|
2834
|
-
# Lists one or more Amazon Q Web Experiences.
|
2930
|
+
# Lists one or more Amazon Q Business Web Experiences.
|
2835
2931
|
#
|
2836
2932
|
# @option params [required, String] :application_id
|
2837
|
-
# The identifier of the Amazon Q application linked to the
|
2838
|
-
# experiences.
|
2933
|
+
# The identifier of the Amazon Q Business application linked to the
|
2934
|
+
# listed web experiences.
|
2839
2935
|
#
|
2840
2936
|
# @option params [Integer] :max_results
|
2841
|
-
# The maximum number of Amazon Q Web Experiences to return.
|
2937
|
+
# The maximum number of Amazon Q Business Web Experiences to return.
|
2842
2938
|
#
|
2843
2939
|
# @option params [String] :next_token
|
2844
2940
|
# If the `maxResults` response was incomplete because there is more data
|
2845
|
-
# to retrieve, Amazon Q returns a pagination token in the
|
2846
|
-
# can use this pagination token to retrieve the next set
|
2847
|
-
# 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.
|
2848
2944
|
#
|
2849
2945
|
# @return [Types::ListWebExperiencesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2850
2946
|
#
|
@@ -2880,7 +2976,7 @@ module Aws::QBusiness
|
|
2880
2976
|
req.send_request(options)
|
2881
2977
|
end
|
2882
2978
|
|
2883
|
-
# Enables your end user to
|
2979
|
+
# Enables your end user to provide feedback on their Amazon Q Business
|
2884
2980
|
# generated chat responses.
|
2885
2981
|
#
|
2886
2982
|
# @option params [required, String] :application_id
|
@@ -2898,7 +2994,7 @@ module Aws::QBusiness
|
|
2898
2994
|
# @option params [Types::MessageUsefulnessFeedback] :message_usefulness
|
2899
2995
|
# The feedback usefulness value given by the user to the chat message.
|
2900
2996
|
#
|
2901
|
-
# @option params [
|
2997
|
+
# @option params [String] :user_id
|
2902
2998
|
# The identifier of the user giving the feedback.
|
2903
2999
|
#
|
2904
3000
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -2912,11 +3008,11 @@ module Aws::QBusiness
|
|
2912
3008
|
# message_id: "SystemMessageId", # required
|
2913
3009
|
# message_usefulness: {
|
2914
3010
|
# comment: "MessageUsefulnessComment",
|
2915
|
-
# reason: "NOT_FACTUALLY_CORRECT", # accepts NOT_FACTUALLY_CORRECT, HARMFUL_OR_UNSAFE, INCORRECT_OR_MISSING_SOURCES, NOT_HELPFUL, FACTUALLY_CORRECT, COMPLETE, RELEVANT_SOURCES, HELPFUL
|
3011
|
+
# reason: "NOT_FACTUALLY_CORRECT", # accepts NOT_FACTUALLY_CORRECT, HARMFUL_OR_UNSAFE, INCORRECT_OR_MISSING_SOURCES, NOT_HELPFUL, FACTUALLY_CORRECT, COMPLETE, RELEVANT_SOURCES, HELPFUL, NOT_BASED_ON_DOCUMENTS, NOT_COMPLETE, NOT_CONCISE, OTHER
|
2916
3012
|
# submitted_at: Time.now, # required
|
2917
3013
|
# usefulness: "USEFUL", # required, accepts USEFUL, NOT_USEFUL
|
2918
3014
|
# },
|
2919
|
-
# user_id: "UserId",
|
3015
|
+
# user_id: "UserId",
|
2920
3016
|
# })
|
2921
3017
|
#
|
2922
3018
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/PutFeedback AWS API Documentation
|
@@ -2937,7 +3033,7 @@ module Aws::QBusiness
|
|
2937
3033
|
# list of users or people who work in these teams. Only users who work
|
2938
3034
|
# in research and engineering, and therefore belong in the intellectual
|
2939
3035
|
# property group, can see top-secret company documents in their Amazon Q
|
2940
|
-
# chat results.
|
3036
|
+
# Business chat results.
|
2941
3037
|
#
|
2942
3038
|
# @option params [required, String] :application_id
|
2943
3039
|
# The identifier of the application in which the user and group mapping
|
@@ -2955,8 +3051,8 @@ module Aws::QBusiness
|
|
2955
3051
|
#
|
2956
3052
|
# @option params [required, Types::GroupMembers] :group_members
|
2957
3053
|
# A list of users or sub groups that belong to a group. This is for
|
2958
|
-
# generating Amazon Q chat results only from document a user
|
2959
|
-
# to.
|
3054
|
+
# generating Amazon Q Business chat results only from document a user
|
3055
|
+
# has access to.
|
2960
3056
|
#
|
2961
3057
|
# @option params [required, String] :group_name
|
2962
3058
|
# The list that contains your users or sub groups that belong the same
|
@@ -3013,12 +3109,12 @@ module Aws::QBusiness
|
|
3013
3109
|
end
|
3014
3110
|
|
3015
3111
|
# Starts a data source connector synchronization job. If a
|
3016
|
-
# synchronization job is already in progress, Amazon Q returns
|
3017
|
-
# `ConflictException`.
|
3112
|
+
# synchronization job is already in progress, Amazon Q Business returns
|
3113
|
+
# a `ConflictException`.
|
3018
3114
|
#
|
3019
3115
|
# @option params [required, String] :application_id
|
3020
|
-
# The identifier of Amazon Q application the data source is
|
3021
|
-
# to.
|
3116
|
+
# The identifier of Amazon Q Business application the data source is
|
3117
|
+
# connected to.
|
3022
3118
|
#
|
3023
3119
|
# @option params [required, String] :data_source_id
|
3024
3120
|
# The identifier of the data source connector.
|
@@ -3051,19 +3147,19 @@ module Aws::QBusiness
|
|
3051
3147
|
req.send_request(options)
|
3052
3148
|
end
|
3053
3149
|
|
3054
|
-
# Stops an Amazon Q data source connector synchronization job
|
3055
|
-
# progress.
|
3150
|
+
# Stops an Amazon Q Business data source connector synchronization job
|
3151
|
+
# already in progress.
|
3056
3152
|
#
|
3057
3153
|
# @option params [required, String] :application_id
|
3058
|
-
# The identifier of the Amazon Q application that the data
|
3059
|
-
# connected to.
|
3154
|
+
# The identifier of the Amazon Q Business application that the data
|
3155
|
+
# source is connected to.
|
3060
3156
|
#
|
3061
3157
|
# @option params [required, String] :data_source_id
|
3062
3158
|
# The identifier of the data source connector.
|
3063
3159
|
#
|
3064
3160
|
# @option params [required, String] :index_id
|
3065
|
-
# The identifier of the index used with the Amazon Q data
|
3066
|
-
# connector.
|
3161
|
+
# The identifier of the index used with the Amazon Q Business data
|
3162
|
+
# source connector.
|
3067
3163
|
#
|
3068
3164
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3069
3165
|
#
|
@@ -3084,18 +3180,18 @@ module Aws::QBusiness
|
|
3084
3180
|
req.send_request(options)
|
3085
3181
|
end
|
3086
3182
|
|
3087
|
-
# Adds the specified tag to the specified Amazon Q application
|
3088
|
-
# source resource. If the tag already exists, the existing value
|
3089
|
-
# 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.
|
3090
3186
|
#
|
3091
3187
|
# @option params [required, String] :resource_arn
|
3092
|
-
# The Amazon Resource Name (ARN) of the Amazon Q application or
|
3093
|
-
# source to tag.
|
3188
|
+
# The Amazon Resource Name (ARN) of the Amazon Q Business application or
|
3189
|
+
# data source to tag.
|
3094
3190
|
#
|
3095
3191
|
# @option params [required, Array<Types::Tag>] :tags
|
3096
|
-
# A list of tag keys to add to the Amazon Q application or data
|
3097
|
-
# If a tag already exists, the existing value is replaced with
|
3098
|
-
# 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.
|
3099
3195
|
#
|
3100
3196
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3101
3197
|
#
|
@@ -3120,15 +3216,16 @@ module Aws::QBusiness
|
|
3120
3216
|
req.send_request(options)
|
3121
3217
|
end
|
3122
3218
|
|
3123
|
-
# 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.
|
3124
3220
|
#
|
3125
3221
|
# @option params [required, String] :resource_arn
|
3126
|
-
# The Amazon Resource Name (ARN) of the Amazon Q application,
|
3127
|
-
# 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.
|
3128
3224
|
#
|
3129
3225
|
# @option params [required, Array<String>] :tag_keys
|
3130
|
-
# A list of tag keys to remove from the Amazon Q application or
|
3131
|
-
# 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.
|
3132
3229
|
#
|
3133
3230
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3134
3231
|
#
|
@@ -3148,24 +3245,24 @@ module Aws::QBusiness
|
|
3148
3245
|
req.send_request(options)
|
3149
3246
|
end
|
3150
3247
|
|
3151
|
-
# Updates an existing Amazon Q application.
|
3248
|
+
# Updates an existing Amazon Q Business application.
|
3152
3249
|
#
|
3153
3250
|
# @option params [required, String] :application_id
|
3154
|
-
# The identifier of the Amazon Q application.
|
3251
|
+
# The identifier of the Amazon Q Business application.
|
3155
3252
|
#
|
3156
3253
|
# @option params [Types::AttachmentsConfiguration] :attachments_configuration
|
3157
3254
|
# An option to allow end users to upload files directly during chat.
|
3158
3255
|
#
|
3159
3256
|
# @option params [String] :description
|
3160
|
-
# A description for the Amazon Q application.
|
3257
|
+
# A description for the Amazon Q Business application.
|
3161
3258
|
#
|
3162
3259
|
# @option params [String] :display_name
|
3163
|
-
# A name for the Amazon Q application.
|
3260
|
+
# A name for the Amazon Q Business application.
|
3164
3261
|
#
|
3165
3262
|
# @option params [String] :role_arn
|
3166
3263
|
# An Amazon Web Services Identity and Access Management (IAM) role that
|
3167
|
-
# gives Amazon Q permission to access Amazon CloudWatch logs
|
3168
|
-
# metrics.
|
3264
|
+
# gives Amazon Q Business permission to access Amazon CloudWatch logs
|
3265
|
+
# and metrics.
|
3169
3266
|
#
|
3170
3267
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3171
3268
|
#
|
@@ -3191,7 +3288,7 @@ module Aws::QBusiness
|
|
3191
3288
|
end
|
3192
3289
|
|
3193
3290
|
# Updates an set of chat controls configured for an existing Amazon Q
|
3194
|
-
# application.
|
3291
|
+
# Business application.
|
3195
3292
|
#
|
3196
3293
|
# @option params [required, String] :application_id
|
3197
3294
|
# The identifier of the application for which the chat controls are
|
@@ -3202,11 +3299,14 @@ module Aws::QBusiness
|
|
3202
3299
|
#
|
3203
3300
|
# @option params [String] :client_token
|
3204
3301
|
# A token that you provide to identify the request to update a Amazon Q
|
3205
|
-
# application chat configuration.
|
3302
|
+
# Business application chat configuration.
|
3206
3303
|
#
|
3207
3304
|
# **A suitable default value is auto-generated.** You should normally
|
3208
3305
|
# not need to pass this option.**
|
3209
3306
|
#
|
3307
|
+
# @option params [Types::CreatorModeConfiguration] :creator_mode_configuration
|
3308
|
+
# The configuration details for `CREATOR_MODE`.
|
3309
|
+
#
|
3210
3310
|
# @option params [String] :response_scope
|
3211
3311
|
# The response scope configured for your application. This determines
|
3212
3312
|
# whether your application uses its retrieval augmented generation (RAG)
|
@@ -3232,6 +3332,9 @@ module Aws::QBusiness
|
|
3232
3332
|
# system_message_override: "SystemMessageOverride",
|
3233
3333
|
# },
|
3234
3334
|
# client_token: "ClientToken",
|
3335
|
+
# creator_mode_configuration: {
|
3336
|
+
# creator_mode_control: "ENABLED", # required, accepts ENABLED, DISABLED
|
3337
|
+
# },
|
3235
3338
|
# response_scope: "ENTERPRISE_CONTENT_ONLY", # accepts ENTERPRISE_CONTENT_ONLY, EXTENDED_KNOWLEDGE_ENABLED
|
3236
3339
|
# topic_configurations_to_create_or_update: [
|
3237
3340
|
# {
|
@@ -3310,14 +3413,15 @@ module Aws::QBusiness
|
|
3310
3413
|
req.send_request(options)
|
3311
3414
|
end
|
3312
3415
|
|
3313
|
-
# Updates an existing Amazon Q data source connector.
|
3416
|
+
# Updates an existing Amazon Q Business data source connector.
|
3314
3417
|
#
|
3315
3418
|
# @option params [required, String] :application_id
|
3316
|
-
# The identifier of the Amazon Q application the data source is
|
3317
|
-
# to.
|
3419
|
+
# The identifier of the Amazon Q Business application the data source is
|
3420
|
+
# attached to.
|
3318
3421
|
#
|
3319
3422
|
# @option params [Hash,Array,String,Numeric,Boolean] :configuration
|
3320
|
-
# Provides the configuration information for an Amazon Q data
|
3423
|
+
# Provides the configuration information for an Amazon Q Business data
|
3424
|
+
# source.
|
3321
3425
|
#
|
3322
3426
|
# Document type used to carry open content
|
3323
3427
|
# (Hash,Array,String,Numeric,Boolean). A document type value is
|
@@ -3443,20 +3547,22 @@ module Aws::QBusiness
|
|
3443
3547
|
req.send_request(options)
|
3444
3548
|
end
|
3445
3549
|
|
3446
|
-
# Updates an Amazon Q index.
|
3550
|
+
# Updates an Amazon Q Business index.
|
3447
3551
|
#
|
3448
3552
|
# @option params [required, String] :application_id
|
3449
|
-
# The identifier of the Amazon Q application connected to the
|
3553
|
+
# The identifier of the Amazon Q Business application connected to the
|
3554
|
+
# index.
|
3450
3555
|
#
|
3451
3556
|
# @option params [Types::IndexCapacityConfiguration] :capacity_configuration
|
3452
3557
|
# The storage capacity units you want to provision for your Amazon Q
|
3453
|
-
# 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.
|
3454
3560
|
#
|
3455
3561
|
# @option params [String] :description
|
3456
|
-
# The description of the Amazon Q index.
|
3562
|
+
# The description of the Amazon Q Business index.
|
3457
3563
|
#
|
3458
3564
|
# @option params [String] :display_name
|
3459
|
-
# The name of the Amazon Q index.
|
3565
|
+
# The name of the Amazon Q Business index.
|
3460
3566
|
#
|
3461
3567
|
# @option params [Array<Types::DocumentAttributeConfiguration>] :document_attribute_configurations
|
3462
3568
|
# Configuration information for document metadata or fields. Document
|
@@ -3469,7 +3575,7 @@ module Aws::QBusiness
|
|
3469
3575
|
# [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes
|
3470
3576
|
#
|
3471
3577
|
# @option params [required, String] :index_id
|
3472
|
-
# The identifier of the Amazon Q index.
|
3578
|
+
# The identifier of the Amazon Q Business index.
|
3473
3579
|
#
|
3474
3580
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3475
3581
|
#
|
@@ -3501,7 +3607,7 @@ module Aws::QBusiness
|
|
3501
3607
|
req.send_request(options)
|
3502
3608
|
end
|
3503
3609
|
|
3504
|
-
# Updates an Amazon Q plugin.
|
3610
|
+
# Updates an Amazon Q Business plugin.
|
3505
3611
|
#
|
3506
3612
|
# @option params [required, String] :application_id
|
3507
3613
|
# The identifier of the application the plugin is attached to.
|
@@ -3552,14 +3658,14 @@ module Aws::QBusiness
|
|
3552
3658
|
req.send_request(options)
|
3553
3659
|
end
|
3554
3660
|
|
3555
|
-
# Updates the retriever used for your Amazon Q application.
|
3661
|
+
# Updates the retriever used for your Amazon Q Business application.
|
3556
3662
|
#
|
3557
3663
|
# @option params [required, String] :application_id
|
3558
|
-
# The identifier of your Amazon Q application.
|
3664
|
+
# The identifier of your Amazon Q Business application.
|
3559
3665
|
#
|
3560
3666
|
# @option params [Types::RetrieverConfiguration] :configuration
|
3561
3667
|
# Provides information on how the retriever used for your Amazon Q
|
3562
|
-
# application is configured.
|
3668
|
+
# Business application is configured.
|
3563
3669
|
#
|
3564
3670
|
# @option params [String] :display_name
|
3565
3671
|
# The name of your retriever.
|
@@ -3582,6 +3688,27 @@ module Aws::QBusiness
|
|
3582
3688
|
# index_id: "KendraIndexId", # required
|
3583
3689
|
# },
|
3584
3690
|
# native_index_configuration: {
|
3691
|
+
# boosting_override: {
|
3692
|
+
# "DocumentAttributeKey" => {
|
3693
|
+
# date_configuration: {
|
3694
|
+
# boosting_duration_in_seconds: 1,
|
3695
|
+
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
3696
|
+
# },
|
3697
|
+
# number_configuration: {
|
3698
|
+
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
3699
|
+
# boosting_type: "PRIORITIZE_LARGER_VALUES", # accepts PRIORITIZE_LARGER_VALUES, PRIORITIZE_SMALLER_VALUES
|
3700
|
+
# },
|
3701
|
+
# string_configuration: {
|
3702
|
+
# attribute_value_boosting: {
|
3703
|
+
# "String" => "LOW", # accepts LOW, MEDIUM, HIGH, VERY_HIGH
|
3704
|
+
# },
|
3705
|
+
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
3706
|
+
# },
|
3707
|
+
# string_list_configuration: {
|
3708
|
+
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
3709
|
+
# },
|
3710
|
+
# },
|
3711
|
+
# },
|
3585
3712
|
# index_id: "IndexId", # required
|
3586
3713
|
# },
|
3587
3714
|
# },
|
@@ -3664,31 +3791,32 @@ module Aws::QBusiness
|
|
3664
3791
|
req.send_request(options)
|
3665
3792
|
end
|
3666
3793
|
|
3667
|
-
# Updates an Amazon Q web experience.
|
3794
|
+
# Updates an Amazon Q Business web experience.
|
3668
3795
|
#
|
3669
3796
|
# @option params [required, String] :application_id
|
3670
|
-
# The identifier of the Amazon Q application attached to the
|
3671
|
-
# experience.
|
3797
|
+
# The identifier of the Amazon Q Business application attached to the
|
3798
|
+
# web experience.
|
3672
3799
|
#
|
3673
3800
|
# @option params [Types::WebExperienceAuthConfiguration] :authentication_configuration
|
3674
|
-
# The authentication configuration of the Amazon Q web
|
3801
|
+
# The authentication configuration of the Amazon Q Business web
|
3802
|
+
# experience.
|
3675
3803
|
#
|
3676
3804
|
# @option params [String] :sample_prompts_control_mode
|
3677
3805
|
# Determines whether sample prompts are enabled in the web experience
|
3678
3806
|
# for an end user.
|
3679
3807
|
#
|
3680
3808
|
# @option params [String] :subtitle
|
3681
|
-
# The subtitle of the Amazon Q web experience.
|
3809
|
+
# The subtitle of the Amazon Q Business web experience.
|
3682
3810
|
#
|
3683
3811
|
# @option params [String] :title
|
3684
|
-
# The title of the Amazon Q web experience.
|
3812
|
+
# The title of the Amazon Q Business web experience.
|
3685
3813
|
#
|
3686
3814
|
# @option params [required, String] :web_experience_id
|
3687
|
-
# The identifier of the Amazon Q web experience.
|
3815
|
+
# The identifier of the Amazon Q Business web experience.
|
3688
3816
|
#
|
3689
3817
|
# @option params [String] :welcome_message
|
3690
|
-
# A customized welcome message for an end user in an Amazon Q
|
3691
|
-
# experience.
|
3818
|
+
# A customized welcome message for an end user in an Amazon Q Business
|
3819
|
+
# web experience.
|
3692
3820
|
#
|
3693
3821
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3694
3822
|
#
|
@@ -3733,7 +3861,7 @@ module Aws::QBusiness
|
|
3733
3861
|
params: params,
|
3734
3862
|
config: config)
|
3735
3863
|
context[:gem_name] = 'aws-sdk-qbusiness'
|
3736
|
-
context[:gem_version] = '1.
|
3864
|
+
context[:gem_version] = '1.3.0'
|
3737
3865
|
Seahorse::Client::Request.new(handlers, context)
|
3738
3866
|
end
|
3739
3867
|
|