@aws-sdk/client-qbusiness 3.840.0 → 3.844.0

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

@@ -0,0 +1,100 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ListChatResponseConfigurationsRequest, ListChatResponseConfigurationsResponse } from "../models/models_1";
+import { QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QBusinessClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListChatResponseConfigurationsCommand}.
+ */
+export interface ListChatResponseConfigurationsCommandInput extends ListChatResponseConfigurationsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListChatResponseConfigurationsCommand}.
+ */
+export interface ListChatResponseConfigurationsCommandOutput extends ListChatResponseConfigurationsResponse, __MetadataBearer {
+}
+declare const ListChatResponseConfigurationsCommand_base: {
+    new (input: ListChatResponseConfigurationsCommandInput): import("@smithy/smithy-client").CommandImpl<ListChatResponseConfigurationsCommandInput, ListChatResponseConfigurationsCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: ListChatResponseConfigurationsCommandInput): import("@smithy/smithy-client").CommandImpl<ListChatResponseConfigurationsCommandInput, ListChatResponseConfigurationsCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Retrieves a list of all chat response configurations available in a specified Amazon Q Business application. This operation returns summary information about each configuration to help administrators manage and select appropriate response settings.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QBusinessClient, ListChatResponseConfigurationsCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
+ * // const { QBusinessClient, ListChatResponseConfigurationsCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
+ * const client = new QBusinessClient(config);
+ * const input = { // ListChatResponseConfigurationsRequest
+ *   applicationId: "STRING_VALUE", // required
+ *   maxResults: Number("int"),
+ *   nextToken: "STRING_VALUE",
+ * };
+ * const command = new ListChatResponseConfigurationsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListChatResponseConfigurationsResponse
+ * //   chatResponseConfigurations: [ // ChatResponseConfigurations
+ * //     { // ChatResponseConfiguration
+ * //       chatResponseConfigurationId: "STRING_VALUE", // required
+ * //       chatResponseConfigurationArn: "STRING_VALUE", // required
+ * //       displayName: "STRING_VALUE", // required
+ * //       responseConfigurationSummary: "STRING_VALUE",
+ * //       status: "CREATING" || "UPDATING" || "FAILED" || "ACTIVE", // required
+ * //       createdAt: new Date("TIMESTAMP"),
+ * //       updatedAt: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListChatResponseConfigurationsCommandInput - {@link ListChatResponseConfigurationsCommandInput}
+ * @returns {@link ListChatResponseConfigurationsCommandOutput}
+ * @see {@link ListChatResponseConfigurationsCommandInput} for command's `input` shape.
+ * @see {@link ListChatResponseConfigurationsCommandOutput} for command's `response` shape.
+ * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p> You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
+ *
+ * @throws {@link QBusinessServiceException}
+ * <p>Base exception class for all service exceptions from QBusiness service.</p>
+ *
+ *
+ * @public
+ */
+export declare class ListChatResponseConfigurationsCommand extends ListChatResponseConfigurationsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListChatResponseConfigurationsRequest;
+            output: ListChatResponseConfigurationsResponse;
+        };
+        sdk: {
+            input: ListChatResponseConfigurationsCommandInput;
+            output: ListChatResponseConfigurationsCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,105 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { UpdateChatResponseConfigurationRequest, UpdateChatResponseConfigurationResponse } from "../models/models_1";
+import { QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QBusinessClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateChatResponseConfigurationCommand}.
+ */
+export interface UpdateChatResponseConfigurationCommandInput extends UpdateChatResponseConfigurationRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateChatResponseConfigurationCommand}.
+ */
+export interface UpdateChatResponseConfigurationCommandOutput extends UpdateChatResponseConfigurationResponse, __MetadataBearer {
+}
+declare const UpdateChatResponseConfigurationCommand_base: {
+    new (input: UpdateChatResponseConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateChatResponseConfigurationCommandInput, UpdateChatResponseConfigurationCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UpdateChatResponseConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateChatResponseConfigurationCommandInput, UpdateChatResponseConfigurationCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates an existing chat response configuration in an Amazon Q Business application. This operation allows administrators to modify configuration settings, display name, and response parameters to refine how the system generates responses.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QBusinessClient, UpdateChatResponseConfigurationCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
+ * // const { QBusinessClient, UpdateChatResponseConfigurationCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
+ * const client = new QBusinessClient(config);
+ * const input = { // UpdateChatResponseConfigurationRequest
+ *   applicationId: "STRING_VALUE", // required
+ *   chatResponseConfigurationId: "STRING_VALUE", // required
+ *   displayName: "STRING_VALUE",
+ *   responseConfigurations: { // ResponseConfigurations // required
+ *     "<keys>": { // ResponseConfiguration
+ *       instructionCollection: { // InstructionCollection
+ *         responseLength: "STRING_VALUE",
+ *         targetAudience: "STRING_VALUE",
+ *         perspective: "STRING_VALUE",
+ *         outputStyle: "STRING_VALUE",
+ *         identity: "STRING_VALUE",
+ *         tone: "STRING_VALUE",
+ *         customInstructions: "STRING_VALUE",
+ *         examples: "STRING_VALUE",
+ *       },
+ *     },
+ *   },
+ *   clientToken: "STRING_VALUE",
+ * };
+ * const command = new UpdateChatResponseConfigurationCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param UpdateChatResponseConfigurationCommandInput - {@link UpdateChatResponseConfigurationCommandInput}
+ * @returns {@link UpdateChatResponseConfigurationCommandOutput}
+ * @see {@link UpdateChatResponseConfigurationCommandInput} for command's `input` shape.
+ * @see {@link UpdateChatResponseConfigurationCommandOutput} for command's `response` shape.
+ * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p> You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
+ *
+ * @throws {@link QBusinessServiceException}
+ * <p>Base exception class for all service exceptions from QBusiness service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UpdateChatResponseConfigurationCommand extends UpdateChatResponseConfigurationCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateChatResponseConfigurationRequest;
+            output: {};
+        };
+        sdk: {
+            input: UpdateChatResponseConfigurationCommandInput;
+            output: UpdateChatResponseConfigurationCommandOutput;
+        };
+    };
+}

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

@@ -40,24 +40,25 @@ declare const UpdateRetrieverCommand_base: {
  *   configuration: { // RetrieverConfiguration Union: only one key present
  *     nativeIndexConfiguration: { // NativeIndexConfiguration
  *       indexId: "STRING_VALUE", // required
+ *       version: Number("long"),
  *       boostingOverride: { // DocumentAttributeBoostingOverrideMap
  *         "<keys>": { // DocumentAttributeBoostingConfiguration Union: only one key present
  *           numberConfiguration: { // NumberAttributeBoostingConfiguration
- *             boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
+ *             boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH" || "ONE" || "TWO", // required
  *             boostingType: "PRIORITIZE_LARGER_VALUES" || "PRIORITIZE_SMALLER_VALUES",
  *           },
  *           stringConfiguration: { // StringAttributeBoostingConfiguration
- *             boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
+ *             boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH" || "ONE" || "TWO", // required
  *             attributeValueBoosting: { // StringAttributeValueBoosting
- *               "<keys>": "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH",
+ *               "<keys>": "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH" || "ONE" || "TWO" || "THREE" || "FOUR" || "FIVE",
  *             },
  *           },
  *           dateConfiguration: { // DateAttributeBoostingConfiguration
- *             boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
+ *             boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH" || "ONE" || "TWO", // required
  *             boostingDurationInSeconds: Number("long"),
  *           },
  *           stringListConfiguration: { // StringListAttributeBoostingConfiguration
- *             boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
+ *             boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH" || "ONE" || "TWO", // required
  *           },
  *         },
  *       },

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

@@ -7,6 +7,7 @@ export * from "./ChatSyncCommand";
 export * from "./CheckDocumentAccessCommand";
 export * from "./CreateAnonymousWebExperienceUrlCommand";
 export * from "./CreateApplicationCommand";
+export * from "./CreateChatResponseConfigurationCommand";
 export * from "./CreateDataAccessorCommand";
 export * from "./CreateDataSourceCommand";
 export * from "./CreateIndexCommand";
@@ -18,6 +19,7 @@ export * from "./CreateWebExperienceCommand";
 export * from "./DeleteApplicationCommand";
 export * from "./DeleteAttachmentCommand";
 export * from "./DeleteChatControlsConfigurationCommand";
+export * from "./DeleteChatResponseConfigurationCommand";
 export * from "./DeleteConversationCommand";
 export * from "./DeleteDataAccessorCommand";
 export * from "./DeleteDataSourceCommand";
@@ -30,6 +32,7 @@ export * from "./DeleteWebExperienceCommand";
 export * from "./DisassociatePermissionCommand";
 export * from "./GetApplicationCommand";
 export * from "./GetChatControlsConfigurationCommand";
+export * from "./GetChatResponseConfigurationCommand";
 export * from "./GetDataAccessorCommand";
 export * from "./GetDataSourceCommand";
 export * from "./GetGroupCommand";
@@ -42,6 +45,7 @@ export * from "./GetUserCommand";
 export * from "./GetWebExperienceCommand";
 export * from "./ListApplicationsCommand";
 export * from "./ListAttachmentsCommand";
+export * from "./ListChatResponseConfigurationsCommand";
 export * from "./ListConversationsCommand";
 export * from "./ListDataAccessorsCommand";
 export * from "./ListDataSourceSyncJobsCommand";
@@ -67,6 +71,7 @@ export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
 export * from "./UpdateApplicationCommand";
 export * from "./UpdateChatControlsConfigurationCommand";
+export * from "./UpdateChatResponseConfigurationCommand";
 export * from "./UpdateDataAccessorCommand";
 export * from "./UpdateDataSourceCommand";
 export * from "./UpdateIndexCommand";