+
+ +## Installing + +To install the this package, simply type add or install @aws-sdk/client-qbusiness +using your favorite package manager: + +- `npm install @aws-sdk/client-qbusiness` +- `yarn add @aws-sdk/client-qbusiness` +- `pnpm add @aws-sdk/client-qbusiness` + +## Getting Started + +### Import + +The AWS SDK is modulized by clients and commands. +To send a request, you only need to import the `QBusinessClient` and +the commands you need, for example `ListApplicationsCommand`: + +```js +// ES5 example +const { QBusinessClient, ListApplicationsCommand } = require("@aws-sdk/client-qbusiness"); +``` + +```ts +// ES6+ example +import { QBusinessClient, ListApplicationsCommand } from "@aws-sdk/client-qbusiness"; +``` + +### Usage + +To send a request, you: + +- Initiate client with configuration (e.g. credentials, region). +- Initiate command with input parameters. +- Call `send` operation on client with command object as input. +- If you are using a custom http handler, you may call `destroy()` to close open connections. + +```js +// a client can be shared by different commands. +const client = new QBusinessClient({ region: "REGION" }); + +const params = { + /** input parameters */ +}; +const command = new ListApplicationsCommand(params); +``` + +#### Async/await + +We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await) +operator to wait for the promise returned by send operation as follows: + +```js +// async/await. +try { + const data = await client.send(command); + // process data. +} catch (error) { + // error handling. +} finally { + // finally. +} +``` + +Async-await is clean, concise, intuitive, easy to debug and has better error handling +as compared to using Promise chains or callbacks. + +#### Promises + +You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining) +to execute send operation. + +```js +client.send(command).then( + (data) => { + // process data. + }, + (error) => { + // error handling. + } +); +``` + +Promises can also be called using `.catch()` and `.finally()` as follows: + +```js +client + .send(command) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }) + .finally(() => { + // finally. + }); +``` + +#### Callbacks + +We do not recommend using callbacks because of [callback hell](http://callbackhell.com/), +but they are supported by the send operation. + +```js +// callbacks. +client.send(command, (err, data) => { + // process err and data. +}); +``` + +#### v2 compatible style + +The client can also send requests using v2 compatible style. +However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post +on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/) + +```ts +import * as AWS from "@aws-sdk/client-qbusiness"; +const client = new AWS.QBusiness({ region: "REGION" }); + +// async/await. +try { + const data = await client.listApplications(params); + // process data. +} catch (error) { + // error handling. +} + +// Promises. +client + .listApplications(params) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }); + +// callbacks. +client.listApplications(params, (err, data) => { + // process err and data. +}); +``` + +### Troubleshooting + +When the service returns an exception, the error will include the exception information, +as well as response metadata (e.g. request id). + +```js +try { + const data = await client.send(command); + // process data. +} catch (error) { + const { requestId, cfId, extendedRequestId } = error.$metadata; + console.log({ requestId, cfId, extendedRequestId }); + /** + * The keys within exceptions are also parsed. + * You can access them by specifying exception names: + * if (error.name === 'SomeServiceException') { + * const value = error.specialKeyInException; + * } + */ +} +``` + +## Getting Help + +Please use these community resources for getting help. +We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them. + +- Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html) + or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html). +- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/) + on AWS Developer Blog. +- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`. +- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3). +- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose). + +To test your universal JavaScript code in Node.js, browser and react-native environments, +visit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests). + +## Contributing + +This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-qbusiness` package is updated. +To contribute to client you can check our [generate clients scripts](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients). + +## License + +This SDK is distributed under the +[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0), +see LICENSE for more information. + +## Client Commands (Operations List) + ++ *
+ */ +export class QBusiness extends QBusinessClient implements QBusiness {} +createAggregatedClient(commands, QBusiness); diff --git a/clients/client-qbusiness/src/QBusinessClient.ts b/clients/client-qbusiness/src/QBusinessClient.ts new file mode 100644 index 000000000000..67d068cef4c4 --- /dev/null +++ b/clients/client-qbusiness/src/QBusinessClient.ts @@ -0,0 +1,487 @@ +// smithy-typescript generated code +import { + getHostHeaderPlugin, + HostHeaderInputConfig, + HostHeaderResolvedConfig, + resolveHostHeaderConfig, +} from "@aws-sdk/middleware-host-header"; +import { getLoggerPlugin } from "@aws-sdk/middleware-logger"; +import { getRecursionDetectionPlugin } from "@aws-sdk/middleware-recursion-detection"; +import { + AwsAuthInputConfig, + AwsAuthResolvedConfig, + getAwsAuthPlugin, + resolveAwsAuthConfig, +} from "@aws-sdk/middleware-signing"; +import { + getUserAgentPlugin, + resolveUserAgentConfig, + UserAgentInputConfig, + UserAgentResolvedConfig, +} from "@aws-sdk/middleware-user-agent"; +import { Credentials as __Credentials } from "@aws-sdk/types"; +import { RegionInputConfig, RegionResolvedConfig, resolveRegionConfig } from "@smithy/config-resolver"; +import { getContentLengthPlugin } from "@smithy/middleware-content-length"; +import { EndpointInputConfig, EndpointResolvedConfig, resolveEndpointConfig } from "@smithy/middleware-endpoint"; +import { getRetryPlugin, resolveRetryConfig, 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, + Checksum as __Checksum, + ChecksumConstructor as __ChecksumConstructor, + Decoder as __Decoder, + Encoder as __Encoder, + EndpointV2 as __EndpointV2, + Hash as __Hash, + 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, + resolveClientEndpointParameters, +} from "./endpoint/EndpointParameters"; +import { getRuntimeConfig as __getRuntimeConfig } from "./runtimeConfig"; +import { resolveRuntimeExtensions, 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+ *
+ */ +export 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]: __CheckOptionalClientConfigAsynchronously deletes one or more documents added using the
+ * BatchPutDocument API from an Amazon Q index.
You can see the progress of the deletion, and any error messages related to the + * process, by using CloudWatch.
+ * @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) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link ConflictException} (client fault) + *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.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class BatchDeleteDocumentCommand extends $Command< + BatchDeleteDocumentCommandInput, + BatchDeleteDocumentCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: BatchDeleteDocumentCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackAdds one or more documents to an Amazon Q index.
+ *You use this API to:
+ *ingest your structured and unstructured documents and documents stored in an + * Amazon S3 bucket into an Amazon Q index.
+ *add custom attributes to documents in an Amazon Q index.
+ *attach an access control list to the documents added to an Amazon Q + * index.
+ *You can see the progress of the deletion, and any error messages related to the + * process, by using CloudWatch.
+ * @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: "You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link ConflictException} (client fault) + *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.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *You have exceeded the set limits for your Amazon Q service.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class BatchPutDocumentCommand extends $Command< + BatchPutDocumentCommandInput, + BatchPutDocumentCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: BatchPutDocumentCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackStarts or continues a non-streaming Amazon Q conversation.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, ChatSyncCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, ChatSyncCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // ChatSyncInput + * applicationId: "STRING_VALUE", // required + * userId: "STRING_VALUE", // required + * userGroups: [ // UserGroups + * "STRING_VALUE", + * ], + * userMessage: "STRING_VALUE", + * attachments: [ // AttachmentsInput + * { // AttachmentInput + * name: "STRING_VALUE", // required + * data: "BLOB_VALUE", // required + * }, + * ], + * actionExecution: { // ActionExecution + * pluginId: "STRING_VALUE", // required + * payload: { // ActionExecutionPayload // required + * "You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link ConflictException} (client fault) + *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.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link LicenseNotFoundException} (client fault) + *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.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class ChatSyncCommand extends $Command< + ChatSyncCommandInput, + ChatSyncCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ChatSyncCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCreates an Amazon Q application.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, CreateApplicationCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, CreateApplicationCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // CreateApplicationRequest + * displayName: "STRING_VALUE", // required + * roleArn: "STRING_VALUE", // required + * description: "STRING_VALUE", + * encryptionConfiguration: { // EncryptionConfiguration + * kmsKeyId: "STRING_VALUE", + * }, + * tags: [ // Tags + * { // Tag + * key: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * ], + * clientToken: "STRING_VALUE", + * attachmentsConfiguration: { // AttachmentsConfiguration + * attachmentsControlMode: "ENABLED" || "DISABLED", // required + * }, + * }; + * const command = new CreateApplicationCommand(input); + * const response = await client.send(command); + * // { // CreateApplicationResponse + * // applicationId: "STRING_VALUE", + * // applicationArn: "STRING_VALUE", + * // }; + * + * ``` + * + * @param CreateApplicationCommandInput - {@link CreateApplicationCommandInput} + * @returns {@link CreateApplicationCommandOutput} + * @see {@link CreateApplicationCommandInput} for command's `input` shape. + * @see {@link CreateApplicationCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link ConflictException} (client fault) + *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.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *You have exceeded the set limits for your Amazon Q service.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class CreateApplicationCommand extends $Command< + CreateApplicationCommandInput, + CreateApplicationCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CreateApplicationCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCreates a data source connector for an Amazon Q application.
+ *
+ * CreateDataSource is a synchronous operation. The operation returns 200 if
+ * the data source was successfully created. Otherwise, an exception is raised.
You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link ConflictException} (client fault) + *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.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *You have exceeded the set limits for your Amazon Q service.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class CreateDataSourceCommand extends $Command< + CreateDataSourceCommandInput, + CreateDataSourceCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CreateDataSourceCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCreates an Amazon Q index.
+ *To determine if index creation has completed, check the Status field
+ * returned from a call to DescribeIndex. The Status field is set
+ * to ACTIVE when the index is ready to use.
Once the index is active, you can index your documents using the
+ * BatchPutDocument
+ * API or the
+ * CreateDataSource
+ * API.
You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link ConflictException} (client fault) + *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.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *You have exceeded the set limits for your Amazon Q service.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class CreateIndexCommand extends $Command< + CreateIndexCommandInput, + CreateIndexCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CreateIndexCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCreates an Amazon Q plugin.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, CreatePluginCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, CreatePluginCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // CreatePluginRequest + * applicationId: "STRING_VALUE", // required + * displayName: "STRING_VALUE", // required + * type: "SERVICE_NOW" || "SALESFORCE" || "JIRA" || "ZENDESK", // required + * serverUrl: "STRING_VALUE", // required + * authConfiguration: { // PluginAuthConfiguration Union: only one key present + * basicAuthConfiguration: { // BasicAuthConfiguration + * secretArn: "STRING_VALUE", // required + * roleArn: "STRING_VALUE", // required + * }, + * oAuth2ClientCredentialConfiguration: { // OAuth2ClientCredentialConfiguration + * secretArn: "STRING_VALUE", // required + * roleArn: "STRING_VALUE", // required + * }, + * }, + * tags: [ // Tags + * { // Tag + * key: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * ], + * clientToken: "STRING_VALUE", + * }; + * const command = new CreatePluginCommand(input); + * const response = await client.send(command); + * // { // CreatePluginResponse + * // pluginId: "STRING_VALUE", + * // pluginArn: "STRING_VALUE", + * // }; + * + * ``` + * + * @param CreatePluginCommandInput - {@link CreatePluginCommandInput} + * @returns {@link CreatePluginCommandOutput} + * @see {@link CreatePluginCommandInput} for command's `input` shape. + * @see {@link CreatePluginCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link ConflictException} (client fault) + *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.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *You have exceeded the set limits for your Amazon Q service.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class CreatePluginCommand extends $Command< + CreatePluginCommandInput, + CreatePluginCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CreatePluginCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackAdds a retriever to your Amazon Q application.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, CreateRetrieverCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, CreateRetrieverCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // CreateRetrieverRequest + * applicationId: "STRING_VALUE", // required + * type: "NATIVE_INDEX" || "KENDRA_INDEX", // required + * displayName: "STRING_VALUE", // required + * configuration: { // RetrieverConfiguration Union: only one key present + * nativeIndexConfiguration: { // NativeIndexConfiguration + * indexId: "STRING_VALUE", // required + * }, + * kendraIndexConfiguration: { // KendraIndexConfiguration + * indexId: "STRING_VALUE", // required + * }, + * }, + * roleArn: "STRING_VALUE", + * clientToken: "STRING_VALUE", + * tags: [ // Tags + * { // Tag + * key: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * ], + * }; + * const command = new CreateRetrieverCommand(input); + * const response = await client.send(command); + * // { // CreateRetrieverResponse + * // retrieverId: "STRING_VALUE", + * // retrieverArn: "STRING_VALUE", + * // }; + * + * ``` + * + * @param CreateRetrieverCommandInput - {@link CreateRetrieverCommandInput} + * @returns {@link CreateRetrieverCommandOutput} + * @see {@link CreateRetrieverCommandInput} for command's `input` shape. + * @see {@link CreateRetrieverCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link ConflictException} (client fault) + *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.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *You have exceeded the set limits for your Amazon Q service.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class CreateRetrieverCommand extends $Command< + CreateRetrieverCommandInput, + CreateRetrieverCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CreateRetrieverCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCreates a universally unique identifier (UUID) mapped to a list of local user ids + * within an application.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, CreateUserCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, CreateUserCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // CreateUserRequest + * applicationId: "STRING_VALUE", // required + * userId: "STRING_VALUE", // required + * userAliases: [ // UserAliases + * { // UserAlias + * indexId: "STRING_VALUE", + * dataSourceId: "STRING_VALUE", + * userId: "STRING_VALUE", // required + * }, + * ], + * clientToken: "STRING_VALUE", + * }; + * const command = new CreateUserCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param CreateUserCommandInput - {@link CreateUserCommandInput} + * @returns {@link CreateUserCommandOutput} + * @see {@link CreateUserCommandInput} for command's `input` shape. + * @see {@link CreateUserCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link ConflictException} (client fault) + *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.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *You have exceeded the set limits for your Amazon Q service.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class CreateUserCommand extends $Command< + CreateUserCommandInput, + CreateUserCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CreateUserCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCreates an Amazon Q web experience.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, CreateWebExperienceCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, CreateWebExperienceCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // CreateWebExperienceRequest + * applicationId: "STRING_VALUE", // required + * title: "STRING_VALUE", + * subtitle: "STRING_VALUE", + * welcomeMessage: "STRING_VALUE", + * samplePromptsControlMode: "ENABLED" || "DISABLED", + * tags: [ // Tags + * { // Tag + * key: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * ], + * clientToken: "STRING_VALUE", + * }; + * const command = new CreateWebExperienceCommand(input); + * const response = await client.send(command); + * // { // CreateWebExperienceResponse + * // webExperienceId: "STRING_VALUE", + * // webExperienceArn: "STRING_VALUE", + * // }; + * + * ``` + * + * @param CreateWebExperienceCommandInput - {@link CreateWebExperienceCommandInput} + * @returns {@link CreateWebExperienceCommandOutput} + * @see {@link CreateWebExperienceCommandInput} for command's `input` shape. + * @see {@link CreateWebExperienceCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link ConflictException} (client fault) + *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.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *You have exceeded the set limits for your Amazon Q service.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class CreateWebExperienceCommand extends $Command< + CreateWebExperienceCommandInput, + CreateWebExperienceCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CreateWebExperienceCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes an Amazon Q application.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, DeleteApplicationCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, DeleteApplicationCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // DeleteApplicationRequest + * applicationId: "STRING_VALUE", // required + * }; + * const command = new DeleteApplicationCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteApplicationCommandInput - {@link DeleteApplicationCommandInput} + * @returns {@link DeleteApplicationCommandOutput} + * @see {@link DeleteApplicationCommandInput} for command's `input` shape. + * @see {@link DeleteApplicationCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link ConflictException} (client fault) + *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.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class DeleteApplicationCommand extends $Command< + DeleteApplicationCommandInput, + DeleteApplicationCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteApplicationCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes chat controls configured for an existing Amazon Q application.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, DeleteChatControlsConfigurationCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, DeleteChatControlsConfigurationCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // DeleteChatControlsConfigurationRequest + * applicationId: "STRING_VALUE", // required + * }; + * const command = new DeleteChatControlsConfigurationCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteChatControlsConfigurationCommandInput - {@link DeleteChatControlsConfigurationCommandInput} + * @returns {@link DeleteChatControlsConfigurationCommandOutput} + * @see {@link DeleteChatControlsConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteChatControlsConfigurationCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class DeleteChatControlsConfigurationCommand extends $Command< + DeleteChatControlsConfigurationCommandInput, + DeleteChatControlsConfigurationCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteChatControlsConfigurationCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes an Amazon Q web experience conversation.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, DeleteConversationCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, DeleteConversationCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // DeleteConversationRequest + * conversationId: "STRING_VALUE", // required + * applicationId: "STRING_VALUE", // required + * userId: "STRING_VALUE", // required + * }; + * const command = new DeleteConversationCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteConversationCommandInput - {@link DeleteConversationCommandInput} + * @returns {@link DeleteConversationCommandOutput} + * @see {@link DeleteConversationCommandInput} for command's `input` shape. + * @see {@link DeleteConversationCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link LicenseNotFoundException} (client fault) + *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.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class DeleteConversationCommand extends $Command< + DeleteConversationCommandInput, + DeleteConversationCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteConversationCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes an Amazon Q data source connector. While the data source is being
+ * deleted, the Status field returned by a call to the
+ * DescribeDataSource API is set to DELETING.
You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link ConflictException} (client fault) + *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.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class DeleteDataSourceCommand extends $Command< + DeleteDataSourceCommandInput, + DeleteDataSourceCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteDataSourceCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes a group so that all users and sub groups that belong to the group can no + * longer access documents only available to that group. For example, after deleting the + * group "Summer Interns", all interns who belonged to that group no longer see intern-only + * documents in their chat results.
+ *If you want to delete, update, or replace users or sub groups of a group, you need to
+ * use the PutGroup operation. For example, if a user in the group
+ * "Engineering" leaves the engineering team and another user takes their place, you
+ * provide an updated list of users or sub groups that belong to the "Engineering" group
+ * when calling PutGroup.
You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link ConflictException} (client fault) + *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.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class DeleteGroupCommand extends $Command< + DeleteGroupCommandInput, + DeleteGroupCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteGroupCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes an Amazon Q index.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, DeleteIndexCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, DeleteIndexCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // DeleteIndexRequest + * applicationId: "STRING_VALUE", // required + * indexId: "STRING_VALUE", // required + * }; + * const command = new DeleteIndexCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteIndexCommandInput - {@link DeleteIndexCommandInput} + * @returns {@link DeleteIndexCommandOutput} + * @see {@link DeleteIndexCommandInput} for command's `input` shape. + * @see {@link DeleteIndexCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link ConflictException} (client fault) + *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.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class DeleteIndexCommand extends $Command< + DeleteIndexCommandInput, + DeleteIndexCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteIndexCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes an Amazon Q plugin.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, DeletePluginCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, DeletePluginCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // DeletePluginRequest + * applicationId: "STRING_VALUE", // required + * pluginId: "STRING_VALUE", // required + * }; + * const command = new DeletePluginCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeletePluginCommandInput - {@link DeletePluginCommandInput} + * @returns {@link DeletePluginCommandOutput} + * @see {@link DeletePluginCommandInput} for command's `input` shape. + * @see {@link DeletePluginCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link ConflictException} (client fault) + *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.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class DeletePluginCommand extends $Command< + DeletePluginCommandInput, + DeletePluginCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeletePluginCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes the retriever used by an Amazon Q application.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, DeleteRetrieverCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, DeleteRetrieverCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // DeleteRetrieverRequest + * applicationId: "STRING_VALUE", // required + * retrieverId: "STRING_VALUE", // required + * }; + * const command = new DeleteRetrieverCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteRetrieverCommandInput - {@link DeleteRetrieverCommandInput} + * @returns {@link DeleteRetrieverCommandOutput} + * @see {@link DeleteRetrieverCommandInput} for command's `input` shape. + * @see {@link DeleteRetrieverCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link ConflictException} (client fault) + *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.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class DeleteRetrieverCommand extends $Command< + DeleteRetrieverCommandInput, + DeleteRetrieverCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteRetrieverCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes a user by email id.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, DeleteUserCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, DeleteUserCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // DeleteUserRequest + * applicationId: "STRING_VALUE", // required + * userId: "STRING_VALUE", // required + * }; + * const command = new DeleteUserCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteUserCommandInput - {@link DeleteUserCommandInput} + * @returns {@link DeleteUserCommandOutput} + * @see {@link DeleteUserCommandInput} for command's `input` shape. + * @see {@link DeleteUserCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link ConflictException} (client fault) + *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.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class DeleteUserCommand extends $Command< + DeleteUserCommandInput, + DeleteUserCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteUserCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes an Amazon Q web experience.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, DeleteWebExperienceCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, DeleteWebExperienceCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // DeleteWebExperienceRequest + * applicationId: "STRING_VALUE", // required + * webExperienceId: "STRING_VALUE", // required + * }; + * const command = new DeleteWebExperienceCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteWebExperienceCommandInput - {@link DeleteWebExperienceCommandInput} + * @returns {@link DeleteWebExperienceCommandOutput} + * @see {@link DeleteWebExperienceCommandInput} for command's `input` shape. + * @see {@link DeleteWebExperienceCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link ConflictException} (client fault) + *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.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class DeleteWebExperienceCommand extends $Command< + DeleteWebExperienceCommandInput, + DeleteWebExperienceCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteWebExperienceCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets information about an existing Amazon Q application.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, GetApplicationCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, GetApplicationCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // GetApplicationRequest + * applicationId: "STRING_VALUE", // required + * }; + * const command = new GetApplicationCommand(input); + * const response = await client.send(command); + * // { // GetApplicationResponse + * // displayName: "STRING_VALUE", + * // applicationId: "STRING_VALUE", + * // applicationArn: "STRING_VALUE", + * // roleArn: "STRING_VALUE", + * // status: "CREATING" || "ACTIVE" || "DELETING" || "FAILED" || "UPDATING", + * // description: "STRING_VALUE", + * // encryptionConfiguration: { // EncryptionConfiguration + * // kmsKeyId: "STRING_VALUE", + * // }, + * // createdAt: new Date("TIMESTAMP"), + * // updatedAt: new Date("TIMESTAMP"), + * // error: { // ErrorDetail + * // errorMessage: "STRING_VALUE", + * // errorCode: "InternalError" || "InvalidRequest" || "ResourceInactive" || "ResourceNotFound", + * // }, + * // attachmentsConfiguration: { // AppliedAttachmentsConfiguration + * // attachmentsControlMode: "ENABLED" || "DISABLED", + * // }, + * // }; + * + * ``` + * + * @param GetApplicationCommandInput - {@link GetApplicationCommandInput} + * @returns {@link GetApplicationCommandOutput} + * @see {@link GetApplicationCommandInput} for command's `input` shape. + * @see {@link GetApplicationCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class GetApplicationCommand extends $Command< + GetApplicationCommandInput, + GetApplicationCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetApplicationCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets information about an chat controls configured for an existing Amazon Q + * application.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, GetChatControlsConfigurationCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, GetChatControlsConfigurationCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // GetChatControlsConfigurationRequest + * applicationId: "STRING_VALUE", // required + * maxResults: Number("int"), + * nextToken: "STRING_VALUE", + * }; + * const command = new GetChatControlsConfigurationCommand(input); + * const response = await client.send(command); + * // { // GetChatControlsConfigurationResponse + * // responseScope: "ENTERPRISE_CONTENT_ONLY" || "EXTENDED_KNOWLEDGE_ENABLED", + * // blockedPhrases: { // BlockedPhrasesConfiguration + * // blockedPhrases: [ // BlockedPhrases + * // "STRING_VALUE", + * // ], + * // systemMessageOverride: "STRING_VALUE", + * // }, + * // topicConfigurations: [ // TopicConfigurations + * // { // TopicConfiguration + * // name: "STRING_VALUE", // required + * // description: "STRING_VALUE", + * // exampleChatMessages: [ // ExampleChatMessages + * // "STRING_VALUE", + * // ], + * // rules: [ // Rules // required + * // { // Rule + * // includedUsersAndGroups: { // UsersAndGroups + * // userIds: [ // UserIds + * // "STRING_VALUE", + * // ], + * // userGroups: [ // UserGroups + * // "STRING_VALUE", + * // ], + * // }, + * // excludedUsersAndGroups: { + * // userIds: [ + * // "STRING_VALUE", + * // ], + * // userGroups: [ + * // "STRING_VALUE", + * // ], + * // }, + * // ruleType: "CONTENT_BLOCKER_RULE" || "CONTENT_RETRIEVAL_RULE", // required + * // ruleConfiguration: { // RuleConfiguration Union: only one key present + * // contentBlockerRule: { // ContentBlockerRule + * // systemMessageOverride: "STRING_VALUE", + * // }, + * // contentRetrievalRule: { // ContentRetrievalRule + * // eligibleDataSources: [ // EligibleDataSources + * // { // EligibleDataSource + * // indexId: "STRING_VALUE", + * // dataSourceId: "STRING_VALUE", + * // }, + * // ], + * // }, + * // }, + * // }, + * // ], + * // }, + * // ], + * // nextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param GetChatControlsConfigurationCommandInput - {@link GetChatControlsConfigurationCommandInput} + * @returns {@link GetChatControlsConfigurationCommandOutput} + * @see {@link GetChatControlsConfigurationCommandInput} for command's `input` shape. + * @see {@link GetChatControlsConfigurationCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class GetChatControlsConfigurationCommand extends $Command< + GetChatControlsConfigurationCommandInput, + GetChatControlsConfigurationCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetChatControlsConfigurationCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets information about an existing Amazon Q data source connector.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, GetDataSourceCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, GetDataSourceCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // GetDataSourceRequest + * applicationId: "STRING_VALUE", // required + * indexId: "STRING_VALUE", // required + * dataSourceId: "STRING_VALUE", // required + * }; + * const command = new GetDataSourceCommand(input); + * const response = await client.send(command); + * // { // GetDataSourceResponse + * // applicationId: "STRING_VALUE", + * // indexId: "STRING_VALUE", + * // dataSourceId: "STRING_VALUE", + * // dataSourceArn: "STRING_VALUE", + * // displayName: "STRING_VALUE", + * // type: "STRING_VALUE", + * // configuration: "DOCUMENT_VALUE", + * // vpcConfiguration: { // DataSourceVpcConfiguration + * // subnetIds: [ // SubnetIds // required + * // "STRING_VALUE", + * // ], + * // securityGroupIds: [ // SecurityGroupIds // required + * // "STRING_VALUE", + * // ], + * // }, + * // createdAt: new Date("TIMESTAMP"), + * // updatedAt: new Date("TIMESTAMP"), + * // description: "STRING_VALUE", + * // status: "PENDING_CREATION" || "CREATING" || "ACTIVE" || "DELETING" || "FAILED" || "UPDATING", + * // syncSchedule: "STRING_VALUE", + * // roleArn: "STRING_VALUE", + * // error: { // ErrorDetail + * // errorMessage: "STRING_VALUE", + * // errorCode: "InternalError" || "InvalidRequest" || "ResourceInactive" || "ResourceNotFound", + * // }, + * // 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: { // DocumentAttributeValue Union: only one key present + * // stringValue: "STRING_VALUE", + * // stringListValue: [ // DocumentAttributeStringListValue + * // "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: {// Union: only one key present + * // stringValue: "STRING_VALUE", + * // stringListValue: [ + * // "STRING_VALUE", + * // ], + * // longValue: Number("long"), + * // dateValue: new Date("TIMESTAMP"), + * // }, + * // }, + * // 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: {// Union: only one key present + * // stringValue: "STRING_VALUE", + * // stringListValue: [ + * // "STRING_VALUE", + * // ], + * // longValue: Number("long"), + * // dateValue: new Date("TIMESTAMP"), + * // }, + * // }, + * // lambdaArn: "STRING_VALUE", + * // s3BucketName: "STRING_VALUE", + * // roleArn: "STRING_VALUE", + * // }, + * // }, + * // }; + * + * ``` + * + * @param GetDataSourceCommandInput - {@link GetDataSourceCommandInput} + * @returns {@link GetDataSourceCommandOutput} + * @see {@link GetDataSourceCommandInput} for command's `input` shape. + * @see {@link GetDataSourceCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class GetDataSourceCommand extends $Command< + GetDataSourceCommandInput, + GetDataSourceCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetDataSourceCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDescribes a group by group name.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, GetGroupCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, GetGroupCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // GetGroupRequest + * applicationId: "STRING_VALUE", // required + * indexId: "STRING_VALUE", // required + * groupName: "STRING_VALUE", // required + * dataSourceId: "STRING_VALUE", + * }; + * const command = new GetGroupCommand(input); + * const response = await client.send(command); + * // { // GetGroupResponse + * // status: { // GroupStatusDetail + * // status: "FAILED" || "SUCCEEDED" || "PROCESSING" || "DELETING" || "DELETED", + * // lastUpdatedAt: new Date("TIMESTAMP"), + * // errorDetail: { // ErrorDetail + * // errorMessage: "STRING_VALUE", + * // errorCode: "InternalError" || "InvalidRequest" || "ResourceInactive" || "ResourceNotFound", + * // }, + * // }, + * // statusHistory: [ // GroupStatusDetails + * // { + * // status: "FAILED" || "SUCCEEDED" || "PROCESSING" || "DELETING" || "DELETED", + * // lastUpdatedAt: new Date("TIMESTAMP"), + * // errorDetail: { + * // errorMessage: "STRING_VALUE", + * // errorCode: "InternalError" || "InvalidRequest" || "ResourceInactive" || "ResourceNotFound", + * // }, + * // }, + * // ], + * // }; + * + * ``` + * + * @param GetGroupCommandInput - {@link GetGroupCommandInput} + * @returns {@link GetGroupCommandOutput} + * @see {@link GetGroupCommandInput} for command's `input` shape. + * @see {@link GetGroupCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link ConflictException} (client fault) + *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.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class GetGroupCommand extends $Command< + GetGroupCommandInput, + GetGroupCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetGroupCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets information about an existing Amazon Q index.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, GetIndexCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, GetIndexCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // GetIndexRequest + * applicationId: "STRING_VALUE", // required + * indexId: "STRING_VALUE", // required + * }; + * const command = new GetIndexCommand(input); + * const response = await client.send(command); + * // { // GetIndexResponse + * // applicationId: "STRING_VALUE", + * // indexId: "STRING_VALUE", + * // displayName: "STRING_VALUE", + * // indexArn: "STRING_VALUE", + * // status: "CREATING" || "ACTIVE" || "DELETING" || "FAILED" || "UPDATING", + * // description: "STRING_VALUE", + * // createdAt: new Date("TIMESTAMP"), + * // updatedAt: new Date("TIMESTAMP"), + * // capacityConfiguration: { // IndexCapacityConfiguration + * // units: Number("int"), + * // }, + * // documentAttributeConfigurations: [ // DocumentAttributeConfigurations + * // { // DocumentAttributeConfiguration + * // name: "STRING_VALUE", + * // type: "STRING" || "STRING_LIST" || "NUMBER" || "DATE", + * // search: "ENABLED" || "DISABLED", + * // }, + * // ], + * // error: { // ErrorDetail + * // errorMessage: "STRING_VALUE", + * // errorCode: "InternalError" || "InvalidRequest" || "ResourceInactive" || "ResourceNotFound", + * // }, + * // indexStatistics: { // IndexStatistics + * // textDocumentStatistics: { // TextDocumentStatistics + * // indexedTextBytes: Number("long"), + * // indexedTextDocumentCount: Number("int"), + * // }, + * // }, + * // }; + * + * ``` + * + * @param GetIndexCommandInput - {@link GetIndexCommandInput} + * @returns {@link GetIndexCommandOutput} + * @see {@link GetIndexCommandInput} for command's `input` shape. + * @see {@link GetIndexCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class GetIndexCommand extends $Command< + GetIndexCommandInput, + GetIndexCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetIndexCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets information about an existing Amazon Q plugin.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, GetPluginCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, GetPluginCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // GetPluginRequest + * applicationId: "STRING_VALUE", // required + * pluginId: "STRING_VALUE", // required + * }; + * const command = new GetPluginCommand(input); + * const response = await client.send(command); + * // { // GetPluginResponse + * // applicationId: "STRING_VALUE", + * // pluginId: "STRING_VALUE", + * // displayName: "STRING_VALUE", + * // type: "SERVICE_NOW" || "SALESFORCE" || "JIRA" || "ZENDESK", + * // serverUrl: "STRING_VALUE", + * // authConfiguration: { // PluginAuthConfiguration Union: only one key present + * // basicAuthConfiguration: { // BasicAuthConfiguration + * // secretArn: "STRING_VALUE", // required + * // roleArn: "STRING_VALUE", // required + * // }, + * // oAuth2ClientCredentialConfiguration: { // OAuth2ClientCredentialConfiguration + * // secretArn: "STRING_VALUE", // required + * // roleArn: "STRING_VALUE", // required + * // }, + * // }, + * // pluginArn: "STRING_VALUE", + * // state: "ENABLED" || "DISABLED", + * // createdAt: new Date("TIMESTAMP"), + * // updatedAt: new Date("TIMESTAMP"), + * // }; + * + * ``` + * + * @param GetPluginCommandInput - {@link GetPluginCommandInput} + * @returns {@link GetPluginCommandOutput} + * @see {@link GetPluginCommandInput} for command's `input` shape. + * @see {@link GetPluginCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class GetPluginCommand extends $Command< + GetPluginCommandInput, + GetPluginCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetPluginCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets information about an existing retriever used by an Amazon Q + * application.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, GetRetrieverCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, GetRetrieverCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // GetRetrieverRequest + * applicationId: "STRING_VALUE", // required + * retrieverId: "STRING_VALUE", // required + * }; + * const command = new GetRetrieverCommand(input); + * const response = await client.send(command); + * // { // GetRetrieverResponse + * // applicationId: "STRING_VALUE", + * // retrieverId: "STRING_VALUE", + * // retrieverArn: "STRING_VALUE", + * // type: "NATIVE_INDEX" || "KENDRA_INDEX", + * // status: "CREATING" || "ACTIVE" || "FAILED", + * // displayName: "STRING_VALUE", + * // configuration: { // RetrieverConfiguration Union: only one key present + * // nativeIndexConfiguration: { // NativeIndexConfiguration + * // indexId: "STRING_VALUE", // required + * // }, + * // kendraIndexConfiguration: { // KendraIndexConfiguration + * // indexId: "STRING_VALUE", // required + * // }, + * // }, + * // roleArn: "STRING_VALUE", + * // createdAt: new Date("TIMESTAMP"), + * // updatedAt: new Date("TIMESTAMP"), + * // }; + * + * ``` + * + * @param GetRetrieverCommandInput - {@link GetRetrieverCommandInput} + * @returns {@link GetRetrieverCommandOutput} + * @see {@link GetRetrieverCommandInput} for command's `input` shape. + * @see {@link GetRetrieverCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class GetRetrieverCommand extends $Command< + GetRetrieverCommandInput, + GetRetrieverCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetRetrieverCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDescribes the universally unique identifier (UUID) associated with a local user in a + * data source.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, GetUserCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, GetUserCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // GetUserRequest + * applicationId: "STRING_VALUE", // required + * userId: "STRING_VALUE", // required + * }; + * const command = new GetUserCommand(input); + * const response = await client.send(command); + * // { // GetUserResponse + * // userAliases: [ // UserAliases + * // { // UserAlias + * // indexId: "STRING_VALUE", + * // dataSourceId: "STRING_VALUE", + * // userId: "STRING_VALUE", // required + * // }, + * // ], + * // }; + * + * ``` + * + * @param GetUserCommandInput - {@link GetUserCommandInput} + * @returns {@link GetUserCommandOutput} + * @see {@link GetUserCommandInput} for command's `input` shape. + * @see {@link GetUserCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link ConflictException} (client fault) + *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.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class GetUserCommand extends $CommandGets information about an existing Amazon Q web experience.
+ * @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) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class GetWebExperienceCommand extends $Command< + GetWebExperienceCommandInput, + GetWebExperienceCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetWebExperienceCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists Amazon Q applications.
+ * @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) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class ListApplicationsCommand extends $Command< + ListApplicationsCommandInput, + ListApplicationsCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListApplicationsCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists one or more Amazon Q conversations.
+ * @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) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link LicenseNotFoundException} (client fault) + *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.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class ListConversationsCommand extends $Command< + ListConversationsCommandInput, + ListConversationsCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListConversationsCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGet information about an Amazon Q data source connector synchronization.
+ * @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) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class ListDataSourceSyncJobsCommand extends $Command< + ListDataSourceSyncJobsCommandInput, + ListDataSourceSyncJobsCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListDataSourceSyncJobsCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists the Amazon Q data source connectors that you have created.
+ * @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) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class ListDataSourcesCommand extends $Command< + ListDataSourcesCommandInput, + ListDataSourcesCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListDataSourcesCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackA list of documents attached to an index.
+ * @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) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class ListDocumentsCommand extends $Command< + ListDocumentsCommandInput, + ListDocumentsCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListDocumentsCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackProvides a list of groups that are mapped to users.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, ListGroupsCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, ListGroupsCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // ListGroupsRequest + * applicationId: "STRING_VALUE", // required + * indexId: "STRING_VALUE", // required + * updatedEarlierThan: new Date("TIMESTAMP"), // required + * dataSourceId: "STRING_VALUE", + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * }; + * const command = new ListGroupsCommand(input); + * const response = await client.send(command); + * // { // ListGroupsResponse + * // nextToken: "STRING_VALUE", + * // items: [ // GroupSummaryList + * // { // GroupSummary + * // groupName: "STRING_VALUE", + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListGroupsCommandInput - {@link ListGroupsCommandInput} + * @returns {@link ListGroupsCommandOutput} + * @see {@link ListGroupsCommandInput} for command's `input` shape. + * @see {@link ListGroupsCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link ConflictException} (client fault) + *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.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class ListGroupsCommand extends $Command< + ListGroupsCommandInput, + ListGroupsCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListGroupsCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists the Amazon Q indices you have created.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, ListIndicesCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, ListIndicesCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // ListIndicesRequest + * applicationId: "STRING_VALUE", // required + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * }; + * const command = new ListIndicesCommand(input); + * const response = await client.send(command); + * // { // ListIndicesResponse + * // nextToken: "STRING_VALUE", + * // indices: [ // Indices + * // { // Index + * // displayName: "STRING_VALUE", + * // indexId: "STRING_VALUE", + * // createdAt: new Date("TIMESTAMP"), + * // updatedAt: new Date("TIMESTAMP"), + * // status: "CREATING" || "ACTIVE" || "DELETING" || "FAILED" || "UPDATING", + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListIndicesCommandInput - {@link ListIndicesCommandInput} + * @returns {@link ListIndicesCommandOutput} + * @see {@link ListIndicesCommandInput} for command's `input` shape. + * @see {@link ListIndicesCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class ListIndicesCommand extends $Command< + ListIndicesCommandInput, + ListIndicesCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListIndicesCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets a list of messages associated with an Amazon Q web experience.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, ListMessagesCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, ListMessagesCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // ListMessagesRequest + * conversationId: "STRING_VALUE", // required + * applicationId: "STRING_VALUE", // required + * userId: "STRING_VALUE", // required + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * }; + * const command = new ListMessagesCommand(input); + * const response = await client.send(command); + * // { // ListMessagesResponse + * // messages: [ // Messages + * // { // Message + * // messageId: "STRING_VALUE", + * // body: "STRING_VALUE", + * // time: new Date("TIMESTAMP"), + * // type: "USER" || "SYSTEM", + * // attachments: [ // AttachmentsOutput + * // { // AttachmentOutput + * // name: "STRING_VALUE", + * // status: "FAILED" || "SUCCEEDED", + * // error: { // ErrorDetail + * // errorMessage: "STRING_VALUE", + * // errorCode: "InternalError" || "InvalidRequest" || "ResourceInactive" || "ResourceNotFound", + * // }, + * // }, + * // ], + * // sourceAttribution: [ // SourceAttributions + * // { // SourceAttribution + * // title: "STRING_VALUE", + * // snippet: "STRING_VALUE", + * // url: "STRING_VALUE", + * // citationNumber: Number("int"), + * // updatedAt: new Date("TIMESTAMP"), + * // textMessageSegments: [ // TextSegmentList + * // { // TextSegment + * // beginOffset: Number("int"), + * // endOffset: Number("int"), + * // }, + * // ], + * // }, + * // ], + * // actionReview: { // ActionReview + * // pluginId: "STRING_VALUE", + * // pluginType: "SERVICE_NOW" || "SALESFORCE" || "JIRA" || "ZENDESK", + * // payload: { // ActionReviewPayload + * // "You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link LicenseNotFoundException} (client fault) + *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.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class ListMessagesCommand extends $Command< + ListMessagesCommandInput, + ListMessagesCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListMessagesCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists configured Amazon Q plugins.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, ListPluginsCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, ListPluginsCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // ListPluginsRequest + * applicationId: "STRING_VALUE", // required + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * }; + * const command = new ListPluginsCommand(input); + * const response = await client.send(command); + * // { // ListPluginsResponse + * // nextToken: "STRING_VALUE", + * // plugins: [ // Plugins + * // { // Plugin + * // pluginId: "STRING_VALUE", + * // displayName: "STRING_VALUE", + * // type: "SERVICE_NOW" || "SALESFORCE" || "JIRA" || "ZENDESK", + * // serverUrl: "STRING_VALUE", + * // state: "ENABLED" || "DISABLED", + * // createdAt: new Date("TIMESTAMP"), + * // updatedAt: new Date("TIMESTAMP"), + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListPluginsCommandInput - {@link ListPluginsCommandInput} + * @returns {@link ListPluginsCommandOutput} + * @see {@link ListPluginsCommandInput} for command's `input` shape. + * @see {@link ListPluginsCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class ListPluginsCommand extends $Command< + ListPluginsCommandInput, + ListPluginsCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListPluginsCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists the retriever used by an Amazon Q application.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, ListRetrieversCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, ListRetrieversCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // ListRetrieversRequest + * applicationId: "STRING_VALUE", // required + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * }; + * const command = new ListRetrieversCommand(input); + * const response = await client.send(command); + * // { // ListRetrieversResponse + * // retrievers: [ // Retrievers + * // { // Retriever + * // applicationId: "STRING_VALUE", + * // retrieverId: "STRING_VALUE", + * // type: "NATIVE_INDEX" || "KENDRA_INDEX", + * // status: "CREATING" || "ACTIVE" || "FAILED", + * // displayName: "STRING_VALUE", + * // }, + * // ], + * // nextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListRetrieversCommandInput - {@link ListRetrieversCommandInput} + * @returns {@link ListRetrieversCommandOutput} + * @see {@link ListRetrieversCommandInput} for command's `input` shape. + * @see {@link ListRetrieversCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class ListRetrieversCommand extends $Command< + ListRetrieversCommandInput, + ListRetrieversCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListRetrieversCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets a list of tags associated with a specified resource. Amazon Q applications + * and data sources can have tags associated with them.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, ListTagsForResourceCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, ListTagsForResourceCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // ListTagsForResourceRequest + * resourceARN: "STRING_VALUE", // required + * }; + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * // { // ListTagsForResourceResponse + * // tags: [ // Tags + * // { // Tag + * // key: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput} + * @returns {@link ListTagsForResourceCommandOutput} + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class ListTagsForResourceCommand extends $Command< + ListTagsForResourceCommandInput, + ListTagsForResourceCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListTagsForResourceCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists one or more Amazon Q Web Experiences.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, ListWebExperiencesCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, ListWebExperiencesCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // ListWebExperiencesRequest + * applicationId: "STRING_VALUE", // required + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * }; + * const command = new ListWebExperiencesCommand(input); + * const response = await client.send(command); + * // { // ListWebExperiencesResponse + * // webExperiences: [ // WebExperiences + * // { // WebExperience + * // webExperienceId: "STRING_VALUE", + * // createdAt: new Date("TIMESTAMP"), + * // updatedAt: new Date("TIMESTAMP"), + * // defaultEndpoint: "STRING_VALUE", + * // status: "CREATING" || "ACTIVE" || "DELETING" || "FAILED" || "PENDING_AUTH_CONFIG", + * // }, + * // ], + * // nextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListWebExperiencesCommandInput - {@link ListWebExperiencesCommandInput} + * @returns {@link ListWebExperiencesCommandOutput} + * @see {@link ListWebExperiencesCommandInput} for command's `input` shape. + * @see {@link ListWebExperiencesCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class ListWebExperiencesCommand extends $Command< + ListWebExperiencesCommandInput, + ListWebExperiencesCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListWebExperiencesCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackEnables your end user to to provide feedback on their Amazon Q generated chat + * responses.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QBusinessClient, PutFeedbackCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import + * // const { QBusinessClient, PutFeedbackCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import + * const client = new QBusinessClient(config); + * const input = { // PutFeedbackRequest + * applicationId: "STRING_VALUE", // required + * userId: "STRING_VALUE", // required + * conversationId: "STRING_VALUE", // required + * messageId: "STRING_VALUE", // required + * messageCopiedAt: new Date("TIMESTAMP"), + * messageUsefulness: { // MessageUsefulnessFeedback + * usefulness: "USEFUL" || "NOT_USEFUL", // required + * reason: "NOT_FACTUALLY_CORRECT" || "HARMFUL_OR_UNSAFE" || "INCORRECT_OR_MISSING_SOURCES" || "NOT_HELPFUL" || "FACTUALLY_CORRECT" || "COMPLETE" || "RELEVANT_SOURCES" || "HELPFUL", + * comment: "STRING_VALUE", + * submittedAt: new Date("TIMESTAMP"), // required + * }, + * }; + * const command = new PutFeedbackCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param PutFeedbackCommandInput - {@link PutFeedbackCommandInput} + * @returns {@link PutFeedbackCommandOutput} + * @see {@link PutFeedbackCommandInput} for command's `input` shape. + * @see {@link PutFeedbackCommandOutput} for command's `response` shape. + * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to perform this action. Make sure you have the required + * permission policies and user accounts and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An issue occurred with the internal server used for your Amazon Q service. Wait + * some minutes and try again, or contact Support for help.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you want to use doesn’t exist. Make sure you have provided the correct + * resource and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to throttling. Reduce the number of requests and try + * again.
+ * + * @throws {@link ValidationException} (client fault) + *The input doesn't meet the constraints set by the Amazon Q service. Provide the + * correct input and try again.
+ * + * @throws {@link QBusinessServiceException} + *Base exception class for all service exceptions from QBusiness service.
+ * + */ +export class PutFeedbackCommand extends $Command< + PutFeedbackCommandInput, + PutFeedbackCommandOutput, + QBusinessClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: PutFeedbackCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack