@aws-sdk/client-qconnect 3.461.0

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

@@ -0,0 +1,114 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { UpdateContentRequest, UpdateContentResponse } from "../models/models_0";
+import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateContentCommand}.
+ */
+export interface UpdateContentCommandInput extends UpdateContentRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateContentCommand}.
+ */
+export interface UpdateContentCommandOutput extends UpdateContentResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Updates information about the content.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QConnectClient, UpdateContentCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
+ * // const { QConnectClient, UpdateContentCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
+ * const client = new QConnectClient(config);
+ * const input = { // UpdateContentRequest
+ *   knowledgeBaseId: "STRING_VALUE", // required
+ *   contentId: "STRING_VALUE", // required
+ *   revisionId: "STRING_VALUE",
+ *   title: "STRING_VALUE",
+ *   overrideLinkOutUri: "STRING_VALUE",
+ *   removeOverrideLinkOutUri: true || false,
+ *   metadata: { // ContentMetadata
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ *   uploadId: "STRING_VALUE",
+ * };
+ * const command = new UpdateContentCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateContentResponse
+ * //   content: { // ContentData
+ * //     contentArn: "STRING_VALUE", // required
+ * //     contentId: "STRING_VALUE", // required
+ * //     knowledgeBaseArn: "STRING_VALUE", // required
+ * //     knowledgeBaseId: "STRING_VALUE", // required
+ * //     name: "STRING_VALUE", // required
+ * //     revisionId: "STRING_VALUE", // required
+ * //     title: "STRING_VALUE", // required
+ * //     contentType: "STRING_VALUE", // required
+ * //     status: "STRING_VALUE", // required
+ * //     metadata: { // ContentMetadata // required
+ * //       "<keys>": "STRING_VALUE",
+ * //     },
+ * //     tags: { // Tags
+ * //       "<keys>": "STRING_VALUE",
+ * //     },
+ * //     linkOutUri: "STRING_VALUE",
+ * //     url: "STRING_VALUE", // required
+ * //     urlExpiry: new Date("TIMESTAMP"), // required
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateContentCommandInput - {@link UpdateContentCommandInput}
+ * @returns {@link UpdateContentCommandOutput}
+ * @see {@link UpdateContentCommandInput} for command's `input` shape.
+ * @see {@link UpdateContentCommandOutput} for command's `response` shape.
+ * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link PreconditionFailedException} (client fault)
+ *  <p>The provided <code>revisionId</code> does not match, indicating the content has been
+ *       modified since it was last read.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource does not exist.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by a service.</p>
+ *
+ * @throws {@link QConnectServiceException}
+ * <p>Base exception class for all service exceptions from QConnect service.</p>
+ *
+ */
+export declare class UpdateContentCommand extends $Command<UpdateContentCommandInput, UpdateContentCommandOutput, QConnectClientResolvedConfig> {
+    readonly input: UpdateContentCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateContentCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateContentCommandInput, UpdateContentCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,113 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { UpdateKnowledgeBaseTemplateUriRequest, UpdateKnowledgeBaseTemplateUriResponse } from "../models/models_0";
+import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateKnowledgeBaseTemplateUriCommand}.
+ */
+export interface UpdateKnowledgeBaseTemplateUriCommandInput extends UpdateKnowledgeBaseTemplateUriRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateKnowledgeBaseTemplateUriCommand}.
+ */
+export interface UpdateKnowledgeBaseTemplateUriCommandOutput extends UpdateKnowledgeBaseTemplateUriResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Updates the template URI of a knowledge base. This is only supported for knowledge bases
+ *       of type EXTERNAL. Include a single variable in <code>$\{variable\}</code> format; this
+ *       interpolated by Amazon Q using ingested content. For example, if you ingest a Salesforce
+ *       article, it has an <code>Id</code> value, and you can set the template URI to
+ *         <code>https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*$\{Id\}*\/view</code>.
+ *     </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QConnectClient, UpdateKnowledgeBaseTemplateUriCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
+ * // const { QConnectClient, UpdateKnowledgeBaseTemplateUriCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
+ * const client = new QConnectClient(config);
+ * const input = { // UpdateKnowledgeBaseTemplateUriRequest
+ *   knowledgeBaseId: "STRING_VALUE", // required
+ *   templateUri: "STRING_VALUE", // required
+ * };
+ * const command = new UpdateKnowledgeBaseTemplateUriCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateKnowledgeBaseTemplateUriResponse
+ * //   knowledgeBase: { // KnowledgeBaseData
+ * //     knowledgeBaseId: "STRING_VALUE", // required
+ * //     knowledgeBaseArn: "STRING_VALUE", // required
+ * //     name: "STRING_VALUE", // required
+ * //     knowledgeBaseType: "STRING_VALUE", // required
+ * //     status: "STRING_VALUE", // required
+ * //     lastContentModificationTime: new Date("TIMESTAMP"),
+ * //     sourceConfiguration: { // SourceConfiguration Union: only one key present
+ * //       appIntegrations: { // AppIntegrationsConfiguration
+ * //         appIntegrationArn: "STRING_VALUE", // required
+ * //         objectFields: [ // ObjectFieldsList
+ * //           "STRING_VALUE",
+ * //         ],
+ * //       },
+ * //     },
+ * //     renderingConfiguration: { // RenderingConfiguration
+ * //       templateUri: "STRING_VALUE",
+ * //     },
+ * //     serverSideEncryptionConfiguration: { // ServerSideEncryptionConfiguration
+ * //       kmsKeyId: "STRING_VALUE",
+ * //     },
+ * //     description: "STRING_VALUE",
+ * //     tags: { // Tags
+ * //       "<keys>": "STRING_VALUE",
+ * //     },
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateKnowledgeBaseTemplateUriCommandInput - {@link UpdateKnowledgeBaseTemplateUriCommandInput}
+ * @returns {@link UpdateKnowledgeBaseTemplateUriCommandOutput}
+ * @see {@link UpdateKnowledgeBaseTemplateUriCommandInput} for command's `input` shape.
+ * @see {@link UpdateKnowledgeBaseTemplateUriCommandOutput} for command's `response` shape.
+ * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource does not exist.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by a service.</p>
+ *
+ * @throws {@link QConnectServiceException}
+ * <p>Base exception class for all service exceptions from QConnect service.</p>
+ *
+ */
+export declare class UpdateKnowledgeBaseTemplateUriCommand extends $Command<UpdateKnowledgeBaseTemplateUriCommandInput, UpdateKnowledgeBaseTemplateUriCommandOutput, QConnectClientResolvedConfig> {
+    readonly input: UpdateKnowledgeBaseTemplateUriCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateKnowledgeBaseTemplateUriCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateKnowledgeBaseTemplateUriCommandInput, UpdateKnowledgeBaseTemplateUriCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,149 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { UpdateQuickResponseRequest, UpdateQuickResponseResponse } from "../models/models_0";
+import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateQuickResponseCommand}.
+ */
+export interface UpdateQuickResponseCommandInput extends UpdateQuickResponseRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateQuickResponseCommand}.
+ */
+export interface UpdateQuickResponseCommandOutput extends UpdateQuickResponseResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Updates an existing Amazon Q quick response.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QConnectClient, UpdateQuickResponseCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
+ * // const { QConnectClient, UpdateQuickResponseCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
+ * const client = new QConnectClient(config);
+ * const input = { // UpdateQuickResponseRequest
+ *   knowledgeBaseId: "STRING_VALUE", // required
+ *   quickResponseId: "STRING_VALUE", // required
+ *   name: "STRING_VALUE",
+ *   content: { // QuickResponseDataProvider Union: only one key present
+ *     content: "STRING_VALUE",
+ *   },
+ *   contentType: "STRING_VALUE",
+ *   groupingConfiguration: { // GroupingConfiguration
+ *     criteria: "STRING_VALUE",
+ *     values: [ // GroupingValues
+ *       "STRING_VALUE",
+ *     ],
+ *   },
+ *   removeGroupingConfiguration: true || false,
+ *   description: "STRING_VALUE",
+ *   removeDescription: true || false,
+ *   shortcutKey: "STRING_VALUE",
+ *   removeShortcutKey: true || false,
+ *   isActive: true || false,
+ *   channels: [ // Channels
+ *     "STRING_VALUE",
+ *   ],
+ *   language: "STRING_VALUE",
+ * };
+ * const command = new UpdateQuickResponseCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateQuickResponseResponse
+ * //   quickResponse: { // QuickResponseData
+ * //     quickResponseArn: "STRING_VALUE", // required
+ * //     quickResponseId: "STRING_VALUE", // required
+ * //     knowledgeBaseArn: "STRING_VALUE", // required
+ * //     knowledgeBaseId: "STRING_VALUE", // required
+ * //     name: "STRING_VALUE", // required
+ * //     contentType: "STRING_VALUE", // required
+ * //     status: "STRING_VALUE", // required
+ * //     createdTime: new Date("TIMESTAMP"), // required
+ * //     lastModifiedTime: new Date("TIMESTAMP"), // required
+ * //     contents: { // QuickResponseContents
+ * //       plainText: { // QuickResponseContentProvider Union: only one key present
+ * //         content: "STRING_VALUE",
+ * //       },
+ * //       markdown: {//  Union: only one key present
+ * //         content: "STRING_VALUE",
+ * //       },
+ * //     },
+ * //     description: "STRING_VALUE",
+ * //     groupingConfiguration: { // GroupingConfiguration
+ * //       criteria: "STRING_VALUE",
+ * //       values: [ // GroupingValues
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
+ * //     shortcutKey: "STRING_VALUE",
+ * //     lastModifiedBy: "STRING_VALUE",
+ * //     isActive: true || false,
+ * //     channels: [ // Channels
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     language: "STRING_VALUE",
+ * //     tags: { // Tags
+ * //       "<keys>": "STRING_VALUE",
+ * //     },
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateQuickResponseCommandInput - {@link UpdateQuickResponseCommandInput}
+ * @returns {@link UpdateQuickResponseCommandOutput}
+ * @see {@link UpdateQuickResponseCommandInput} for command's `input` shape.
+ * @see {@link UpdateQuickResponseCommandOutput} for command's `response` shape.
+ * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The request could not be processed because of conflict in the current state of the
+ *       resource. For example, if you're using a <code>Create</code> API (such as
+ *         <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
+ *       same name) is being created or mutated.</p>
+ *
+ * @throws {@link PreconditionFailedException} (client fault)
+ *  <p>The provided <code>revisionId</code> does not match, indicating the content has been
+ *       modified since it was last read.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource does not exist.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by a service.</p>
+ *
+ * @throws {@link QConnectServiceException}
+ * <p>Base exception class for all service exceptions from QConnect service.</p>
+ *
+ */
+export declare class UpdateQuickResponseCommand extends $Command<UpdateQuickResponseCommandInput, UpdateQuickResponseCommandOutput, QConnectClientResolvedConfig> {
+    readonly input: UpdateQuickResponseCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateQuickResponseCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateQuickResponseCommandInput, UpdateQuickResponseCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,41 @@
+export * from "./CreateAssistantAssociationCommand";
+export * from "./CreateAssistantCommand";
+export * from "./CreateContentCommand";
+export * from "./CreateKnowledgeBaseCommand";
+export * from "./CreateQuickResponseCommand";
+export * from "./CreateSessionCommand";
+export * from "./DeleteAssistantAssociationCommand";
+export * from "./DeleteAssistantCommand";
+export * from "./DeleteContentCommand";
+export * from "./DeleteImportJobCommand";
+export * from "./DeleteKnowledgeBaseCommand";
+export * from "./DeleteQuickResponseCommand";
+export * from "./GetAssistantAssociationCommand";
+export * from "./GetAssistantCommand";
+export * from "./GetContentCommand";
+export * from "./GetContentSummaryCommand";
+export * from "./GetImportJobCommand";
+export * from "./GetKnowledgeBaseCommand";
+export * from "./GetQuickResponseCommand";
+export * from "./GetRecommendationsCommand";
+export * from "./GetSessionCommand";
+export * from "./ListAssistantAssociationsCommand";
+export * from "./ListAssistantsCommand";
+export * from "./ListContentsCommand";
+export * from "./ListImportJobsCommand";
+export * from "./ListKnowledgeBasesCommand";
+export * from "./ListQuickResponsesCommand";
+export * from "./ListTagsForResourceCommand";
+export * from "./NotifyRecommendationsReceivedCommand";
+export * from "./QueryAssistantCommand";
+export * from "./RemoveKnowledgeBaseTemplateUriCommand";
+export * from "./SearchContentCommand";
+export * from "./SearchQuickResponsesCommand";
+export * from "./SearchSessionsCommand";
+export * from "./StartContentUploadCommand";
+export * from "./StartImportJobCommand";
+export * from "./TagResourceCommand";
+export * from "./UntagResourceCommand";
+export * from "./UpdateContentCommand";
+export * from "./UpdateKnowledgeBaseTemplateUriCommand";
+export * from "./UpdateQuickResponseCommand";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -0,0 +1,22 @@
+import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
+/**
+ * @public
+ */
+export interface ClientInputEndpointParameters {
+    region?: string | Provider<string>;
+    useDualstackEndpoint?: boolean | Provider<boolean>;
+    useFipsEndpoint?: boolean | Provider<boolean>;
+    endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
+}
+export type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export interface EndpointParameters extends __EndpointParameters {
+    Region?: string;
+    UseDualStack?: boolean;
+    UseFIPS?: boolean;
+    Endpoint?: string;
+}

package/dist-types/endpoint/endpointResolver.d.ts

@@ -0,0 +1,5 @@
+import { EndpointV2, Logger } from "@smithy/types";
+import { EndpointParameters } from "./EndpointParameters";
+export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
+    logger?: Logger;
+}) => EndpointV2;

package/dist-types/endpoint/ruleset.d.ts

@@ -0,0 +1,2 @@
+import { RuleSetObject } from "@smithy/types";
+export declare const ruleSet: RuleSetObject;

package/dist-types/extensionConfiguration.d.ts

@@ -0,0 +1,8 @@
+import { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
+import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
+import { DefaultExtensionConfiguration } from "@smithy/types";
+/**
+ * @internal
+ */
+export interface QConnectExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration {
+}

package/dist-types/index.d.ts

@@ -0,0 +1,27 @@
+/**
+ * <p>Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution
+ *       of Amazon Connect Wisdom that delivers real-time recommendations to help contact center
+ *       agents resolve customer issues quickly and accurately.</p>
+ *          <p>Amazon Q automatically detects customer intent during calls and chats using
+ *       conversational analytics and natural language understanding (NLU). It then provides agents
+ *       with immediate, real-time generative responses and suggested actions, and links to relevant
+ *       documents and articles. Agents can also query Amazon Q directly using natural language or
+ *       keywords to answer customer requests.</p>
+ *          <p>Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or
+ *       manage content by uploading custom files.</p>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-q-connect.html">Use Amazon Q in Connect for generative AI
+ *         powered agent assistance in real-time</a> in the <i>Amazon Connect
+ *         Administrator Guide</i>.</p>
+ *
+ * @packageDocumentation
+ */
+export * from "./QConnectClient";
+export * from "./QConnect";
+export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
+export { RuntimeExtension } from "./runtimeExtensions";
+export { QConnectExtensionConfiguration } from "./extensionConfiguration";
+export * from "./commands";
+export * from "./pagination";
+export * from "./models";
+import "@aws-sdk/util-endpoints";
+export { QConnectServiceException } from "./models/QConnectServiceException";

package/dist-types/models/QConnectServiceException.d.ts

@@ -0,0 +1,13 @@
+import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@smithy/smithy-client";
+export { __ServiceException, __ServiceExceptionOptions };
+/**
+ * @public
+ *
+ * Base exception class for all service exceptions from QConnect service.
+ */
+export declare class QConnectServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

package/dist-types/models/index.d.ts

@@ -0,0 +1 @@
+export * from "./models_0";