aws-sdk-qbusiness 1.22.0 → 1.24.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-qbusiness/async_client.rb +7 -3
- data/lib/aws-sdk-qbusiness/client.rb +1206 -45
- data/lib/aws-sdk-qbusiness/client_api.rb +589 -7
- data/lib/aws-sdk-qbusiness/errors.rb +32 -0
- data/lib/aws-sdk-qbusiness/event_streams.rb +3 -1
- data/lib/aws-sdk-qbusiness/types.rb +1437 -133
- data/lib/aws-sdk-qbusiness.rb +2 -2
- data/sig/client.rbs +495 -11
- data/sig/errors.rbs +6 -0
- data/sig/types.rbs +365 -12
- metadata +2 -2
@@ -458,6 +458,51 @@ module Aws::QBusiness
|
|
458
458
|
|
459
459
|
# @!group API Operations
|
460
460
|
|
461
|
+
# Adds or updates a permission policy for a Q Business application,
|
462
|
+
# allowing cross-account access for an ISV. This operation creates a new
|
463
|
+
# policy statement for the specified Q Business application. The policy
|
464
|
+
# statement defines the IAM actions that the ISV is allowed to perform
|
465
|
+
# on the Q Business application's resources.
|
466
|
+
#
|
467
|
+
# @option params [required, String] :application_id
|
468
|
+
# The unique identifier of the Q Business application.
|
469
|
+
#
|
470
|
+
# @option params [required, String] :statement_id
|
471
|
+
# A unique identifier for the policy statement.
|
472
|
+
#
|
473
|
+
# @option params [required, Array<String>] :actions
|
474
|
+
# The list of Q Business actions that the ISV is allowed to perform.
|
475
|
+
#
|
476
|
+
# @option params [required, String] :principal
|
477
|
+
# The Amazon Resource Name (ARN) of the IAM role for the ISV that is
|
478
|
+
# being granted permission.
|
479
|
+
#
|
480
|
+
# @return [Types::AssociatePermissionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
481
|
+
#
|
482
|
+
# * {Types::AssociatePermissionResponse#statement #statement} => String
|
483
|
+
#
|
484
|
+
# @example Request syntax with placeholder values
|
485
|
+
#
|
486
|
+
# resp = client.associate_permission({
|
487
|
+
# application_id: "ApplicationId", # required
|
488
|
+
# statement_id: "StatementId", # required
|
489
|
+
# actions: ["QIamAction"], # required
|
490
|
+
# principal: "PrincipalRoleArn", # required
|
491
|
+
# })
|
492
|
+
#
|
493
|
+
# @example Response structure
|
494
|
+
#
|
495
|
+
# resp.statement #=> String
|
496
|
+
#
|
497
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/AssociatePermission AWS API Documentation
|
498
|
+
#
|
499
|
+
# @overload associate_permission(params = {})
|
500
|
+
# @param [Hash] params ({})
|
501
|
+
def associate_permission(params = {}, options = {})
|
502
|
+
req = build_request(:associate_permission, params)
|
503
|
+
req.send_request(options)
|
504
|
+
end
|
505
|
+
|
461
506
|
# Asynchronously deletes one or more documents added using the
|
462
507
|
# `BatchPutDocument` API from an Amazon Q Business index.
|
463
508
|
#
|
@@ -655,6 +700,11 @@ module Aws::QBusiness
|
|
655
700
|
# role_arn: "RoleArn",
|
656
701
|
# },
|
657
702
|
# },
|
703
|
+
# media_extraction_configuration: {
|
704
|
+
# image_extraction_configuration: {
|
705
|
+
# image_extraction_status: "ENABLED", # required, accepts ENABLED, DISABLED
|
706
|
+
# },
|
707
|
+
# },
|
658
708
|
# },
|
659
709
|
# ],
|
660
710
|
# role_arn: "RoleArn",
|
@@ -716,22 +766,33 @@ module Aws::QBusiness
|
|
716
766
|
# on document attributes or metadata fields.
|
717
767
|
#
|
718
768
|
# @option params [String] :chat_mode
|
719
|
-
# The chat modes available to
|
769
|
+
# The `chatMode` parameter determines the chat modes available to Amazon
|
770
|
+
# Q Business users:
|
771
|
+
#
|
772
|
+
# * `RETRIEVAL_MODE` - If you choose this mode, Amazon Q generates
|
773
|
+
# responses solely from the data sources connected and indexed by the
|
774
|
+
# application. If an answer is not found in the data sources or there
|
775
|
+
# are no data sources available, Amazon Q will respond with a "*No
|
776
|
+
# Answer Found*" message, unless LLM knowledge has been enabled. In
|
777
|
+
# that case, Amazon Q will generate a response from the LLM knowledge
|
778
|
+
#
|
779
|
+
# * `CREATOR_MODE` - By selecting this mode, you can choose to generate
|
780
|
+
# responses only from the LLM knowledge. You can also attach files and
|
781
|
+
# have Amazon Q generate a response based on the data in those files.
|
782
|
+
# If the attached files do not contain an answer for the query, Amazon
|
783
|
+
# Q will automatically fall back to generating a response from the LLM
|
784
|
+
# knowledge.
|
720
785
|
#
|
721
|
-
# * `
|
722
|
-
#
|
723
|
-
# responses only from data sources connected to an Amazon Q Business
|
724
|
-
# application.
|
786
|
+
# * `PLUGIN_MODE` - By selecting this mode, users can choose to use
|
787
|
+
# plugins in chat to get their responses.
|
725
788
|
#
|
726
|
-
#
|
727
|
-
#
|
728
|
-
# connected data sources, for a chat request.
|
789
|
+
# <note markdown="1"> If none of the modes are selected, Amazon Q will only respond using
|
790
|
+
# the information from the attached files.
|
729
791
|
#
|
730
|
-
#
|
731
|
-
# plugins in chat.
|
792
|
+
# </note>
|
732
793
|
#
|
733
794
|
# For more information, see [Admin controls and guardrails][1],
|
734
|
-
# [Plugins][2], and [
|
795
|
+
# [Plugins][2], and [Response sources][3].
|
735
796
|
#
|
736
797
|
#
|
737
798
|
#
|
@@ -768,8 +829,14 @@ module Aws::QBusiness
|
|
768
829
|
# user_message: "UserMessage",
|
769
830
|
# attachments: [
|
770
831
|
# {
|
771
|
-
#
|
772
|
-
#
|
832
|
+
# data: "data",
|
833
|
+
# name: "AttachmentName",
|
834
|
+
# copy_from: {
|
835
|
+
# conversation: {
|
836
|
+
# conversation_id: "ConversationId", # required
|
837
|
+
# attachment_id: "AttachmentId", # required
|
838
|
+
# },
|
839
|
+
# },
|
773
840
|
# },
|
774
841
|
# ],
|
775
842
|
# action_execution: {
|
@@ -883,7 +950,7 @@ module Aws::QBusiness
|
|
883
950
|
# resp.system_message_id #=> String
|
884
951
|
# resp.user_message_id #=> String
|
885
952
|
# resp.action_review.plugin_id #=> String
|
886
|
-
# resp.action_review.plugin_type #=> String, one of "SERVICE_NOW", "SALESFORCE", "JIRA", "ZENDESK", "CUSTOM"
|
953
|
+
# resp.action_review.plugin_type #=> String, one of "SERVICE_NOW", "SALESFORCE", "JIRA", "ZENDESK", "CUSTOM", "QUICKSIGHT", "SERVICENOW_NOW_PLATFORM", "JIRA_CLOUD", "SALESFORCE_CRM", "ZENDESK_SUITE", "ATLASSIAN_CONFLUENCE", "GOOGLE_CALENDAR", "MICROSOFT_TEAMS", "MICROSOFT_EXCHANGE", "PAGERDUTY_ADVANCE", "SMARTSHEET", "ASANA"
|
887
954
|
# resp.action_review.payload #=> Hash
|
888
955
|
# resp.action_review.payload["ActionPayloadFieldKey"].display_name #=> String
|
889
956
|
# resp.action_review.payload["ActionPayloadFieldKey"].display_order #=> Integer
|
@@ -904,11 +971,15 @@ module Aws::QBusiness
|
|
904
971
|
# resp.source_attributions[0].text_message_segments[0].begin_offset #=> Integer
|
905
972
|
# resp.source_attributions[0].text_message_segments[0].end_offset #=> Integer
|
906
973
|
# resp.source_attributions[0].text_message_segments[0].snippet_excerpt.text #=> String
|
974
|
+
# resp.source_attributions[0].text_message_segments[0].media_id #=> String
|
975
|
+
# resp.source_attributions[0].text_message_segments[0].media_mime_type #=> String
|
907
976
|
# resp.failed_attachments #=> Array
|
908
977
|
# resp.failed_attachments[0].name #=> String
|
909
|
-
# resp.failed_attachments[0].status #=> String, one of "FAILED", "
|
978
|
+
# resp.failed_attachments[0].status #=> String, one of "FAILED", "SUCCESS"
|
910
979
|
# resp.failed_attachments[0].error.error_message #=> String
|
911
980
|
# resp.failed_attachments[0].error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
981
|
+
# resp.failed_attachments[0].attachment_id #=> String
|
982
|
+
# resp.failed_attachments[0].conversation_id #=> String
|
912
983
|
#
|
913
984
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ChatSync AWS API Documentation
|
914
985
|
#
|
@@ -928,10 +999,15 @@ module Aws::QBusiness
|
|
928
999
|
# You must use the Amazon Q Business console to assign subscription
|
929
1000
|
# tiers to users.
|
930
1001
|
#
|
931
|
-
#
|
932
|
-
# the Amazon Web Services account when
|
933
|
-
# in the request. For more information, see [ Using
|
934
|
-
# for Q Apps
|
1002
|
+
# An Amazon Q Apps service linked role will be created if it's absent
|
1003
|
+
# in the Amazon Web Services account when `QAppsConfiguration` is
|
1004
|
+
# enabled in the request. For more information, see [ Using
|
1005
|
+
# service-linked roles for Q Apps][2].
|
1006
|
+
#
|
1007
|
+
# When you create an application, Amazon Q Business may securely
|
1008
|
+
# transmit data for processing from your selected Amazon Web Services
|
1009
|
+
# region, but within your geography. For more information, see [Cross
|
1010
|
+
# region inference in Amazon Q Business][3].
|
935
1011
|
#
|
936
1012
|
# </note>
|
937
1013
|
#
|
@@ -939,6 +1015,7 @@ module Aws::QBusiness
|
|
939
1015
|
#
|
940
1016
|
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#user-sub-tiers
|
941
1017
|
# [2]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles-qapps.html
|
1018
|
+
# [3]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/cross-region-inference.html
|
942
1019
|
#
|
943
1020
|
# @option params [required, String] :display_name
|
944
1021
|
# A name for the Amazon Q Business application.
|
@@ -1004,6 +1081,17 @@ module Aws::QBusiness
|
|
1004
1081
|
#
|
1005
1082
|
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html
|
1006
1083
|
#
|
1084
|
+
# @option params [Types::QuickSightConfiguration] :quick_sight_configuration
|
1085
|
+
# The Amazon QuickSight configuration for an Amazon Q Business
|
1086
|
+
# application that uses QuickSight for authentication. This
|
1087
|
+
# configuration is required if your application uses QuickSight as the
|
1088
|
+
# identity provider. For more information, see [Creating an Amazon
|
1089
|
+
# QuickSight integrated application][1].
|
1090
|
+
#
|
1091
|
+
#
|
1092
|
+
#
|
1093
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/create-quicksight-integrated-application.html
|
1094
|
+
#
|
1007
1095
|
# @return [Types::CreateApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1008
1096
|
#
|
1009
1097
|
# * {Types::CreateApplicationResponse#application_id #application_id} => String
|
@@ -1014,8 +1102,8 @@ module Aws::QBusiness
|
|
1014
1102
|
# resp = client.create_application({
|
1015
1103
|
# display_name: "ApplicationName", # required
|
1016
1104
|
# role_arn: "RoleArn",
|
1017
|
-
# identity_type: "AWS_IAM_IDP_SAML", # accepts AWS_IAM_IDP_SAML, AWS_IAM_IDP_OIDC, AWS_IAM_IDC
|
1018
|
-
# iam_identity_provider_arn: "
|
1105
|
+
# identity_type: "AWS_IAM_IDP_SAML", # accepts AWS_IAM_IDP_SAML, AWS_IAM_IDP_OIDC, AWS_IAM_IDC, AWS_QUICKSIGHT_IDP
|
1106
|
+
# iam_identity_provider_arn: "IAMIdentityProviderArn",
|
1019
1107
|
# identity_center_instance_arn: "InstanceArn",
|
1020
1108
|
# client_ids_for_oidc: ["ClientIdForOIDC"],
|
1021
1109
|
# description: "Description",
|
@@ -1038,6 +1126,9 @@ module Aws::QBusiness
|
|
1038
1126
|
# personalization_configuration: {
|
1039
1127
|
# personalization_control_mode: "ENABLED", # required, accepts ENABLED, DISABLED
|
1040
1128
|
# },
|
1129
|
+
# quick_sight_configuration: {
|
1130
|
+
# client_namespace: "ClientNamespace", # required
|
1131
|
+
# },
|
1041
1132
|
# })
|
1042
1133
|
#
|
1043
1134
|
# @example Response structure
|
@@ -1054,6 +1145,161 @@ module Aws::QBusiness
|
|
1054
1145
|
req.send_request(options)
|
1055
1146
|
end
|
1056
1147
|
|
1148
|
+
# Creates a new data accessor for an ISV to access data from a Q
|
1149
|
+
# Business application. The data accessor is an entity that represents
|
1150
|
+
# the ISV's access to the Q Business application's data. It includes
|
1151
|
+
# the IAM role ARN for the ISV, a friendly name, and a set of action
|
1152
|
+
# configurations that define the specific actions the ISV is allowed to
|
1153
|
+
# perform and any associated data filters. When the data accessor is
|
1154
|
+
# created, an AWS IAM Identity Center application is also created to
|
1155
|
+
# manage the ISV's identity and authentication for accessing the Q
|
1156
|
+
# Business application.
|
1157
|
+
#
|
1158
|
+
# @option params [required, String] :application_id
|
1159
|
+
# The unique identifier of the Q Business application.
|
1160
|
+
#
|
1161
|
+
# @option params [required, String] :principal
|
1162
|
+
# The Amazon Resource Name (ARN) of the IAM role for the ISV that will
|
1163
|
+
# be accessing the data.
|
1164
|
+
#
|
1165
|
+
# @option params [required, Array<Types::ActionConfiguration>] :action_configurations
|
1166
|
+
# A list of action configurations specifying the allowed actions and any
|
1167
|
+
# associated filters.
|
1168
|
+
#
|
1169
|
+
# @option params [String] :client_token
|
1170
|
+
# A unique, case-sensitive identifier you provide to ensure idempotency
|
1171
|
+
# of the request.
|
1172
|
+
#
|
1173
|
+
# **A suitable default value is auto-generated.** You should normally
|
1174
|
+
# not need to pass this option.**
|
1175
|
+
#
|
1176
|
+
# @option params [required, String] :display_name
|
1177
|
+
# A friendly name for the data accessor.
|
1178
|
+
#
|
1179
|
+
# @option params [Array<Types::Tag>] :tags
|
1180
|
+
# The tags to associate with the data accessor.
|
1181
|
+
#
|
1182
|
+
# @return [Types::CreateDataAccessorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1183
|
+
#
|
1184
|
+
# * {Types::CreateDataAccessorResponse#data_accessor_id #data_accessor_id} => String
|
1185
|
+
# * {Types::CreateDataAccessorResponse#idc_application_arn #idc_application_arn} => String
|
1186
|
+
# * {Types::CreateDataAccessorResponse#data_accessor_arn #data_accessor_arn} => String
|
1187
|
+
#
|
1188
|
+
# @example Request syntax with placeholder values
|
1189
|
+
#
|
1190
|
+
# resp = client.create_data_accessor({
|
1191
|
+
# application_id: "ApplicationId", # required
|
1192
|
+
# principal: "PrincipalRoleArn", # required
|
1193
|
+
# action_configurations: [ # required
|
1194
|
+
# {
|
1195
|
+
# action: "QIamAction", # required
|
1196
|
+
# filter_configuration: {
|
1197
|
+
# document_attribute_filter: { # required
|
1198
|
+
# and_all_filters: [
|
1199
|
+
# {
|
1200
|
+
# # recursive AttributeFilter
|
1201
|
+
# },
|
1202
|
+
# ],
|
1203
|
+
# or_all_filters: [
|
1204
|
+
# {
|
1205
|
+
# # recursive AttributeFilter
|
1206
|
+
# },
|
1207
|
+
# ],
|
1208
|
+
# not_filter: {
|
1209
|
+
# # recursive AttributeFilter
|
1210
|
+
# },
|
1211
|
+
# equals_to: {
|
1212
|
+
# name: "DocumentAttributeKey", # required
|
1213
|
+
# value: { # required
|
1214
|
+
# string_value: "DocumentAttributeValueStringValueString",
|
1215
|
+
# string_list_value: ["String"],
|
1216
|
+
# long_value: 1,
|
1217
|
+
# date_value: Time.now,
|
1218
|
+
# },
|
1219
|
+
# },
|
1220
|
+
# contains_all: {
|
1221
|
+
# name: "DocumentAttributeKey", # required
|
1222
|
+
# value: { # required
|
1223
|
+
# string_value: "DocumentAttributeValueStringValueString",
|
1224
|
+
# string_list_value: ["String"],
|
1225
|
+
# long_value: 1,
|
1226
|
+
# date_value: Time.now,
|
1227
|
+
# },
|
1228
|
+
# },
|
1229
|
+
# contains_any: {
|
1230
|
+
# name: "DocumentAttributeKey", # required
|
1231
|
+
# value: { # required
|
1232
|
+
# string_value: "DocumentAttributeValueStringValueString",
|
1233
|
+
# string_list_value: ["String"],
|
1234
|
+
# long_value: 1,
|
1235
|
+
# date_value: Time.now,
|
1236
|
+
# },
|
1237
|
+
# },
|
1238
|
+
# greater_than: {
|
1239
|
+
# name: "DocumentAttributeKey", # required
|
1240
|
+
# value: { # required
|
1241
|
+
# string_value: "DocumentAttributeValueStringValueString",
|
1242
|
+
# string_list_value: ["String"],
|
1243
|
+
# long_value: 1,
|
1244
|
+
# date_value: Time.now,
|
1245
|
+
# },
|
1246
|
+
# },
|
1247
|
+
# greater_than_or_equals: {
|
1248
|
+
# name: "DocumentAttributeKey", # required
|
1249
|
+
# value: { # required
|
1250
|
+
# string_value: "DocumentAttributeValueStringValueString",
|
1251
|
+
# string_list_value: ["String"],
|
1252
|
+
# long_value: 1,
|
1253
|
+
# date_value: Time.now,
|
1254
|
+
# },
|
1255
|
+
# },
|
1256
|
+
# less_than: {
|
1257
|
+
# name: "DocumentAttributeKey", # required
|
1258
|
+
# value: { # required
|
1259
|
+
# string_value: "DocumentAttributeValueStringValueString",
|
1260
|
+
# string_list_value: ["String"],
|
1261
|
+
# long_value: 1,
|
1262
|
+
# date_value: Time.now,
|
1263
|
+
# },
|
1264
|
+
# },
|
1265
|
+
# less_than_or_equals: {
|
1266
|
+
# name: "DocumentAttributeKey", # required
|
1267
|
+
# value: { # required
|
1268
|
+
# string_value: "DocumentAttributeValueStringValueString",
|
1269
|
+
# string_list_value: ["String"],
|
1270
|
+
# long_value: 1,
|
1271
|
+
# date_value: Time.now,
|
1272
|
+
# },
|
1273
|
+
# },
|
1274
|
+
# },
|
1275
|
+
# },
|
1276
|
+
# },
|
1277
|
+
# ],
|
1278
|
+
# client_token: "ClientToken",
|
1279
|
+
# display_name: "DataAccessorName", # required
|
1280
|
+
# tags: [
|
1281
|
+
# {
|
1282
|
+
# key: "TagKey", # required
|
1283
|
+
# value: "TagValue", # required
|
1284
|
+
# },
|
1285
|
+
# ],
|
1286
|
+
# })
|
1287
|
+
#
|
1288
|
+
# @example Response structure
|
1289
|
+
#
|
1290
|
+
# resp.data_accessor_id #=> String
|
1291
|
+
# resp.idc_application_arn #=> String
|
1292
|
+
# resp.data_accessor_arn #=> String
|
1293
|
+
#
|
1294
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateDataAccessor AWS API Documentation
|
1295
|
+
#
|
1296
|
+
# @overload create_data_accessor(params = {})
|
1297
|
+
# @param [Hash] params ({})
|
1298
|
+
def create_data_accessor(params = {}, options = {})
|
1299
|
+
req = build_request(:create_data_accessor, params)
|
1300
|
+
req.send_request(options)
|
1301
|
+
end
|
1302
|
+
|
1057
1303
|
# Creates a data source connector for an Amazon Q Business application.
|
1058
1304
|
#
|
1059
1305
|
# `CreateDataSource` is a synchronous operation. The operation returns
|
@@ -1156,6 +1402,10 @@ module Aws::QBusiness
|
|
1156
1402
|
#
|
1157
1403
|
# [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html
|
1158
1404
|
#
|
1405
|
+
# @option params [Types::MediaExtractionConfiguration] :media_extraction_configuration
|
1406
|
+
# The configuration for extracting information from media in documents
|
1407
|
+
# during ingestion.
|
1408
|
+
#
|
1159
1409
|
# @return [Types::CreateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1160
1410
|
#
|
1161
1411
|
# * {Types::CreateDataSourceResponse#data_source_id #data_source_id} => String
|
@@ -1240,6 +1490,11 @@ module Aws::QBusiness
|
|
1240
1490
|
# role_arn: "RoleArn",
|
1241
1491
|
# },
|
1242
1492
|
# },
|
1493
|
+
# media_extraction_configuration: {
|
1494
|
+
# image_extraction_configuration: {
|
1495
|
+
# image_extraction_status: "ENABLED", # required, accepts ENABLED, DISABLED
|
1496
|
+
# },
|
1497
|
+
# },
|
1243
1498
|
# })
|
1244
1499
|
#
|
1245
1500
|
# @example Response structure
|
@@ -1276,6 +1531,9 @@ module Aws::QBusiness
|
|
1276
1531
|
# @option params [required, String] :display_name
|
1277
1532
|
# A name for the Amazon Q Business index.
|
1278
1533
|
#
|
1534
|
+
# @option params [String] :description
|
1535
|
+
# A description for the Amazon Q Business index.
|
1536
|
+
#
|
1279
1537
|
# @option params [String] :type
|
1280
1538
|
# The index type that's suitable for your needs. For more information
|
1281
1539
|
# on what's included in each type of index, see [Amazon Q Business
|
@@ -1285,9 +1543,6 @@ module Aws::QBusiness
|
|
1285
1543
|
#
|
1286
1544
|
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#index-tiers
|
1287
1545
|
#
|
1288
|
-
# @option params [String] :description
|
1289
|
-
# A description for the Amazon Q Business index.
|
1290
|
-
#
|
1291
1546
|
# @option params [Array<Types::Tag>] :tags
|
1292
1547
|
# A list of key-value pairs that identify or categorize the index. You
|
1293
1548
|
# can also use tags to help control access to the index. Tag keys and
|
@@ -1316,8 +1571,8 @@ module Aws::QBusiness
|
|
1316
1571
|
# resp = client.create_index({
|
1317
1572
|
# application_id: "ApplicationId", # required
|
1318
1573
|
# display_name: "IndexName", # required
|
1319
|
-
# type: "ENTERPRISE", # accepts ENTERPRISE, STARTER
|
1320
1574
|
# description: "Description",
|
1575
|
+
# type: "ENTERPRISE", # accepts ENTERPRISE, STARTER
|
1321
1576
|
# tags: [
|
1322
1577
|
# {
|
1323
1578
|
# key: "TagKey", # required
|
@@ -1390,7 +1645,7 @@ module Aws::QBusiness
|
|
1390
1645
|
# resp = client.create_plugin({
|
1391
1646
|
# application_id: "ApplicationId", # required
|
1392
1647
|
# display_name: "PluginName", # required
|
1393
|
-
# type: "SERVICE_NOW", # required, accepts SERVICE_NOW, SALESFORCE, JIRA, ZENDESK, CUSTOM
|
1648
|
+
# type: "SERVICE_NOW", # required, accepts SERVICE_NOW, SALESFORCE, JIRA, ZENDESK, CUSTOM, QUICKSIGHT, SERVICENOW_NOW_PLATFORM, JIRA_CLOUD, SALESFORCE_CRM, ZENDESK_SUITE, ATLASSIAN_CONFLUENCE, GOOGLE_CALENDAR, MICROSOFT_TEAMS, MICROSOFT_EXCHANGE, PAGERDUTY_ADVANCE, SMARTSHEET, ASANA
|
1394
1649
|
# auth_configuration: { # required
|
1395
1650
|
# basic_auth_configuration: {
|
1396
1651
|
# secret_arn: "SecretArn", # required
|
@@ -1399,9 +1654,15 @@ module Aws::QBusiness
|
|
1399
1654
|
# o_auth_2_client_credential_configuration: {
|
1400
1655
|
# secret_arn: "SecretArn", # required
|
1401
1656
|
# role_arn: "RoleArn", # required
|
1657
|
+
# authorization_url: "Url",
|
1658
|
+
# token_url: "Url",
|
1402
1659
|
# },
|
1403
1660
|
# no_auth_configuration: {
|
1404
1661
|
# },
|
1662
|
+
# idc_auth_configuration: {
|
1663
|
+
# idc_application_arn: "IdcApplicationArn", # required
|
1664
|
+
# role_arn: "RoleArn", # required
|
1665
|
+
# },
|
1405
1666
|
# },
|
1406
1667
|
# server_url: "Url",
|
1407
1668
|
# custom_plugin_configuration: {
|
@@ -1638,6 +1899,26 @@ module Aws::QBusiness
|
|
1638
1899
|
# Information about the identity provider (IdP) used to authenticate end
|
1639
1900
|
# users of an Amazon Q Business web experience.
|
1640
1901
|
#
|
1902
|
+
# @option params [Types::BrowserExtensionConfiguration] :browser_extension_configuration
|
1903
|
+
# The browser extension configuration for an Amazon Q Business web
|
1904
|
+
# experience.
|
1905
|
+
#
|
1906
|
+
# <note markdown="1"> For Amazon Q Business application using external OIDC-compliant
|
1907
|
+
# identity providers (IdPs). The IdP administrator must add the browser
|
1908
|
+
# extension sign-in redirect URLs to the IdP application. For more
|
1909
|
+
# information, see [Configure external OIDC identity provider for your
|
1910
|
+
# browser extensions.][1].
|
1911
|
+
#
|
1912
|
+
# </note>
|
1913
|
+
#
|
1914
|
+
#
|
1915
|
+
#
|
1916
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/browser-extensions.html
|
1917
|
+
#
|
1918
|
+
# @option params [Types::CustomizationConfiguration] :customization_configuration
|
1919
|
+
# Sets the custom logo, favicon, font, and color used in the Amazon Q
|
1920
|
+
# web experience.
|
1921
|
+
#
|
1641
1922
|
# @return [Types::CreateWebExperienceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1642
1923
|
#
|
1643
1924
|
# * {Types::CreateWebExperienceResponse#web_experience_id #web_experience_id} => String
|
@@ -1669,6 +1950,15 @@ module Aws::QBusiness
|
|
1669
1950
|
# secrets_role: "RoleArn", # required
|
1670
1951
|
# },
|
1671
1952
|
# },
|
1953
|
+
# browser_extension_configuration: {
|
1954
|
+
# enabled_browser_extensions: ["FIREFOX"], # required, accepts FIREFOX, CHROME
|
1955
|
+
# },
|
1956
|
+
# customization_configuration: {
|
1957
|
+
# custom_css_url: "CustomCSSUrl",
|
1958
|
+
# logo_url: "LogoUrl",
|
1959
|
+
# font_url: "FontUrl",
|
1960
|
+
# favicon_url: "FaviconUrl",
|
1961
|
+
# },
|
1672
1962
|
# })
|
1673
1963
|
#
|
1674
1964
|
# @example Response structure
|
@@ -1763,6 +2053,35 @@ module Aws::QBusiness
|
|
1763
2053
|
req.send_request(options)
|
1764
2054
|
end
|
1765
2055
|
|
2056
|
+
# Deletes a specified data accessor. This operation permanently removes
|
2057
|
+
# the data accessor and its associated AWS IAM Identity Center
|
2058
|
+
# application. Any access granted to the ISV through this data accessor
|
2059
|
+
# will be revoked
|
2060
|
+
#
|
2061
|
+
# @option params [required, String] :application_id
|
2062
|
+
# The unique identifier of the Q Business application.
|
2063
|
+
#
|
2064
|
+
# @option params [required, String] :data_accessor_id
|
2065
|
+
# The unique identifier of the data accessor to delete.
|
2066
|
+
#
|
2067
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2068
|
+
#
|
2069
|
+
# @example Request syntax with placeholder values
|
2070
|
+
#
|
2071
|
+
# resp = client.delete_data_accessor({
|
2072
|
+
# application_id: "ApplicationId", # required
|
2073
|
+
# data_accessor_id: "DataAccessorId", # required
|
2074
|
+
# })
|
2075
|
+
#
|
2076
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteDataAccessor AWS API Documentation
|
2077
|
+
#
|
2078
|
+
# @overload delete_data_accessor(params = {})
|
2079
|
+
# @param [Hash] params ({})
|
2080
|
+
def delete_data_accessor(params = {}, options = {})
|
2081
|
+
req = build_request(:delete_data_accessor, params)
|
2082
|
+
req.send_request(options)
|
2083
|
+
end
|
2084
|
+
|
1766
2085
|
# Deletes an Amazon Q Business data source connector. While the data
|
1767
2086
|
# source is being deleted, the `Status` field returned by a call to the
|
1768
2087
|
# `DescribeDataSource` API is set to `DELETING`.
|
@@ -1985,6 +2304,35 @@ module Aws::QBusiness
|
|
1985
2304
|
req.send_request(options)
|
1986
2305
|
end
|
1987
2306
|
|
2307
|
+
# Removes a permission policy from a Q Business application, revoking
|
2308
|
+
# the cross-account access that was previously granted to an ISV. This
|
2309
|
+
# operation deletes the specified policy statement from the
|
2310
|
+
# application's permission policy.
|
2311
|
+
#
|
2312
|
+
# @option params [required, String] :application_id
|
2313
|
+
# The unique identifier of the Q Business application.
|
2314
|
+
#
|
2315
|
+
# @option params [required, String] :statement_id
|
2316
|
+
# The statement ID of the permission to remove.
|
2317
|
+
#
|
2318
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2319
|
+
#
|
2320
|
+
# @example Request syntax with placeholder values
|
2321
|
+
#
|
2322
|
+
# resp = client.disassociate_permission({
|
2323
|
+
# application_id: "ApplicationId", # required
|
2324
|
+
# statement_id: "String", # required
|
2325
|
+
# })
|
2326
|
+
#
|
2327
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DisassociatePermission AWS API Documentation
|
2328
|
+
#
|
2329
|
+
# @overload disassociate_permission(params = {})
|
2330
|
+
# @param [Hash] params ({})
|
2331
|
+
def disassociate_permission(params = {}, options = {})
|
2332
|
+
req = build_request(:disassociate_permission, params)
|
2333
|
+
req.send_request(options)
|
2334
|
+
end
|
2335
|
+
|
1988
2336
|
# Gets information about an existing Amazon Q Business application.
|
1989
2337
|
#
|
1990
2338
|
# @option params [required, String] :application_id
|
@@ -2010,6 +2358,7 @@ module Aws::QBusiness
|
|
2010
2358
|
# * {Types::GetApplicationResponse#personalization_configuration #personalization_configuration} => Types::PersonalizationConfiguration
|
2011
2359
|
# * {Types::GetApplicationResponse#auto_subscription_configuration #auto_subscription_configuration} => Types::AutoSubscriptionConfiguration
|
2012
2360
|
# * {Types::GetApplicationResponse#client_ids_for_oidc #client_ids_for_oidc} => Array<String>
|
2361
|
+
# * {Types::GetApplicationResponse#quick_sight_configuration #quick_sight_configuration} => Types::QuickSightConfiguration
|
2013
2362
|
#
|
2014
2363
|
# @example Request syntax with placeholder values
|
2015
2364
|
#
|
@@ -2022,7 +2371,7 @@ module Aws::QBusiness
|
|
2022
2371
|
# resp.display_name #=> String
|
2023
2372
|
# resp.application_id #=> String
|
2024
2373
|
# resp.application_arn #=> String
|
2025
|
-
# resp.identity_type #=> String, one of "AWS_IAM_IDP_SAML", "AWS_IAM_IDP_OIDC", "AWS_IAM_IDC"
|
2374
|
+
# resp.identity_type #=> String, one of "AWS_IAM_IDP_SAML", "AWS_IAM_IDP_OIDC", "AWS_IAM_IDC", "AWS_QUICKSIGHT_IDP"
|
2026
2375
|
# resp.iam_identity_provider_arn #=> String
|
2027
2376
|
# resp.identity_center_application_arn #=> String
|
2028
2377
|
# resp.role_arn #=> String
|
@@ -2040,6 +2389,7 @@ module Aws::QBusiness
|
|
2040
2389
|
# resp.auto_subscription_configuration.default_subscription_type #=> String, one of "Q_LITE", "Q_BUSINESS"
|
2041
2390
|
# resp.client_ids_for_oidc #=> Array
|
2042
2391
|
# resp.client_ids_for_oidc[0] #=> String
|
2392
|
+
# resp.quick_sight_configuration.client_namespace #=> String
|
2043
2393
|
#
|
2044
2394
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetApplication AWS API Documentation
|
2045
2395
|
#
|
@@ -2121,6 +2471,107 @@ module Aws::QBusiness
|
|
2121
2471
|
req.send_request(options)
|
2122
2472
|
end
|
2123
2473
|
|
2474
|
+
# Retrieves information about a specified data accessor. This operation
|
2475
|
+
# returns details about the data accessor, including its display name,
|
2476
|
+
# unique identifier, Amazon Resource Name (ARN), the associated Q
|
2477
|
+
# Business application and AWS IAM Identity Center application, the IAM
|
2478
|
+
# role for the ISV, the action configurations, and the timestamps for
|
2479
|
+
# when the data accessor was created and last updated.
|
2480
|
+
#
|
2481
|
+
# @option params [required, String] :application_id
|
2482
|
+
# The unique identifier of the Q Business application.
|
2483
|
+
#
|
2484
|
+
# @option params [required, String] :data_accessor_id
|
2485
|
+
# The unique identifier of the data accessor to retrieve.
|
2486
|
+
#
|
2487
|
+
# @return [Types::GetDataAccessorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2488
|
+
#
|
2489
|
+
# * {Types::GetDataAccessorResponse#display_name #display_name} => String
|
2490
|
+
# * {Types::GetDataAccessorResponse#data_accessor_id #data_accessor_id} => String
|
2491
|
+
# * {Types::GetDataAccessorResponse#data_accessor_arn #data_accessor_arn} => String
|
2492
|
+
# * {Types::GetDataAccessorResponse#application_id #application_id} => String
|
2493
|
+
# * {Types::GetDataAccessorResponse#idc_application_arn #idc_application_arn} => String
|
2494
|
+
# * {Types::GetDataAccessorResponse#principal #principal} => String
|
2495
|
+
# * {Types::GetDataAccessorResponse#action_configurations #action_configurations} => Array<Types::ActionConfiguration>
|
2496
|
+
# * {Types::GetDataAccessorResponse#created_at #created_at} => Time
|
2497
|
+
# * {Types::GetDataAccessorResponse#updated_at #updated_at} => Time
|
2498
|
+
#
|
2499
|
+
# @example Request syntax with placeholder values
|
2500
|
+
#
|
2501
|
+
# resp = client.get_data_accessor({
|
2502
|
+
# application_id: "ApplicationId", # required
|
2503
|
+
# data_accessor_id: "DataAccessorId", # required
|
2504
|
+
# })
|
2505
|
+
#
|
2506
|
+
# @example Response structure
|
2507
|
+
#
|
2508
|
+
# resp.display_name #=> String
|
2509
|
+
# resp.data_accessor_id #=> String
|
2510
|
+
# resp.data_accessor_arn #=> String
|
2511
|
+
# resp.application_id #=> String
|
2512
|
+
# resp.idc_application_arn #=> String
|
2513
|
+
# resp.principal #=> String
|
2514
|
+
# resp.action_configurations #=> Array
|
2515
|
+
# resp.action_configurations[0].action #=> String
|
2516
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.and_all_filters #=> Array
|
2517
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.and_all_filters[0] #=> Types::AttributeFilter
|
2518
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.or_all_filters #=> Array
|
2519
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.or_all_filters[0] #=> Types::AttributeFilter
|
2520
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.not_filter #=> Types::AttributeFilter
|
2521
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.equals_to.name #=> String
|
2522
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.equals_to.value.string_value #=> String
|
2523
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.equals_to.value.string_list_value #=> Array
|
2524
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.equals_to.value.string_list_value[0] #=> String
|
2525
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.equals_to.value.long_value #=> Integer
|
2526
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.equals_to.value.date_value #=> Time
|
2527
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.contains_all.name #=> String
|
2528
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.contains_all.value.string_value #=> String
|
2529
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.contains_all.value.string_list_value #=> Array
|
2530
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.contains_all.value.string_list_value[0] #=> String
|
2531
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.contains_all.value.long_value #=> Integer
|
2532
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.contains_all.value.date_value #=> Time
|
2533
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.contains_any.name #=> String
|
2534
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.contains_any.value.string_value #=> String
|
2535
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.contains_any.value.string_list_value #=> Array
|
2536
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.contains_any.value.string_list_value[0] #=> String
|
2537
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.contains_any.value.long_value #=> Integer
|
2538
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.contains_any.value.date_value #=> Time
|
2539
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.greater_than.name #=> String
|
2540
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.greater_than.value.string_value #=> String
|
2541
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.greater_than.value.string_list_value #=> Array
|
2542
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.greater_than.value.string_list_value[0] #=> String
|
2543
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.greater_than.value.long_value #=> Integer
|
2544
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.greater_than.value.date_value #=> Time
|
2545
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.greater_than_or_equals.name #=> String
|
2546
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.greater_than_or_equals.value.string_value #=> String
|
2547
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.greater_than_or_equals.value.string_list_value #=> Array
|
2548
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.greater_than_or_equals.value.string_list_value[0] #=> String
|
2549
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.greater_than_or_equals.value.long_value #=> Integer
|
2550
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.greater_than_or_equals.value.date_value #=> Time
|
2551
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.less_than.name #=> String
|
2552
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.less_than.value.string_value #=> String
|
2553
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.less_than.value.string_list_value #=> Array
|
2554
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.less_than.value.string_list_value[0] #=> String
|
2555
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.less_than.value.long_value #=> Integer
|
2556
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.less_than.value.date_value #=> Time
|
2557
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.less_than_or_equals.name #=> String
|
2558
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.less_than_or_equals.value.string_value #=> String
|
2559
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.less_than_or_equals.value.string_list_value #=> Array
|
2560
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.less_than_or_equals.value.string_list_value[0] #=> String
|
2561
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.less_than_or_equals.value.long_value #=> Integer
|
2562
|
+
# resp.action_configurations[0].filter_configuration.document_attribute_filter.less_than_or_equals.value.date_value #=> Time
|
2563
|
+
# resp.created_at #=> Time
|
2564
|
+
# resp.updated_at #=> Time
|
2565
|
+
#
|
2566
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetDataAccessor AWS API Documentation
|
2567
|
+
#
|
2568
|
+
# @overload get_data_accessor(params = {})
|
2569
|
+
# @param [Hash] params ({})
|
2570
|
+
def get_data_accessor(params = {}, options = {})
|
2571
|
+
req = build_request(:get_data_accessor, params)
|
2572
|
+
req.send_request(options)
|
2573
|
+
end
|
2574
|
+
|
2124
2575
|
# Gets information about an existing Amazon Q Business data source
|
2125
2576
|
# connector.
|
2126
2577
|
#
|
@@ -2151,6 +2602,7 @@ module Aws::QBusiness
|
|
2151
2602
|
# * {Types::GetDataSourceResponse#role_arn #role_arn} => String
|
2152
2603
|
# * {Types::GetDataSourceResponse#error #error} => Types::ErrorDetail
|
2153
2604
|
# * {Types::GetDataSourceResponse#document_enrichment_configuration #document_enrichment_configuration} => Types::DocumentEnrichmentConfiguration
|
2605
|
+
# * {Types::GetDataSourceResponse#media_extraction_configuration #media_extraction_configuration} => Types::MediaExtractionConfiguration
|
2154
2606
|
#
|
2155
2607
|
# @example Request syntax with placeholder values
|
2156
2608
|
#
|
@@ -2216,6 +2668,7 @@ module Aws::QBusiness
|
|
2216
2668
|
# resp.document_enrichment_configuration.post_extraction_hook_configuration.lambda_arn #=> String
|
2217
2669
|
# resp.document_enrichment_configuration.post_extraction_hook_configuration.s3_bucket_name #=> String
|
2218
2670
|
# resp.document_enrichment_configuration.post_extraction_hook_configuration.role_arn #=> String
|
2671
|
+
# resp.media_extraction_configuration.image_extraction_configuration.image_extraction_status #=> String, one of "ENABLED", "DISABLED"
|
2219
2672
|
#
|
2220
2673
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetDataSource AWS API Documentation
|
2221
2674
|
#
|
@@ -2289,9 +2742,9 @@ module Aws::QBusiness
|
|
2289
2742
|
# * {Types::GetIndexResponse#application_id #application_id} => String
|
2290
2743
|
# * {Types::GetIndexResponse#index_id #index_id} => String
|
2291
2744
|
# * {Types::GetIndexResponse#display_name #display_name} => String
|
2292
|
-
# * {Types::GetIndexResponse#type #type} => String
|
2293
2745
|
# * {Types::GetIndexResponse#index_arn #index_arn} => String
|
2294
2746
|
# * {Types::GetIndexResponse#status #status} => String
|
2747
|
+
# * {Types::GetIndexResponse#type #type} => String
|
2295
2748
|
# * {Types::GetIndexResponse#description #description} => String
|
2296
2749
|
# * {Types::GetIndexResponse#created_at #created_at} => Time
|
2297
2750
|
# * {Types::GetIndexResponse#updated_at #updated_at} => Time
|
@@ -2312,9 +2765,9 @@ module Aws::QBusiness
|
|
2312
2765
|
# resp.application_id #=> String
|
2313
2766
|
# resp.index_id #=> String
|
2314
2767
|
# resp.display_name #=> String
|
2315
|
-
# resp.type #=> String, one of "ENTERPRISE", "STARTER"
|
2316
2768
|
# resp.index_arn #=> String
|
2317
2769
|
# resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING"
|
2770
|
+
# resp.type #=> String, one of "ENTERPRISE", "STARTER"
|
2318
2771
|
# resp.description #=> String
|
2319
2772
|
# resp.created_at #=> Time
|
2320
2773
|
# resp.updated_at #=> Time
|
@@ -2337,6 +2790,62 @@ module Aws::QBusiness
|
|
2337
2790
|
req.send_request(options)
|
2338
2791
|
end
|
2339
2792
|
|
2793
|
+
# Returns the image bytes corresponding to a media object. If you have
|
2794
|
+
# implemented your own application with the Chat and ChatSync APIs, and
|
2795
|
+
# have enabled content extraction from visual data in Amazon Q Business,
|
2796
|
+
# you use the GetMedia API operation to download the images so you can
|
2797
|
+
# show them in your UI with responses.
|
2798
|
+
#
|
2799
|
+
# For more information, see [Extracting semantic meaning from images and
|
2800
|
+
# visuals][1].
|
2801
|
+
#
|
2802
|
+
#
|
2803
|
+
#
|
2804
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/extracting-meaning-from-images.html
|
2805
|
+
#
|
2806
|
+
# @option params [required, String] :application_id
|
2807
|
+
# The identifier of the Amazon Q Business which contains the media
|
2808
|
+
# object.
|
2809
|
+
#
|
2810
|
+
# @option params [required, String] :conversation_id
|
2811
|
+
# The identifier of the Amazon Q Business conversation.
|
2812
|
+
#
|
2813
|
+
# @option params [required, String] :message_id
|
2814
|
+
# The identifier of the Amazon Q Business message.
|
2815
|
+
#
|
2816
|
+
# @option params [required, String] :media_id
|
2817
|
+
# The identifier of the media object. You can find this in the
|
2818
|
+
# `sourceAttributions` returned by the `Chat`, `ChatSync`, and
|
2819
|
+
# `ListMessages` API responses.
|
2820
|
+
#
|
2821
|
+
# @return [Types::GetMediaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2822
|
+
#
|
2823
|
+
# * {Types::GetMediaResponse#media_bytes #media_bytes} => String
|
2824
|
+
# * {Types::GetMediaResponse#media_mime_type #media_mime_type} => String
|
2825
|
+
#
|
2826
|
+
# @example Request syntax with placeholder values
|
2827
|
+
#
|
2828
|
+
# resp = client.get_media({
|
2829
|
+
# application_id: "ApplicationId", # required
|
2830
|
+
# conversation_id: "ConversationId", # required
|
2831
|
+
# message_id: "MessageId", # required
|
2832
|
+
# media_id: "MediaId", # required
|
2833
|
+
# })
|
2834
|
+
#
|
2835
|
+
# @example Response structure
|
2836
|
+
#
|
2837
|
+
# resp.media_bytes #=> String
|
2838
|
+
# resp.media_mime_type #=> String
|
2839
|
+
#
|
2840
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetMedia AWS API Documentation
|
2841
|
+
#
|
2842
|
+
# @overload get_media(params = {})
|
2843
|
+
# @param [Hash] params ({})
|
2844
|
+
def get_media(params = {}, options = {})
|
2845
|
+
req = build_request(:get_media, params)
|
2846
|
+
req.send_request(options)
|
2847
|
+
end
|
2848
|
+
|
2340
2849
|
# Gets information about an existing Amazon Q Business plugin.
|
2341
2850
|
#
|
2342
2851
|
# @option params [required, String] :application_id
|
@@ -2372,12 +2881,16 @@ module Aws::QBusiness
|
|
2372
2881
|
# resp.application_id #=> String
|
2373
2882
|
# resp.plugin_id #=> String
|
2374
2883
|
# resp.display_name #=> String
|
2375
|
-
# resp.type #=> String, one of "SERVICE_NOW", "SALESFORCE", "JIRA", "ZENDESK", "CUSTOM"
|
2884
|
+
# resp.type #=> String, one of "SERVICE_NOW", "SALESFORCE", "JIRA", "ZENDESK", "CUSTOM", "QUICKSIGHT", "SERVICENOW_NOW_PLATFORM", "JIRA_CLOUD", "SALESFORCE_CRM", "ZENDESK_SUITE", "ATLASSIAN_CONFLUENCE", "GOOGLE_CALENDAR", "MICROSOFT_TEAMS", "MICROSOFT_EXCHANGE", "PAGERDUTY_ADVANCE", "SMARTSHEET", "ASANA"
|
2376
2885
|
# resp.server_url #=> String
|
2377
2886
|
# resp.auth_configuration.basic_auth_configuration.secret_arn #=> String
|
2378
2887
|
# resp.auth_configuration.basic_auth_configuration.role_arn #=> String
|
2379
2888
|
# resp.auth_configuration.o_auth_2_client_credential_configuration.secret_arn #=> String
|
2380
2889
|
# resp.auth_configuration.o_auth_2_client_credential_configuration.role_arn #=> String
|
2890
|
+
# resp.auth_configuration.o_auth_2_client_credential_configuration.authorization_url #=> String
|
2891
|
+
# resp.auth_configuration.o_auth_2_client_credential_configuration.token_url #=> String
|
2892
|
+
# resp.auth_configuration.idc_auth_configuration.idc_application_arn #=> String
|
2893
|
+
# resp.auth_configuration.idc_auth_configuration.role_arn #=> String
|
2381
2894
|
# resp.custom_plugin_configuration.description #=> String
|
2382
2895
|
# resp.custom_plugin_configuration.api_schema_type #=> String, one of "OPEN_API_V3"
|
2383
2896
|
# resp.custom_plugin_configuration.api_schema.payload #=> String
|
@@ -2398,6 +2911,36 @@ module Aws::QBusiness
|
|
2398
2911
|
req.send_request(options)
|
2399
2912
|
end
|
2400
2913
|
|
2914
|
+
# Retrieves the current permission policy for a Q Business application.
|
2915
|
+
# The policy is returned as a JSON-formatted string and defines the IAM
|
2916
|
+
# actions that are allowed or denied for the application's resources.
|
2917
|
+
#
|
2918
|
+
# @option params [required, String] :application_id
|
2919
|
+
# The unique identifier of the Q Business application.
|
2920
|
+
#
|
2921
|
+
# @return [Types::GetPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2922
|
+
#
|
2923
|
+
# * {Types::GetPolicyResponse#policy #policy} => String
|
2924
|
+
#
|
2925
|
+
# @example Request syntax with placeholder values
|
2926
|
+
#
|
2927
|
+
# resp = client.get_policy({
|
2928
|
+
# application_id: "ApplicationId", # required
|
2929
|
+
# })
|
2930
|
+
#
|
2931
|
+
# @example Response structure
|
2932
|
+
#
|
2933
|
+
# resp.policy #=> String
|
2934
|
+
#
|
2935
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetPolicy AWS API Documentation
|
2936
|
+
#
|
2937
|
+
# @overload get_policy(params = {})
|
2938
|
+
# @param [Hash] params ({})
|
2939
|
+
def get_policy(params = {}, options = {})
|
2940
|
+
req = build_request(:get_policy, params)
|
2941
|
+
req.send_request(options)
|
2942
|
+
end
|
2943
|
+
|
2401
2944
|
# Gets information about an existing retriever used by an Amazon Q
|
2402
2945
|
# Business application.
|
2403
2946
|
#
|
@@ -2523,6 +3066,8 @@ module Aws::QBusiness
|
|
2523
3066
|
# * {Types::GetWebExperienceResponse#identity_provider_configuration #identity_provider_configuration} => Types::IdentityProviderConfiguration
|
2524
3067
|
# * {Types::GetWebExperienceResponse#authentication_configuration #authentication_configuration} => Types::WebExperienceAuthConfiguration
|
2525
3068
|
# * {Types::GetWebExperienceResponse#error #error} => Types::ErrorDetail
|
3069
|
+
# * {Types::GetWebExperienceResponse#browser_extension_configuration #browser_extension_configuration} => Types::BrowserExtensionConfiguration
|
3070
|
+
# * {Types::GetWebExperienceResponse#customization_configuration #customization_configuration} => Types::CustomizationConfiguration
|
2526
3071
|
#
|
2527
3072
|
# @example Request syntax with placeholder values
|
2528
3073
|
#
|
@@ -2556,6 +3101,12 @@ module Aws::QBusiness
|
|
2556
3101
|
# resp.authentication_configuration.saml_configuration.user_group_attribute #=> String
|
2557
3102
|
# resp.error.error_message #=> String
|
2558
3103
|
# resp.error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
3104
|
+
# resp.browser_extension_configuration.enabled_browser_extensions #=> Array
|
3105
|
+
# resp.browser_extension_configuration.enabled_browser_extensions[0] #=> String, one of "FIREFOX", "CHROME"
|
3106
|
+
# resp.customization_configuration.custom_css_url #=> String
|
3107
|
+
# resp.customization_configuration.logo_url #=> String
|
3108
|
+
# resp.customization_configuration.font_url #=> String
|
3109
|
+
# resp.customization_configuration.favicon_url #=> String
|
2559
3110
|
#
|
2560
3111
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetWebExperience AWS API Documentation
|
2561
3112
|
#
|
@@ -2568,10 +3119,21 @@ module Aws::QBusiness
|
|
2568
3119
|
|
2569
3120
|
# Lists Amazon Q Business applications.
|
2570
3121
|
#
|
2571
|
-
#
|
2572
|
-
#
|
2573
|
-
#
|
2574
|
-
#
|
3122
|
+
# <note markdown="1"> Amazon Q Business applications may securely transmit data for
|
3123
|
+
# processing across Amazon Web Services Regions within your geography.
|
3124
|
+
# For more information, see [Cross region inference in Amazon Q
|
3125
|
+
# Business][1].
|
3126
|
+
#
|
3127
|
+
# </note>
|
3128
|
+
#
|
3129
|
+
#
|
3130
|
+
#
|
3131
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/cross-region-inference.html
|
3132
|
+
#
|
3133
|
+
# @option params [String] :next_token
|
3134
|
+
# If the `maxResults` response was incomplete because there is more data
|
3135
|
+
# to retrieve, Amazon Q Business returns a pagination token in the
|
3136
|
+
# response. You can use this pagination token to retrieve the next set
|
2575
3137
|
# of Amazon Q Business applications.
|
2576
3138
|
#
|
2577
3139
|
# @option params [Integer] :max_results
|
@@ -2600,7 +3162,8 @@ module Aws::QBusiness
|
|
2600
3162
|
# resp.applications[0].created_at #=> Time
|
2601
3163
|
# resp.applications[0].updated_at #=> Time
|
2602
3164
|
# resp.applications[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING"
|
2603
|
-
# resp.applications[0].identity_type #=> String, one of "AWS_IAM_IDP_SAML", "AWS_IAM_IDP_OIDC", "AWS_IAM_IDC"
|
3165
|
+
# resp.applications[0].identity_type #=> String, one of "AWS_IAM_IDP_SAML", "AWS_IAM_IDP_OIDC", "AWS_IAM_IDC", "AWS_QUICKSIGHT_IDP"
|
3166
|
+
# resp.applications[0].quick_sight_configuration.client_namespace #=> String
|
2604
3167
|
#
|
2605
3168
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListApplications AWS API Documentation
|
2606
3169
|
#
|
@@ -2611,6 +3174,72 @@ module Aws::QBusiness
|
|
2611
3174
|
req.send_request(options)
|
2612
3175
|
end
|
2613
3176
|
|
3177
|
+
# Gets a list of attachments associated with an Amazon Q Business web
|
3178
|
+
# experience or a list of attachements associated with a specific Amazon
|
3179
|
+
# Q Business conversation.
|
3180
|
+
#
|
3181
|
+
# @option params [required, String] :application_id
|
3182
|
+
# The unique identifier for the Amazon Q Business application.
|
3183
|
+
#
|
3184
|
+
# @option params [String] :conversation_id
|
3185
|
+
# The unique identifier of the Amazon Q Business web experience
|
3186
|
+
# conversation.
|
3187
|
+
#
|
3188
|
+
# @option params [String] :user_id
|
3189
|
+
# The unique identifier of the user involved in the Amazon Q Business
|
3190
|
+
# web experience conversation.
|
3191
|
+
#
|
3192
|
+
# @option params [String] :next_token
|
3193
|
+
# If the number of attachments returned exceeds `maxResults`, Amazon Q
|
3194
|
+
# Business returns a next token as a pagination token to retrieve the
|
3195
|
+
# next set of attachments.
|
3196
|
+
#
|
3197
|
+
# @option params [Integer] :max_results
|
3198
|
+
# The maximum number of attachements to return.
|
3199
|
+
#
|
3200
|
+
# @return [Types::ListAttachmentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3201
|
+
#
|
3202
|
+
# * {Types::ListAttachmentsResponse#attachments #attachments} => Array<Types::Attachment>
|
3203
|
+
# * {Types::ListAttachmentsResponse#next_token #next_token} => String
|
3204
|
+
#
|
3205
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3206
|
+
#
|
3207
|
+
# @example Request syntax with placeholder values
|
3208
|
+
#
|
3209
|
+
# resp = client.list_attachments({
|
3210
|
+
# application_id: "ApplicationId", # required
|
3211
|
+
# conversation_id: "ConversationId",
|
3212
|
+
# user_id: "UserId",
|
3213
|
+
# next_token: "NextToken",
|
3214
|
+
# max_results: 1,
|
3215
|
+
# })
|
3216
|
+
#
|
3217
|
+
# @example Response structure
|
3218
|
+
#
|
3219
|
+
# resp.attachments #=> Array
|
3220
|
+
# resp.attachments[0].attachment_id #=> String
|
3221
|
+
# resp.attachments[0].conversation_id #=> String
|
3222
|
+
# resp.attachments[0].name #=> String
|
3223
|
+
# resp.attachments[0].copy_from.conversation.conversation_id #=> String
|
3224
|
+
# resp.attachments[0].copy_from.conversation.attachment_id #=> String
|
3225
|
+
# resp.attachments[0].file_type #=> String
|
3226
|
+
# resp.attachments[0].file_size #=> Integer
|
3227
|
+
# resp.attachments[0].md5chksum #=> String
|
3228
|
+
# resp.attachments[0].created_at #=> Time
|
3229
|
+
# resp.attachments[0].status #=> String, one of "FAILED", "SUCCESS"
|
3230
|
+
# resp.attachments[0].error.error_message #=> String
|
3231
|
+
# resp.attachments[0].error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
3232
|
+
# resp.next_token #=> String
|
3233
|
+
#
|
3234
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListAttachments AWS API Documentation
|
3235
|
+
#
|
3236
|
+
# @overload list_attachments(params = {})
|
3237
|
+
# @param [Hash] params ({})
|
3238
|
+
def list_attachments(params = {}, options = {})
|
3239
|
+
req = build_request(:list_attachments, params)
|
3240
|
+
req.send_request(options)
|
3241
|
+
end
|
3242
|
+
|
2614
3243
|
# Lists one or more Amazon Q Business conversations.
|
2615
3244
|
#
|
2616
3245
|
# @option params [required, String] :application_id
|
@@ -2662,6 +3291,57 @@ module Aws::QBusiness
|
|
2662
3291
|
req.send_request(options)
|
2663
3292
|
end
|
2664
3293
|
|
3294
|
+
# Lists the data accessors for a Q Business application. This operation
|
3295
|
+
# returns a paginated list of data accessor summaries, including the
|
3296
|
+
# friendly name, unique identifier, ARN, associated IAM role, and
|
3297
|
+
# creation/update timestamps for each data accessor.
|
3298
|
+
#
|
3299
|
+
# @option params [required, String] :application_id
|
3300
|
+
# The unique identifier of the Q Business application.
|
3301
|
+
#
|
3302
|
+
# @option params [String] :next_token
|
3303
|
+
# The token for the next set of results. (You received this token from a
|
3304
|
+
# previous call.)
|
3305
|
+
#
|
3306
|
+
# @option params [Integer] :max_results
|
3307
|
+
# The maximum number of results to return in a single call.
|
3308
|
+
#
|
3309
|
+
# @return [Types::ListDataAccessorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3310
|
+
#
|
3311
|
+
# * {Types::ListDataAccessorsResponse#data_accessors #data_accessors} => Array<Types::DataAccessor>
|
3312
|
+
# * {Types::ListDataAccessorsResponse#next_token #next_token} => String
|
3313
|
+
#
|
3314
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3315
|
+
#
|
3316
|
+
# @example Request syntax with placeholder values
|
3317
|
+
#
|
3318
|
+
# resp = client.list_data_accessors({
|
3319
|
+
# application_id: "ApplicationId", # required
|
3320
|
+
# next_token: "NextToken1500",
|
3321
|
+
# max_results: 1,
|
3322
|
+
# })
|
3323
|
+
#
|
3324
|
+
# @example Response structure
|
3325
|
+
#
|
3326
|
+
# resp.data_accessors #=> Array
|
3327
|
+
# resp.data_accessors[0].display_name #=> String
|
3328
|
+
# resp.data_accessors[0].data_accessor_id #=> String
|
3329
|
+
# resp.data_accessors[0].data_accessor_arn #=> String
|
3330
|
+
# resp.data_accessors[0].idc_application_arn #=> String
|
3331
|
+
# resp.data_accessors[0].principal #=> String
|
3332
|
+
# resp.data_accessors[0].created_at #=> Time
|
3333
|
+
# resp.data_accessors[0].updated_at #=> Time
|
3334
|
+
# resp.next_token #=> String
|
3335
|
+
#
|
3336
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListDataAccessors AWS API Documentation
|
3337
|
+
#
|
3338
|
+
# @overload list_data_accessors(params = {})
|
3339
|
+
# @param [Hash] params ({})
|
3340
|
+
def list_data_accessors(params = {}, options = {})
|
3341
|
+
req = build_request(:list_data_accessors, params)
|
3342
|
+
req.send_request(options)
|
3343
|
+
end
|
3344
|
+
|
2665
3345
|
# Get information about an Amazon Q Business data source connector
|
2666
3346
|
# synchronization.
|
2667
3347
|
#
|
@@ -2977,7 +3657,7 @@ module Aws::QBusiness
|
|
2977
3657
|
# experience conversation.
|
2978
3658
|
#
|
2979
3659
|
# @option params [String] :next_token
|
2980
|
-
# If the number of
|
3660
|
+
# If the number of messages returned exceeds `maxResults`, Amazon Q
|
2981
3661
|
# Business returns a next token as a pagination token to retrieve the
|
2982
3662
|
# next set of messages.
|
2983
3663
|
#
|
@@ -3010,9 +3690,11 @@ module Aws::QBusiness
|
|
3010
3690
|
# resp.messages[0].type #=> String, one of "USER", "SYSTEM"
|
3011
3691
|
# resp.messages[0].attachments #=> Array
|
3012
3692
|
# resp.messages[0].attachments[0].name #=> String
|
3013
|
-
# resp.messages[0].attachments[0].status #=> String, one of "FAILED", "
|
3693
|
+
# resp.messages[0].attachments[0].status #=> String, one of "FAILED", "SUCCESS"
|
3014
3694
|
# resp.messages[0].attachments[0].error.error_message #=> String
|
3015
3695
|
# resp.messages[0].attachments[0].error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
3696
|
+
# resp.messages[0].attachments[0].attachment_id #=> String
|
3697
|
+
# resp.messages[0].attachments[0].conversation_id #=> String
|
3016
3698
|
# resp.messages[0].source_attribution #=> Array
|
3017
3699
|
# resp.messages[0].source_attribution[0].title #=> String
|
3018
3700
|
# resp.messages[0].source_attribution[0].snippet #=> String
|
@@ -3023,8 +3705,10 @@ module Aws::QBusiness
|
|
3023
3705
|
# resp.messages[0].source_attribution[0].text_message_segments[0].begin_offset #=> Integer
|
3024
3706
|
# resp.messages[0].source_attribution[0].text_message_segments[0].end_offset #=> Integer
|
3025
3707
|
# resp.messages[0].source_attribution[0].text_message_segments[0].snippet_excerpt.text #=> String
|
3708
|
+
# resp.messages[0].source_attribution[0].text_message_segments[0].media_id #=> String
|
3709
|
+
# resp.messages[0].source_attribution[0].text_message_segments[0].media_mime_type #=> String
|
3026
3710
|
# resp.messages[0].action_review.plugin_id #=> String
|
3027
|
-
# resp.messages[0].action_review.plugin_type #=> String, one of "SERVICE_NOW", "SALESFORCE", "JIRA", "ZENDESK", "CUSTOM"
|
3711
|
+
# resp.messages[0].action_review.plugin_type #=> String, one of "SERVICE_NOW", "SALESFORCE", "JIRA", "ZENDESK", "CUSTOM", "QUICKSIGHT", "SERVICENOW_NOW_PLATFORM", "JIRA_CLOUD", "SALESFORCE_CRM", "ZENDESK_SUITE", "ATLASSIAN_CONFLUENCE", "GOOGLE_CALENDAR", "MICROSOFT_TEAMS", "MICROSOFT_EXCHANGE", "PAGERDUTY_ADVANCE", "SMARTSHEET", "ASANA"
|
3028
3712
|
# resp.messages[0].action_review.payload #=> Hash
|
3029
3713
|
# resp.messages[0].action_review.payload["ActionPayloadFieldKey"].display_name #=> String
|
3030
3714
|
# resp.messages[0].action_review.payload["ActionPayloadFieldKey"].display_order #=> Integer
|
@@ -3048,6 +3732,146 @@ module Aws::QBusiness
|
|
3048
3732
|
req.send_request(options)
|
3049
3733
|
end
|
3050
3734
|
|
3735
|
+
# Lists configured Amazon Q Business actions for a specific plugin in an
|
3736
|
+
# Amazon Q Business application.
|
3737
|
+
#
|
3738
|
+
# @option params [required, String] :application_id
|
3739
|
+
# The identifier of the Amazon Q Business application the plugin is
|
3740
|
+
# attached to.
|
3741
|
+
#
|
3742
|
+
# @option params [required, String] :plugin_id
|
3743
|
+
# The identifier of the Amazon Q Business plugin.
|
3744
|
+
#
|
3745
|
+
# @option params [String] :next_token
|
3746
|
+
# If the number of plugin actions returned exceeds `maxResults`, Amazon
|
3747
|
+
# Q Business returns a next token as a pagination token to retrieve the
|
3748
|
+
# next set of plugin actions.
|
3749
|
+
#
|
3750
|
+
# @option params [Integer] :max_results
|
3751
|
+
# The maximum number of plugin actions to return.
|
3752
|
+
#
|
3753
|
+
# @return [Types::ListPluginActionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3754
|
+
#
|
3755
|
+
# * {Types::ListPluginActionsResponse#next_token #next_token} => String
|
3756
|
+
# * {Types::ListPluginActionsResponse#items #items} => Array<Types::ActionSummary>
|
3757
|
+
#
|
3758
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3759
|
+
#
|
3760
|
+
# @example Request syntax with placeholder values
|
3761
|
+
#
|
3762
|
+
# resp = client.list_plugin_actions({
|
3763
|
+
# application_id: "ApplicationId", # required
|
3764
|
+
# plugin_id: "PluginId", # required
|
3765
|
+
# next_token: "NextToken",
|
3766
|
+
# max_results: 1,
|
3767
|
+
# })
|
3768
|
+
#
|
3769
|
+
# @example Response structure
|
3770
|
+
#
|
3771
|
+
# resp.next_token #=> String
|
3772
|
+
# resp.items #=> Array
|
3773
|
+
# resp.items[0].action_identifier #=> String
|
3774
|
+
# resp.items[0].display_name #=> String
|
3775
|
+
# resp.items[0].instruction_example #=> String
|
3776
|
+
# resp.items[0].description #=> String
|
3777
|
+
#
|
3778
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListPluginActions AWS API Documentation
|
3779
|
+
#
|
3780
|
+
# @overload list_plugin_actions(params = {})
|
3781
|
+
# @param [Hash] params ({})
|
3782
|
+
def list_plugin_actions(params = {}, options = {})
|
3783
|
+
req = build_request(:list_plugin_actions, params)
|
3784
|
+
req.send_request(options)
|
3785
|
+
end
|
3786
|
+
|
3787
|
+
# Lists configured Amazon Q Business actions for any plugin type—both
|
3788
|
+
# built-in and custom.
|
3789
|
+
#
|
3790
|
+
# @option params [required, String] :plugin_type
|
3791
|
+
# The type of the plugin.
|
3792
|
+
#
|
3793
|
+
# @option params [String] :next_token
|
3794
|
+
# If the number of plugins returned exceeds `maxResults`, Amazon Q
|
3795
|
+
# Business returns a next token as a pagination token to retrieve the
|
3796
|
+
# next set of plugins.
|
3797
|
+
#
|
3798
|
+
# @option params [Integer] :max_results
|
3799
|
+
# The maximum number of plugins to return.
|
3800
|
+
#
|
3801
|
+
# @return [Types::ListPluginTypeActionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3802
|
+
#
|
3803
|
+
# * {Types::ListPluginTypeActionsResponse#next_token #next_token} => String
|
3804
|
+
# * {Types::ListPluginTypeActionsResponse#items #items} => Array<Types::ActionSummary>
|
3805
|
+
#
|
3806
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3807
|
+
#
|
3808
|
+
# @example Request syntax with placeholder values
|
3809
|
+
#
|
3810
|
+
# resp = client.list_plugin_type_actions({
|
3811
|
+
# plugin_type: "SERVICE_NOW", # required, accepts SERVICE_NOW, SALESFORCE, JIRA, ZENDESK, CUSTOM, QUICKSIGHT, SERVICENOW_NOW_PLATFORM, JIRA_CLOUD, SALESFORCE_CRM, ZENDESK_SUITE, ATLASSIAN_CONFLUENCE, GOOGLE_CALENDAR, MICROSOFT_TEAMS, MICROSOFT_EXCHANGE, PAGERDUTY_ADVANCE, SMARTSHEET, ASANA
|
3812
|
+
# next_token: "NextToken",
|
3813
|
+
# max_results: 1,
|
3814
|
+
# })
|
3815
|
+
#
|
3816
|
+
# @example Response structure
|
3817
|
+
#
|
3818
|
+
# resp.next_token #=> String
|
3819
|
+
# resp.items #=> Array
|
3820
|
+
# resp.items[0].action_identifier #=> String
|
3821
|
+
# resp.items[0].display_name #=> String
|
3822
|
+
# resp.items[0].instruction_example #=> String
|
3823
|
+
# resp.items[0].description #=> String
|
3824
|
+
#
|
3825
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListPluginTypeActions AWS API Documentation
|
3826
|
+
#
|
3827
|
+
# @overload list_plugin_type_actions(params = {})
|
3828
|
+
# @param [Hash] params ({})
|
3829
|
+
def list_plugin_type_actions(params = {}, options = {})
|
3830
|
+
req = build_request(:list_plugin_type_actions, params)
|
3831
|
+
req.send_request(options)
|
3832
|
+
end
|
3833
|
+
|
3834
|
+
# Lists metadata for all Amazon Q Business plugin types.
|
3835
|
+
#
|
3836
|
+
# @option params [String] :next_token
|
3837
|
+
# If the metadata returned exceeds `maxResults`, Amazon Q Business
|
3838
|
+
# returns a next token as a pagination token to retrieve the next set of
|
3839
|
+
# metadata.
|
3840
|
+
#
|
3841
|
+
# @option params [Integer] :max_results
|
3842
|
+
# The maximum number of plugin metadata items to return.
|
3843
|
+
#
|
3844
|
+
# @return [Types::ListPluginTypeMetadataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3845
|
+
#
|
3846
|
+
# * {Types::ListPluginTypeMetadataResponse#next_token #next_token} => String
|
3847
|
+
# * {Types::ListPluginTypeMetadataResponse#items #items} => Array<Types::PluginTypeMetadataSummary>
|
3848
|
+
#
|
3849
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3850
|
+
#
|
3851
|
+
# @example Request syntax with placeholder values
|
3852
|
+
#
|
3853
|
+
# resp = client.list_plugin_type_metadata({
|
3854
|
+
# next_token: "NextToken",
|
3855
|
+
# max_results: 1,
|
3856
|
+
# })
|
3857
|
+
#
|
3858
|
+
# @example Response structure
|
3859
|
+
#
|
3860
|
+
# resp.next_token #=> String
|
3861
|
+
# resp.items #=> Array
|
3862
|
+
# resp.items[0].type #=> String, one of "SERVICE_NOW", "SALESFORCE", "JIRA", "ZENDESK", "CUSTOM", "QUICKSIGHT", "SERVICENOW_NOW_PLATFORM", "JIRA_CLOUD", "SALESFORCE_CRM", "ZENDESK_SUITE", "ATLASSIAN_CONFLUENCE", "GOOGLE_CALENDAR", "MICROSOFT_TEAMS", "MICROSOFT_EXCHANGE", "PAGERDUTY_ADVANCE", "SMARTSHEET", "ASANA"
|
3863
|
+
# resp.items[0].category #=> String, one of "Customer relationship management (CRM)", "Project management", "Communication", "Productivity", "Ticketing and incident management"
|
3864
|
+
# resp.items[0].description #=> String
|
3865
|
+
#
|
3866
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListPluginTypeMetadata AWS API Documentation
|
3867
|
+
#
|
3868
|
+
# @overload list_plugin_type_metadata(params = {})
|
3869
|
+
# @param [Hash] params ({})
|
3870
|
+
def list_plugin_type_metadata(params = {}, options = {})
|
3871
|
+
req = build_request(:list_plugin_type_metadata, params)
|
3872
|
+
req.send_request(options)
|
3873
|
+
end
|
3874
|
+
|
3051
3875
|
# Lists configured Amazon Q Business plugins.
|
3052
3876
|
#
|
3053
3877
|
# @option params [required, String] :application_id
|
@@ -3083,7 +3907,7 @@ module Aws::QBusiness
|
|
3083
3907
|
# resp.plugins #=> Array
|
3084
3908
|
# resp.plugins[0].plugin_id #=> String
|
3085
3909
|
# resp.plugins[0].display_name #=> String
|
3086
|
-
# resp.plugins[0].type #=> String, one of "SERVICE_NOW", "SALESFORCE", "JIRA", "ZENDESK", "CUSTOM"
|
3910
|
+
# resp.plugins[0].type #=> String, one of "SERVICE_NOW", "SALESFORCE", "JIRA", "ZENDESK", "CUSTOM", "QUICKSIGHT", "SERVICENOW_NOW_PLATFORM", "JIRA_CLOUD", "SALESFORCE_CRM", "ZENDESK_SUITE", "ATLASSIAN_CONFLUENCE", "GOOGLE_CALENDAR", "MICROSOFT_TEAMS", "MICROSOFT_EXCHANGE", "PAGERDUTY_ADVANCE", "SMARTSHEET", "ASANA"
|
3087
3911
|
# resp.plugins[0].server_url #=> String
|
3088
3912
|
# resp.plugins[0].state #=> String, one of "ENABLED", "DISABLED"
|
3089
3913
|
# resp.plugins[0].build_status #=> String, one of "READY", "CREATE_IN_PROGRESS", "CREATE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "DELETE_IN_PROGRESS", "DELETE_FAILED"
|
@@ -3366,6 +4190,168 @@ module Aws::QBusiness
|
|
3366
4190
|
req.send_request(options)
|
3367
4191
|
end
|
3368
4192
|
|
4193
|
+
# Searches for relevant content in a Q Business application based on a
|
4194
|
+
# query. This operation takes a search query text, the Q Business
|
4195
|
+
# application identifier, and optional filters (such as user ID, user
|
4196
|
+
# groups, content source, and maximum results) as input. It returns a
|
4197
|
+
# list of relevant content items, where each item includes the content
|
4198
|
+
# text, the unique document identifier, the document title, the document
|
4199
|
+
# URI, any relevant document attributes, and score attributes indicating
|
4200
|
+
# the confidence level of the relevance.
|
4201
|
+
#
|
4202
|
+
# @option params [required, String] :application_id
|
4203
|
+
# The unique identifier of the Q Business application to search.
|
4204
|
+
#
|
4205
|
+
# @option params [String] :user_id
|
4206
|
+
# The ID of the user performing the search. Used for access control.
|
4207
|
+
#
|
4208
|
+
# @option params [Array<String>] :user_groups
|
4209
|
+
# The groups the user belongs to. Used for access control.
|
4210
|
+
#
|
4211
|
+
# @option params [required, String] :query_text
|
4212
|
+
# The text to search for.
|
4213
|
+
#
|
4214
|
+
# @option params [required, Types::ContentSource] :content_source
|
4215
|
+
# The source of content to search in.
|
4216
|
+
#
|
4217
|
+
# @option params [Types::AttributeFilter] :attribute_filter
|
4218
|
+
# Enables filtering of responses based on document attributes or
|
4219
|
+
# metadata fields.
|
4220
|
+
#
|
4221
|
+
# @option params [Integer] :max_results
|
4222
|
+
# The maximum number of results to return.
|
4223
|
+
#
|
4224
|
+
# @option params [String] :next_token
|
4225
|
+
# The token for the next set of results. (You received this token from a
|
4226
|
+
# previous call.)
|
4227
|
+
#
|
4228
|
+
# @return [Types::SearchRelevantContentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4229
|
+
#
|
4230
|
+
# * {Types::SearchRelevantContentResponse#relevant_content #relevant_content} => Array<Types::RelevantContent>
|
4231
|
+
# * {Types::SearchRelevantContentResponse#next_token #next_token} => String
|
4232
|
+
#
|
4233
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4234
|
+
#
|
4235
|
+
# @example Request syntax with placeholder values
|
4236
|
+
#
|
4237
|
+
# resp = client.search_relevant_content({
|
4238
|
+
# application_id: "ApplicationId", # required
|
4239
|
+
# user_id: "UserId",
|
4240
|
+
# user_groups: ["String"],
|
4241
|
+
# query_text: "QueryText", # required
|
4242
|
+
# content_source: { # required
|
4243
|
+
# retriever: {
|
4244
|
+
# retriever_id: "RetrieverId", # required
|
4245
|
+
# },
|
4246
|
+
# },
|
4247
|
+
# attribute_filter: {
|
4248
|
+
# and_all_filters: [
|
4249
|
+
# {
|
4250
|
+
# # recursive AttributeFilter
|
4251
|
+
# },
|
4252
|
+
# ],
|
4253
|
+
# or_all_filters: [
|
4254
|
+
# {
|
4255
|
+
# # recursive AttributeFilter
|
4256
|
+
# },
|
4257
|
+
# ],
|
4258
|
+
# not_filter: {
|
4259
|
+
# # recursive AttributeFilter
|
4260
|
+
# },
|
4261
|
+
# equals_to: {
|
4262
|
+
# name: "DocumentAttributeKey", # required
|
4263
|
+
# value: { # required
|
4264
|
+
# string_value: "DocumentAttributeValueStringValueString",
|
4265
|
+
# string_list_value: ["String"],
|
4266
|
+
# long_value: 1,
|
4267
|
+
# date_value: Time.now,
|
4268
|
+
# },
|
4269
|
+
# },
|
4270
|
+
# contains_all: {
|
4271
|
+
# name: "DocumentAttributeKey", # required
|
4272
|
+
# value: { # required
|
4273
|
+
# string_value: "DocumentAttributeValueStringValueString",
|
4274
|
+
# string_list_value: ["String"],
|
4275
|
+
# long_value: 1,
|
4276
|
+
# date_value: Time.now,
|
4277
|
+
# },
|
4278
|
+
# },
|
4279
|
+
# contains_any: {
|
4280
|
+
# name: "DocumentAttributeKey", # required
|
4281
|
+
# value: { # required
|
4282
|
+
# string_value: "DocumentAttributeValueStringValueString",
|
4283
|
+
# string_list_value: ["String"],
|
4284
|
+
# long_value: 1,
|
4285
|
+
# date_value: Time.now,
|
4286
|
+
# },
|
4287
|
+
# },
|
4288
|
+
# greater_than: {
|
4289
|
+
# name: "DocumentAttributeKey", # required
|
4290
|
+
# value: { # required
|
4291
|
+
# string_value: "DocumentAttributeValueStringValueString",
|
4292
|
+
# string_list_value: ["String"],
|
4293
|
+
# long_value: 1,
|
4294
|
+
# date_value: Time.now,
|
4295
|
+
# },
|
4296
|
+
# },
|
4297
|
+
# greater_than_or_equals: {
|
4298
|
+
# name: "DocumentAttributeKey", # required
|
4299
|
+
# value: { # required
|
4300
|
+
# string_value: "DocumentAttributeValueStringValueString",
|
4301
|
+
# string_list_value: ["String"],
|
4302
|
+
# long_value: 1,
|
4303
|
+
# date_value: Time.now,
|
4304
|
+
# },
|
4305
|
+
# },
|
4306
|
+
# less_than: {
|
4307
|
+
# name: "DocumentAttributeKey", # required
|
4308
|
+
# value: { # required
|
4309
|
+
# string_value: "DocumentAttributeValueStringValueString",
|
4310
|
+
# string_list_value: ["String"],
|
4311
|
+
# long_value: 1,
|
4312
|
+
# date_value: Time.now,
|
4313
|
+
# },
|
4314
|
+
# },
|
4315
|
+
# less_than_or_equals: {
|
4316
|
+
# name: "DocumentAttributeKey", # required
|
4317
|
+
# value: { # required
|
4318
|
+
# string_value: "DocumentAttributeValueStringValueString",
|
4319
|
+
# string_list_value: ["String"],
|
4320
|
+
# long_value: 1,
|
4321
|
+
# date_value: Time.now,
|
4322
|
+
# },
|
4323
|
+
# },
|
4324
|
+
# },
|
4325
|
+
# max_results: 1,
|
4326
|
+
# next_token: "NextToken",
|
4327
|
+
# })
|
4328
|
+
#
|
4329
|
+
# @example Response structure
|
4330
|
+
#
|
4331
|
+
# resp.relevant_content #=> Array
|
4332
|
+
# resp.relevant_content[0].content #=> String
|
4333
|
+
# resp.relevant_content[0].document_id #=> String
|
4334
|
+
# resp.relevant_content[0].document_title #=> String
|
4335
|
+
# resp.relevant_content[0].document_uri #=> String
|
4336
|
+
# resp.relevant_content[0].document_attributes #=> Array
|
4337
|
+
# resp.relevant_content[0].document_attributes[0].name #=> String
|
4338
|
+
# resp.relevant_content[0].document_attributes[0].value.string_value #=> String
|
4339
|
+
# resp.relevant_content[0].document_attributes[0].value.string_list_value #=> Array
|
4340
|
+
# resp.relevant_content[0].document_attributes[0].value.string_list_value[0] #=> String
|
4341
|
+
# resp.relevant_content[0].document_attributes[0].value.long_value #=> Integer
|
4342
|
+
# resp.relevant_content[0].document_attributes[0].value.date_value #=> Time
|
4343
|
+
# resp.relevant_content[0].score_attributes.score_confidence #=> String, one of "VERY_HIGH", "HIGH", "MEDIUM", "LOW", "NOT_AVAILABLE"
|
4344
|
+
# resp.next_token #=> String
|
4345
|
+
#
|
4346
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/SearchRelevantContent AWS API Documentation
|
4347
|
+
#
|
4348
|
+
# @overload search_relevant_content(params = {})
|
4349
|
+
# @param [Hash] params ({})
|
4350
|
+
def search_relevant_content(params = {}, options = {})
|
4351
|
+
req = build_request(:search_relevant_content, params)
|
4352
|
+
req.send_request(options)
|
4353
|
+
end
|
4354
|
+
|
3369
4355
|
# Starts a data source connector synchronization job. If a
|
3370
4356
|
# synchronization job is already in progress, Amazon Q Business returns
|
3371
4357
|
# a `ConflictException`.
|
@@ -3505,16 +4491,24 @@ module Aws::QBusiness
|
|
3505
4491
|
|
3506
4492
|
# Updates an existing Amazon Q Business application.
|
3507
4493
|
#
|
3508
|
-
# <note markdown="1">
|
3509
|
-
#
|
3510
|
-
#
|
3511
|
-
#
|
4494
|
+
# <note markdown="1"> Amazon Q Business applications may securely transmit data for
|
4495
|
+
# processing across Amazon Web Services Regions within your geography.
|
4496
|
+
# For more information, see [Cross region inference in Amazon Q
|
4497
|
+
# Business][1].
|
4498
|
+
#
|
4499
|
+
# </note>
|
4500
|
+
#
|
4501
|
+
# <note markdown="1"> An Amazon Q Apps service-linked role will be created if it's absent
|
4502
|
+
# in the Amazon Web Services account when `QAppsConfiguration` is
|
4503
|
+
# enabled in the request. For more information, see [Using
|
4504
|
+
# service-linked roles for Q Apps][2].
|
3512
4505
|
#
|
3513
4506
|
# </note>
|
3514
4507
|
#
|
3515
4508
|
#
|
3516
4509
|
#
|
3517
|
-
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/
|
4510
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/cross-region-inference.html
|
4511
|
+
# [2]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles-qapps.html
|
3518
4512
|
#
|
3519
4513
|
# @option params [required, String] :application_id
|
3520
4514
|
# The identifier of the Amazon Q Business application.
|
@@ -3715,6 +4709,129 @@ module Aws::QBusiness
|
|
3715
4709
|
req.send_request(options)
|
3716
4710
|
end
|
3717
4711
|
|
4712
|
+
# Updates an existing data accessor. This operation allows modifying the
|
4713
|
+
# action configurations (the allowed actions and associated filters) and
|
4714
|
+
# the display name of the data accessor. It does not allow changing the
|
4715
|
+
# IAM role associated with the data accessor or other core properties of
|
4716
|
+
# the data accessor.
|
4717
|
+
#
|
4718
|
+
# @option params [required, String] :application_id
|
4719
|
+
# The unique identifier of the Q Business application.
|
4720
|
+
#
|
4721
|
+
# @option params [required, String] :data_accessor_id
|
4722
|
+
# The unique identifier of the data accessor to update.
|
4723
|
+
#
|
4724
|
+
# @option params [required, Array<Types::ActionConfiguration>] :action_configurations
|
4725
|
+
# The updated list of action configurations specifying the allowed
|
4726
|
+
# actions and any associated filters.
|
4727
|
+
#
|
4728
|
+
# @option params [String] :display_name
|
4729
|
+
# The updated friendly name for the data accessor.
|
4730
|
+
#
|
4731
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4732
|
+
#
|
4733
|
+
# @example Request syntax with placeholder values
|
4734
|
+
#
|
4735
|
+
# resp = client.update_data_accessor({
|
4736
|
+
# application_id: "ApplicationId", # required
|
4737
|
+
# data_accessor_id: "DataAccessorId", # required
|
4738
|
+
# action_configurations: [ # required
|
4739
|
+
# {
|
4740
|
+
# action: "QIamAction", # required
|
4741
|
+
# filter_configuration: {
|
4742
|
+
# document_attribute_filter: { # required
|
4743
|
+
# and_all_filters: [
|
4744
|
+
# {
|
4745
|
+
# # recursive AttributeFilter
|
4746
|
+
# },
|
4747
|
+
# ],
|
4748
|
+
# or_all_filters: [
|
4749
|
+
# {
|
4750
|
+
# # recursive AttributeFilter
|
4751
|
+
# },
|
4752
|
+
# ],
|
4753
|
+
# not_filter: {
|
4754
|
+
# # recursive AttributeFilter
|
4755
|
+
# },
|
4756
|
+
# equals_to: {
|
4757
|
+
# name: "DocumentAttributeKey", # required
|
4758
|
+
# value: { # required
|
4759
|
+
# string_value: "DocumentAttributeValueStringValueString",
|
4760
|
+
# string_list_value: ["String"],
|
4761
|
+
# long_value: 1,
|
4762
|
+
# date_value: Time.now,
|
4763
|
+
# },
|
4764
|
+
# },
|
4765
|
+
# contains_all: {
|
4766
|
+
# name: "DocumentAttributeKey", # required
|
4767
|
+
# value: { # required
|
4768
|
+
# string_value: "DocumentAttributeValueStringValueString",
|
4769
|
+
# string_list_value: ["String"],
|
4770
|
+
# long_value: 1,
|
4771
|
+
# date_value: Time.now,
|
4772
|
+
# },
|
4773
|
+
# },
|
4774
|
+
# contains_any: {
|
4775
|
+
# name: "DocumentAttributeKey", # required
|
4776
|
+
# value: { # required
|
4777
|
+
# string_value: "DocumentAttributeValueStringValueString",
|
4778
|
+
# string_list_value: ["String"],
|
4779
|
+
# long_value: 1,
|
4780
|
+
# date_value: Time.now,
|
4781
|
+
# },
|
4782
|
+
# },
|
4783
|
+
# greater_than: {
|
4784
|
+
# name: "DocumentAttributeKey", # required
|
4785
|
+
# value: { # required
|
4786
|
+
# string_value: "DocumentAttributeValueStringValueString",
|
4787
|
+
# string_list_value: ["String"],
|
4788
|
+
# long_value: 1,
|
4789
|
+
# date_value: Time.now,
|
4790
|
+
# },
|
4791
|
+
# },
|
4792
|
+
# greater_than_or_equals: {
|
4793
|
+
# name: "DocumentAttributeKey", # required
|
4794
|
+
# value: { # required
|
4795
|
+
# string_value: "DocumentAttributeValueStringValueString",
|
4796
|
+
# string_list_value: ["String"],
|
4797
|
+
# long_value: 1,
|
4798
|
+
# date_value: Time.now,
|
4799
|
+
# },
|
4800
|
+
# },
|
4801
|
+
# less_than: {
|
4802
|
+
# name: "DocumentAttributeKey", # required
|
4803
|
+
# value: { # required
|
4804
|
+
# string_value: "DocumentAttributeValueStringValueString",
|
4805
|
+
# string_list_value: ["String"],
|
4806
|
+
# long_value: 1,
|
4807
|
+
# date_value: Time.now,
|
4808
|
+
# },
|
4809
|
+
# },
|
4810
|
+
# less_than_or_equals: {
|
4811
|
+
# name: "DocumentAttributeKey", # required
|
4812
|
+
# value: { # required
|
4813
|
+
# string_value: "DocumentAttributeValueStringValueString",
|
4814
|
+
# string_list_value: ["String"],
|
4815
|
+
# long_value: 1,
|
4816
|
+
# date_value: Time.now,
|
4817
|
+
# },
|
4818
|
+
# },
|
4819
|
+
# },
|
4820
|
+
# },
|
4821
|
+
# },
|
4822
|
+
# ],
|
4823
|
+
# display_name: "DataAccessorName",
|
4824
|
+
# })
|
4825
|
+
#
|
4826
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateDataAccessor AWS API Documentation
|
4827
|
+
#
|
4828
|
+
# @overload update_data_accessor(params = {})
|
4829
|
+
# @param [Hash] params ({})
|
4830
|
+
def update_data_accessor(params = {}, options = {})
|
4831
|
+
req = build_request(:update_data_accessor, params)
|
4832
|
+
req.send_request(options)
|
4833
|
+
end
|
4834
|
+
|
3718
4835
|
# Updates an existing Amazon Q Business data source connector.
|
3719
4836
|
#
|
3720
4837
|
# @option params [required, String] :application_id
|
@@ -3763,6 +4880,10 @@ module Aws::QBusiness
|
|
3763
4880
|
#
|
3764
4881
|
# [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html
|
3765
4882
|
#
|
4883
|
+
# @option params [Types::MediaExtractionConfiguration] :media_extraction_configuration
|
4884
|
+
# The configuration for extracting information from media in documents
|
4885
|
+
# for your data source.
|
4886
|
+
#
|
3766
4887
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3767
4888
|
#
|
3768
4889
|
# @example Request syntax with placeholder values
|
@@ -3838,6 +4959,11 @@ module Aws::QBusiness
|
|
3838
4959
|
# role_arn: "RoleArn",
|
3839
4960
|
# },
|
3840
4961
|
# },
|
4962
|
+
# media_extraction_configuration: {
|
4963
|
+
# image_extraction_configuration: {
|
4964
|
+
# image_extraction_status: "ENABLED", # required, accepts ENABLED, DISABLED
|
4965
|
+
# },
|
4966
|
+
# },
|
3841
4967
|
# })
|
3842
4968
|
#
|
3843
4969
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateDataSource AWS API Documentation
|
@@ -3961,9 +5087,15 @@ module Aws::QBusiness
|
|
3961
5087
|
# o_auth_2_client_credential_configuration: {
|
3962
5088
|
# secret_arn: "SecretArn", # required
|
3963
5089
|
# role_arn: "RoleArn", # required
|
5090
|
+
# authorization_url: "Url",
|
5091
|
+
# token_url: "Url",
|
3964
5092
|
# },
|
3965
5093
|
# no_auth_configuration: {
|
3966
5094
|
# },
|
5095
|
+
# idc_auth_configuration: {
|
5096
|
+
# idc_application_arn: "IdcApplicationArn", # required
|
5097
|
+
# role_arn: "RoleArn", # required
|
5098
|
+
# },
|
3967
5099
|
# },
|
3968
5100
|
# })
|
3969
5101
|
#
|
@@ -4155,6 +5287,26 @@ module Aws::QBusiness
|
|
4155
5287
|
# URL</i> and not a full path. For example,
|
4156
5288
|
# <code>https://docs.aws.amazon.com</code>.</p> </li> </ul> </note>
|
4157
5289
|
#
|
5290
|
+
# @option params [Types::BrowserExtensionConfiguration] :browser_extension_configuration
|
5291
|
+
# The browser extension configuration for an Amazon Q Business web
|
5292
|
+
# experience.
|
5293
|
+
#
|
5294
|
+
# <note markdown="1"> For Amazon Q Business application using external OIDC-compliant
|
5295
|
+
# identity providers (IdPs). The IdP administrator must add the browser
|
5296
|
+
# extension sign-in redirect URLs to the IdP application. For more
|
5297
|
+
# information, see [Configure external OIDC identity provider for your
|
5298
|
+
# browser extensions.][1].
|
5299
|
+
#
|
5300
|
+
# </note>
|
5301
|
+
#
|
5302
|
+
#
|
5303
|
+
#
|
5304
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/browser-extensions.html
|
5305
|
+
#
|
5306
|
+
# @option params [Types::CustomizationConfiguration] :customization_configuration
|
5307
|
+
# Updates the custom logo, favicon, font, and color used in the Amazon Q
|
5308
|
+
# web experience.
|
5309
|
+
#
|
4158
5310
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4159
5311
|
#
|
4160
5312
|
# @example Request syntax with placeholder values
|
@@ -4185,6 +5337,15 @@ module Aws::QBusiness
|
|
4185
5337
|
# },
|
4186
5338
|
# },
|
4187
5339
|
# origins: ["Origin"],
|
5340
|
+
# browser_extension_configuration: {
|
5341
|
+
# enabled_browser_extensions: ["FIREFOX"], # required, accepts FIREFOX, CHROME
|
5342
|
+
# },
|
5343
|
+
# customization_configuration: {
|
5344
|
+
# custom_css_url: "CustomCSSUrl",
|
5345
|
+
# logo_url: "LogoUrl",
|
5346
|
+
# font_url: "FontUrl",
|
5347
|
+
# favicon_url: "FaviconUrl",
|
5348
|
+
# },
|
4188
5349
|
# })
|
4189
5350
|
#
|
4190
5351
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateWebExperience AWS API Documentation
|
@@ -4214,7 +5375,7 @@ module Aws::QBusiness
|
|
4214
5375
|
tracer: tracer
|
4215
5376
|
)
|
4216
5377
|
context[:gem_name] = 'aws-sdk-qbusiness'
|
4217
|
-
context[:gem_version] = '1.
|
5378
|
+
context[:gem_version] = '1.24.0'
|
4218
5379
|
Seahorse::Client::Request.new(handlers, context)
|
4219
5380
|
end
|
4220
5381
|
|