aws-sdk-qbusiness 1.34.0 → 1.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4614a1bcb8aa0f7d7f629afdce8a88a26a477af72140f7d6c407131a9054ea00
-  data.tar.gz: '097f9ebfc553e50fe7b339172274c82309b6a1e46b1e81ec7f7fa86473892162'
+  metadata.gz: f1266de04bc0aa4b1e9c78811490a2e783484983bbccf57d444f4c8bd46509a3
+  data.tar.gz: 1d3047a4ea8808fab59d3abad23aa889437cc8e21248e20b955b95aafa20f8de
 SHA512:
-  metadata.gz: f431d09304fdf124af8e7ad89eef477337a49150817b37372d6ad864cef507fc30e86485845e159b387e57a459a852de9e8d293a0064b361cef8d84e6589607e
-  data.tar.gz: ce28b90dab2432fef0a76e3b1453c05055e1d21947b6c16968c5c125db5e94ae4dc044d9a00cad482b7512f249275ecb05de3d7d73bca6abf173022fbb019499
+  metadata.gz: f664e18f6386912821c94702c8081652c028283b8aeee4c434243e967b4d9d2c2e35a50b493f5ff7a7354f2acd96e3bde055855f604b31cfe0481c9fe7a953ba
+  data.tar.gz: 0a97d51d297a277393dc08ce746dcaa96506c38ef6b534abff0e27b44725b83826dbf883fbf5020ab01431175f83fab6dcc49f04c21448d5bef299f33a7197c8

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.36.0 (2025-04-28)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.35.0 (2025-04-21)
+------------------
+
+* 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.
+
 1.34.0 (2025-04-10)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.34.0
+1.36.0

data/lib/aws-sdk-qbusiness/async_client.rb

@@ -10,32 +10,44 @@
 begin
   require 'http/2'
 rescue LoadError; end
-require 'aws-sdk-core/plugins/credentials_configuration.rb'
-require 'aws-sdk-core/plugins/logging.rb'
-require 'aws-sdk-core/plugins/param_converter.rb'
-require 'aws-sdk-core/plugins/param_validator.rb'
-require 'aws-sdk-core/plugins/user_agent.rb'
-require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
-require 'aws-sdk-core/plugins/retry_errors.rb'
-require 'aws-sdk-core/plugins/global_configuration.rb'
-require 'aws-sdk-core/plugins/regional_endpoint.rb'
-require 'aws-sdk-core/plugins/stub_responses.rb'
-require 'aws-sdk-core/plugins/idempotency_token.rb'
-require 'aws-sdk-core/plugins/invocation_id.rb'
-require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
-require 'aws-sdk-core/plugins/http_checksum.rb'
-require 'aws-sdk-core/plugins/checksum_algorithm.rb'
-require 'aws-sdk-core/plugins/request_compression.rb'
-require 'aws-sdk-core/plugins/defaults_mode.rb'
-require 'aws-sdk-core/plugins/recursion_detection.rb'
-require 'aws-sdk-core/plugins/telemetry.rb'
-require 'aws-sdk-core/plugins/sign.rb'
-require 'aws-sdk-core/plugins/protocols/rest_json.rb'
-require 'aws-sdk-core/plugins/event_stream_configuration.rb'
+require 'aws-sdk-core/plugins/credentials_configuration'
+require 'aws-sdk-core/plugins/logging'
+require 'aws-sdk-core/plugins/param_converter'
+require 'aws-sdk-core/plugins/param_validator'
+require 'aws-sdk-core/plugins/user_agent'
+require 'aws-sdk-core/plugins/helpful_socket_errors'
+require 'aws-sdk-core/plugins/retry_errors'
+require 'aws-sdk-core/plugins/global_configuration'
+require 'aws-sdk-core/plugins/regional_endpoint'
+require 'aws-sdk-core/plugins/stub_responses'
+require 'aws-sdk-core/plugins/idempotency_token'
+require 'aws-sdk-core/plugins/invocation_id'
+require 'aws-sdk-core/plugins/jsonvalue_converter'
+require 'aws-sdk-core/plugins/http_checksum'
+require 'aws-sdk-core/plugins/checksum_algorithm'
+require 'aws-sdk-core/plugins/request_compression'
+require 'aws-sdk-core/plugins/defaults_mode'
+require 'aws-sdk-core/plugins/recursion_detection'
+require 'aws-sdk-core/plugins/telemetry'
+require 'aws-sdk-core/plugins/sign'
+require 'aws-sdk-core/plugins/protocols/rest_json'
+require 'aws-sdk-core/plugins/event_stream_configuration'
 
 Aws::Plugins::GlobalConfiguration.add_identifier(:qbusiness)
 
 module Aws::QBusiness
+  # An API async client for QBusiness.  To construct an async client, you need to configure a `:region` and `:credentials`.
+  #
+  #     async_client = Aws::QBusiness::AsyncClient.new(
+  #       region: region_name,
+  #       credentials: credentials,
+  #       # ...
+  #     )
+  #
+  # For details on configuring region and credentials see
+  # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
+  #
+  # See {#initialize} for a full list of supported configuration options.
   class AsyncClient < Seahorse::Client::AsyncBase
 
     include Aws::AsyncClientStubs
@@ -68,6 +80,13 @@ module Aws::QBusiness
     add_plugin(Aws::Plugins::EventStreamConfiguration)
     add_plugin(Aws::QBusiness::Plugins::Endpoints)
 
+    # @overload initialize(options)
+    #   @param [Hash] options
+    #
+    #   @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
+    #     A list of plugins to apply to the client. Each plugin is either a
+    #     class name or an instance of a plugin class.
+    #
     #   @option options [required, Aws::CredentialProvider] :credentials
     #     Your AWS credentials. This can be an instance of any one of the
     #     following classes:
@@ -415,96 +434,107 @@ module Aws::QBusiness
     #   * {Types::ChatOutput#output_stream #output_stream} => Types::ChatOutputStream
     #
     # @example Bi-directional EventStream Operation Example
-    #
-    #   You can signal input events after the initial request is established. Events
-    #   will be sent to the stream immediately once the stream connection is
-    #   established successfully.
-    #
-    #   To signal events, you can call the #signal methods from an Aws::QBusiness::EventStreams::ChatInputStream
-    #   object. You must signal events before calling #wait or #join! on the async response.
-    #
-    #     input_stream = Aws::QBusiness::EventStreams::ChatInputStream.new
-    #
-    #     async_resp = client.chat(
-    #       # params input
-    #       input_event_stream_handler: input_stream) do |out_stream|
-    #
-    #       # register callbacks for events
-    #       out_stream.on_text_event_event do |event|
-    #         event # => Aws::QBusiness::Types::textEvent
-    #       end
-    #       out_stream.on_metadata_event_event do |event|
-    #         event # => Aws::QBusiness::Types::metadataEvent
-    #       end
-    #       out_stream.on_action_review_event_event do |event|
-    #         event # => Aws::QBusiness::Types::actionReviewEvent
-    #       end
-    #       out_stream.on_failed_attachment_event_event do |event|
-    #         event # => Aws::QBusiness::Types::failedAttachmentEvent
-    #       end
-    #       out_stream.on_auth_challenge_request_event_event do |event|
-    #         event # => Aws::QBusiness::Types::authChallengeRequestEvent
-    #       end
-    #
-    #     end
-    #     # => Aws::Seahorse::Client::AsyncResponse
-    #
-    #     # signal events
-    #     input_stream.signal_configuration_event_event( ... )
-    #     input_stream.signal_text_event_event( ... )
-    #     input_stream.signal_attachment_event_event( ... )
-    #     input_stream.signal_action_execution_event_event( ... )
-    #     input_stream.signal_end_of_input_event_event( ... )
-    #     input_stream.signal_auth_challenge_response_event_event( ... )
-    #
-    #     # make sure to signal :end_stream at the end
-    #     input_stream.signal_end_stream
-    #
-    #     # wait until stream is closed before finalizing the sync response
-    #     resp = async_resp.wait
-    #     # Or close the stream and finalize sync response immediately
-    #     # resp = async_resp.join!
-    #
-    #   You can also provide an Aws::QBusiness::EventStreams::ChatOutputStream object to register callbacks
-    #   before initializing the request instead of processing from the request block.
-    #
-    #     output_stream = Aws::QBusiness::EventStreams::ChatOutputStream.new
-    #     # register callbacks for output events
-    #     output_stream.on_text_event_event do |event|
+    #   # You can signal input events after the initial request is established. Events
+    #   # will be sent to the stream immediately once the stream connection is
+    #   # established successfully.
+    #
+    #   # To signal events, you can call the #signal methods from an
+    #   # Aws::QBusiness::EventStreams::ChatInputStream object.
+    #   # You must signal events before calling #wait or #join! on the async response.
+    #   input_stream = Aws::QBusiness::EventStreams::ChatInputStream.new
+    #
+    #   async_resp = client.chat(
+    #     # params input
+    #     input_event_stream_handler: input_stream
+    #   ) do |out_stream|
+    #     # register callbacks for events
+    #     out_stream.on_text_event_event do |event|
     #       event # => Aws::QBusiness::Types::textEvent
     #     end
-    #     output_stream.on_metadata_event_event do |event|
+    #     out_stream.on_metadata_event_event do |event|
     #       event # => Aws::QBusiness::Types::metadataEvent
     #     end
-    #     output_stream.on_action_review_event_event do |event|
+    #     out_stream.on_action_review_event_event do |event|
     #       event # => Aws::QBusiness::Types::actionReviewEvent
     #     end
-    #     output_stream.on_failed_attachment_event_event do |event|
+    #     out_stream.on_failed_attachment_event_event do |event|
     #       event # => Aws::QBusiness::Types::failedAttachmentEvent
     #     end
-    #     output_stream.on_auth_challenge_request_event_event do |event|
+    #     out_stream.on_auth_challenge_request_event_event do |event|
     #       event # => Aws::QBusiness::Types::authChallengeRequestEvent
     #     end
-    #     output_stream.on_error_event do |event|
-    #       # catch unmodeled error event in the stream
-    #       raise event
-    #       # => Aws::Errors::EventError
-    #       # event.event_type => :error
-    #       # event.error_code => String
-    #       # event.error_message => String
-    #     end
-    #
-    #     async_resp = client.chat (
-    #       # params input
-    #       input_event_stream_handler: input_stream
-    #       output_event_stream_handler: output_stream
-    #     )
-    #
-    #     resp = async_resp.join!
-    #
-    #   You can also iterate through events after the response is complete.
-    #
-    #   Events are available at resp.output_stream # => Enumerator
+    #   end
+    #   # => Aws::Seahorse::Client::AsyncResponse
+    #
+    #   # signal events
+    #   input_stream.signal_configuration_event_event(
+    #     # ...
+    #   )
+    #   input_stream.signal_text_event_event(
+    #     # ...
+    #   )
+    #   input_stream.signal_attachment_event_event(
+    #     # ...
+    #   )
+    #   input_stream.signal_action_execution_event_event(
+    #     # ...
+    #   )
+    #   input_stream.signal_end_of_input_event_event(
+    #     # ...
+    #   )
+    #   input_stream.signal_auth_challenge_response_event_event(
+    #     # ...
+    #   )
+    #
+    #   # make sure to signal :end_stream at the end
+    #   input_stream.signal_end_stream
+    #
+    #   # wait until stream is closed before finalizing the sync response
+    #   resp = async_resp.wait
+    #
+    #   # Or close the stream and finalize sync response immediately
+    #   resp = async_resp.join!
+    #
+    #   # You can also provide an Aws::QBusiness::EventStreams::ChatOutputStream object
+    #   # to register callbacks before initializing the request instead of processing
+    #   # from the request block.
+    #   output_stream = Aws::QBusiness::EventStreams::ChatOutputStream.new
+    #
+    #   # register callbacks for output events
+    #   output_stream.on_text_event_event do |event|
+    #     event # => Aws::QBusiness::Types::textEvent
+    #   end
+    #   output_stream.on_metadata_event_event do |event|
+    #     event # => Aws::QBusiness::Types::metadataEvent
+    #   end
+    #   output_stream.on_action_review_event_event do |event|
+    #     event # => Aws::QBusiness::Types::actionReviewEvent
+    #   end
+    #   output_stream.on_failed_attachment_event_event do |event|
+    #     event # => Aws::QBusiness::Types::failedAttachmentEvent
+    #   end
+    #   output_stream.on_auth_challenge_request_event_event do |event|
+    #     event # => Aws::QBusiness::Types::authChallengeRequestEvent
+    #   end
+    #   output_stream.on_error_event do |event|
+    #     # catch unmodeled error event in the stream
+    #     raise event
+    #     # => Aws::Errors::EventError
+    #     # event.event_type => :error
+    #     # event.error_code => String
+    #     # event.error_message => String
+    #   end
+    #
+    #   async_resp = client.chat(
+    #     # params input
+    #     input_event_stream_handler: input_stream,
+    #     output_event_stream_handler: output_stream
+    #   )
+    #   resp = async_resp.join!
+    #
+    #   # You can also iterate through events after the response is complete.
+    #   # Events are available at
+    #   resp.output_stream # => Enumerator
     #
     # @example Request syntax with placeholder values
     #
@@ -524,18 +554,18 @@ module Aws::QBusiness
     #
     # @example Response structure
     #
-    #   All events are available at resp.output_stream:
+    #   # All events are available at resp.output_stream:
     #   resp.output_stream #=> Enumerator
     #   resp.output_stream.event_types #=> [:text_event, :metadata_event, :action_review_event, :failed_attachment_event, :auth_challenge_request_event]
     #
-    #   For :text_event event available at #on_text_event_event callback and response eventstream enumerator:
+    #   # For :text_event event available at #on_text_event_event callback and response eventstream enumerator:
     #   event.system_message_type #=> String, one of "RESPONSE", "GROUNDED_RESPONSE"
     #   event.conversation_id #=> String
     #   event.user_message_id #=> String
     #   event.system_message_id #=> String
     #   event.system_message #=> String
     #
-    #   For :metadata_event event available at #on_metadata_event_event callback and response eventstream enumerator:
+    #   # For :metadata_event event available at #on_metadata_event_event callback and response eventstream enumerator:
     #   event.conversation_id #=> String
     #   event.user_message_id #=> String
     #   event.system_message_id #=> String
@@ -565,7 +595,7 @@ module Aws::QBusiness
     #   event.source_attributions[0].text_message_segments[0].source_details.video_source_details.video_extraction_type #=> String, one of "TRANSCRIPT", "SUMMARY"
     #   event.final_text_message #=> String
     #
-    #   For :action_review_event event available at #on_action_review_event_event callback and response eventstream enumerator:
+    #   # For :action_review_event event available at #on_action_review_event_event callback and response eventstream enumerator:
     #   event.conversation_id #=> String
     #   event.user_message_id #=> String
     #   event.system_message_id #=> String
@@ -581,7 +611,7 @@ module Aws::QBusiness
     #   event.payload["ActionPayloadFieldKey"].required #=> Boolean
     #   event.payload_field_name_separator #=> String
     #
-    #   For :failed_attachment_event event available at #on_failed_attachment_event_event callback and response eventstream enumerator:
+    #   # For :failed_attachment_event event available at #on_failed_attachment_event_event callback and response eventstream enumerator:
     #   event.conversation_id #=> String
     #   event.user_message_id #=> String
     #   event.system_message_id #=> String
@@ -592,7 +622,7 @@ module Aws::QBusiness
     #   event.attachment.attachment_id #=> String
     #   event.attachment.conversation_id #=> String
     #
-    #   For :auth_challenge_request_event event available at #on_auth_challenge_request_event_event callback and response eventstream enumerator:
+    #   # For :auth_challenge_request_event event available at #on_auth_challenge_request_event_event callback and response eventstream enumerator:
     #   event.authorization_url #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/Chat AWS API Documentation
@@ -643,7 +673,7 @@ module Aws::QBusiness
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-qbusiness'
-      context[:gem_version] = '1.34.0'
+      context[:gem_version] = '1.36.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-qbusiness/client.rb

@@ -1072,6 +1072,88 @@ module Aws::QBusiness
       req.send_request(options)
     end
 
+    # Verifies if a user has access permissions for a specified document and
+    # returns the actual ACL attached to the document. Resolves user access
+    # on the document via user aliases and groups when verifying user
+    # access.
+    #
+    # @option params [required, String] :application_id
+    #   The unique identifier of the application. This is required to identify
+    #   the specific Amazon Q Business application context for the document
+    #   access check.
+    #
+    # @option params [required, String] :index_id
+    #   The unique identifier of the index. Used to locate the correct index
+    #   within the application where the document is stored.
+    #
+    # @option params [required, String] :user_id
+    #   The unique identifier of the user. Used to check the access
+    #   permissions for this specific user against the document's ACL.
+    #
+    # @option params [required, String] :document_id
+    #   The unique identifier of the document. Specifies which document's
+    #   access permissions are being checked.
+    #
+    # @option params [String] :data_source_id
+    #   The unique identifier of the data source. Identifies the specific data
+    #   source from which the document originates. Should not be used when a
+    #   document is uploaded directly with BatchPutDocument, as no
+    #   dataSourceId is available or necessary.
+    #
+    # @return [Types::CheckDocumentAccessResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CheckDocumentAccessResponse#user_groups #user_groups} => Array<Types::AssociatedGroup>
+    #   * {Types::CheckDocumentAccessResponse#user_aliases #user_aliases} => Array<Types::AssociatedUser>
+    #   * {Types::CheckDocumentAccessResponse#has_access #has_access} => Boolean
+    #   * {Types::CheckDocumentAccessResponse#document_acl #document_acl} => Types::DocumentAcl
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.check_document_access({
+    #     application_id: "ApplicationId", # required
+    #     index_id: "IndexId", # required
+    #     user_id: "String", # required
+    #     document_id: "DocumentId", # required
+    #     data_source_id: "DataSourceId",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.user_groups #=> Array
+    #   resp.user_groups[0].name #=> String
+    #   resp.user_groups[0].type #=> String, one of "INDEX", "DATASOURCE"
+    #   resp.user_aliases #=> Array
+    #   resp.user_aliases[0].id #=> String
+    #   resp.user_aliases[0].type #=> String, one of "INDEX", "DATASOURCE"
+    #   resp.has_access #=> Boolean
+    #   resp.document_acl.allowlist.member_relation #=> String, one of "AND", "OR"
+    #   resp.document_acl.allowlist.conditions #=> Array
+    #   resp.document_acl.allowlist.conditions[0].member_relation #=> String, one of "AND", "OR"
+    #   resp.document_acl.allowlist.conditions[0].users #=> Array
+    #   resp.document_acl.allowlist.conditions[0].users[0].id #=> String
+    #   resp.document_acl.allowlist.conditions[0].users[0].type #=> String, one of "INDEX", "DATASOURCE"
+    #   resp.document_acl.allowlist.conditions[0].groups #=> Array
+    #   resp.document_acl.allowlist.conditions[0].groups[0].name #=> String
+    #   resp.document_acl.allowlist.conditions[0].groups[0].type #=> String, one of "INDEX", "DATASOURCE"
+    #   resp.document_acl.deny_list.member_relation #=> String, one of "AND", "OR"
+    #   resp.document_acl.deny_list.conditions #=> Array
+    #   resp.document_acl.deny_list.conditions[0].member_relation #=> String, one of "AND", "OR"
+    #   resp.document_acl.deny_list.conditions[0].users #=> Array
+    #   resp.document_acl.deny_list.conditions[0].users[0].id #=> String
+    #   resp.document_acl.deny_list.conditions[0].users[0].type #=> String, one of "INDEX", "DATASOURCE"
+    #   resp.document_acl.deny_list.conditions[0].groups #=> Array
+    #   resp.document_acl.deny_list.conditions[0].groups[0].name #=> String
+    #   resp.document_acl.deny_list.conditions[0].groups[0].type #=> String, one of "INDEX", "DATASOURCE"
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CheckDocumentAccess AWS API Documentation
+    #
+    # @overload check_document_access(params = {})
+    # @param [Hash] params ({})
+    def check_document_access(params = {}, options = {})
+      req = build_request(:check_document_access, params)
+      req.send_request(options)
+    end
+
     # Creates an Amazon Q Business application.
     #
     # <note markdown="1"> There are new tiers for Amazon Q Business. Not all features in Amazon
@@ -2017,12 +2099,14 @@ module Aws::QBusiness
     #
     # @option params [Array<String>] :origins
     #   Sets the website domain origins that are allowed to embed the Amazon Q
-    #   Business web experience.      The <i>domain origin</i> refers to the
-    #   base URL for accessing a website including the protocol
-    #   (<code>http/https</code>), the domain name, and the port number (if
-    #   specified). </p> <note> <p>You must only submit a <i>base URL</i> and
-    #   not a full path. For example,
-    #   <code>https://docs.aws.amazon.com</code>.</p> </note>
+    #   Business web experience. The *domain origin* refers to the base URL
+    #   for accessing a website including the protocol (`http/https`), the
+    #   domain name, and the port number (if specified).
+    #
+    #   <note markdown="1"> You must only submit a *base URL* and not a full path. For example,
+    #   `https://docs.aws.amazon.com`.
+    #
+    #    </note>
     #
     # @option params [String] :role_arn
     #   The Amazon Resource Name (ARN) of the service role attached to your
@@ -5601,14 +5685,17 @@ module Aws::QBusiness
     #
     # @option params [Array<String>] :origins
     #   Updates the website domain origins that are allowed to embed the
-    #   Amazon Q Business web experience.      The <i>domain origin</i> refers
-    #   to the <i>base URL</i> for accessing a website including the protocol
-    #   (<code>http/https</code>), the domain name, and the port number (if
-    #   specified).</p> <note> <ul> <li> <p>Any values except
-    #   <code>null</code> submitted as part of this update will replace all
-    #   previous values.</p> </li> <li> <p>You must only submit a <i>base
-    #   URL</i> and not a full path. For example,
-    #   <code>https://docs.aws.amazon.com</code>.</p> </li> </ul> </note>
+    #   Amazon Q Business web experience. The *domain origin* refers to the
+    #   *base URL* for accessing a website including the protocol
+    #   (`http/https`), the domain name, and the port number (if specified).
+    #
+    #   <note markdown="1"> * Any values except `null` submitted as part of this update will
+    #     replace all previous values.
+    #
+    #   * You must only submit a *base URL* and not a full path. For example,
+    #     `https://docs.aws.amazon.com`.
+    #
+    #    </note>
     #
     # @option params [Types::BrowserExtensionConfiguration] :browser_extension_configuration
     #   The browser extension configuration for an Amazon Q Business web
@@ -5698,7 +5785,7 @@ module Aws::QBusiness
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-qbusiness'
-      context[:gem_version] = '1.34.0'
+      context[:gem_version] = '1.36.0'
       Seahorse::Client::Request.new(handlers, context)
     end