aws-sdk-qbusiness 1.33.0 → 1.37.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-qbusiness/async_client.rb +140 -109
- data/lib/aws-sdk-qbusiness/client.rb +153 -18
- data/lib/aws-sdk-qbusiness/client_api.rb +188 -74
- data/lib/aws-sdk-qbusiness/types.rb +351 -24
- data/lib/aws-sdk-qbusiness.rb +1 -1
- data/sig/async_client.rbs +87 -0
- data/sig/client.rbs +35 -18
- data/sig/types.rbs +83 -3
- metadata +3 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f6ca1f60c3a014b2450eccf0c8eb40043fa1951700123ad68ef9cca1c25ede35
|
4
|
+
data.tar.gz: cce6c893e069a2e628c8eafc54aab6219a3cfb2432f0bce138809ea48669101d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 57eb0ac97847576b003c82ff45bdb974396c4a977104332ea99f89eaa96157fe2e673ea3a9431a07cccfdb96a6bb7a48809eefeb029dca9a2b6ce5abf51c1c68
|
7
|
+
data.tar.gz: 2483ded6df586e5bfa99fde430325b2736a5787fbd9ecbb2a4e017624a689cd1f0ed285893ff92ea49110c70884e353ee6febd086ab4ceae57a0017272cb1be9
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.37.0 (2025-04-29)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Add support for anonymous user access for Q Business applications
|
8
|
+
|
9
|
+
1.36.0 (2025-04-28)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.35.0 (2025-04-21)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - The CheckDocumentAccess API for Amazon Q Business is a self-service debugging API that allows administrators to verify document access permissions and review Access Control List (ACL) configurations.
|
18
|
+
|
19
|
+
1.34.0 (2025-04-10)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Adds functionality to enable/disable a new Q Business Hallucination Reduction feature. If enabled, Q Business will detect and attempt to remove Hallucinations from certain Chat requests.
|
23
|
+
|
4
24
|
1.33.0 (2025-03-21)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.37.0
|
@@ -10,32 +10,44 @@
|
|
10
10
|
begin
|
11
11
|
require 'http/2'
|
12
12
|
rescue LoadError; end
|
13
|
-
require 'aws-sdk-core/plugins/credentials_configuration
|
14
|
-
require 'aws-sdk-core/plugins/logging
|
15
|
-
require 'aws-sdk-core/plugins/param_converter
|
16
|
-
require 'aws-sdk-core/plugins/param_validator
|
17
|
-
require 'aws-sdk-core/plugins/user_agent
|
18
|
-
require 'aws-sdk-core/plugins/helpful_socket_errors
|
19
|
-
require 'aws-sdk-core/plugins/retry_errors
|
20
|
-
require 'aws-sdk-core/plugins/global_configuration
|
21
|
-
require 'aws-sdk-core/plugins/regional_endpoint
|
22
|
-
require 'aws-sdk-core/plugins/stub_responses
|
23
|
-
require 'aws-sdk-core/plugins/idempotency_token
|
24
|
-
require 'aws-sdk-core/plugins/invocation_id
|
25
|
-
require 'aws-sdk-core/plugins/jsonvalue_converter
|
26
|
-
require 'aws-sdk-core/plugins/http_checksum
|
27
|
-
require 'aws-sdk-core/plugins/checksum_algorithm
|
28
|
-
require 'aws-sdk-core/plugins/request_compression
|
29
|
-
require 'aws-sdk-core/plugins/defaults_mode
|
30
|
-
require 'aws-sdk-core/plugins/recursion_detection
|
31
|
-
require 'aws-sdk-core/plugins/telemetry
|
32
|
-
require 'aws-sdk-core/plugins/sign
|
33
|
-
require 'aws-sdk-core/plugins/protocols/rest_json
|
34
|
-
require 'aws-sdk-core/plugins/event_stream_configuration
|
13
|
+
require 'aws-sdk-core/plugins/credentials_configuration'
|
14
|
+
require 'aws-sdk-core/plugins/logging'
|
15
|
+
require 'aws-sdk-core/plugins/param_converter'
|
16
|
+
require 'aws-sdk-core/plugins/param_validator'
|
17
|
+
require 'aws-sdk-core/plugins/user_agent'
|
18
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors'
|
19
|
+
require 'aws-sdk-core/plugins/retry_errors'
|
20
|
+
require 'aws-sdk-core/plugins/global_configuration'
|
21
|
+
require 'aws-sdk-core/plugins/regional_endpoint'
|
22
|
+
require 'aws-sdk-core/plugins/stub_responses'
|
23
|
+
require 'aws-sdk-core/plugins/idempotency_token'
|
24
|
+
require 'aws-sdk-core/plugins/invocation_id'
|
25
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter'
|
26
|
+
require 'aws-sdk-core/plugins/http_checksum'
|
27
|
+
require 'aws-sdk-core/plugins/checksum_algorithm'
|
28
|
+
require 'aws-sdk-core/plugins/request_compression'
|
29
|
+
require 'aws-sdk-core/plugins/defaults_mode'
|
30
|
+
require 'aws-sdk-core/plugins/recursion_detection'
|
31
|
+
require 'aws-sdk-core/plugins/telemetry'
|
32
|
+
require 'aws-sdk-core/plugins/sign'
|
33
|
+
require 'aws-sdk-core/plugins/protocols/rest_json'
|
34
|
+
require 'aws-sdk-core/plugins/event_stream_configuration'
|
35
35
|
|
36
36
|
Aws::Plugins::GlobalConfiguration.add_identifier(:qbusiness)
|
37
37
|
|
38
38
|
module Aws::QBusiness
|
39
|
+
# An API async client for QBusiness. To construct an async client, you need to configure a `:region` and `:credentials`.
|
40
|
+
#
|
41
|
+
# async_client = Aws::QBusiness::AsyncClient.new(
|
42
|
+
# region: region_name,
|
43
|
+
# credentials: credentials,
|
44
|
+
# # ...
|
45
|
+
# )
|
46
|
+
#
|
47
|
+
# For details on configuring region and credentials see
|
48
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
49
|
+
#
|
50
|
+
# See {#initialize} for a full list of supported configuration options.
|
39
51
|
class AsyncClient < Seahorse::Client::AsyncBase
|
40
52
|
|
41
53
|
include Aws::AsyncClientStubs
|
@@ -68,6 +80,13 @@ module Aws::QBusiness
|
|
68
80
|
add_plugin(Aws::Plugins::EventStreamConfiguration)
|
69
81
|
add_plugin(Aws::QBusiness::Plugins::Endpoints)
|
70
82
|
|
83
|
+
# @overload initialize(options)
|
84
|
+
# @param [Hash] options
|
85
|
+
#
|
86
|
+
# @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
|
87
|
+
# A list of plugins to apply to the client. Each plugin is either a
|
88
|
+
# class name or an instance of a plugin class.
|
89
|
+
#
|
71
90
|
# @option options [required, Aws::CredentialProvider] :credentials
|
72
91
|
# Your AWS credentials. This can be an instance of any one of the
|
73
92
|
# following classes:
|
@@ -415,96 +434,107 @@ module Aws::QBusiness
|
|
415
434
|
# * {Types::ChatOutput#output_stream #output_stream} => Types::ChatOutputStream
|
416
435
|
#
|
417
436
|
# @example Bi-directional EventStream Operation Example
|
418
|
-
#
|
419
|
-
#
|
420
|
-
#
|
421
|
-
#
|
422
|
-
#
|
423
|
-
#
|
424
|
-
#
|
425
|
-
#
|
426
|
-
#
|
427
|
-
#
|
428
|
-
#
|
429
|
-
#
|
430
|
-
#
|
431
|
-
#
|
432
|
-
#
|
433
|
-
# out_stream.on_text_event_event do |event|
|
434
|
-
# event # => Aws::QBusiness::Types::textEvent
|
435
|
-
# end
|
436
|
-
# out_stream.on_metadata_event_event do |event|
|
437
|
-
# event # => Aws::QBusiness::Types::metadataEvent
|
438
|
-
# end
|
439
|
-
# out_stream.on_action_review_event_event do |event|
|
440
|
-
# event # => Aws::QBusiness::Types::actionReviewEvent
|
441
|
-
# end
|
442
|
-
# out_stream.on_failed_attachment_event_event do |event|
|
443
|
-
# event # => Aws::QBusiness::Types::failedAttachmentEvent
|
444
|
-
# end
|
445
|
-
# out_stream.on_auth_challenge_request_event_event do |event|
|
446
|
-
# event # => Aws::QBusiness::Types::authChallengeRequestEvent
|
447
|
-
# end
|
448
|
-
#
|
449
|
-
# end
|
450
|
-
# # => Aws::Seahorse::Client::AsyncResponse
|
451
|
-
#
|
452
|
-
# # signal events
|
453
|
-
# input_stream.signal_configuration_event_event( ... )
|
454
|
-
# input_stream.signal_text_event_event( ... )
|
455
|
-
# input_stream.signal_attachment_event_event( ... )
|
456
|
-
# input_stream.signal_action_execution_event_event( ... )
|
457
|
-
# input_stream.signal_end_of_input_event_event( ... )
|
458
|
-
# input_stream.signal_auth_challenge_response_event_event( ... )
|
459
|
-
#
|
460
|
-
# # make sure to signal :end_stream at the end
|
461
|
-
# input_stream.signal_end_stream
|
462
|
-
#
|
463
|
-
# # wait until stream is closed before finalizing the sync response
|
464
|
-
# resp = async_resp.wait
|
465
|
-
# # Or close the stream and finalize sync response immediately
|
466
|
-
# # resp = async_resp.join!
|
467
|
-
#
|
468
|
-
# You can also provide an Aws::QBusiness::EventStreams::ChatOutputStream object to register callbacks
|
469
|
-
# before initializing the request instead of processing from the request block.
|
470
|
-
#
|
471
|
-
# output_stream = Aws::QBusiness::EventStreams::ChatOutputStream.new
|
472
|
-
# # register callbacks for output events
|
473
|
-
# output_stream.on_text_event_event do |event|
|
437
|
+
# # You can signal input events after the initial request is established. Events
|
438
|
+
# # will be sent to the stream immediately once the stream connection is
|
439
|
+
# # established successfully.
|
440
|
+
#
|
441
|
+
# # To signal events, you can call the #signal methods from an
|
442
|
+
# # Aws::QBusiness::EventStreams::ChatInputStream object.
|
443
|
+
# # You must signal events before calling #wait or #join! on the async response.
|
444
|
+
# input_stream = Aws::QBusiness::EventStreams::ChatInputStream.new
|
445
|
+
#
|
446
|
+
# async_resp = client.chat(
|
447
|
+
# # params input
|
448
|
+
# input_event_stream_handler: input_stream
|
449
|
+
# ) do |out_stream|
|
450
|
+
# # register callbacks for events
|
451
|
+
# out_stream.on_text_event_event do |event|
|
474
452
|
# event # => Aws::QBusiness::Types::textEvent
|
475
453
|
# end
|
476
|
-
#
|
454
|
+
# out_stream.on_metadata_event_event do |event|
|
477
455
|
# event # => Aws::QBusiness::Types::metadataEvent
|
478
456
|
# end
|
479
|
-
#
|
457
|
+
# out_stream.on_action_review_event_event do |event|
|
480
458
|
# event # => Aws::QBusiness::Types::actionReviewEvent
|
481
459
|
# end
|
482
|
-
#
|
460
|
+
# out_stream.on_failed_attachment_event_event do |event|
|
483
461
|
# event # => Aws::QBusiness::Types::failedAttachmentEvent
|
484
462
|
# end
|
485
|
-
#
|
463
|
+
# out_stream.on_auth_challenge_request_event_event do |event|
|
486
464
|
# event # => Aws::QBusiness::Types::authChallengeRequestEvent
|
487
465
|
# end
|
488
|
-
#
|
489
|
-
#
|
490
|
-
#
|
491
|
-
#
|
492
|
-
#
|
493
|
-
#
|
494
|
-
#
|
495
|
-
#
|
496
|
-
#
|
497
|
-
#
|
498
|
-
#
|
499
|
-
#
|
500
|
-
#
|
501
|
-
#
|
502
|
-
#
|
503
|
-
#
|
504
|
-
#
|
505
|
-
#
|
506
|
-
#
|
507
|
-
#
|
466
|
+
# end
|
467
|
+
# # => Aws::Seahorse::Client::AsyncResponse
|
468
|
+
#
|
469
|
+
# # signal events
|
470
|
+
# input_stream.signal_configuration_event_event(
|
471
|
+
# # ...
|
472
|
+
# )
|
473
|
+
# input_stream.signal_text_event_event(
|
474
|
+
# # ...
|
475
|
+
# )
|
476
|
+
# input_stream.signal_attachment_event_event(
|
477
|
+
# # ...
|
478
|
+
# )
|
479
|
+
# input_stream.signal_action_execution_event_event(
|
480
|
+
# # ...
|
481
|
+
# )
|
482
|
+
# input_stream.signal_end_of_input_event_event(
|
483
|
+
# # ...
|
484
|
+
# )
|
485
|
+
# input_stream.signal_auth_challenge_response_event_event(
|
486
|
+
# # ...
|
487
|
+
# )
|
488
|
+
#
|
489
|
+
# # make sure to signal :end_stream at the end
|
490
|
+
# input_stream.signal_end_stream
|
491
|
+
#
|
492
|
+
# # wait until stream is closed before finalizing the sync response
|
493
|
+
# resp = async_resp.wait
|
494
|
+
#
|
495
|
+
# # Or close the stream and finalize sync response immediately
|
496
|
+
# resp = async_resp.join!
|
497
|
+
#
|
498
|
+
# # You can also provide an Aws::QBusiness::EventStreams::ChatOutputStream object
|
499
|
+
# # to register callbacks before initializing the request instead of processing
|
500
|
+
# # from the request block.
|
501
|
+
# output_stream = Aws::QBusiness::EventStreams::ChatOutputStream.new
|
502
|
+
#
|
503
|
+
# # register callbacks for output events
|
504
|
+
# output_stream.on_text_event_event do |event|
|
505
|
+
# event # => Aws::QBusiness::Types::textEvent
|
506
|
+
# end
|
507
|
+
# output_stream.on_metadata_event_event do |event|
|
508
|
+
# event # => Aws::QBusiness::Types::metadataEvent
|
509
|
+
# end
|
510
|
+
# output_stream.on_action_review_event_event do |event|
|
511
|
+
# event # => Aws::QBusiness::Types::actionReviewEvent
|
512
|
+
# end
|
513
|
+
# output_stream.on_failed_attachment_event_event do |event|
|
514
|
+
# event # => Aws::QBusiness::Types::failedAttachmentEvent
|
515
|
+
# end
|
516
|
+
# output_stream.on_auth_challenge_request_event_event do |event|
|
517
|
+
# event # => Aws::QBusiness::Types::authChallengeRequestEvent
|
518
|
+
# end
|
519
|
+
# output_stream.on_error_event do |event|
|
520
|
+
# # catch unmodeled error event in the stream
|
521
|
+
# raise event
|
522
|
+
# # => Aws::Errors::EventError
|
523
|
+
# # event.event_type => :error
|
524
|
+
# # event.error_code => String
|
525
|
+
# # event.error_message => String
|
526
|
+
# end
|
527
|
+
#
|
528
|
+
# async_resp = client.chat(
|
529
|
+
# # params input
|
530
|
+
# input_event_stream_handler: input_stream,
|
531
|
+
# output_event_stream_handler: output_stream
|
532
|
+
# )
|
533
|
+
# resp = async_resp.join!
|
534
|
+
#
|
535
|
+
# # You can also iterate through events after the response is complete.
|
536
|
+
# # Events are available at
|
537
|
+
# resp.output_stream # => Enumerator
|
508
538
|
#
|
509
539
|
# @example Request syntax with placeholder values
|
510
540
|
#
|
@@ -524,17 +554,18 @@ module Aws::QBusiness
|
|
524
554
|
#
|
525
555
|
# @example Response structure
|
526
556
|
#
|
527
|
-
# All events are available at resp.output_stream:
|
557
|
+
# # All events are available at resp.output_stream:
|
528
558
|
# resp.output_stream #=> Enumerator
|
529
559
|
# resp.output_stream.event_types #=> [:text_event, :metadata_event, :action_review_event, :failed_attachment_event, :auth_challenge_request_event]
|
530
560
|
#
|
531
|
-
# For :text_event event available at #on_text_event_event callback and response eventstream enumerator:
|
561
|
+
# # For :text_event event available at #on_text_event_event callback and response eventstream enumerator:
|
562
|
+
# event.system_message_type #=> String, one of "RESPONSE", "GROUNDED_RESPONSE"
|
532
563
|
# event.conversation_id #=> String
|
533
564
|
# event.user_message_id #=> String
|
534
565
|
# event.system_message_id #=> String
|
535
566
|
# event.system_message #=> String
|
536
567
|
#
|
537
|
-
# For :metadata_event event available at #on_metadata_event_event callback and response eventstream enumerator:
|
568
|
+
# # For :metadata_event event available at #on_metadata_event_event callback and response eventstream enumerator:
|
538
569
|
# event.conversation_id #=> String
|
539
570
|
# event.user_message_id #=> String
|
540
571
|
# event.system_message_id #=> String
|
@@ -564,7 +595,7 @@ module Aws::QBusiness
|
|
564
595
|
# event.source_attributions[0].text_message_segments[0].source_details.video_source_details.video_extraction_type #=> String, one of "TRANSCRIPT", "SUMMARY"
|
565
596
|
# event.final_text_message #=> String
|
566
597
|
#
|
567
|
-
# For :action_review_event event available at #on_action_review_event_event callback and response eventstream enumerator:
|
598
|
+
# # For :action_review_event event available at #on_action_review_event_event callback and response eventstream enumerator:
|
568
599
|
# event.conversation_id #=> String
|
569
600
|
# event.user_message_id #=> String
|
570
601
|
# event.system_message_id #=> String
|
@@ -580,7 +611,7 @@ module Aws::QBusiness
|
|
580
611
|
# event.payload["ActionPayloadFieldKey"].required #=> Boolean
|
581
612
|
# event.payload_field_name_separator #=> String
|
582
613
|
#
|
583
|
-
# For :failed_attachment_event event available at #on_failed_attachment_event_event callback and response eventstream enumerator:
|
614
|
+
# # For :failed_attachment_event event available at #on_failed_attachment_event_event callback and response eventstream enumerator:
|
584
615
|
# event.conversation_id #=> String
|
585
616
|
# event.user_message_id #=> String
|
586
617
|
# event.system_message_id #=> String
|
@@ -591,7 +622,7 @@ module Aws::QBusiness
|
|
591
622
|
# event.attachment.attachment_id #=> String
|
592
623
|
# event.attachment.conversation_id #=> String
|
593
624
|
#
|
594
|
-
# For :auth_challenge_request_event event available at #on_auth_challenge_request_event_event callback and response eventstream enumerator:
|
625
|
+
# # For :auth_challenge_request_event event available at #on_auth_challenge_request_event_event callback and response eventstream enumerator:
|
595
626
|
# event.authorization_url #=> String
|
596
627
|
#
|
597
628
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/Chat AWS API Documentation
|
@@ -642,7 +673,7 @@ module Aws::QBusiness
|
|
642
673
|
tracer: tracer
|
643
674
|
)
|
644
675
|
context[:gem_name] = 'aws-sdk-qbusiness'
|
645
|
-
context[:gem_version] = '1.
|
676
|
+
context[:gem_version] = '1.37.0'
|
646
677
|
Seahorse::Client::Request.new(handlers, context)
|
647
678
|
end
|
648
679
|
|
@@ -1072,6 +1072,128 @@ module Aws::QBusiness
|
|
1072
1072
|
req.send_request(options)
|
1073
1073
|
end
|
1074
1074
|
|
1075
|
+
# Verifies if a user has access permissions for a specified document and
|
1076
|
+
# returns the actual ACL attached to the document. Resolves user access
|
1077
|
+
# on the document via user aliases and groups when verifying user
|
1078
|
+
# access.
|
1079
|
+
#
|
1080
|
+
# @option params [required, String] :application_id
|
1081
|
+
# The unique identifier of the application. This is required to identify
|
1082
|
+
# the specific Amazon Q Business application context for the document
|
1083
|
+
# access check.
|
1084
|
+
#
|
1085
|
+
# @option params [required, String] :index_id
|
1086
|
+
# The unique identifier of the index. Used to locate the correct index
|
1087
|
+
# within the application where the document is stored.
|
1088
|
+
#
|
1089
|
+
# @option params [required, String] :user_id
|
1090
|
+
# The unique identifier of the user. Used to check the access
|
1091
|
+
# permissions for this specific user against the document's ACL.
|
1092
|
+
#
|
1093
|
+
# @option params [required, String] :document_id
|
1094
|
+
# The unique identifier of the document. Specifies which document's
|
1095
|
+
# access permissions are being checked.
|
1096
|
+
#
|
1097
|
+
# @option params [String] :data_source_id
|
1098
|
+
# The unique identifier of the data source. Identifies the specific data
|
1099
|
+
# source from which the document originates. Should not be used when a
|
1100
|
+
# document is uploaded directly with BatchPutDocument, as no
|
1101
|
+
# dataSourceId is available or necessary.
|
1102
|
+
#
|
1103
|
+
# @return [Types::CheckDocumentAccessResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1104
|
+
#
|
1105
|
+
# * {Types::CheckDocumentAccessResponse#user_groups #user_groups} => Array<Types::AssociatedGroup>
|
1106
|
+
# * {Types::CheckDocumentAccessResponse#user_aliases #user_aliases} => Array<Types::AssociatedUser>
|
1107
|
+
# * {Types::CheckDocumentAccessResponse#has_access #has_access} => Boolean
|
1108
|
+
# * {Types::CheckDocumentAccessResponse#document_acl #document_acl} => Types::DocumentAcl
|
1109
|
+
#
|
1110
|
+
# @example Request syntax with placeholder values
|
1111
|
+
#
|
1112
|
+
# resp = client.check_document_access({
|
1113
|
+
# application_id: "ApplicationId", # required
|
1114
|
+
# index_id: "IndexId", # required
|
1115
|
+
# user_id: "String", # required
|
1116
|
+
# document_id: "DocumentId", # required
|
1117
|
+
# data_source_id: "DataSourceId",
|
1118
|
+
# })
|
1119
|
+
#
|
1120
|
+
# @example Response structure
|
1121
|
+
#
|
1122
|
+
# resp.user_groups #=> Array
|
1123
|
+
# resp.user_groups[0].name #=> String
|
1124
|
+
# resp.user_groups[0].type #=> String, one of "INDEX", "DATASOURCE"
|
1125
|
+
# resp.user_aliases #=> Array
|
1126
|
+
# resp.user_aliases[0].id #=> String
|
1127
|
+
# resp.user_aliases[0].type #=> String, one of "INDEX", "DATASOURCE"
|
1128
|
+
# resp.has_access #=> Boolean
|
1129
|
+
# resp.document_acl.allowlist.member_relation #=> String, one of "AND", "OR"
|
1130
|
+
# resp.document_acl.allowlist.conditions #=> Array
|
1131
|
+
# resp.document_acl.allowlist.conditions[0].member_relation #=> String, one of "AND", "OR"
|
1132
|
+
# resp.document_acl.allowlist.conditions[0].users #=> Array
|
1133
|
+
# resp.document_acl.allowlist.conditions[0].users[0].id #=> String
|
1134
|
+
# resp.document_acl.allowlist.conditions[0].users[0].type #=> String, one of "INDEX", "DATASOURCE"
|
1135
|
+
# resp.document_acl.allowlist.conditions[0].groups #=> Array
|
1136
|
+
# resp.document_acl.allowlist.conditions[0].groups[0].name #=> String
|
1137
|
+
# resp.document_acl.allowlist.conditions[0].groups[0].type #=> String, one of "INDEX", "DATASOURCE"
|
1138
|
+
# resp.document_acl.deny_list.member_relation #=> String, one of "AND", "OR"
|
1139
|
+
# resp.document_acl.deny_list.conditions #=> Array
|
1140
|
+
# resp.document_acl.deny_list.conditions[0].member_relation #=> String, one of "AND", "OR"
|
1141
|
+
# resp.document_acl.deny_list.conditions[0].users #=> Array
|
1142
|
+
# resp.document_acl.deny_list.conditions[0].users[0].id #=> String
|
1143
|
+
# resp.document_acl.deny_list.conditions[0].users[0].type #=> String, one of "INDEX", "DATASOURCE"
|
1144
|
+
# resp.document_acl.deny_list.conditions[0].groups #=> Array
|
1145
|
+
# resp.document_acl.deny_list.conditions[0].groups[0].name #=> String
|
1146
|
+
# resp.document_acl.deny_list.conditions[0].groups[0].type #=> String, one of "INDEX", "DATASOURCE"
|
1147
|
+
#
|
1148
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CheckDocumentAccess AWS API Documentation
|
1149
|
+
#
|
1150
|
+
# @overload check_document_access(params = {})
|
1151
|
+
# @param [Hash] params ({})
|
1152
|
+
def check_document_access(params = {}, options = {})
|
1153
|
+
req = build_request(:check_document_access, params)
|
1154
|
+
req.send_request(options)
|
1155
|
+
end
|
1156
|
+
|
1157
|
+
# Creates a unique URL for anonymous Amazon Q Business web experience.
|
1158
|
+
# This URL can only be used once and must be used within 5 minutes after
|
1159
|
+
# it's generated.
|
1160
|
+
#
|
1161
|
+
# @option params [required, String] :application_id
|
1162
|
+
# The identifier of the Amazon Q Business application environment
|
1163
|
+
# attached to the web experience.
|
1164
|
+
#
|
1165
|
+
# @option params [required, String] :web_experience_id
|
1166
|
+
# The identifier of the web experience.
|
1167
|
+
#
|
1168
|
+
# @option params [Integer] :session_duration_in_minutes
|
1169
|
+
# The duration of the session associated with the unique URL for the web
|
1170
|
+
# experience.
|
1171
|
+
#
|
1172
|
+
# @return [Types::CreateAnonymousWebExperienceUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1173
|
+
#
|
1174
|
+
# * {Types::CreateAnonymousWebExperienceUrlResponse#anonymous_url #anonymous_url} => String
|
1175
|
+
#
|
1176
|
+
# @example Request syntax with placeholder values
|
1177
|
+
#
|
1178
|
+
# resp = client.create_anonymous_web_experience_url({
|
1179
|
+
# application_id: "ApplicationId", # required
|
1180
|
+
# web_experience_id: "WebExperienceId", # required
|
1181
|
+
# session_duration_in_minutes: 1,
|
1182
|
+
# })
|
1183
|
+
#
|
1184
|
+
# @example Response structure
|
1185
|
+
#
|
1186
|
+
# resp.anonymous_url #=> String
|
1187
|
+
#
|
1188
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateAnonymousWebExperienceUrl AWS API Documentation
|
1189
|
+
#
|
1190
|
+
# @overload create_anonymous_web_experience_url(params = {})
|
1191
|
+
# @param [Hash] params ({})
|
1192
|
+
def create_anonymous_web_experience_url(params = {}, options = {})
|
1193
|
+
req = build_request(:create_anonymous_web_experience_url, params)
|
1194
|
+
req.send_request(options)
|
1195
|
+
end
|
1196
|
+
|
1075
1197
|
# Creates an Amazon Q Business application.
|
1076
1198
|
#
|
1077
1199
|
# <note markdown="1"> There are new tiers for Amazon Q Business. Not all features in Amazon
|
@@ -1184,7 +1306,7 @@ module Aws::QBusiness
|
|
1184
1306
|
# resp = client.create_application({
|
1185
1307
|
# display_name: "ApplicationName", # required
|
1186
1308
|
# role_arn: "RoleArn",
|
1187
|
-
# identity_type: "AWS_IAM_IDP_SAML", # accepts AWS_IAM_IDP_SAML, AWS_IAM_IDP_OIDC, AWS_IAM_IDC, AWS_QUICKSIGHT_IDP
|
1309
|
+
# identity_type: "AWS_IAM_IDP_SAML", # accepts AWS_IAM_IDP_SAML, AWS_IAM_IDP_OIDC, AWS_IAM_IDC, AWS_QUICKSIGHT_IDP, ANONYMOUS
|
1188
1310
|
# iam_identity_provider_arn: "IAMIdentityProviderArn",
|
1189
1311
|
# identity_center_instance_arn: "InstanceArn",
|
1190
1312
|
# client_ids_for_oidc: ["ClientIdForOIDC"],
|
@@ -2017,12 +2139,14 @@ module Aws::QBusiness
|
|
2017
2139
|
#
|
2018
2140
|
# @option params [Array<String>] :origins
|
2019
2141
|
# Sets the website domain origins that are allowed to embed the Amazon Q
|
2020
|
-
# Business web experience.
|
2021
|
-
#
|
2022
|
-
#
|
2023
|
-
#
|
2024
|
-
# not a full path. For example,
|
2025
|
-
#
|
2142
|
+
# Business web experience. The *domain origin* refers to the base URL
|
2143
|
+
# for accessing a website including the protocol (`http/https`), the
|
2144
|
+
# domain name, and the port number (if specified).
|
2145
|
+
#
|
2146
|
+
# <note markdown="1"> You must only submit a *base URL* and not a full path. For example,
|
2147
|
+
# `https://docs.aws.amazon.com`.
|
2148
|
+
#
|
2149
|
+
# </note>
|
2026
2150
|
#
|
2027
2151
|
# @option params [String] :role_arn
|
2028
2152
|
# The Amazon Resource Name (ARN) of the service role attached to your
|
@@ -2561,7 +2685,7 @@ module Aws::QBusiness
|
|
2561
2685
|
# resp.display_name #=> String
|
2562
2686
|
# resp.application_id #=> String
|
2563
2687
|
# resp.application_arn #=> String
|
2564
|
-
# resp.identity_type #=> String, one of "AWS_IAM_IDP_SAML", "AWS_IAM_IDP_OIDC", "AWS_IAM_IDC", "AWS_QUICKSIGHT_IDP"
|
2688
|
+
# resp.identity_type #=> String, one of "AWS_IAM_IDP_SAML", "AWS_IAM_IDP_OIDC", "AWS_IAM_IDC", "AWS_QUICKSIGHT_IDP", "ANONYMOUS"
|
2565
2689
|
# resp.iam_identity_provider_arn #=> String
|
2566
2690
|
# resp.identity_center_application_arn #=> String
|
2567
2691
|
# resp.role_arn #=> String
|
@@ -2614,6 +2738,7 @@ module Aws::QBusiness
|
|
2614
2738
|
# * {Types::GetChatControlsConfigurationResponse#topic_configurations #topic_configurations} => Array<Types::TopicConfiguration>
|
2615
2739
|
# * {Types::GetChatControlsConfigurationResponse#creator_mode_configuration #creator_mode_configuration} => Types::AppliedCreatorModeConfiguration
|
2616
2740
|
# * {Types::GetChatControlsConfigurationResponse#next_token #next_token} => String
|
2741
|
+
# * {Types::GetChatControlsConfigurationResponse#hallucination_reduction_configuration #hallucination_reduction_configuration} => Types::HallucinationReductionConfiguration
|
2617
2742
|
#
|
2618
2743
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2619
2744
|
#
|
@@ -2653,6 +2778,7 @@ module Aws::QBusiness
|
|
2653
2778
|
# resp.topic_configurations[0].rules[0].rule_configuration.content_retrieval_rule.eligible_data_sources[0].data_source_id #=> String
|
2654
2779
|
# resp.creator_mode_configuration.creator_mode_control #=> String, one of "ENABLED", "DISABLED"
|
2655
2780
|
# resp.next_token #=> String
|
2781
|
+
# resp.hallucination_reduction_configuration.hallucination_reduction_control #=> String, one of "ENABLED", "DISABLED"
|
2656
2782
|
#
|
2657
2783
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetChatControlsConfiguration AWS API Documentation
|
2658
2784
|
#
|
@@ -3357,7 +3483,7 @@ module Aws::QBusiness
|
|
3357
3483
|
# resp.applications[0].created_at #=> Time
|
3358
3484
|
# resp.applications[0].updated_at #=> Time
|
3359
3485
|
# resp.applications[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING"
|
3360
|
-
# resp.applications[0].identity_type #=> String, one of "AWS_IAM_IDP_SAML", "AWS_IAM_IDP_OIDC", "AWS_IAM_IDC", "AWS_QUICKSIGHT_IDP"
|
3486
|
+
# resp.applications[0].identity_type #=> String, one of "AWS_IAM_IDP_SAML", "AWS_IAM_IDP_OIDC", "AWS_IAM_IDC", "AWS_QUICKSIGHT_IDP", "ANONYMOUS"
|
3361
3487
|
# resp.applications[0].quick_sight_configuration.client_namespace #=> String
|
3362
3488
|
#
|
3363
3489
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListApplications AWS API Documentation
|
@@ -4873,6 +4999,9 @@ module Aws::QBusiness
|
|
4873
4999
|
# @option params [Types::CreatorModeConfiguration] :creator_mode_configuration
|
4874
5000
|
# The configuration details for `CREATOR_MODE`.
|
4875
5001
|
#
|
5002
|
+
# @option params [Types::HallucinationReductionConfiguration] :hallucination_reduction_configuration
|
5003
|
+
# The hallucination reduction settings for your application.
|
5004
|
+
#
|
4876
5005
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4877
5006
|
#
|
4878
5007
|
# @example Request syntax with placeholder values
|
@@ -4958,6 +5087,9 @@ module Aws::QBusiness
|
|
4958
5087
|
# creator_mode_configuration: {
|
4959
5088
|
# creator_mode_control: "ENABLED", # required, accepts ENABLED, DISABLED
|
4960
5089
|
# },
|
5090
|
+
# hallucination_reduction_configuration: {
|
5091
|
+
# hallucination_reduction_control: "ENABLED", # accepts ENABLED, DISABLED
|
5092
|
+
# },
|
4961
5093
|
# })
|
4962
5094
|
#
|
4963
5095
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateChatControlsConfiguration AWS API Documentation
|
@@ -5593,14 +5725,17 @@ module Aws::QBusiness
|
|
5593
5725
|
#
|
5594
5726
|
# @option params [Array<String>] :origins
|
5595
5727
|
# Updates the website domain origins that are allowed to embed the
|
5596
|
-
# Amazon Q Business web experience.
|
5597
|
-
#
|
5598
|
-
# (
|
5599
|
-
#
|
5600
|
-
# <
|
5601
|
-
#
|
5602
|
-
#
|
5603
|
-
#
|
5728
|
+
# Amazon Q Business web experience. The *domain origin* refers to the
|
5729
|
+
# *base URL* for accessing a website including the protocol
|
5730
|
+
# (`http/https`), the domain name, and the port number (if specified).
|
5731
|
+
#
|
5732
|
+
# <note markdown="1"> * Any values except `null` submitted as part of this update will
|
5733
|
+
# replace all previous values.
|
5734
|
+
#
|
5735
|
+
# * You must only submit a *base URL* and not a full path. For example,
|
5736
|
+
# `https://docs.aws.amazon.com`.
|
5737
|
+
#
|
5738
|
+
# </note>
|
5604
5739
|
#
|
5605
5740
|
# @option params [Types::BrowserExtensionConfiguration] :browser_extension_configuration
|
5606
5741
|
# The browser extension configuration for an Amazon Q Business web
|
@@ -5690,7 +5825,7 @@ module Aws::QBusiness
|
|
5690
5825
|
tracer: tracer
|
5691
5826
|
)
|
5692
5827
|
context[:gem_name] = 'aws-sdk-qbusiness'
|
5693
|
-
context[:gem_version] = '1.
|
5828
|
+
context[:gem_version] = '1.37.0'
|
5694
5829
|
Seahorse::Client::Request.new(handlers, context)
|
5695
5830
|
end
|
5696
5831
|
|