feat(client-qbusiness): 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.

Author: awstools

clients/client-qbusiness/README.md

@@ -6,45 +6,7 @@
 
 AWS SDK for JavaScript QBusiness Client for Node.js, Browser and React Native.
 
-<p>This is the <i>Amazon Q Business</i> API Reference. Amazon Q Business is a fully
-managed, generative-AI powered enterprise chat assistant that you can deploy within your
-organization. Amazon Q Business enhances employee productivity by supporting key tasks such
-as question-answering, knowledge discovery, writing email messages, summarizing text,
-drafting document outlines, and brainstorming ideas. Users ask questions of
-Amazon Q Business and get answers that are presented in a conversational manner. For an
-introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
-<i>Amazon Q Business User Guide</i>
-</a>.</p>
-<p>For an overview of the Amazon Q Business APIs, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/api-ref.html#api-overview">Overview of Amazon Q Business API operations</a>.</p>
-<p>For information about the IAM access control permissions you need to
-use this API, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html">IAM roles for Amazon Q Business</a> in the
-<i>Amazon Q Business User Guide</i>.</p>
-<p>The following resources provide additional information about using the Amazon Q Business
-API:</p>
-<ul>
-<li>
-<p>
-<i>
-<a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for
-Amazon Q Business</a>
-</i>
-</p>
-</li>
-<li>
-<p>
-<i>
-<a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q Business CLI Reference</a>
-</i>
-</p>
-</li>
-<li>
-<p>
-<i>
-<a href="https://docs.aws.amazon.com/general/latest/gr/amazonq.html">Amazon Web Services General Reference</a>
-</i>
-</p>
-</li>
-</ul>
+<p>This is the <i>Amazon Q Business</i> API Reference. Amazon Q Business is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q Business enhances employee productivity by supporting key tasks such as question-answering, knowledge discovery, writing email messages, summarizing text, drafting document outlines, and brainstorming ideas. Users ask questions of Amazon Q Business and get answers that are presented in a conversational manner. For an introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html"> <i>Amazon Q Business User Guide</i> </a>.</p> <p>For an overview of the Amazon Q Business APIs, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/api-ref.html#api-overview">Overview of Amazon Q Business API operations</a>.</p> <p>For information about the IAM access control permissions you need to use this API, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html">IAM roles for Amazon Q Business</a> in the <i>Amazon Q Business User Guide</i>.</p> <p>The following resources provide additional information about using the Amazon Q Business API:</p> <ul> <li> <p> <i> <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for Amazon Q Business</a> </i> </p> </li> <li> <p> <i> <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q Business CLI Reference</a> </i> </p> </li> <li> <p> <i> <a href="https://docs.aws.amazon.com/general/latest/gr/amazonq.html">Amazon Web Services General Reference</a> </i> </p> </li> </ul>
 
 ## Installing
 
@@ -288,6 +250,14 @@ ChatSync
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qbusiness/command/ChatSyncCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qbusiness/Interface/ChatSyncCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qbusiness/Interface/ChatSyncCommandOutput/)
 
+</details>
+<details>
+<summary>
+CheckDocumentAccess
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qbusiness/command/CheckDocumentAccessCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qbusiness/Interface/CheckDocumentAccessCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qbusiness/Interface/CheckDocumentAccessCommandOutput/)
+
 </details>
 <details>
 <summary>

clients/client-qbusiness/src/QBusiness.ts

@@ -24,6 +24,11 @@ import {
 } from "./commands/CancelSubscriptionCommand";
 import { ChatCommand, ChatCommandInput, ChatCommandOutput } from "./commands/ChatCommand";
 import { ChatSyncCommand, ChatSyncCommandInput, ChatSyncCommandOutput } from "./commands/ChatSyncCommand";
+import {
+  CheckDocumentAccessCommand,
+  CheckDocumentAccessCommandInput,
+  CheckDocumentAccessCommandOutput,
+} from "./commands/CheckDocumentAccessCommand";
 import {
   CreateApplicationCommand,
   CreateApplicationCommandInput,
@@ -302,6 +307,7 @@ const commands = {
   CancelSubscriptionCommand,
   ChatCommand,
   ChatSyncCommand,
+  CheckDocumentAccessCommand,
   CreateApplicationCommand,
   CreateDataAccessorCommand,
   CreateDataSourceCommand,
@@ -460,6 +466,23 @@ export interface QBusiness {
     cb: (err: any, data?: ChatSyncCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link CheckDocumentAccessCommand}
+   */
+  checkDocumentAccess(
+    args: CheckDocumentAccessCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<CheckDocumentAccessCommandOutput>;
+  checkDocumentAccess(
+    args: CheckDocumentAccessCommandInput,
+    cb: (err: any, data?: CheckDocumentAccessCommandOutput) => void
+  ): void;
+  checkDocumentAccess(
+    args: CheckDocumentAccessCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: CheckDocumentAccessCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link CreateApplicationCommand}
    */
@@ -1451,45 +1474,7 @@ export interface QBusiness {
 }
 
 /**
- * <p>This is the <i>Amazon Q Business</i> API Reference. Amazon Q Business is a fully
- *             managed, generative-AI powered enterprise chat assistant that you can deploy within your
- *             organization. Amazon Q Business enhances employee productivity by supporting key tasks such
- *             as question-answering, knowledge discovery, writing email messages, summarizing text,
- *             drafting document outlines, and brainstorming ideas. Users ask questions of
- *             Amazon Q Business and get answers that are presented in a conversational manner. For an
- *             introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
- *                <i>Amazon Q Business User Guide</i>
- *             </a>.</p>
- *          <p>For an overview of the Amazon Q Business APIs, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/api-ref.html#api-overview">Overview of Amazon Q Business API operations</a>.</p>
- *          <p>For information about the IAM access control permissions you need to
- *             use this API, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html">IAM roles for Amazon Q Business</a> in the
- *                 <i>Amazon Q Business User Guide</i>.</p>
- *          <p>The following resources provide additional information about using the Amazon Q Business
- *             API:</p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <i>
- *                      <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for
- *                             Amazon Q Business</a>
- *                   </i>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <i>
- *                      <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q Business CLI Reference</a>
- *                   </i>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <i>
- *                      <a href="https://docs.aws.amazon.com/general/latest/gr/amazonq.html">Amazon Web Services General Reference</a>
- *                   </i>
- *                </p>
- *             </li>
- *          </ul>
+ * <p>This is the <i>Amazon Q Business</i> API Reference. Amazon Q Business is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q Business enhances employee productivity by supporting key tasks such as question-answering, knowledge discovery, writing email messages, summarizing text, drafting document outlines, and brainstorming ideas. Users ask questions of Amazon Q Business and get answers that are presented in a conversational manner. For an introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html"> <i>Amazon Q Business User Guide</i> </a>.</p> <p>For an overview of the Amazon Q Business APIs, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/api-ref.html#api-overview">Overview of Amazon Q Business API operations</a>.</p> <p>For information about the IAM access control permissions you need to use this API, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html">IAM roles for Amazon Q Business</a> in the <i>Amazon Q Business User Guide</i>.</p> <p>The following resources provide additional information about using the Amazon Q Business API:</p> <ul> <li> <p> <i> <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for Amazon Q Business</a> </i> </p> </li> <li> <p> <i> <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q Business CLI Reference</a> </i> </p> </li> <li> <p> <i> <a href="https://docs.aws.amazon.com/general/latest/gr/amazonq.html">Amazon Web Services General Reference</a> </i> </p> </li> </ul>
  * @public
  */
 export class QBusiness extends QBusinessClient implements QBusiness {}

clients/client-qbusiness/src/QBusinessClient.ts

@@ -77,6 +77,10 @@ import { BatchPutDocumentCommandInput, BatchPutDocumentCommandOutput } from "./c
 import { CancelSubscriptionCommandInput, CancelSubscriptionCommandOutput } from "./commands/CancelSubscriptionCommand";
 import { ChatCommandInput, ChatCommandOutput } from "./commands/ChatCommand";
 import { ChatSyncCommandInput, ChatSyncCommandOutput } from "./commands/ChatSyncCommand";
+import {
+  CheckDocumentAccessCommandInput,
+  CheckDocumentAccessCommandOutput,
+} from "./commands/CheckDocumentAccessCommand";
 import { CreateApplicationCommandInput, CreateApplicationCommandOutput } from "./commands/CreateApplicationCommand";
 import { CreateDataAccessorCommandInput, CreateDataAccessorCommandOutput } from "./commands/CreateDataAccessorCommand";
 import { CreateDataSourceCommandInput, CreateDataSourceCommandOutput } from "./commands/CreateDataSourceCommand";
@@ -209,6 +213,7 @@ export type ServiceInputTypes =
   | CancelSubscriptionCommandInput
   | ChatCommandInput
   | ChatSyncCommandInput
+  | CheckDocumentAccessCommandInput
   | CreateApplicationCommandInput
   | CreateDataAccessorCommandInput
   | CreateDataSourceCommandInput
@@ -289,6 +294,7 @@ export type ServiceOutputTypes =
   | CancelSubscriptionCommandOutput
   | ChatCommandOutput
   | ChatSyncCommandOutput
+  | CheckDocumentAccessCommandOutput
   | CreateApplicationCommandOutput
   | CreateDataAccessorCommandOutput
   | CreateDataSourceCommandOutput
@@ -565,45 +571,7 @@ export type QBusinessClientResolvedConfigType = __SmithyResolvedConfiguration<__
 export interface QBusinessClientResolvedConfig extends QBusinessClientResolvedConfigType {}
 
 /**
- * <p>This is the <i>Amazon Q Business</i> API Reference. Amazon Q Business is a fully
- *             managed, generative-AI powered enterprise chat assistant that you can deploy within your
- *             organization. Amazon Q Business enhances employee productivity by supporting key tasks such
- *             as question-answering, knowledge discovery, writing email messages, summarizing text,
- *             drafting document outlines, and brainstorming ideas. Users ask questions of
- *             Amazon Q Business and get answers that are presented in a conversational manner. For an
- *             introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
- *                <i>Amazon Q Business User Guide</i>
- *             </a>.</p>
- *          <p>For an overview of the Amazon Q Business APIs, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/api-ref.html#api-overview">Overview of Amazon Q Business API operations</a>.</p>
- *          <p>For information about the IAM access control permissions you need to
- *             use this API, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html">IAM roles for Amazon Q Business</a> in the
- *                 <i>Amazon Q Business User Guide</i>.</p>
- *          <p>The following resources provide additional information about using the Amazon Q Business
- *             API:</p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <i>
- *                      <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for
- *                             Amazon Q Business</a>
- *                   </i>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <i>
- *                      <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q Business CLI Reference</a>
- *                   </i>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <i>
- *                      <a href="https://docs.aws.amazon.com/general/latest/gr/amazonq.html">Amazon Web Services General Reference</a>
- *                   </i>
- *                </p>
- *             </li>
- *          </ul>
+ * <p>This is the <i>Amazon Q Business</i> API Reference. Amazon Q Business is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q Business enhances employee productivity by supporting key tasks such as question-answering, knowledge discovery, writing email messages, summarizing text, drafting document outlines, and brainstorming ideas. Users ask questions of Amazon Q Business and get answers that are presented in a conversational manner. For an introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html"> <i>Amazon Q Business User Guide</i> </a>.</p> <p>For an overview of the Amazon Q Business APIs, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/api-ref.html#api-overview">Overview of Amazon Q Business API operations</a>.</p> <p>For information about the IAM access control permissions you need to use this API, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html">IAM roles for Amazon Q Business</a> in the <i>Amazon Q Business User Guide</i>.</p> <p>The following resources provide additional information about using the Amazon Q Business API:</p> <ul> <li> <p> <i> <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for Amazon Q Business</a> </i> </p> </li> <li> <p> <i> <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q Business CLI Reference</a> </i> </p> </li> <li> <p> <i> <a href="https://docs.aws.amazon.com/general/latest/gr/amazonq.html">Amazon Web Services General Reference</a> </i> </p> </li> </ul>
  * @public
  */
 export class QBusinessClient extends __Client<

clients/client-qbusiness/src/commands/AssociatePermissionCommand.ts

@@ -28,9 +28,7 @@ export interface AssociatePermissionCommandInput extends AssociatePermissionRequ
 export interface AssociatePermissionCommandOutput extends AssociatePermissionResponse, __MetadataBearer {}
 
 /**
- * <p>Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV.
- *          This operation creates a new policy statement for the specified Amazon Q Business application.
- *          The policy statement defines the IAM actions that the ISV is allowed to perform on the Amazon Q Business application's resources.</p>
+ * <p>Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV. This operation creates a new policy statement for the specified Amazon Q Business application. The policy statement defines the IAM actions that the ISV is allowed to perform on the Amazon Q Business application's resources.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -60,31 +58,25 @@ export interface AssociatePermissionCommandOutput extends AssociatePermissionRes
  * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  <p> You don't have access to perform this action. Make sure you have the required
- *             permission policies and user accounts and try again.</p>
+ *  <p> You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.</p>
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>You are trying to perform an action that conflicts with the current status of your
- *             resource. Fix any inconsistencies with your resources and try again.</p>
+ *  <p>You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
- *             some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
+ *  <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
- *             provided the correct resource and try again.</p>
+ *  <p>The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.</p>
  *
  * @throws {@link ServiceQuotaExceededException} (client fault)
  *  <p>You have exceeded the set limits for your Amazon Q Business service. </p>
  *
  * @throws {@link ThrottlingException} (client fault)
- *  <p>The request was denied due to throttling. Reduce the number of requests and try
- *             again.</p>
+ *  <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
- *             correct input and try again.</p>
+ *  <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
  *
  * @throws {@link QBusinessServiceException}
  * <p>Base exception class for all service exceptions from QBusiness service.</p>