aws-sdk-qbusiness 1.22.0 → 1.23.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-qbusiness/async_client.rb +6 -2
- data/lib/aws-sdk-qbusiness/client.rb +271 -33
- data/lib/aws-sdk-qbusiness/client_api.rb +140 -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 +450 -40
- data/lib/aws-sdk-qbusiness.rb +1 -1
- data/sig/client.rbs +63 -5
- data/sig/errors.rbs +6 -0
- data/sig/types.rbs +101 -4
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 11f8df5cb0d23dc562b54d5f20c196ed1ce0f089939130a520358a786810bdb5
|
4
|
+
data.tar.gz: f3789123fc2f550d23be0fb6d5c1c537220af0f3eecf402cf676e52aaa328a25
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 10580dbabbaad596966919dee0596f6ca2b59d81d5ddeac14344592997341fbb957db0e1aa9364c452fe25e500b5b18881b791f7e3a84ddb3d779a47d4de4a54
|
7
|
+
data.tar.gz: e3b055e6e93ba7d261067d3520b4e004b9bac9cb0e08fa8fa93691c0c89dd9b582b7834b287d6e6103d67948f7809f36a195c2f0410ff3b11504b574e994473f
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.23.0 (2024-12-02)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Amazon Q Business now supports capabilities to extract insights and answer questions from visual elements embedded within documents, a browser extension for Google Chrome, Mozilla Firefox, and Microsoft Edge, and attachments across conversations.
|
8
|
+
|
4
9
|
1.22.0 (2024-11-08)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.23.0
|
@@ -525,6 +525,8 @@ module Aws::QBusiness
|
|
525
525
|
# event.source_attributions[0].text_message_segments[0].begin_offset #=> Integer
|
526
526
|
# event.source_attributions[0].text_message_segments[0].end_offset #=> Integer
|
527
527
|
# event.source_attributions[0].text_message_segments[0].snippet_excerpt.text #=> String
|
528
|
+
# event.source_attributions[0].text_message_segments[0].media_id #=> String
|
529
|
+
# event.source_attributions[0].text_message_segments[0].media_mime_type #=> String
|
528
530
|
# event.final_text_message #=> String
|
529
531
|
#
|
530
532
|
# For :action_review_event event available at #on_action_review_event_event callback and response eventstream enumerator:
|
@@ -548,9 +550,11 @@ module Aws::QBusiness
|
|
548
550
|
# event.user_message_id #=> String
|
549
551
|
# event.system_message_id #=> String
|
550
552
|
# event.attachment.name #=> String
|
551
|
-
# event.attachment.status #=> String, one of "FAILED", "
|
553
|
+
# event.attachment.status #=> String, one of "FAILED", "SUCCESS"
|
552
554
|
# event.attachment.error.error_message #=> String
|
553
555
|
# event.attachment.error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
556
|
+
# event.attachment.attachment_id #=> String
|
557
|
+
# event.attachment.conversation_id #=> String
|
554
558
|
#
|
555
559
|
# For :auth_challenge_request_event event available at #on_auth_challenge_request_event_event callback and response eventstream enumerator:
|
556
560
|
# event.authorization_url #=> String
|
@@ -603,7 +607,7 @@ module Aws::QBusiness
|
|
603
607
|
tracer: tracer
|
604
608
|
)
|
605
609
|
context[:gem_name] = 'aws-sdk-qbusiness'
|
606
|
-
context[:gem_version] = '1.
|
610
|
+
context[:gem_version] = '1.23.0'
|
607
611
|
Seahorse::Client::Request.new(handlers, context)
|
608
612
|
end
|
609
613
|
|
@@ -655,6 +655,11 @@ module Aws::QBusiness
|
|
655
655
|
# role_arn: "RoleArn",
|
656
656
|
# },
|
657
657
|
# },
|
658
|
+
# media_extraction_configuration: {
|
659
|
+
# image_extraction_configuration: {
|
660
|
+
# image_extraction_status: "ENABLED", # required, accepts ENABLED, DISABLED
|
661
|
+
# },
|
662
|
+
# },
|
658
663
|
# },
|
659
664
|
# ],
|
660
665
|
# role_arn: "RoleArn",
|
@@ -716,22 +721,33 @@ module Aws::QBusiness
|
|
716
721
|
# on document attributes or metadata fields.
|
717
722
|
#
|
718
723
|
# @option params [String] :chat_mode
|
719
|
-
# The chat modes available to
|
724
|
+
# The `chatMode` parameter determines the chat modes available to Amazon
|
725
|
+
# Q Business users:
|
726
|
+
#
|
727
|
+
# * `RETRIEVAL_MODE` - If you choose this mode, Amazon Q generates
|
728
|
+
# responses solely from the data sources connected and indexed by the
|
729
|
+
# application. If an answer is not found in the data sources or there
|
730
|
+
# are no data sources available, Amazon Q will respond with a "*No
|
731
|
+
# Answer Found*" message, unless LLM knowledge has been enabled. In
|
732
|
+
# that case, Amazon Q will generate a response from the LLM knowledge
|
733
|
+
#
|
734
|
+
# * `CREATOR_MODE` - By selecting this mode, you can choose to generate
|
735
|
+
# responses only from the LLM knowledge. You can also attach files and
|
736
|
+
# have Amazon Q generate a response based on the data in those files.
|
737
|
+
# If the attached files do not contain an answer for the query, Amazon
|
738
|
+
# Q will automatically fall back to generating a response from the LLM
|
739
|
+
# knowledge.
|
720
740
|
#
|
721
|
-
# * `
|
722
|
-
#
|
723
|
-
# responses only from data sources connected to an Amazon Q Business
|
724
|
-
# application.
|
741
|
+
# * `PLUGIN_MODE` - By selecting this mode, users can choose to use
|
742
|
+
# plugins in chat to get their responses.
|
725
743
|
#
|
726
|
-
#
|
727
|
-
#
|
728
|
-
# connected data sources, for a chat request.
|
744
|
+
# <note markdown="1"> If none of the modes are selected, Amazon Q will only respond using
|
745
|
+
# the information from the attached files.
|
729
746
|
#
|
730
|
-
#
|
731
|
-
# plugins in chat.
|
747
|
+
# </note>
|
732
748
|
#
|
733
749
|
# For more information, see [Admin controls and guardrails][1],
|
734
|
-
# [Plugins][2], and [
|
750
|
+
# [Plugins][2], and [Response sources][3].
|
735
751
|
#
|
736
752
|
#
|
737
753
|
#
|
@@ -768,8 +784,14 @@ module Aws::QBusiness
|
|
768
784
|
# user_message: "UserMessage",
|
769
785
|
# attachments: [
|
770
786
|
# {
|
771
|
-
#
|
772
|
-
#
|
787
|
+
# data: "data",
|
788
|
+
# name: "AttachmentName",
|
789
|
+
# copy_from: {
|
790
|
+
# conversation: {
|
791
|
+
# conversation_id: "ConversationId", # required
|
792
|
+
# attachment_id: "AttachmentId", # required
|
793
|
+
# },
|
794
|
+
# },
|
773
795
|
# },
|
774
796
|
# ],
|
775
797
|
# action_execution: {
|
@@ -904,11 +926,15 @@ module Aws::QBusiness
|
|
904
926
|
# resp.source_attributions[0].text_message_segments[0].begin_offset #=> Integer
|
905
927
|
# resp.source_attributions[0].text_message_segments[0].end_offset #=> Integer
|
906
928
|
# resp.source_attributions[0].text_message_segments[0].snippet_excerpt.text #=> String
|
929
|
+
# resp.source_attributions[0].text_message_segments[0].media_id #=> String
|
930
|
+
# resp.source_attributions[0].text_message_segments[0].media_mime_type #=> String
|
907
931
|
# resp.failed_attachments #=> Array
|
908
932
|
# resp.failed_attachments[0].name #=> String
|
909
|
-
# resp.failed_attachments[0].status #=> String, one of "FAILED", "
|
933
|
+
# resp.failed_attachments[0].status #=> String, one of "FAILED", "SUCCESS"
|
910
934
|
# resp.failed_attachments[0].error.error_message #=> String
|
911
935
|
# resp.failed_attachments[0].error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
936
|
+
# resp.failed_attachments[0].attachment_id #=> String
|
937
|
+
# resp.failed_attachments[0].conversation_id #=> String
|
912
938
|
#
|
913
939
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ChatSync AWS API Documentation
|
914
940
|
#
|
@@ -928,10 +954,15 @@ module Aws::QBusiness
|
|
928
954
|
# You must use the Amazon Q Business console to assign subscription
|
929
955
|
# tiers to users.
|
930
956
|
#
|
931
|
-
#
|
932
|
-
# the Amazon Web Services account when
|
933
|
-
# in the request. For more information, see [ Using
|
934
|
-
# for Q Apps
|
957
|
+
# An Amazon Q Apps service linked role will be created if it's absent
|
958
|
+
# in the Amazon Web Services account when `QAppsConfiguration` is
|
959
|
+
# enabled in the request. For more information, see [ Using
|
960
|
+
# service-linked roles for Q Apps][2].
|
961
|
+
#
|
962
|
+
# When you create an application, Amazon Q Business may securely
|
963
|
+
# transmit data for processing from your selected Amazon Web Services
|
964
|
+
# region, but within your geography. For more information, see [Cross
|
965
|
+
# region inference in Amazon Q Business][3].
|
935
966
|
#
|
936
967
|
# </note>
|
937
968
|
#
|
@@ -939,6 +970,7 @@ module Aws::QBusiness
|
|
939
970
|
#
|
940
971
|
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#user-sub-tiers
|
941
972
|
# [2]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles-qapps.html
|
973
|
+
# [3]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/cross-region-inference.html
|
942
974
|
#
|
943
975
|
# @option params [required, String] :display_name
|
944
976
|
# A name for the Amazon Q Business application.
|
@@ -1015,7 +1047,7 @@ module Aws::QBusiness
|
|
1015
1047
|
# display_name: "ApplicationName", # required
|
1016
1048
|
# role_arn: "RoleArn",
|
1017
1049
|
# identity_type: "AWS_IAM_IDP_SAML", # accepts AWS_IAM_IDP_SAML, AWS_IAM_IDP_OIDC, AWS_IAM_IDC
|
1018
|
-
# iam_identity_provider_arn: "
|
1050
|
+
# iam_identity_provider_arn: "IAMIdentityProviderArn",
|
1019
1051
|
# identity_center_instance_arn: "InstanceArn",
|
1020
1052
|
# client_ids_for_oidc: ["ClientIdForOIDC"],
|
1021
1053
|
# description: "Description",
|
@@ -1156,6 +1188,10 @@ module Aws::QBusiness
|
|
1156
1188
|
#
|
1157
1189
|
# [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html
|
1158
1190
|
#
|
1191
|
+
# @option params [Types::MediaExtractionConfiguration] :media_extraction_configuration
|
1192
|
+
# The configuration for extracting information from media in documents
|
1193
|
+
# during ingestion.
|
1194
|
+
#
|
1159
1195
|
# @return [Types::CreateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1160
1196
|
#
|
1161
1197
|
# * {Types::CreateDataSourceResponse#data_source_id #data_source_id} => String
|
@@ -1240,6 +1276,11 @@ module Aws::QBusiness
|
|
1240
1276
|
# role_arn: "RoleArn",
|
1241
1277
|
# },
|
1242
1278
|
# },
|
1279
|
+
# media_extraction_configuration: {
|
1280
|
+
# image_extraction_configuration: {
|
1281
|
+
# image_extraction_status: "ENABLED", # required, accepts ENABLED, DISABLED
|
1282
|
+
# },
|
1283
|
+
# },
|
1243
1284
|
# })
|
1244
1285
|
#
|
1245
1286
|
# @example Response structure
|
@@ -1276,6 +1317,9 @@ module Aws::QBusiness
|
|
1276
1317
|
# @option params [required, String] :display_name
|
1277
1318
|
# A name for the Amazon Q Business index.
|
1278
1319
|
#
|
1320
|
+
# @option params [String] :description
|
1321
|
+
# A description for the Amazon Q Business index.
|
1322
|
+
#
|
1279
1323
|
# @option params [String] :type
|
1280
1324
|
# The index type that's suitable for your needs. For more information
|
1281
1325
|
# on what's included in each type of index, see [Amazon Q Business
|
@@ -1285,9 +1329,6 @@ module Aws::QBusiness
|
|
1285
1329
|
#
|
1286
1330
|
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#index-tiers
|
1287
1331
|
#
|
1288
|
-
# @option params [String] :description
|
1289
|
-
# A description for the Amazon Q Business index.
|
1290
|
-
#
|
1291
1332
|
# @option params [Array<Types::Tag>] :tags
|
1292
1333
|
# A list of key-value pairs that identify or categorize the index. You
|
1293
1334
|
# can also use tags to help control access to the index. Tag keys and
|
@@ -1316,8 +1357,8 @@ module Aws::QBusiness
|
|
1316
1357
|
# resp = client.create_index({
|
1317
1358
|
# application_id: "ApplicationId", # required
|
1318
1359
|
# display_name: "IndexName", # required
|
1319
|
-
# type: "ENTERPRISE", # accepts ENTERPRISE, STARTER
|
1320
1360
|
# description: "Description",
|
1361
|
+
# type: "ENTERPRISE", # accepts ENTERPRISE, STARTER
|
1321
1362
|
# tags: [
|
1322
1363
|
# {
|
1323
1364
|
# key: "TagKey", # required
|
@@ -1638,6 +1679,22 @@ module Aws::QBusiness
|
|
1638
1679
|
# Information about the identity provider (IdP) used to authenticate end
|
1639
1680
|
# users of an Amazon Q Business web experience.
|
1640
1681
|
#
|
1682
|
+
# @option params [Types::BrowserExtensionConfiguration] :browser_extension_configuration
|
1683
|
+
# The browser extension configuration for an Amazon Q Business web
|
1684
|
+
# experience.
|
1685
|
+
#
|
1686
|
+
# <note markdown="1"> For Amazon Q Business application using external OIDC-compliant
|
1687
|
+
# identity providers (IdPs). The IdP administrator must add the browser
|
1688
|
+
# extension sign-in redirect URLs to the IdP application. For more
|
1689
|
+
# information, see [Configure external OIDC identity provider for your
|
1690
|
+
# browser extensions.][1].
|
1691
|
+
#
|
1692
|
+
# </note>
|
1693
|
+
#
|
1694
|
+
#
|
1695
|
+
#
|
1696
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/browser-extensions.html
|
1697
|
+
#
|
1641
1698
|
# @return [Types::CreateWebExperienceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1642
1699
|
#
|
1643
1700
|
# * {Types::CreateWebExperienceResponse#web_experience_id #web_experience_id} => String
|
@@ -1669,6 +1726,9 @@ module Aws::QBusiness
|
|
1669
1726
|
# secrets_role: "RoleArn", # required
|
1670
1727
|
# },
|
1671
1728
|
# },
|
1729
|
+
# browser_extension_configuration: {
|
1730
|
+
# enabled_browser_extensions: ["FIREFOX"], # required, accepts FIREFOX, CHROME
|
1731
|
+
# },
|
1672
1732
|
# })
|
1673
1733
|
#
|
1674
1734
|
# @example Response structure
|
@@ -2151,6 +2211,7 @@ module Aws::QBusiness
|
|
2151
2211
|
# * {Types::GetDataSourceResponse#role_arn #role_arn} => String
|
2152
2212
|
# * {Types::GetDataSourceResponse#error #error} => Types::ErrorDetail
|
2153
2213
|
# * {Types::GetDataSourceResponse#document_enrichment_configuration #document_enrichment_configuration} => Types::DocumentEnrichmentConfiguration
|
2214
|
+
# * {Types::GetDataSourceResponse#media_extraction_configuration #media_extraction_configuration} => Types::MediaExtractionConfiguration
|
2154
2215
|
#
|
2155
2216
|
# @example Request syntax with placeholder values
|
2156
2217
|
#
|
@@ -2216,6 +2277,7 @@ module Aws::QBusiness
|
|
2216
2277
|
# resp.document_enrichment_configuration.post_extraction_hook_configuration.lambda_arn #=> String
|
2217
2278
|
# resp.document_enrichment_configuration.post_extraction_hook_configuration.s3_bucket_name #=> String
|
2218
2279
|
# resp.document_enrichment_configuration.post_extraction_hook_configuration.role_arn #=> String
|
2280
|
+
# resp.media_extraction_configuration.image_extraction_configuration.image_extraction_status #=> String, one of "ENABLED", "DISABLED"
|
2219
2281
|
#
|
2220
2282
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetDataSource AWS API Documentation
|
2221
2283
|
#
|
@@ -2289,9 +2351,9 @@ module Aws::QBusiness
|
|
2289
2351
|
# * {Types::GetIndexResponse#application_id #application_id} => String
|
2290
2352
|
# * {Types::GetIndexResponse#index_id #index_id} => String
|
2291
2353
|
# * {Types::GetIndexResponse#display_name #display_name} => String
|
2292
|
-
# * {Types::GetIndexResponse#type #type} => String
|
2293
2354
|
# * {Types::GetIndexResponse#index_arn #index_arn} => String
|
2294
2355
|
# * {Types::GetIndexResponse#status #status} => String
|
2356
|
+
# * {Types::GetIndexResponse#type #type} => String
|
2295
2357
|
# * {Types::GetIndexResponse#description #description} => String
|
2296
2358
|
# * {Types::GetIndexResponse#created_at #created_at} => Time
|
2297
2359
|
# * {Types::GetIndexResponse#updated_at #updated_at} => Time
|
@@ -2312,9 +2374,9 @@ module Aws::QBusiness
|
|
2312
2374
|
# resp.application_id #=> String
|
2313
2375
|
# resp.index_id #=> String
|
2314
2376
|
# resp.display_name #=> String
|
2315
|
-
# resp.type #=> String, one of "ENTERPRISE", "STARTER"
|
2316
2377
|
# resp.index_arn #=> String
|
2317
2378
|
# resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING"
|
2379
|
+
# resp.type #=> String, one of "ENTERPRISE", "STARTER"
|
2318
2380
|
# resp.description #=> String
|
2319
2381
|
# resp.created_at #=> Time
|
2320
2382
|
# resp.updated_at #=> Time
|
@@ -2337,6 +2399,62 @@ module Aws::QBusiness
|
|
2337
2399
|
req.send_request(options)
|
2338
2400
|
end
|
2339
2401
|
|
2402
|
+
# Returns the image bytes corresponding to a media object. If you have
|
2403
|
+
# implemented your own application with the Chat and ChatSync APIs, and
|
2404
|
+
# have enabled content extraction from visual data in Amazon Q Business,
|
2405
|
+
# you use the GetMedia API operation to download the images so you can
|
2406
|
+
# show them in your UI with responses.
|
2407
|
+
#
|
2408
|
+
# For more information, see [Extracting semantic meaning from images and
|
2409
|
+
# visuals][1].
|
2410
|
+
#
|
2411
|
+
#
|
2412
|
+
#
|
2413
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/extracting-meaning-from-images.html
|
2414
|
+
#
|
2415
|
+
# @option params [required, String] :application_id
|
2416
|
+
# The identifier of the Amazon Q Business which contains the media
|
2417
|
+
# object.
|
2418
|
+
#
|
2419
|
+
# @option params [required, String] :conversation_id
|
2420
|
+
# The identifier of the Amazon Q Business conversation.
|
2421
|
+
#
|
2422
|
+
# @option params [required, String] :message_id
|
2423
|
+
# The identifier of the Amazon Q Business message.
|
2424
|
+
#
|
2425
|
+
# @option params [required, String] :media_id
|
2426
|
+
# The identifier of the media object. You can find this in the
|
2427
|
+
# `sourceAttributions` returned by the `Chat`, `ChatSync`, and
|
2428
|
+
# `ListMessages` API responses.
|
2429
|
+
#
|
2430
|
+
# @return [Types::GetMediaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2431
|
+
#
|
2432
|
+
# * {Types::GetMediaResponse#media_bytes #media_bytes} => String
|
2433
|
+
# * {Types::GetMediaResponse#media_mime_type #media_mime_type} => String
|
2434
|
+
#
|
2435
|
+
# @example Request syntax with placeholder values
|
2436
|
+
#
|
2437
|
+
# resp = client.get_media({
|
2438
|
+
# application_id: "ApplicationId", # required
|
2439
|
+
# conversation_id: "ConversationId", # required
|
2440
|
+
# message_id: "MessageId", # required
|
2441
|
+
# media_id: "MediaId", # required
|
2442
|
+
# })
|
2443
|
+
#
|
2444
|
+
# @example Response structure
|
2445
|
+
#
|
2446
|
+
# resp.media_bytes #=> String
|
2447
|
+
# resp.media_mime_type #=> String
|
2448
|
+
#
|
2449
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetMedia AWS API Documentation
|
2450
|
+
#
|
2451
|
+
# @overload get_media(params = {})
|
2452
|
+
# @param [Hash] params ({})
|
2453
|
+
def get_media(params = {}, options = {})
|
2454
|
+
req = build_request(:get_media, params)
|
2455
|
+
req.send_request(options)
|
2456
|
+
end
|
2457
|
+
|
2340
2458
|
# Gets information about an existing Amazon Q Business plugin.
|
2341
2459
|
#
|
2342
2460
|
# @option params [required, String] :application_id
|
@@ -2523,6 +2641,7 @@ module Aws::QBusiness
|
|
2523
2641
|
# * {Types::GetWebExperienceResponse#identity_provider_configuration #identity_provider_configuration} => Types::IdentityProviderConfiguration
|
2524
2642
|
# * {Types::GetWebExperienceResponse#authentication_configuration #authentication_configuration} => Types::WebExperienceAuthConfiguration
|
2525
2643
|
# * {Types::GetWebExperienceResponse#error #error} => Types::ErrorDetail
|
2644
|
+
# * {Types::GetWebExperienceResponse#browser_extension_configuration #browser_extension_configuration} => Types::BrowserExtensionConfiguration
|
2526
2645
|
#
|
2527
2646
|
# @example Request syntax with placeholder values
|
2528
2647
|
#
|
@@ -2556,6 +2675,8 @@ module Aws::QBusiness
|
|
2556
2675
|
# resp.authentication_configuration.saml_configuration.user_group_attribute #=> String
|
2557
2676
|
# resp.error.error_message #=> String
|
2558
2677
|
# resp.error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
2678
|
+
# resp.browser_extension_configuration.enabled_browser_extensions #=> Array
|
2679
|
+
# resp.browser_extension_configuration.enabled_browser_extensions[0] #=> String, one of "FIREFOX", "CHROME"
|
2559
2680
|
#
|
2560
2681
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetWebExperience AWS API Documentation
|
2561
2682
|
#
|
@@ -2568,6 +2689,17 @@ module Aws::QBusiness
|
|
2568
2689
|
|
2569
2690
|
# Lists Amazon Q Business applications.
|
2570
2691
|
#
|
2692
|
+
# <note markdown="1"> Amazon Q Business applications may securely transmit data for
|
2693
|
+
# processing across Amazon Web Services Regions within your geography.
|
2694
|
+
# For more information, see [Cross region inference in Amazon Q
|
2695
|
+
# Business][1].
|
2696
|
+
#
|
2697
|
+
# </note>
|
2698
|
+
#
|
2699
|
+
#
|
2700
|
+
#
|
2701
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/cross-region-inference.html
|
2702
|
+
#
|
2571
2703
|
# @option params [String] :next_token
|
2572
2704
|
# If the `maxResults` response was incomplete because there is more data
|
2573
2705
|
# to retrieve, Amazon Q Business returns a pagination token in the
|
@@ -2611,6 +2743,72 @@ module Aws::QBusiness
|
|
2611
2743
|
req.send_request(options)
|
2612
2744
|
end
|
2613
2745
|
|
2746
|
+
# Gets a list of attachments associated with an Amazon Q Business web
|
2747
|
+
# experience or a list of attachements associated with a specific Amazon
|
2748
|
+
# Q Business conversation.
|
2749
|
+
#
|
2750
|
+
# @option params [required, String] :application_id
|
2751
|
+
# The unique identifier for the Amazon Q Business application.
|
2752
|
+
#
|
2753
|
+
# @option params [String] :conversation_id
|
2754
|
+
# The unique identifier of the Amazon Q Business web experience
|
2755
|
+
# conversation.
|
2756
|
+
#
|
2757
|
+
# @option params [String] :user_id
|
2758
|
+
# The unique identifier of the user involved in the Amazon Q Business
|
2759
|
+
# web experience conversation.
|
2760
|
+
#
|
2761
|
+
# @option params [String] :next_token
|
2762
|
+
# If the number of attachments returned exceeds `maxResults`, Amazon Q
|
2763
|
+
# Business returns a next token as a pagination token to retrieve the
|
2764
|
+
# next set of attachments.
|
2765
|
+
#
|
2766
|
+
# @option params [Integer] :max_results
|
2767
|
+
# The maximum number of attachements to return.
|
2768
|
+
#
|
2769
|
+
# @return [Types::ListAttachmentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2770
|
+
#
|
2771
|
+
# * {Types::ListAttachmentsResponse#attachments #attachments} => Array<Types::Attachment>
|
2772
|
+
# * {Types::ListAttachmentsResponse#next_token #next_token} => String
|
2773
|
+
#
|
2774
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2775
|
+
#
|
2776
|
+
# @example Request syntax with placeholder values
|
2777
|
+
#
|
2778
|
+
# resp = client.list_attachments({
|
2779
|
+
# application_id: "ApplicationId", # required
|
2780
|
+
# conversation_id: "ConversationId",
|
2781
|
+
# user_id: "UserId",
|
2782
|
+
# next_token: "NextToken",
|
2783
|
+
# max_results: 1,
|
2784
|
+
# })
|
2785
|
+
#
|
2786
|
+
# @example Response structure
|
2787
|
+
#
|
2788
|
+
# resp.attachments #=> Array
|
2789
|
+
# resp.attachments[0].attachment_id #=> String
|
2790
|
+
# resp.attachments[0].conversation_id #=> String
|
2791
|
+
# resp.attachments[0].name #=> String
|
2792
|
+
# resp.attachments[0].copy_from.conversation.conversation_id #=> String
|
2793
|
+
# resp.attachments[0].copy_from.conversation.attachment_id #=> String
|
2794
|
+
# resp.attachments[0].file_type #=> String
|
2795
|
+
# resp.attachments[0].file_size #=> Integer
|
2796
|
+
# resp.attachments[0].md5chksum #=> String
|
2797
|
+
# resp.attachments[0].created_at #=> Time
|
2798
|
+
# resp.attachments[0].status #=> String, one of "FAILED", "SUCCESS"
|
2799
|
+
# resp.attachments[0].error.error_message #=> String
|
2800
|
+
# resp.attachments[0].error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
2801
|
+
# resp.next_token #=> String
|
2802
|
+
#
|
2803
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListAttachments AWS API Documentation
|
2804
|
+
#
|
2805
|
+
# @overload list_attachments(params = {})
|
2806
|
+
# @param [Hash] params ({})
|
2807
|
+
def list_attachments(params = {}, options = {})
|
2808
|
+
req = build_request(:list_attachments, params)
|
2809
|
+
req.send_request(options)
|
2810
|
+
end
|
2811
|
+
|
2614
2812
|
# Lists one or more Amazon Q Business conversations.
|
2615
2813
|
#
|
2616
2814
|
# @option params [required, String] :application_id
|
@@ -2977,7 +3175,7 @@ module Aws::QBusiness
|
|
2977
3175
|
# experience conversation.
|
2978
3176
|
#
|
2979
3177
|
# @option params [String] :next_token
|
2980
|
-
# If the number of
|
3178
|
+
# If the number of messages returned exceeds `maxResults`, Amazon Q
|
2981
3179
|
# Business returns a next token as a pagination token to retrieve the
|
2982
3180
|
# next set of messages.
|
2983
3181
|
#
|
@@ -3010,9 +3208,11 @@ module Aws::QBusiness
|
|
3010
3208
|
# resp.messages[0].type #=> String, one of "USER", "SYSTEM"
|
3011
3209
|
# resp.messages[0].attachments #=> Array
|
3012
3210
|
# resp.messages[0].attachments[0].name #=> String
|
3013
|
-
# resp.messages[0].attachments[0].status #=> String, one of "FAILED", "
|
3211
|
+
# resp.messages[0].attachments[0].status #=> String, one of "FAILED", "SUCCESS"
|
3014
3212
|
# resp.messages[0].attachments[0].error.error_message #=> String
|
3015
3213
|
# resp.messages[0].attachments[0].error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
3214
|
+
# resp.messages[0].attachments[0].attachment_id #=> String
|
3215
|
+
# resp.messages[0].attachments[0].conversation_id #=> String
|
3016
3216
|
# resp.messages[0].source_attribution #=> Array
|
3017
3217
|
# resp.messages[0].source_attribution[0].title #=> String
|
3018
3218
|
# resp.messages[0].source_attribution[0].snippet #=> String
|
@@ -3023,6 +3223,8 @@ module Aws::QBusiness
|
|
3023
3223
|
# resp.messages[0].source_attribution[0].text_message_segments[0].begin_offset #=> Integer
|
3024
3224
|
# resp.messages[0].source_attribution[0].text_message_segments[0].end_offset #=> Integer
|
3025
3225
|
# resp.messages[0].source_attribution[0].text_message_segments[0].snippet_excerpt.text #=> String
|
3226
|
+
# resp.messages[0].source_attribution[0].text_message_segments[0].media_id #=> String
|
3227
|
+
# resp.messages[0].source_attribution[0].text_message_segments[0].media_mime_type #=> String
|
3026
3228
|
# resp.messages[0].action_review.plugin_id #=> String
|
3027
3229
|
# resp.messages[0].action_review.plugin_type #=> String, one of "SERVICE_NOW", "SALESFORCE", "JIRA", "ZENDESK", "CUSTOM"
|
3028
3230
|
# resp.messages[0].action_review.payload #=> Hash
|
@@ -3505,16 +3707,24 @@ module Aws::QBusiness
|
|
3505
3707
|
|
3506
3708
|
# Updates an existing Amazon Q Business application.
|
3507
3709
|
#
|
3508
|
-
# <note markdown="1">
|
3509
|
-
#
|
3510
|
-
#
|
3511
|
-
#
|
3710
|
+
# <note markdown="1"> Amazon Q Business applications may securely transmit data for
|
3711
|
+
# processing across Amazon Web Services Regions within your geography.
|
3712
|
+
# For more information, see [Cross region inference in Amazon Q
|
3713
|
+
# Business][1].
|
3512
3714
|
#
|
3513
3715
|
# </note>
|
3514
3716
|
#
|
3717
|
+
# <note markdown="1"> An Amazon Q Apps service-linked role will be created if it's absent
|
3718
|
+
# in the Amazon Web Services account when `QAppsConfiguration` is
|
3719
|
+
# enabled in the request. For more information, see [Using
|
3720
|
+
# service-linked roles for Q Apps][2].
|
3721
|
+
#
|
3722
|
+
# </note>
|
3515
3723
|
#
|
3516
3724
|
#
|
3517
|
-
#
|
3725
|
+
#
|
3726
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/cross-region-inference.html
|
3727
|
+
# [2]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles-qapps.html
|
3518
3728
|
#
|
3519
3729
|
# @option params [required, String] :application_id
|
3520
3730
|
# The identifier of the Amazon Q Business application.
|
@@ -3763,6 +3973,10 @@ module Aws::QBusiness
|
|
3763
3973
|
#
|
3764
3974
|
# [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html
|
3765
3975
|
#
|
3976
|
+
# @option params [Types::MediaExtractionConfiguration] :media_extraction_configuration
|
3977
|
+
# The configuration for extracting information from media in documents
|
3978
|
+
# for your data source.
|
3979
|
+
#
|
3766
3980
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3767
3981
|
#
|
3768
3982
|
# @example Request syntax with placeholder values
|
@@ -3838,6 +4052,11 @@ module Aws::QBusiness
|
|
3838
4052
|
# role_arn: "RoleArn",
|
3839
4053
|
# },
|
3840
4054
|
# },
|
4055
|
+
# media_extraction_configuration: {
|
4056
|
+
# image_extraction_configuration: {
|
4057
|
+
# image_extraction_status: "ENABLED", # required, accepts ENABLED, DISABLED
|
4058
|
+
# },
|
4059
|
+
# },
|
3841
4060
|
# })
|
3842
4061
|
#
|
3843
4062
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateDataSource AWS API Documentation
|
@@ -4155,6 +4374,22 @@ module Aws::QBusiness
|
|
4155
4374
|
# URL</i> and not a full path. For example,
|
4156
4375
|
# <code>https://docs.aws.amazon.com</code>.</p> </li> </ul> </note>
|
4157
4376
|
#
|
4377
|
+
# @option params [Types::BrowserExtensionConfiguration] :browser_extension_configuration
|
4378
|
+
# The browser extension configuration for an Amazon Q Business web
|
4379
|
+
# experience.
|
4380
|
+
#
|
4381
|
+
# <note markdown="1"> For Amazon Q Business application using external OIDC-compliant
|
4382
|
+
# identity providers (IdPs). The IdP administrator must add the browser
|
4383
|
+
# extension sign-in redirect URLs to the IdP application. For more
|
4384
|
+
# information, see [Configure external OIDC identity provider for your
|
4385
|
+
# browser extensions.][1].
|
4386
|
+
#
|
4387
|
+
# </note>
|
4388
|
+
#
|
4389
|
+
#
|
4390
|
+
#
|
4391
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/browser-extensions.html
|
4392
|
+
#
|
4158
4393
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4159
4394
|
#
|
4160
4395
|
# @example Request syntax with placeholder values
|
@@ -4185,6 +4420,9 @@ module Aws::QBusiness
|
|
4185
4420
|
# },
|
4186
4421
|
# },
|
4187
4422
|
# origins: ["Origin"],
|
4423
|
+
# browser_extension_configuration: {
|
4424
|
+
# enabled_browser_extensions: ["FIREFOX"], # required, accepts FIREFOX, CHROME
|
4425
|
+
# },
|
4188
4426
|
# })
|
4189
4427
|
#
|
4190
4428
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateWebExperience AWS API Documentation
|
@@ -4214,7 +4452,7 @@ module Aws::QBusiness
|
|
4214
4452
|
tracer: tracer
|
4215
4453
|
)
|
4216
4454
|
context[:gem_name] = 'aws-sdk-qbusiness'
|
4217
|
-
context[:gem_version] = '1.
|
4455
|
+
context[:gem_version] = '1.23.0'
|
4218
4456
|
Seahorse::Client::Request.new(handlers, context)
|
4219
4457
|
end
|
4220
4458
|
|