@aws-sdk/client-qbusiness 3.461.0

package/dist-types/QBusinessClient.d.ts

@@ -0,0 +1,225 @@
+import { HostHeaderInputConfig, HostHeaderResolvedConfig } from "@aws-sdk/middleware-host-header";
+import { AwsAuthInputConfig, AwsAuthResolvedConfig } from "@aws-sdk/middleware-signing";
+import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
+import { Credentials as __Credentials } from "@aws-sdk/types";
+import { RegionInputConfig, RegionResolvedConfig } from "@smithy/config-resolver";
+import { EndpointInputConfig, EndpointResolvedConfig } from "@smithy/middleware-endpoint";
+import { RetryInputConfig, RetryResolvedConfig } from "@smithy/middleware-retry";
+import { HttpHandler as __HttpHandler } from "@smithy/protocol-http";
+import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@smithy/smithy-client";
+import { BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
+import { BatchDeleteDocumentCommandInput, BatchDeleteDocumentCommandOutput } from "./commands/BatchDeleteDocumentCommand";
+import { BatchPutDocumentCommandInput, BatchPutDocumentCommandOutput } from "./commands/BatchPutDocumentCommand";
+import { ChatSyncCommandInput, ChatSyncCommandOutput } from "./commands/ChatSyncCommand";
+import { CreateApplicationCommandInput, CreateApplicationCommandOutput } from "./commands/CreateApplicationCommand";
+import { CreateDataSourceCommandInput, CreateDataSourceCommandOutput } from "./commands/CreateDataSourceCommand";
+import { CreateIndexCommandInput, CreateIndexCommandOutput } from "./commands/CreateIndexCommand";
+import { CreatePluginCommandInput, CreatePluginCommandOutput } from "./commands/CreatePluginCommand";
+import { CreateRetrieverCommandInput, CreateRetrieverCommandOutput } from "./commands/CreateRetrieverCommand";
+import { CreateUserCommandInput, CreateUserCommandOutput } from "./commands/CreateUserCommand";
+import { CreateWebExperienceCommandInput, CreateWebExperienceCommandOutput } from "./commands/CreateWebExperienceCommand";
+import { DeleteApplicationCommandInput, DeleteApplicationCommandOutput } from "./commands/DeleteApplicationCommand";
+import { DeleteChatControlsConfigurationCommandInput, DeleteChatControlsConfigurationCommandOutput } from "./commands/DeleteChatControlsConfigurationCommand";
+import { DeleteConversationCommandInput, DeleteConversationCommandOutput } from "./commands/DeleteConversationCommand";
+import { DeleteDataSourceCommandInput, DeleteDataSourceCommandOutput } from "./commands/DeleteDataSourceCommand";
+import { DeleteGroupCommandInput, DeleteGroupCommandOutput } from "./commands/DeleteGroupCommand";
+import { DeleteIndexCommandInput, DeleteIndexCommandOutput } from "./commands/DeleteIndexCommand";
+import { DeletePluginCommandInput, DeletePluginCommandOutput } from "./commands/DeletePluginCommand";
+import { DeleteRetrieverCommandInput, DeleteRetrieverCommandOutput } from "./commands/DeleteRetrieverCommand";
+import { DeleteUserCommandInput, DeleteUserCommandOutput } from "./commands/DeleteUserCommand";
+import { DeleteWebExperienceCommandInput, DeleteWebExperienceCommandOutput } from "./commands/DeleteWebExperienceCommand";
+import { GetApplicationCommandInput, GetApplicationCommandOutput } from "./commands/GetApplicationCommand";
+import { GetChatControlsConfigurationCommandInput, GetChatControlsConfigurationCommandOutput } from "./commands/GetChatControlsConfigurationCommand";
+import { GetDataSourceCommandInput, GetDataSourceCommandOutput } from "./commands/GetDataSourceCommand";
+import { GetGroupCommandInput, GetGroupCommandOutput } from "./commands/GetGroupCommand";
+import { GetIndexCommandInput, GetIndexCommandOutput } from "./commands/GetIndexCommand";
+import { GetPluginCommandInput, GetPluginCommandOutput } from "./commands/GetPluginCommand";
+import { GetRetrieverCommandInput, GetRetrieverCommandOutput } from "./commands/GetRetrieverCommand";
+import { GetUserCommandInput, GetUserCommandOutput } from "./commands/GetUserCommand";
+import { GetWebExperienceCommandInput, GetWebExperienceCommandOutput } from "./commands/GetWebExperienceCommand";
+import { ListApplicationsCommandInput, ListApplicationsCommandOutput } from "./commands/ListApplicationsCommand";
+import { ListConversationsCommandInput, ListConversationsCommandOutput } from "./commands/ListConversationsCommand";
+import { ListDataSourcesCommandInput, ListDataSourcesCommandOutput } from "./commands/ListDataSourcesCommand";
+import { ListDataSourceSyncJobsCommandInput, ListDataSourceSyncJobsCommandOutput } from "./commands/ListDataSourceSyncJobsCommand";
+import { ListDocumentsCommandInput, ListDocumentsCommandOutput } from "./commands/ListDocumentsCommand";
+import { ListGroupsCommandInput, ListGroupsCommandOutput } from "./commands/ListGroupsCommand";
+import { ListIndicesCommandInput, ListIndicesCommandOutput } from "./commands/ListIndicesCommand";
+import { ListMessagesCommandInput, ListMessagesCommandOutput } from "./commands/ListMessagesCommand";
+import { ListPluginsCommandInput, ListPluginsCommandOutput } from "./commands/ListPluginsCommand";
+import { ListRetrieversCommandInput, ListRetrieversCommandOutput } from "./commands/ListRetrieversCommand";
+import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
+import { ListWebExperiencesCommandInput, ListWebExperiencesCommandOutput } from "./commands/ListWebExperiencesCommand";
+import { PutFeedbackCommandInput, PutFeedbackCommandOutput } from "./commands/PutFeedbackCommand";
+import { PutGroupCommandInput, PutGroupCommandOutput } from "./commands/PutGroupCommand";
+import { StartDataSourceSyncJobCommandInput, StartDataSourceSyncJobCommandOutput } from "./commands/StartDataSourceSyncJobCommand";
+import { StopDataSourceSyncJobCommandInput, StopDataSourceSyncJobCommandOutput } from "./commands/StopDataSourceSyncJobCommand";
+import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
+import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
+import { UpdateApplicationCommandInput, UpdateApplicationCommandOutput } from "./commands/UpdateApplicationCommand";
+import { UpdateChatControlsConfigurationCommandInput, UpdateChatControlsConfigurationCommandOutput } from "./commands/UpdateChatControlsConfigurationCommand";
+import { UpdateDataSourceCommandInput, UpdateDataSourceCommandOutput } from "./commands/UpdateDataSourceCommand";
+import { UpdateIndexCommandInput, UpdateIndexCommandOutput } from "./commands/UpdateIndexCommand";
+import { UpdatePluginCommandInput, UpdatePluginCommandOutput } from "./commands/UpdatePluginCommand";
+import { UpdateRetrieverCommandInput, UpdateRetrieverCommandOutput } from "./commands/UpdateRetrieverCommand";
+import { UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand";
+import { UpdateWebExperienceCommandInput, UpdateWebExperienceCommandOutput } from "./commands/UpdateWebExperienceCommand";
+import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
+export { __Client };
+/**
+ * @public
+ */
+export type ServiceInputTypes = BatchDeleteDocumentCommandInput | BatchPutDocumentCommandInput | ChatSyncCommandInput | CreateApplicationCommandInput | CreateDataSourceCommandInput | CreateIndexCommandInput | CreatePluginCommandInput | CreateRetrieverCommandInput | CreateUserCommandInput | CreateWebExperienceCommandInput | DeleteApplicationCommandInput | DeleteChatControlsConfigurationCommandInput | DeleteConversationCommandInput | DeleteDataSourceCommandInput | DeleteGroupCommandInput | DeleteIndexCommandInput | DeletePluginCommandInput | DeleteRetrieverCommandInput | DeleteUserCommandInput | DeleteWebExperienceCommandInput | GetApplicationCommandInput | GetChatControlsConfigurationCommandInput | GetDataSourceCommandInput | GetGroupCommandInput | GetIndexCommandInput | GetPluginCommandInput | GetRetrieverCommandInput | GetUserCommandInput | GetWebExperienceCommandInput | ListApplicationsCommandInput | ListConversationsCommandInput | ListDataSourceSyncJobsCommandInput | ListDataSourcesCommandInput | ListDocumentsCommandInput | ListGroupsCommandInput | ListIndicesCommandInput | ListMessagesCommandInput | ListPluginsCommandInput | ListRetrieversCommandInput | ListTagsForResourceCommandInput | ListWebExperiencesCommandInput | PutFeedbackCommandInput | PutGroupCommandInput | StartDataSourceSyncJobCommandInput | StopDataSourceSyncJobCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateApplicationCommandInput | UpdateChatControlsConfigurationCommandInput | UpdateDataSourceCommandInput | UpdateIndexCommandInput | UpdatePluginCommandInput | UpdateRetrieverCommandInput | UpdateUserCommandInput | UpdateWebExperienceCommandInput;
+/**
+ * @public
+ */
+export type ServiceOutputTypes = BatchDeleteDocumentCommandOutput | BatchPutDocumentCommandOutput | ChatSyncCommandOutput | CreateApplicationCommandOutput | CreateDataSourceCommandOutput | CreateIndexCommandOutput | CreatePluginCommandOutput | CreateRetrieverCommandOutput | CreateUserCommandOutput | CreateWebExperienceCommandOutput | DeleteApplicationCommandOutput | DeleteChatControlsConfigurationCommandOutput | DeleteConversationCommandOutput | DeleteDataSourceCommandOutput | DeleteGroupCommandOutput | DeleteIndexCommandOutput | DeletePluginCommandOutput | DeleteRetrieverCommandOutput | DeleteUserCommandOutput | DeleteWebExperienceCommandOutput | GetApplicationCommandOutput | GetChatControlsConfigurationCommandOutput | GetDataSourceCommandOutput | GetGroupCommandOutput | GetIndexCommandOutput | GetPluginCommandOutput | GetRetrieverCommandOutput | GetUserCommandOutput | GetWebExperienceCommandOutput | ListApplicationsCommandOutput | ListConversationsCommandOutput | ListDataSourceSyncJobsCommandOutput | ListDataSourcesCommandOutput | ListDocumentsCommandOutput | ListGroupsCommandOutput | ListIndicesCommandOutput | ListMessagesCommandOutput | ListPluginsCommandOutput | ListRetrieversCommandOutput | ListTagsForResourceCommandOutput | ListWebExperiencesCommandOutput | PutFeedbackCommandOutput | PutGroupCommandOutput | StartDataSourceSyncJobCommandOutput | StopDataSourceSyncJobCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateApplicationCommandOutput | UpdateChatControlsConfigurationCommandOutput | UpdateDataSourceCommandOutput | UpdateIndexCommandOutput | UpdatePluginCommandOutput | UpdateRetrieverCommandOutput | UpdateUserCommandOutput | UpdateWebExperienceCommandOutput;
+/**
+ * @public
+ */
+export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
+    /**
+     * The HTTP handler to use. Fetch in browser and Https in Nodejs.
+     */
+    requestHandler?: __HttpHandler;
+    /**
+     * A constructor for a class implementing the {@link @smithy/types#ChecksumConstructor} interface
+     * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
+     * @internal
+     */
+    sha256?: __ChecksumConstructor | __HashConstructor;
+    /**
+     * The function that will be used to convert strings into HTTP endpoints.
+     * @internal
+     */
+    urlParser?: __UrlParser;
+    /**
+     * A function that can calculate the length of a request body.
+     * @internal
+     */
+    bodyLengthChecker?: __BodyLengthCalculator;
+    /**
+     * A function that converts a stream into an array of bytes.
+     * @internal
+     */
+    streamCollector?: __StreamCollector;
+    /**
+     * The function that will be used to convert a base64-encoded string to a byte array.
+     * @internal
+     */
+    base64Decoder?: __Decoder;
+    /**
+     * The function that will be used to convert binary data to a base64-encoded string.
+     * @internal
+     */
+    base64Encoder?: __Encoder;
+    /**
+     * The function that will be used to convert a UTF8-encoded string to a byte array.
+     * @internal
+     */
+    utf8Decoder?: __Decoder;
+    /**
+     * The function that will be used to convert binary data to a UTF-8 encoded string.
+     * @internal
+     */
+    utf8Encoder?: __Encoder;
+    /**
+     * The runtime environment.
+     * @internal
+     */
+    runtime?: string;
+    /**
+     * Disable dynamically changing the endpoint of the client based on the hostPrefix
+     * trait of an operation.
+     */
+    disableHostPrefix?: boolean;
+    /**
+     * Unique service identifier.
+     * @internal
+     */
+    serviceId?: string;
+    /**
+     * Enables IPv6/IPv4 dualstack endpoint.
+     */
+    useDualstackEndpoint?: boolean | __Provider<boolean>;
+    /**
+     * Enables FIPS compatible endpoints.
+     */
+    useFipsEndpoint?: boolean | __Provider<boolean>;
+    /**
+     * The AWS region to which this client will send requests
+     */
+    region?: string | __Provider<string>;
+    /**
+     * Default credentials provider; Not available in browser runtime.
+     * @internal
+     */
+    credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
+    /**
+     * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
+     * @internal
+     */
+    defaultUserAgentProvider?: Provider<__UserAgent>;
+    /**
+     * Value for how many times a request will be made at most in case of retry.
+     */
+    maxAttempts?: number | __Provider<number>;
+    /**
+     * Specifies which retry algorithm to use.
+     * @see https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-smithy-util-retry/Enum/RETRY_MODES/
+     *
+     */
+    retryMode?: string | __Provider<string>;
+    /**
+     * Optional logger for logging debug/info/warn/error.
+     */
+    logger?: __Logger;
+    /**
+     * Optional extensions
+     */
+    extensions?: RuntimeExtension[];
+    /**
+     * The {@link @smithy/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     */
+    defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
+}
+/**
+ * @public
+ */
+export type QBusinessClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
+/**
+ * @public
+ *
+ *  The configuration interface of QBusinessClient class constructor that set the region, credentials and other options.
+ */
+export interface QBusinessClientConfig extends QBusinessClientConfigType {
+}
+/**
+ * @public
+ */
+export type QBusinessClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RuntimeExtensionsConfig & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
+/**
+ * @public
+ *
+ *  The resolved configuration interface of QBusinessClient class. This is resolved and normalized from the {@link QBusinessClientConfig | constructor configuration interface}.
+ */
+export interface QBusinessClientResolvedConfig extends QBusinessClientResolvedConfigType {
+}
+/**
+ * @public
+ * <p>
+ *         </p>
+ */
+export declare class QBusinessClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, QBusinessClientResolvedConfig> {
+    /**
+     * The resolved configuration of QBusinessClient class. This is resolved and normalized from the {@link QBusinessClientConfig | constructor configuration interface}.
+     */
+    readonly config: QBusinessClientResolvedConfig;
+    constructor(...[configuration]: __CheckOptionalClientConfig<QBusinessClientConfig>);
+    /**
+     * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+     * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+     * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+     */
+    destroy(): void;
+}

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

@@ -0,0 +1,116 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { BatchDeleteDocumentRequest, BatchDeleteDocumentResponse } from "../models/models_0";
+import { QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QBusinessClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link BatchDeleteDocumentCommand}.
+ */
+export interface BatchDeleteDocumentCommandInput extends BatchDeleteDocumentRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link BatchDeleteDocumentCommand}.
+ */
+export interface BatchDeleteDocumentCommandOutput extends BatchDeleteDocumentResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Asynchronously deletes one or more documents added using the
+ *                 <code>BatchPutDocument</code> API from an Amazon Q 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
+ * import { QBusinessClient, BatchDeleteDocumentCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
+ * // const { QBusinessClient, BatchDeleteDocumentCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
+ * const client = new QBusinessClient(config);
+ * const input = { // BatchDeleteDocumentRequest
+ *   applicationId: "STRING_VALUE", // required
+ *   indexId: "STRING_VALUE", // required
+ *   documents: [ // DeleteDocuments // required
+ *     { // DeleteDocument
+ *       documentId: "STRING_VALUE", // required
+ *     },
+ *   ],
+ *   dataSourceSyncId: "STRING_VALUE",
+ * };
+ * const command = new BatchDeleteDocumentCommand(input);
+ * const response = await client.send(command);
+ * // { // BatchDeleteDocumentResponse
+ * //   failedDocuments: [ // FailedDocuments
+ * //     { // FailedDocument
+ * //       id: "STRING_VALUE",
+ * //       error: { // ErrorDetail
+ * //         errorMessage: "STRING_VALUE",
+ * //         errorCode: "InternalError" || "InvalidRequest" || "ResourceInactive" || "ResourceNotFound",
+ * //       },
+ * //       dataSourceId: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param BatchDeleteDocumentCommandInput - {@link BatchDeleteDocumentCommandInput}
+ * @returns {@link BatchDeleteDocumentCommandOutput}
+ * @see {@link BatchDeleteDocumentCommandInput} for command's `input` shape.
+ * @see {@link BatchDeleteDocumentCommandOutput} for command's `response` shape.
+ * @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>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>You are trying to perform an action that conflicts with the current status of your
+ *             resource. Fix any inconsistences 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 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 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>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input doesn't meet the constraints set by the Amazon Q service. Provide the
+ *             correct input and try again.</p>
+ *
+ * @throws {@link QBusinessServiceException}
+ * <p>Base exception class for all service exceptions from QBusiness service.</p>
+ *
+ */
+export declare class BatchDeleteDocumentCommand extends $Command<BatchDeleteDocumentCommandInput, BatchDeleteDocumentCommandOutput, QBusinessClientResolvedConfig> {
+    readonly input: BatchDeleteDocumentCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: BatchDeleteDocumentCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QBusinessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchDeleteDocumentCommandInput, BatchDeleteDocumentCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,228 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { BatchPutDocumentRequest, BatchPutDocumentResponse } from "../models/models_0";
+import { QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QBusinessClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link BatchPutDocumentCommand}.
+ */
+export interface BatchPutDocumentCommandInput extends BatchPutDocumentRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link BatchPutDocumentCommand}.
+ */
+export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Adds one or more documents to an Amazon Q 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 index.</p>
+ *             </li>
+ *             <li>
+ *                <p>add custom attributes to documents in an Amazon Q index.</p>
+ *             </li>
+ *             <li>
+ *                <p>attach an access control list to the documents added to an Amazon Q
+ *                     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
+ * import { QBusinessClient, BatchPutDocumentCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
+ * // const { QBusinessClient, BatchPutDocumentCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
+ * const client = new QBusinessClient(config);
+ * const input = { // BatchPutDocumentRequest
+ *   applicationId: "STRING_VALUE", // required
+ *   indexId: "STRING_VALUE", // required
+ *   documents: [ // Documents // required
+ *     { // Document
+ *       id: "STRING_VALUE", // required
+ *       attributes: [ // DocumentAttributes
+ *         { // DocumentAttribute
+ *           name: "STRING_VALUE", // required
+ *           value: { // DocumentAttributeValue Union: only one key present
+ *             stringValue: "STRING_VALUE",
+ *             stringListValue: [ // DocumentAttributeStringListValue
+ *               "STRING_VALUE",
+ *             ],
+ *             longValue: Number("long"),
+ *             dateValue: new Date("TIMESTAMP"),
+ *           },
+ *         },
+ *       ],
+ *       content: { // DocumentContent Union: only one key present
+ *         blob: "BLOB_VALUE",
+ *         s3: { // S3
+ *           bucket: "STRING_VALUE", // required
+ *           key: "STRING_VALUE", // required
+ *         },
+ *       },
+ *       contentType: "PDF" || "HTML" || "MS_WORD" || "PLAIN_TEXT" || "PPT" || "RTF" || "XML" || "XSLT" || "MS_EXCEL" || "CSV" || "JSON" || "MD",
+ *       title: "STRING_VALUE",
+ *       accessConfiguration: { // AccessConfiguration
+ *         accessControls: [ // AccessControls // required
+ *           { // AccessControl
+ *             principals: [ // Principals // required
+ *               { // Principal Union: only one key present
+ *                 user: { // PrincipalUser
+ *                   id: "STRING_VALUE",
+ *                   access: "ALLOW" || "DENY", // required
+ *                   membershipType: "INDEX" || "DATASOURCE",
+ *                 },
+ *                 group: { // PrincipalGroup
+ *                   name: "STRING_VALUE",
+ *                   access: "ALLOW" || "DENY", // required
+ *                   membershipType: "INDEX" || "DATASOURCE",
+ *                 },
+ *               },
+ *             ],
+ *             memberRelation: "AND" || "OR",
+ *           },
+ *         ],
+ *         memberRelation: "AND" || "OR",
+ *       },
+ *       documentEnrichmentConfiguration: { // DocumentEnrichmentConfiguration
+ *         inlineConfigurations: [ // InlineDocumentEnrichmentConfigurations
+ *           { // InlineDocumentEnrichmentConfiguration
+ *             condition: { // DocumentAttributeCondition
+ *               key: "STRING_VALUE", // required
+ *               operator: "GREATER_THAN" || "GREATER_THAN_OR_EQUALS" || "LESS_THAN" || "LESS_THAN_OR_EQUALS" || "EQUALS" || "NOT_EQUALS" || "CONTAINS" || "NOT_CONTAINS" || "EXISTS" || "NOT_EXISTS" || "BEGINS_WITH", // required
+ *               value: {//  Union: only one key present
+ *                 stringValue: "STRING_VALUE",
+ *                 stringListValue: [
+ *                   "STRING_VALUE",
+ *                 ],
+ *                 longValue: Number("long"),
+ *                 dateValue: new Date("TIMESTAMP"),
+ *               },
+ *             },
+ *             target: { // DocumentAttributeTarget
+ *               key: "STRING_VALUE", // required
+ *               value: {//  Union: only one key present
+ *                 stringValue: "STRING_VALUE",
+ *                 stringListValue: [
+ *                   "STRING_VALUE",
+ *                 ],
+ *                 longValue: Number("long"),
+ *                 dateValue: new Date("TIMESTAMP"),
+ *               },
+ *               attributeValueOperator: "DELETE",
+ *             },
+ *             documentContentOperator: "DELETE",
+ *           },
+ *         ],
+ *         preExtractionHookConfiguration: { // HookConfiguration
+ *           invocationCondition: {
+ *             key: "STRING_VALUE", // required
+ *             operator: "GREATER_THAN" || "GREATER_THAN_OR_EQUALS" || "LESS_THAN" || "LESS_THAN_OR_EQUALS" || "EQUALS" || "NOT_EQUALS" || "CONTAINS" || "NOT_CONTAINS" || "EXISTS" || "NOT_EXISTS" || "BEGINS_WITH", // required
+ *             value: "<DocumentAttributeValue>",
+ *           },
+ *           lambdaArn: "STRING_VALUE",
+ *           s3BucketName: "STRING_VALUE",
+ *           roleArn: "STRING_VALUE",
+ *         },
+ *         postExtractionHookConfiguration: {
+ *           invocationCondition: {
+ *             key: "STRING_VALUE", // required
+ *             operator: "GREATER_THAN" || "GREATER_THAN_OR_EQUALS" || "LESS_THAN" || "LESS_THAN_OR_EQUALS" || "EQUALS" || "NOT_EQUALS" || "CONTAINS" || "NOT_CONTAINS" || "EXISTS" || "NOT_EXISTS" || "BEGINS_WITH", // required
+ *             value: "<DocumentAttributeValue>",
+ *           },
+ *           lambdaArn: "STRING_VALUE",
+ *           s3BucketName: "STRING_VALUE",
+ *           roleArn: "STRING_VALUE",
+ *         },
+ *       },
+ *     },
+ *   ],
+ *   roleArn: "STRING_VALUE",
+ *   dataSourceSyncId: "STRING_VALUE",
+ * };
+ * const command = new BatchPutDocumentCommand(input);
+ * const response = await client.send(command);
+ * // { // BatchPutDocumentResponse
+ * //   failedDocuments: [ // FailedDocuments
+ * //     { // FailedDocument
+ * //       id: "STRING_VALUE",
+ * //       error: { // ErrorDetail
+ * //         errorMessage: "STRING_VALUE",
+ * //         errorCode: "InternalError" || "InvalidRequest" || "ResourceInactive" || "ResourceNotFound",
+ * //       },
+ * //       dataSourceId: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param BatchPutDocumentCommandInput - {@link BatchPutDocumentCommandInput}
+ * @returns {@link BatchPutDocumentCommandOutput}
+ * @see {@link BatchPutDocumentCommandInput} for command's `input` shape.
+ * @see {@link BatchPutDocumentCommandOutput} for command's `response` shape.
+ * @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>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>You are trying to perform an action that conflicts with the current status of your
+ *             resource. Fix any inconsistences 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 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 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 service. </p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <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 service. Provide the
+ *             correct input and try again.</p>
+ *
+ * @throws {@link QBusinessServiceException}
+ * <p>Base exception class for all service exceptions from QBusiness service.</p>
+ *
+ */
+export declare class BatchPutDocumentCommand extends $Command<BatchPutDocumentCommandInput, BatchPutDocumentCommandOutput, QBusinessClientResolvedConfig> {
+    readonly input: BatchPutDocumentCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: BatchPutDocumentCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QBusinessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchPutDocumentCommandInput, BatchPutDocumentCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}