@aws-sdk/client-qconnect 3.699.0 → 3.709.0

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

@@ -0,0 +1,101 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ListAIGuardrailsRequest, ListAIGuardrailsResponse } from "../models/models_0";
+import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListAIGuardrailsCommand}.
+ */
+export interface ListAIGuardrailsCommandInput extends ListAIGuardrailsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListAIGuardrailsCommand}.
+ */
+export interface ListAIGuardrailsCommandOutput extends ListAIGuardrailsResponse, __MetadataBearer {
+}
+declare const ListAIGuardrailsCommand_base: {
+    new (input: ListAIGuardrailsCommandInput): import("@smithy/smithy-client").CommandImpl<ListAIGuardrailsCommandInput, ListAIGuardrailsCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: ListAIGuardrailsCommandInput): import("@smithy/smithy-client").CommandImpl<ListAIGuardrailsCommandInput, ListAIGuardrailsCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Lists the AI Guardrails available on the Amazon Q in Connect assistant.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QConnectClient, ListAIGuardrailsCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
+ * // const { QConnectClient, ListAIGuardrailsCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
+ * const client = new QConnectClient(config);
+ * const input = { // ListAIGuardrailsRequest
+ *   assistantId: "STRING_VALUE", // required
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ * };
+ * const command = new ListAIGuardrailsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListAIGuardrailsResponse
+ * //   aiGuardrailSummaries: [ // AIGuardrailSummariesList // required
+ * //     { // AIGuardrailSummary
+ * //       name: "STRING_VALUE", // required
+ * //       assistantId: "STRING_VALUE", // required
+ * //       assistantArn: "STRING_VALUE", // required
+ * //       aiGuardrailId: "STRING_VALUE", // required
+ * //       aiGuardrailArn: "STRING_VALUE", // required
+ * //       modifiedTime: new Date("TIMESTAMP"),
+ * //       visibilityStatus: "STRING_VALUE", // required
+ * //       description: "STRING_VALUE",
+ * //       status: "STRING_VALUE",
+ * //       tags: { // Tags
+ * //         "<keys>": "STRING_VALUE",
+ * //       },
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListAIGuardrailsCommandInput - {@link ListAIGuardrailsCommandInput}
+ * @returns {@link ListAIGuardrailsCommandOutput}
+ * @see {@link ListAIGuardrailsCommandInput} for command's `input` shape.
+ * @see {@link ListAIGuardrailsCommandOutput} 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 ThrottlingException} (client fault)
+ *  <p>The throttling limit has been exceeded.</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>
+ *
+ * @public
+ */
+export declare class ListAIGuardrailsCommand extends ListAIGuardrailsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListAIGuardrailsRequest;
+            output: ListAIGuardrailsResponse;
+        };
+        sdk: {
+            input: ListAIGuardrailsCommandInput;
+            output: ListAIGuardrailsCommandOutput;
+        };
+    };
+}

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

@@ -1,6 +1,6 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import { ListImportJobsRequest, ListImportJobsResponse } from "../models/models_0";
+import { ListImportJobsRequest, ListImportJobsResponse } from "../models/models_1";
 import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
 /**
  * @public

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

@@ -1,6 +1,6 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import { ListKnowledgeBasesRequest, ListKnowledgeBasesResponse } from "../models/models_0";
+import { ListKnowledgeBasesRequest, ListKnowledgeBasesResponse } from "../models/models_1";
 import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
 /**
  * @public

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

@@ -1,6 +1,6 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import { ListMessageTemplateVersionsRequest, ListMessageTemplateVersionsResponse } from "../models/models_0";
+import { ListMessageTemplateVersionsRequest, ListMessageTemplateVersionsResponse } from "../models/models_1";
 import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
 /**
  * @public

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

@@ -1,6 +1,6 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import { ListMessageTemplatesRequest, ListMessageTemplatesResponse } from "../models/models_0";
+import { ListMessageTemplatesRequest, ListMessageTemplatesResponse } from "../models/models_1";
 import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
 /**
  * @public

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

@@ -0,0 +1,95 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ListMessagesRequest, ListMessagesResponse } from "../models/models_0";
+import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListMessagesCommand}.
+ */
+export interface ListMessagesCommandInput extends ListMessagesRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListMessagesCommand}.
+ */
+export interface ListMessagesCommandOutput extends ListMessagesResponse, __MetadataBearer {
+}
+declare const ListMessagesCommand_base: {
+    new (input: ListMessagesCommandInput): import("@smithy/smithy-client").CommandImpl<ListMessagesCommandInput, ListMessagesCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: ListMessagesCommandInput): import("@smithy/smithy-client").CommandImpl<ListMessagesCommandInput, ListMessagesCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Lists messages on an Amazon Q in Connect session.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QConnectClient, ListMessagesCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
+ * // const { QConnectClient, ListMessagesCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
+ * const client = new QConnectClient(config);
+ * const input = { // ListMessagesRequest
+ *   assistantId: "STRING_VALUE", // required
+ *   sessionId: "STRING_VALUE", // required
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ * };
+ * const command = new ListMessagesCommand(input);
+ * const response = await client.send(command);
+ * // { // ListMessagesResponse
+ * //   messages: [ // MessageList // required
+ * //     { // MessageOutput
+ * //       value: { // MessageData Union: only one key present
+ * //         text: { // TextMessage
+ * //           value: "STRING_VALUE",
+ * //         },
+ * //       },
+ * //       messageId: "STRING_VALUE", // required
+ * //       participant: "STRING_VALUE", // required
+ * //       timestamp: new Date("TIMESTAMP"), // required
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListMessagesCommandInput - {@link ListMessagesCommandInput}
+ * @returns {@link ListMessagesCommandOutput}
+ * @see {@link ListMessagesCommandInput} for command's `input` shape.
+ * @see {@link ListMessagesCommandOutput} 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>
+ *
+ * @public
+ */
+export declare class ListMessagesCommand extends ListMessagesCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListMessagesRequest;
+            output: ListMessagesResponse;
+        };
+        sdk: {
+            input: ListMessagesCommandInput;
+            output: ListMessagesCommandOutput;
+        };
+    };
+}

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

@@ -1,6 +1,6 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import { ListQuickResponsesRequest, ListQuickResponsesResponse } from "../models/models_0";
+import { ListQuickResponsesRequest, ListQuickResponsesResponse } from "../models/models_1";
 import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
 /**
  * @public

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

@@ -1,7 +1,6 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import { RemoveKnowledgeBaseTemplateUriRequest } from "../models/models_0";
-import { RemoveKnowledgeBaseTemplateUriResponse } from "../models/models_1";
+import { RemoveKnowledgeBaseTemplateUriRequest, RemoveKnowledgeBaseTemplateUriResponse } from "../models/models_1";
 import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
 /**
  * @public

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

@@ -1,6 +1,6 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import { RenderMessageTemplateRequest, RenderMessageTemplateResponse } from "../models/models_0";
+import { RenderMessageTemplateRequest, RenderMessageTemplateResponse } from "../models/models_1";
 import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
 /**
  * @public

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

@@ -0,0 +1,114 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { SendMessageRequest, SendMessageResponse } from "../models/models_0";
+import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link SendMessageCommand}.
+ */
+export interface SendMessageCommandInput extends SendMessageRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link SendMessageCommand}.
+ */
+export interface SendMessageCommandOutput extends SendMessageResponse, __MetadataBearer {
+}
+declare const SendMessageCommand_base: {
+    new (input: SendMessageCommandInput): import("@smithy/smithy-client").CommandImpl<SendMessageCommandInput, SendMessageCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: SendMessageCommandInput): import("@smithy/smithy-client").CommandImpl<SendMessageCommandInput, SendMessageCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Submits a message to the Amazon Q in Connect session.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QConnectClient, SendMessageCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
+ * // const { QConnectClient, SendMessageCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
+ * const client = new QConnectClient(config);
+ * const input = { // SendMessageRequest
+ *   assistantId: "STRING_VALUE", // required
+ *   sessionId: "STRING_VALUE", // required
+ *   type: "STRING_VALUE", // required
+ *   message: { // MessageInput
+ *     value: { // MessageData Union: only one key present
+ *       text: { // TextMessage
+ *         value: "STRING_VALUE",
+ *       },
+ *     },
+ *   },
+ *   conversationContext: { // ConversationContext
+ *     selfServiceConversationHistory: [ // SelfServiceConversationHistoryList // required
+ *       { // SelfServiceConversationHistory
+ *         turnNumber: Number("int"), // required
+ *         inputTranscript: "STRING_VALUE",
+ *         botResponse: "STRING_VALUE",
+ *       },
+ *     ],
+ *   },
+ *   clientToken: "STRING_VALUE",
+ * };
+ * const command = new SendMessageCommand(input);
+ * const response = await client.send(command);
+ * // { // SendMessageResponse
+ * //   requestMessageId: "STRING_VALUE", // required
+ * //   nextMessageToken: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param SendMessageCommandInput - {@link SendMessageCommandInput}
+ * @returns {@link SendMessageCommandOutput}
+ * @see {@link SendMessageCommandInput} for command's `input` shape.
+ * @see {@link SendMessageCommandOutput} 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 RequestTimeoutException} (client fault)
+ *  <p>The request reached the service more than 15 minutes after the date stamp on the request
+ *       or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or
+ *       the date stamp on the request is more than 15 minutes in the future.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource does not exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The throttling limit has been exceeded.</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>
+ *
+ * @public
+ */
+export declare class SendMessageCommand extends SendMessageCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: SendMessageRequest;
+            output: SendMessageResponse;
+        };
+        sdk: {
+            input: SendMessageCommandInput;
+            output: SendMessageCommandOutput;
+        };
+    };
+}

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

@@ -42,6 +42,7 @@ declare const UpdateAIAgentCommand_base: {
  *   configuration: { // AIAgentConfiguration Union: only one key present
  *     manualSearchAIAgentConfiguration: { // ManualSearchAIAgentConfiguration
  *       answerGenerationAIPromptId: "STRING_VALUE",
+ *       answerGenerationAIGuardrailId: "STRING_VALUE",
  *       associationConfigurations: [ // AssociationConfigurationList
  *         { // AssociationConfiguration
  *           associationId: "STRING_VALUE",
@@ -79,6 +80,7 @@ declare const UpdateAIAgentCommand_base: {
  *       intentLabelingGenerationAIPromptId: "STRING_VALUE",
  *       queryReformulationAIPromptId: "STRING_VALUE",
  *       answerGenerationAIPromptId: "STRING_VALUE",
+ *       answerGenerationAIGuardrailId: "STRING_VALUE",
  *       associationConfigurations: [
  *         {
  *           associationId: "STRING_VALUE",
@@ -106,6 +108,35 @@ declare const UpdateAIAgentCommand_base: {
  *         },
  *       ],
  *     },
+ *     selfServiceAIAgentConfiguration: { // SelfServiceAIAgentConfiguration
+ *       selfServicePreProcessingAIPromptId: "STRING_VALUE",
+ *       selfServiceAnswerGenerationAIPromptId: "STRING_VALUE",
+ *       selfServiceAIGuardrailId: "STRING_VALUE",
+ *       associationConfigurations: [
+ *         {
+ *           associationId: "STRING_VALUE",
+ *           associationType: "STRING_VALUE",
+ *           associationConfigurationData: {//  Union: only one key present
+ *             knowledgeBaseAssociationConfigurationData: {
+ *               contentTagFilter: {//  Union: only one key present
+ *                 tagCondition: "<TagCondition>",
+ *                 andConditions: [
+ *                   "<TagCondition>",
+ *                 ],
+ *                 orConditions: [
+ *                   {//  Union: only one key present
+ *                     andConditions: "<AndConditions>",
+ *                     tagCondition: "<TagCondition>",
+ *                   },
+ *                 ],
+ *               },
+ *               maxResults: Number("int"),
+ *               overrideKnowledgeBaseSearchType: "STRING_VALUE",
+ *             },
+ *           },
+ *         },
+ *       ],
+ *     },
  *   },
  *   description: "STRING_VALUE",
  * };
@@ -122,6 +153,7 @@ declare const UpdateAIAgentCommand_base: {
  * //     configuration: { // AIAgentConfiguration Union: only one key present
  * //       manualSearchAIAgentConfiguration: { // ManualSearchAIAgentConfiguration
  * //         answerGenerationAIPromptId: "STRING_VALUE",
+ * //         answerGenerationAIGuardrailId: "STRING_VALUE",
  * //         associationConfigurations: [ // AssociationConfigurationList
  * //           { // AssociationConfiguration
  * //             associationId: "STRING_VALUE",
@@ -159,6 +191,7 @@ declare const UpdateAIAgentCommand_base: {
  * //         intentLabelingGenerationAIPromptId: "STRING_VALUE",
  * //         queryReformulationAIPromptId: "STRING_VALUE",
  * //         answerGenerationAIPromptId: "STRING_VALUE",
+ * //         answerGenerationAIGuardrailId: "STRING_VALUE",
  * //         associationConfigurations: [
  * //           {
  * //             associationId: "STRING_VALUE",
@@ -186,6 +219,35 @@ declare const UpdateAIAgentCommand_base: {
  * //           },
  * //         ],
  * //       },
+ * //       selfServiceAIAgentConfiguration: { // SelfServiceAIAgentConfiguration
+ * //         selfServicePreProcessingAIPromptId: "STRING_VALUE",
+ * //         selfServiceAnswerGenerationAIPromptId: "STRING_VALUE",
+ * //         selfServiceAIGuardrailId: "STRING_VALUE",
+ * //         associationConfigurations: [
+ * //           {
+ * //             associationId: "STRING_VALUE",
+ * //             associationType: "STRING_VALUE",
+ * //             associationConfigurationData: {//  Union: only one key present
+ * //               knowledgeBaseAssociationConfigurationData: {
+ * //                 contentTagFilter: {//  Union: only one key present
+ * //                   tagCondition: "<TagCondition>",
+ * //                   andConditions: [
+ * //                     "<TagCondition>",
+ * //                   ],
+ * //                   orConditions: [
+ * //                     {//  Union: only one key present
+ * //                       andConditions: "<AndConditions>",
+ * //                       tagCondition: "<TagCondition>",
+ * //                     },
+ * //                   ],
+ * //                 },
+ * //                 maxResults: Number("int"),
+ * //                 overrideKnowledgeBaseSearchType: "STRING_VALUE",
+ * //               },
+ * //             },
+ * //           },
+ * //         ],
+ * //       },
  * //     },
  * //     modifiedTime: new Date("TIMESTAMP"),
  * //     description: "STRING_VALUE",