@aws-sdk/client-qbusiness 3.787.0 → 3.796.0

package/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>

package/dist-cjs/index.js

@@ -49,6 +49,7 @@ __export(index_exports, {
   ChatOutputStream: () => ChatOutputStream,
   ChatOutputStreamFilterSensitiveLog: () => ChatOutputStreamFilterSensitiveLog,
   ChatSyncCommand: () => ChatSyncCommand,
+  CheckDocumentAccessCommand: () => CheckDocumentAccessCommand,
   ConflictException: () => ConflictException,
   ContentSource: () => ContentSource,
   ContentType: () => ContentType,
@@ -1044,10 +1045,6 @@ var MediaTooLargeException = class _MediaTooLargeException extends QBusinessServ
     Object.setPrototypeOf(this, _MediaTooLargeException.prototype);
   }
 };
-var MessageType = {
-  SYSTEM: "SYSTEM",
-  USER: "USER"
-};
 var APISchemaFilterSensitiveLog = /* @__PURE__ */ __name((obj) => {
   if (obj.payload !== void 0) return { payload: import_smithy_client.SENSITIVE_STRING };
   if (obj.s3 !== void 0) return { s3: obj.s3 };
@@ -1117,6 +1114,10 @@ var ChatOutputFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
 
 // src/models/models_1.ts
 
+var MessageType = {
+  SYSTEM: "SYSTEM",
+  USER: "USER"
+};
 var PluginTypeCategory = {
   COMMUNICATION: "Communication",
   CRM: "Customer relationship management (CRM)",
@@ -1309,6 +1310,21 @@ var se_ChatSyncCommand = /* @__PURE__ */ __name(async (input, context) => {
   b.m("POST").h(headers).q(query).b(body);
   return b.build();
 }, "se_ChatSyncCommand");
+var se_CheckDocumentAccessCommand = /* @__PURE__ */ __name(async (input, context) => {
+  const b = (0, import_core.requestBuilder)(input, context);
+  const headers = {};
+  b.bp("/applications/{applicationId}/index/{indexId}/users/{userId}/documents/{documentId}/check-document-access");
+  b.p("applicationId", () => input.applicationId, "{applicationId}", false);
+  b.p("indexId", () => input.indexId, "{indexId}", false);
+  b.p("userId", () => input.userId, "{userId}", false);
+  b.p("documentId", () => input.documentId, "{documentId}", false);
+  const query = (0, import_smithy_client.map)({
+    [_dSI]: [, input[_dSI]]
+  });
+  let body;
+  b.m("GET").h(headers).q(query).b(body);
+  return b.build();
+}, "se_CheckDocumentAccessCommand");
 var se_CreateApplicationCommand = /* @__PURE__ */ __name(async (input, context) => {
   const b = (0, import_core.requestBuilder)(input, context);
   const headers = {
@@ -2438,6 +2454,23 @@ var de_ChatSyncCommand = /* @__PURE__ */ __name(async (output, context) => {
   Object.assign(contents, doc);
   return contents;
 }, "de_ChatSyncCommand");
+var de_CheckDocumentAccessCommand = /* @__PURE__ */ __name(async (output, context) => {
+  if (output.statusCode !== 200 && output.statusCode >= 300) {
+    return de_CommandError(output, context);
+  }
+  const contents = (0, import_smithy_client.map)({
+    $metadata: deserializeMetadata(output)
+  });
+  const data = (0, import_smithy_client.expectNonNull)((0, import_smithy_client.expectObject)(await (0, import_core2.parseJsonBody)(output.body, context)), "body");
+  const doc = (0, import_smithy_client.take)(data, {
+    documentAcl: import_smithy_client._json,
+    hasAccess: import_smithy_client.expectBoolean,
+    userAliases: import_smithy_client._json,
+    userGroups: import_smithy_client._json
+  });
+  Object.assign(contents, doc);
+  return contents;
+}, "de_CheckDocumentAccessCommand");
 var de_CreateApplicationCommand = /* @__PURE__ */ __name(async (output, context) => {
   if (output.statusCode !== 200 && output.statusCode >= 300) {
     return de_CommandError(output, context);
@@ -4495,6 +4528,21 @@ var ChatSyncCommand = class extends import_smithy_client.Command.classBuilder().
   }
 };
 
+// src/commands/CheckDocumentAccessCommand.ts
+
+
+
+var CheckDocumentAccessCommand = class extends import_smithy_client.Command.classBuilder().ep(commonParams).m(function(Command, cs, config, o) {
+  return [
+    (0, import_middleware_serde.getSerdePlugin)(config, this.serialize, this.deserialize),
+    (0, import_middleware_endpoint.getEndpointPlugin)(config, Command.getEndpointParameterInstructions())
+  ];
+}).s("ExpertQ", "CheckDocumentAccess", {}).n("QBusinessClient", "CheckDocumentAccessCommand").f(void 0, void 0).ser(se_CheckDocumentAccessCommand).de(de_CheckDocumentAccessCommand).build() {
+  static {
+    __name(this, "CheckDocumentAccessCommand");
+  }
+};
+
 // src/commands/CreateApplicationCommand.ts
 
 
@@ -5538,6 +5586,7 @@ var commands = {
   CancelSubscriptionCommand,
   ChatCommand,
   ChatSyncCommand,
+  CheckDocumentAccessCommand,
   CreateApplicationCommand,
   CreateDataAccessorCommand,
   CreateDataSourceCommand,
@@ -5704,6 +5753,7 @@ var paginateSearchRelevantContent = (0, import_core.createPaginator)(QBusinessCl
   CancelSubscriptionCommand,
   ChatCommand,
   ChatSyncCommand,
+  CheckDocumentAccessCommand,
   CreateApplicationCommand,
   CreateDataAccessorCommand,
   CreateDataSourceCommand,
@@ -5868,7 +5918,6 @@ var paginateSearchRelevantContent = (0, import_core.createPaginator)(QBusinessCl
   RuleType,
   GroupStatus,
   MediaTooLargeException,
-  MessageType,
   APISchemaFilterSensitiveLog,
   EncryptionConfigurationFilterSensitiveLog,
   CreateApplicationRequestFilterSensitiveLog,
@@ -5881,6 +5930,7 @@ var paginateSearchRelevantContent = (0, import_core.createPaginator)(QBusinessCl
   UpdatePluginRequestFilterSensitiveLog,
   ChatOutputStreamFilterSensitiveLog,
   ChatOutputFilterSensitiveLog,
+  MessageType,
   PluginTypeCategory,
   MessageUsefulnessReason,
   MessageUsefulness,

package/dist-es/QBusiness.js

@@ -5,6 +5,7 @@ import { BatchPutDocumentCommand, } from "./commands/BatchPutDocumentCommand";
 import { CancelSubscriptionCommand, } from "./commands/CancelSubscriptionCommand";
 import { ChatCommand } from "./commands/ChatCommand";
 import { ChatSyncCommand } from "./commands/ChatSyncCommand";
+import { CheckDocumentAccessCommand, } from "./commands/CheckDocumentAccessCommand";
 import { CreateApplicationCommand, } from "./commands/CreateApplicationCommand";
 import { CreateDataAccessorCommand, } from "./commands/CreateDataAccessorCommand";
 import { CreateDataSourceCommand, } from "./commands/CreateDataSourceCommand";
@@ -82,6 +83,7 @@ const commands = {
     CancelSubscriptionCommand,
     ChatCommand,
     ChatSyncCommand,
+    CheckDocumentAccessCommand,
     CreateApplicationCommand,
     CreateDataAccessorCommand,
     CreateDataSourceCommand,

package/dist-es/commands/CheckDocumentAccessCommand.js

@@ -0,0 +1,22 @@
+import { getEndpointPlugin } from "@smithy/middleware-endpoint";
+import { getSerdePlugin } from "@smithy/middleware-serde";
+import { Command as $Command } from "@smithy/smithy-client";
+import { commonParams } from "../endpoint/EndpointParameters";
+import { de_CheckDocumentAccessCommand, se_CheckDocumentAccessCommand } from "../protocols/Aws_restJson1";
+export { $Command };
+export class CheckDocumentAccessCommand extends $Command
+    .classBuilder()
+    .ep(commonParams)
+    .m(function (Command, cs, config, o) {
+    return [
+        getSerdePlugin(config, this.serialize, this.deserialize),
+        getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
+    ];
+})
+    .s("ExpertQ", "CheckDocumentAccess", {})
+    .n("QBusinessClient", "CheckDocumentAccessCommand")
+    .f(void 0, void 0)
+    .ser(se_CheckDocumentAccessCommand)
+    .de(de_CheckDocumentAccessCommand)
+    .build() {
+}

package/dist-es/commands/index.js

@@ -4,6 +4,7 @@ export * from "./BatchPutDocumentCommand";
 export * from "./CancelSubscriptionCommand";
 export * from "./ChatCommand";
 export * from "./ChatSyncCommand";
+export * from "./CheckDocumentAccessCommand";
 export * from "./CreateApplicationCommand";
 export * from "./CreateDataAccessorCommand";
 export * from "./CreateDataSourceCommand";

package/dist-es/models/models_0.js

@@ -587,10 +587,6 @@ export class MediaTooLargeException extends __BaseException {
         Object.setPrototypeOf(this, MediaTooLargeException.prototype);
     }
 }
-export const MessageType = {
-    SYSTEM: "SYSTEM",
-    USER: "USER",
-};
 export const APISchemaFilterSensitiveLog = (obj) => {
     if (obj.payload !== undefined)
         return { payload: SENSITIVE_STRING };

package/dist-es/models/models_1.js

@@ -1,4 +1,8 @@
 import { SENSITIVE_STRING } from "@smithy/smithy-client";
+export const MessageType = {
+    SYSTEM: "SYSTEM",
+    USER: "USER",
+};
 export const PluginTypeCategory = {
     COMMUNICATION: "Communication",
     CRM: "Customer relationship management (CRM)",

package/dist-es/protocols/Aws_restJson1.js

@@ -113,6 +113,21 @@ export const se_ChatSyncCommand = async (input, context) => {
     b.m("POST").h(headers).q(query).b(body);
     return b.build();
 };
+export const se_CheckDocumentAccessCommand = async (input, context) => {
+    const b = rb(input, context);
+    const headers = {};
+    b.bp("/applications/{applicationId}/index/{indexId}/users/{userId}/documents/{documentId}/check-document-access");
+    b.p("applicationId", () => input.applicationId, "{applicationId}", false);
+    b.p("indexId", () => input.indexId, "{indexId}", false);
+    b.p("userId", () => input.userId, "{userId}", false);
+    b.p("documentId", () => input.documentId, "{documentId}", false);
+    const query = map({
+        [_dSI]: [, input[_dSI]],
+    });
+    let body;
+    b.m("GET").h(headers).q(query).b(body);
+    return b.build();
+};
 export const se_CreateApplicationCommand = async (input, context) => {
     const b = rb(input, context);
     const headers = {
@@ -1196,6 +1211,23 @@ export const de_ChatSyncCommand = async (output, context) => {
     Object.assign(contents, doc);
     return contents;
 };
+export const de_CheckDocumentAccessCommand = async (output, context) => {
+    if (output.statusCode !== 200 && output.statusCode >= 300) {
+        return de_CommandError(output, context);
+    }
+    const contents = map({
+        $metadata: deserializeMetadata(output),
+    });
+    const data = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
+    const doc = take(data, {
+        documentAcl: _json,
+        hasAccess: __expectBoolean,
+        userAliases: _json,
+        userGroups: _json,
+    });
+    Object.assign(contents, doc);
+    return contents;
+};
 export const de_CreateApplicationCommand = async (output, context) => {
     if (output.statusCode !== 200 && output.statusCode >= 300) {
         return de_CommandError(output, context);

package/dist-types/QBusiness.d.ts

@@ -5,6 +5,7 @@ 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";
@@ -112,6 +113,12 @@ export interface QBusiness {
     chatSync(args: ChatSyncCommandInput, options?: __HttpHandlerOptions): Promise<ChatSyncCommandOutput>;
     chatSync(args: ChatSyncCommandInput, cb: (err: any, data?: ChatSyncCommandOutput) => void): void;
     chatSync(args: ChatSyncCommandInput, options: __HttpHandlerOptions, 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}
      */
@@ -530,45 +537,7 @@ export interface QBusiness {
     updateWebExperience(args: UpdateWebExperienceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWebExperienceCommandOutput) => void): void;
 }
 /**
- * <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 declare class QBusiness extends QBusinessClient implements QBusiness {

package/dist-types/QBusinessClient.d.ts

@@ -16,6 +16,7 @@ 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";
@@ -91,11 +92,11 @@ export { __Client };
 /**
  * @public
  */
-export type ServiceInputTypes = AssociatePermissionCommandInput | BatchDeleteDocumentCommandInput | BatchPutDocumentCommandInput | CancelSubscriptionCommandInput | ChatCommandInput | ChatSyncCommandInput | CreateApplicationCommandInput | CreateDataAccessorCommandInput | CreateDataSourceCommandInput | CreateIndexCommandInput | CreatePluginCommandInput | CreateRetrieverCommandInput | CreateSubscriptionCommandInput | CreateUserCommandInput | CreateWebExperienceCommandInput | DeleteApplicationCommandInput | DeleteAttachmentCommandInput | DeleteChatControlsConfigurationCommandInput | DeleteConversationCommandInput | DeleteDataAccessorCommandInput | DeleteDataSourceCommandInput | DeleteGroupCommandInput | DeleteIndexCommandInput | DeletePluginCommandInput | DeleteRetrieverCommandInput | DeleteUserCommandInput | DeleteWebExperienceCommandInput | DisassociatePermissionCommandInput | GetApplicationCommandInput | GetChatControlsConfigurationCommandInput | GetDataAccessorCommandInput | GetDataSourceCommandInput | GetGroupCommandInput | GetIndexCommandInput | GetMediaCommandInput | GetPluginCommandInput | GetPolicyCommandInput | GetRetrieverCommandInput | GetUserCommandInput | GetWebExperienceCommandInput | ListApplicationsCommandInput | ListAttachmentsCommandInput | ListConversationsCommandInput | ListDataAccessorsCommandInput | ListDataSourceSyncJobsCommandInput | ListDataSourcesCommandInput | ListDocumentsCommandInput | ListGroupsCommandInput | ListIndicesCommandInput | ListMessagesCommandInput | ListPluginActionsCommandInput | ListPluginTypeActionsCommandInput | ListPluginTypeMetadataCommandInput | ListPluginsCommandInput | ListRetrieversCommandInput | ListSubscriptionsCommandInput | ListTagsForResourceCommandInput | ListWebExperiencesCommandInput | PutFeedbackCommandInput | PutGroupCommandInput | SearchRelevantContentCommandInput | StartDataSourceSyncJobCommandInput | StopDataSourceSyncJobCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateApplicationCommandInput | UpdateChatControlsConfigurationCommandInput | UpdateDataAccessorCommandInput | UpdateDataSourceCommandInput | UpdateIndexCommandInput | UpdatePluginCommandInput | UpdateRetrieverCommandInput | UpdateSubscriptionCommandInput | UpdateUserCommandInput | UpdateWebExperienceCommandInput;
+export type ServiceInputTypes = AssociatePermissionCommandInput | BatchDeleteDocumentCommandInput | BatchPutDocumentCommandInput | CancelSubscriptionCommandInput | ChatCommandInput | ChatSyncCommandInput | CheckDocumentAccessCommandInput | CreateApplicationCommandInput | CreateDataAccessorCommandInput | CreateDataSourceCommandInput | CreateIndexCommandInput | CreatePluginCommandInput | CreateRetrieverCommandInput | CreateSubscriptionCommandInput | CreateUserCommandInput | CreateWebExperienceCommandInput | DeleteApplicationCommandInput | DeleteAttachmentCommandInput | DeleteChatControlsConfigurationCommandInput | DeleteConversationCommandInput | DeleteDataAccessorCommandInput | DeleteDataSourceCommandInput | DeleteGroupCommandInput | DeleteIndexCommandInput | DeletePluginCommandInput | DeleteRetrieverCommandInput | DeleteUserCommandInput | DeleteWebExperienceCommandInput | DisassociatePermissionCommandInput | GetApplicationCommandInput | GetChatControlsConfigurationCommandInput | GetDataAccessorCommandInput | GetDataSourceCommandInput | GetGroupCommandInput | GetIndexCommandInput | GetMediaCommandInput | GetPluginCommandInput | GetPolicyCommandInput | GetRetrieverCommandInput | GetUserCommandInput | GetWebExperienceCommandInput | ListApplicationsCommandInput | ListAttachmentsCommandInput | ListConversationsCommandInput | ListDataAccessorsCommandInput | ListDataSourceSyncJobsCommandInput | ListDataSourcesCommandInput | ListDocumentsCommandInput | ListGroupsCommandInput | ListIndicesCommandInput | ListMessagesCommandInput | ListPluginActionsCommandInput | ListPluginTypeActionsCommandInput | ListPluginTypeMetadataCommandInput | ListPluginsCommandInput | ListRetrieversCommandInput | ListSubscriptionsCommandInput | ListTagsForResourceCommandInput | ListWebExperiencesCommandInput | PutFeedbackCommandInput | PutGroupCommandInput | SearchRelevantContentCommandInput | StartDataSourceSyncJobCommandInput | StopDataSourceSyncJobCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateApplicationCommandInput | UpdateChatControlsConfigurationCommandInput | UpdateDataAccessorCommandInput | UpdateDataSourceCommandInput | UpdateIndexCommandInput | UpdatePluginCommandInput | UpdateRetrieverCommandInput | UpdateSubscriptionCommandInput | UpdateUserCommandInput | UpdateWebExperienceCommandInput;
 /**
  * @public
  */
-export type ServiceOutputTypes = AssociatePermissionCommandOutput | BatchDeleteDocumentCommandOutput | BatchPutDocumentCommandOutput | CancelSubscriptionCommandOutput | ChatCommandOutput | ChatSyncCommandOutput | CreateApplicationCommandOutput | CreateDataAccessorCommandOutput | CreateDataSourceCommandOutput | CreateIndexCommandOutput | CreatePluginCommandOutput | CreateRetrieverCommandOutput | CreateSubscriptionCommandOutput | CreateUserCommandOutput | CreateWebExperienceCommandOutput | DeleteApplicationCommandOutput | DeleteAttachmentCommandOutput | DeleteChatControlsConfigurationCommandOutput | DeleteConversationCommandOutput | DeleteDataAccessorCommandOutput | DeleteDataSourceCommandOutput | DeleteGroupCommandOutput | DeleteIndexCommandOutput | DeletePluginCommandOutput | DeleteRetrieverCommandOutput | DeleteUserCommandOutput | DeleteWebExperienceCommandOutput | DisassociatePermissionCommandOutput | GetApplicationCommandOutput | GetChatControlsConfigurationCommandOutput | GetDataAccessorCommandOutput | GetDataSourceCommandOutput | GetGroupCommandOutput | GetIndexCommandOutput | GetMediaCommandOutput | GetPluginCommandOutput | GetPolicyCommandOutput | GetRetrieverCommandOutput | GetUserCommandOutput | GetWebExperienceCommandOutput | ListApplicationsCommandOutput | ListAttachmentsCommandOutput | ListConversationsCommandOutput | ListDataAccessorsCommandOutput | ListDataSourceSyncJobsCommandOutput | ListDataSourcesCommandOutput | ListDocumentsCommandOutput | ListGroupsCommandOutput | ListIndicesCommandOutput | ListMessagesCommandOutput | ListPluginActionsCommandOutput | ListPluginTypeActionsCommandOutput | ListPluginTypeMetadataCommandOutput | ListPluginsCommandOutput | ListRetrieversCommandOutput | ListSubscriptionsCommandOutput | ListTagsForResourceCommandOutput | ListWebExperiencesCommandOutput | PutFeedbackCommandOutput | PutGroupCommandOutput | SearchRelevantContentCommandOutput | StartDataSourceSyncJobCommandOutput | StopDataSourceSyncJobCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateApplicationCommandOutput | UpdateChatControlsConfigurationCommandOutput | UpdateDataAccessorCommandOutput | UpdateDataSourceCommandOutput | UpdateIndexCommandOutput | UpdatePluginCommandOutput | UpdateRetrieverCommandOutput | UpdateSubscriptionCommandOutput | UpdateUserCommandOutput | UpdateWebExperienceCommandOutput;
+export type ServiceOutputTypes = AssociatePermissionCommandOutput | BatchDeleteDocumentCommandOutput | BatchPutDocumentCommandOutput | CancelSubscriptionCommandOutput | ChatCommandOutput | ChatSyncCommandOutput | CheckDocumentAccessCommandOutput | CreateApplicationCommandOutput | CreateDataAccessorCommandOutput | CreateDataSourceCommandOutput | CreateIndexCommandOutput | CreatePluginCommandOutput | CreateRetrieverCommandOutput | CreateSubscriptionCommandOutput | CreateUserCommandOutput | CreateWebExperienceCommandOutput | DeleteApplicationCommandOutput | DeleteAttachmentCommandOutput | DeleteChatControlsConfigurationCommandOutput | DeleteConversationCommandOutput | DeleteDataAccessorCommandOutput | DeleteDataSourceCommandOutput | DeleteGroupCommandOutput | DeleteIndexCommandOutput | DeletePluginCommandOutput | DeleteRetrieverCommandOutput | DeleteUserCommandOutput | DeleteWebExperienceCommandOutput | DisassociatePermissionCommandOutput | GetApplicationCommandOutput | GetChatControlsConfigurationCommandOutput | GetDataAccessorCommandOutput | GetDataSourceCommandOutput | GetGroupCommandOutput | GetIndexCommandOutput | GetMediaCommandOutput | GetPluginCommandOutput | GetPolicyCommandOutput | GetRetrieverCommandOutput | GetUserCommandOutput | GetWebExperienceCommandOutput | ListApplicationsCommandOutput | ListAttachmentsCommandOutput | ListConversationsCommandOutput | ListDataAccessorsCommandOutput | ListDataSourceSyncJobsCommandOutput | ListDataSourcesCommandOutput | ListDocumentsCommandOutput | ListGroupsCommandOutput | ListIndicesCommandOutput | ListMessagesCommandOutput | ListPluginActionsCommandOutput | ListPluginTypeActionsCommandOutput | ListPluginTypeMetadataCommandOutput | ListPluginsCommandOutput | ListRetrieversCommandOutput | ListSubscriptionsCommandOutput | ListTagsForResourceCommandOutput | ListWebExperiencesCommandOutput | PutFeedbackCommandOutput | PutGroupCommandOutput | SearchRelevantContentCommandOutput | StartDataSourceSyncJobCommandOutput | StopDataSourceSyncJobCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateApplicationCommandOutput | UpdateChatControlsConfigurationCommandOutput | UpdateDataAccessorCommandOutput | UpdateDataSourceCommandOutput | UpdateIndexCommandOutput | UpdatePluginCommandOutput | UpdateRetrieverCommandOutput | UpdateSubscriptionCommandOutput | UpdateUserCommandOutput | UpdateWebExperienceCommandOutput;
 /**
  * @public
  */
@@ -256,45 +257,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 declare class QBusinessClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, QBusinessClientResolvedConfig> {

package/dist-types/commands/AssociatePermissionCommand.d.ts

@@ -27,9 +27,7 @@ declare const AssociatePermissionCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <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
@@ -59,31 +57,25 @@ declare const AssociatePermissionCommand_base: {
  * @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>

package/dist-types/commands/BatchDeleteDocumentCommand.d.ts

@@ -27,10 +27,7 @@ declare const BatchDeleteDocumentCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Asynchronously deletes one or more documents added using the
- *                 <code>BatchPutDocument</code> API from an Amazon Q Business index.</p>
- *          <p>You can see the progress of the deletion, and any error messages related to the
- *             process, by using CloudWatch.</p>
+ * <p>Asynchronously deletes one or more documents added using the <code>BatchPutDocument</code> API from an Amazon Q Business index.</p> <p>You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -71,28 +68,22 @@ declare const BatchDeleteDocumentCommand_base: {
  * @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 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>

package/dist-types/commands/BatchPutDocumentCommand.d.ts

@@ -27,23 +27,7 @@ declare const BatchPutDocumentCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Adds one or more documents to an Amazon Q Business index.</p>
- *          <p>You use this API to:</p>
- *          <ul>
- *             <li>
- *                <p>ingest your structured and unstructured documents and documents stored in an
- *                         Amazon S3 bucket into an Amazon Q Business index.</p>
- *             </li>
- *             <li>
- *                <p>add custom attributes to documents in an Amazon Q Business index.</p>
- *             </li>
- *             <li>
- *                <p>attach an access control list to the documents added to an Amazon Q Business
- *                     index.</p>
- *             </li>
- *          </ul>
- *          <p>You can see the progress of the deletion, and any error messages related to the
- *             process, by using CloudWatch.</p>
+ * <p>Adds one or more documents to an Amazon Q Business index.</p> <p>You use this API to:</p> <ul> <li> <p>ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q Business index.</p> </li> <li> <p>add custom attributes to documents in an Amazon Q Business index.</p> </li> <li> <p>attach an access control list to the documents added to an Amazon Q Business index.</p> </li> </ul> <p>You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -191,31 +175,25 @@ declare const BatchPutDocumentCommand_base: {
  * @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>