@aws-sdk/client-qbusiness 3.461.0

package/dist-types/commands/GetWebExperienceCommand.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 { GetWebExperienceRequest, GetWebExperienceResponse } from "../models/models_0";
+import { QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QBusinessClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetWebExperienceCommand}.
+ */
+export interface GetWebExperienceCommandInput extends GetWebExperienceRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetWebExperienceCommand}.
+ */
+export interface GetWebExperienceCommandOutput extends GetWebExperienceResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Gets information about an existing Amazon Q web experience.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QBusinessClient, GetWebExperienceCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
+ * // const { QBusinessClient, GetWebExperienceCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
+ * const client = new QBusinessClient(config);
+ * const input = { // GetWebExperienceRequest
+ *   applicationId: "STRING_VALUE", // required
+ *   webExperienceId: "STRING_VALUE", // required
+ * };
+ * const command = new GetWebExperienceCommand(input);
+ * const response = await client.send(command);
+ * // { // GetWebExperienceResponse
+ * //   applicationId: "STRING_VALUE",
+ * //   webExperienceId: "STRING_VALUE",
+ * //   webExperienceArn: "STRING_VALUE",
+ * //   defaultEndpoint: "STRING_VALUE",
+ * //   status: "CREATING" || "ACTIVE" || "DELETING" || "FAILED" || "PENDING_AUTH_CONFIG",
+ * //   createdAt: new Date("TIMESTAMP"),
+ * //   updatedAt: new Date("TIMESTAMP"),
+ * //   title: "STRING_VALUE",
+ * //   subtitle: "STRING_VALUE",
+ * //   welcomeMessage: "STRING_VALUE",
+ * //   samplePromptsControlMode: "ENABLED" || "DISABLED",
+ * //   authenticationConfiguration: { // WebExperienceAuthConfiguration Union: only one key present
+ * //     samlConfiguration: { // SamlConfiguration
+ * //       metadataXML: "STRING_VALUE", // required
+ * //       roleArn: "STRING_VALUE", // required
+ * //       userIdAttribute: "STRING_VALUE", // required
+ * //       userGroupAttribute: "STRING_VALUE",
+ * //     },
+ * //   },
+ * //   error: { // ErrorDetail
+ * //     errorMessage: "STRING_VALUE",
+ * //     errorCode: "InternalError" || "InvalidRequest" || "ResourceInactive" || "ResourceNotFound",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetWebExperienceCommandInput - {@link GetWebExperienceCommandInput}
+ * @returns {@link GetWebExperienceCommandOutput}
+ * @see {@link GetWebExperienceCommandInput} for command's `input` shape.
+ * @see {@link GetWebExperienceCommandOutput} 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 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 GetWebExperienceCommand extends $Command<GetWebExperienceCommandInput, GetWebExperienceCommandOutput, QBusinessClientResolvedConfig> {
+    readonly input: GetWebExperienceCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: GetWebExperienceCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QBusinessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetWebExperienceCommandInput, GetWebExperienceCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,99 @@
+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 { ListApplicationsRequest, ListApplicationsResponse } from "../models/models_0";
+import { QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QBusinessClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListApplicationsCommand}.
+ */
+export interface ListApplicationsCommandInput extends ListApplicationsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListApplicationsCommand}.
+ */
+export interface ListApplicationsCommandOutput extends ListApplicationsResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Lists Amazon Q applications.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QBusinessClient, ListApplicationsCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
+ * // const { QBusinessClient, ListApplicationsCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
+ * const client = new QBusinessClient(config);
+ * const input = { // ListApplicationsRequest
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ * };
+ * const command = new ListApplicationsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListApplicationsResponse
+ * //   nextToken: "STRING_VALUE",
+ * //   applications: [ // Applications
+ * //     { // Application
+ * //       displayName: "STRING_VALUE",
+ * //       applicationId: "STRING_VALUE",
+ * //       createdAt: new Date("TIMESTAMP"),
+ * //       updatedAt: new Date("TIMESTAMP"),
+ * //       status: "CREATING" || "ACTIVE" || "DELETING" || "FAILED" || "UPDATING",
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param ListApplicationsCommandInput - {@link ListApplicationsCommandInput}
+ * @returns {@link ListApplicationsCommandOutput}
+ * @see {@link ListApplicationsCommandInput} for command's `input` shape.
+ * @see {@link ListApplicationsCommandOutput} 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 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 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 ListApplicationsCommand extends $Command<ListApplicationsCommandInput, ListApplicationsCommandOutput, QBusinessClientResolvedConfig> {
+    readonly input: ListApplicationsCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: ListApplicationsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QBusinessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListApplicationsCommandInput, ListApplicationsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,107 @@
+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 { ListConversationsRequest, ListConversationsResponse } from "../models/models_0";
+import { QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QBusinessClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListConversationsCommand}.
+ */
+export interface ListConversationsCommandInput extends ListConversationsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListConversationsCommand}.
+ */
+export interface ListConversationsCommandOutput extends ListConversationsResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Lists one or more Amazon Q conversations.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QBusinessClient, ListConversationsCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
+ * // const { QBusinessClient, ListConversationsCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
+ * const client = new QBusinessClient(config);
+ * const input = { // ListConversationsRequest
+ *   applicationId: "STRING_VALUE", // required
+ *   userId: "STRING_VALUE", // required
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ * };
+ * const command = new ListConversationsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListConversationsResponse
+ * //   nextToken: "STRING_VALUE",
+ * //   conversations: [ // Conversations
+ * //     { // Conversation
+ * //       conversationId: "STRING_VALUE",
+ * //       title: "STRING_VALUE",
+ * //       startTime: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param ListConversationsCommandInput - {@link ListConversationsCommandInput}
+ * @returns {@link ListConversationsCommandOutput}
+ * @see {@link ListConversationsCommandInput} for command's `input` shape.
+ * @see {@link ListConversationsCommandOutput} 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 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 LicenseNotFoundException} (client fault)
+ *  <p>You don't have permissions to perform the action because your license is inactive. Ask
+ *             your admin to activate your license and try again after your licence is active.</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 ListConversationsCommand extends $Command<ListConversationsCommandInput, ListConversationsCommandOutput, QBusinessClientResolvedConfig> {
+    readonly input: ListConversationsCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: ListConversationsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QBusinessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListConversationsCommandInput, ListConversationsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,120 @@
+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 { ListDataSourceSyncJobsRequest, ListDataSourceSyncJobsResponse } from "../models/models_0";
+import { QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QBusinessClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListDataSourceSyncJobsCommand}.
+ */
+export interface ListDataSourceSyncJobsCommandInput extends ListDataSourceSyncJobsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListDataSourceSyncJobsCommand}.
+ */
+export interface ListDataSourceSyncJobsCommandOutput extends ListDataSourceSyncJobsResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Get information about an Amazon Q data source connector synchronization.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QBusinessClient, ListDataSourceSyncJobsCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
+ * // const { QBusinessClient, ListDataSourceSyncJobsCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
+ * const client = new QBusinessClient(config);
+ * const input = { // ListDataSourceSyncJobsRequest
+ *   dataSourceId: "STRING_VALUE", // required
+ *   applicationId: "STRING_VALUE", // required
+ *   indexId: "STRING_VALUE", // required
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ *   startTime: new Date("TIMESTAMP"),
+ *   endTime: new Date("TIMESTAMP"),
+ *   statusFilter: "FAILED" || "SUCCEEDED" || "SYNCING" || "INCOMPLETE" || "STOPPING" || "ABORTED" || "SYNCING_INDEXING",
+ * };
+ * const command = new ListDataSourceSyncJobsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListDataSourceSyncJobsResponse
+ * //   history: [ // DataSourceSyncJobs
+ * //     { // DataSourceSyncJob
+ * //       executionId: "STRING_VALUE",
+ * //       startTime: new Date("TIMESTAMP"),
+ * //       endTime: new Date("TIMESTAMP"),
+ * //       status: "FAILED" || "SUCCEEDED" || "SYNCING" || "INCOMPLETE" || "STOPPING" || "ABORTED" || "SYNCING_INDEXING",
+ * //       error: { // ErrorDetail
+ * //         errorMessage: "STRING_VALUE",
+ * //         errorCode: "InternalError" || "InvalidRequest" || "ResourceInactive" || "ResourceNotFound",
+ * //       },
+ * //       dataSourceErrorCode: "STRING_VALUE",
+ * //       metrics: { // DataSourceSyncJobMetrics
+ * //         documentsAdded: "STRING_VALUE",
+ * //         documentsModified: "STRING_VALUE",
+ * //         documentsDeleted: "STRING_VALUE",
+ * //         documentsFailed: "STRING_VALUE",
+ * //         documentsScanned: "STRING_VALUE",
+ * //       },
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListDataSourceSyncJobsCommandInput - {@link ListDataSourceSyncJobsCommandInput}
+ * @returns {@link ListDataSourceSyncJobsCommandOutput}
+ * @see {@link ListDataSourceSyncJobsCommandInput} for command's `input` shape.
+ * @see {@link ListDataSourceSyncJobsCommandOutput} 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 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 ListDataSourceSyncJobsCommand extends $Command<ListDataSourceSyncJobsCommandInput, ListDataSourceSyncJobsCommandOutput, QBusinessClientResolvedConfig> {
+    readonly input: ListDataSourceSyncJobsCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: ListDataSourceSyncJobsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QBusinessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListDataSourceSyncJobsCommandInput, ListDataSourceSyncJobsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,106 @@
+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 { ListDataSourcesRequest, ListDataSourcesResponse } from "../models/models_0";
+import { QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QBusinessClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListDataSourcesCommand}.
+ */
+export interface ListDataSourcesCommandInput extends ListDataSourcesRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListDataSourcesCommand}.
+ */
+export interface ListDataSourcesCommandOutput extends ListDataSourcesResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Lists the Amazon Q data source connectors that you have created.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QBusinessClient, ListDataSourcesCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
+ * // const { QBusinessClient, ListDataSourcesCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
+ * const client = new QBusinessClient(config);
+ * const input = { // ListDataSourcesRequest
+ *   applicationId: "STRING_VALUE", // required
+ *   indexId: "STRING_VALUE", // required
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ * };
+ * const command = new ListDataSourcesCommand(input);
+ * const response = await client.send(command);
+ * // { // ListDataSourcesResponse
+ * //   dataSources: [ // DataSources
+ * //     { // DataSource
+ * //       displayName: "STRING_VALUE",
+ * //       dataSourceId: "STRING_VALUE",
+ * //       type: "STRING_VALUE",
+ * //       createdAt: new Date("TIMESTAMP"),
+ * //       updatedAt: new Date("TIMESTAMP"),
+ * //       status: "PENDING_CREATION" || "CREATING" || "ACTIVE" || "DELETING" || "FAILED" || "UPDATING",
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListDataSourcesCommandInput - {@link ListDataSourcesCommandInput}
+ * @returns {@link ListDataSourcesCommandOutput}
+ * @see {@link ListDataSourcesCommandInput} for command's `input` shape.
+ * @see {@link ListDataSourcesCommandOutput} 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 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 ListDataSourcesCommand extends $Command<ListDataSourcesCommandInput, ListDataSourcesCommandOutput, QBusinessClientResolvedConfig> {
+    readonly input: ListDataSourcesCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: ListDataSourcesCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QBusinessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListDataSourcesCommandInput, ListDataSourcesCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,111 @@
+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 { ListDocumentsRequest, ListDocumentsResponse } from "../models/models_0";
+import { QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QBusinessClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListDocumentsCommand}.
+ */
+export interface ListDocumentsCommandInput extends ListDocumentsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListDocumentsCommand}.
+ */
+export interface ListDocumentsCommandOutput extends ListDocumentsResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>A list of documents attached to an index.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QBusinessClient, ListDocumentsCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
+ * // const { QBusinessClient, ListDocumentsCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
+ * const client = new QBusinessClient(config);
+ * const input = { // ListDocumentsRequest
+ *   applicationId: "STRING_VALUE", // required
+ *   indexId: "STRING_VALUE", // required
+ *   dataSourceIds: [ // DataSourceIds
+ *     "STRING_VALUE",
+ *   ],
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ * };
+ * const command = new ListDocumentsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListDocumentsResponse
+ * //   documentDetailList: [ // DocumentDetailList
+ * //     { // DocumentDetails
+ * //       documentId: "STRING_VALUE",
+ * //       status: "RECEIVED" || "PROCESSING" || "INDEXED" || "UPDATED" || "FAILED" || "DELETING" || "DELETED" || "DOCUMENT_FAILED_TO_INDEX",
+ * //       error: { // ErrorDetail
+ * //         errorMessage: "STRING_VALUE",
+ * //         errorCode: "InternalError" || "InvalidRequest" || "ResourceInactive" || "ResourceNotFound",
+ * //       },
+ * //       createdAt: new Date("TIMESTAMP"),
+ * //       updatedAt: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListDocumentsCommandInput - {@link ListDocumentsCommandInput}
+ * @returns {@link ListDocumentsCommandOutput}
+ * @see {@link ListDocumentsCommandInput} for command's `input` shape.
+ * @see {@link ListDocumentsCommandOutput} 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 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 ListDocumentsCommand extends $Command<ListDocumentsCommandInput, ListDocumentsCommandOutput, QBusinessClientResolvedConfig> {
+    readonly input: ListDocumentsCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: ListDocumentsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QBusinessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListDocumentsCommandInput, ListDocumentsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}