@aws-sdk/client-chatbot 3.696.0 → 3.700.0

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

@@ -0,0 +1,128 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ChatbotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChatbotClient";
+import { GetCustomActionRequest, GetCustomActionResult } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetCustomActionCommand}.
+ */
+export interface GetCustomActionCommandInput extends GetCustomActionRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetCustomActionCommand}.
+ */
+export interface GetCustomActionCommandOutput extends GetCustomActionResult, __MetadataBearer {
+}
+declare const GetCustomActionCommand_base: {
+    new (input: GetCustomActionCommandInput): import("@smithy/smithy-client").CommandImpl<GetCustomActionCommandInput, GetCustomActionCommandOutput, ChatbotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetCustomActionCommandInput): import("@smithy/smithy-client").CommandImpl<GetCustomActionCommandInput, GetCustomActionCommandOutput, ChatbotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns a custom action.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ChatbotClient, GetCustomActionCommand } from "@aws-sdk/client-chatbot"; // ES Modules import
+ * // const { ChatbotClient, GetCustomActionCommand } = require("@aws-sdk/client-chatbot"); // CommonJS import
+ * const client = new ChatbotClient(config);
+ * const input = { // GetCustomActionRequest
+ *   CustomActionArn: "STRING_VALUE", // required
+ * };
+ * const command = new GetCustomActionCommand(input);
+ * const response = await client.send(command);
+ * // { // GetCustomActionResult
+ * //   CustomAction: { // CustomAction
+ * //     CustomActionArn: "STRING_VALUE", // required
+ * //     Definition: { // CustomActionDefinition
+ * //       CommandText: "STRING_VALUE", // required
+ * //     },
+ * //     AliasName: "STRING_VALUE",
+ * //     Attachments: [ // CustomActionAttachmentList
+ * //       { // CustomActionAttachment
+ * //         NotificationType: "STRING_VALUE",
+ * //         ButtonText: "STRING_VALUE",
+ * //         Criteria: [ // CustomActionAttachmentCriteriaList
+ * //           { // CustomActionAttachmentCriteria
+ * //             Operator: "HAS_VALUE" || "EQUALS", // required
+ * //             VariableName: "STRING_VALUE", // required
+ * //             Value: "STRING_VALUE",
+ * //           },
+ * //         ],
+ * //         Variables: { // CustomActionAttachmentVariables
+ * //           "<keys>": "STRING_VALUE",
+ * //         },
+ * //       },
+ * //     ],
+ * //     ActionName: "STRING_VALUE",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetCustomActionCommandInput - {@link GetCustomActionCommandInput}
+ * @returns {@link GetCustomActionCommandOutput}
+ * @see {@link GetCustomActionCommandInput} for command's `input` shape.
+ * @see {@link GetCustomActionCommandOutput} for command's `response` shape.
+ * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape.
+ *
+ * @throws {@link InternalServiceError} (server fault)
+ *  <p>Unexpected error during processing of request.</p>
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>We were unable to find the resource for your request</p>
+ *
+ * @throws {@link UnauthorizedException} (client fault)
+ *  <p>The request was rejected because it doesn't have valid credentials for the target resource.</p>
+ *
+ * @throws {@link ChatbotServiceException}
+ * <p>Base exception class for all service exceptions from Chatbot service.</p>
+ *
+ * @public
+ * @example Get a custom action
+ * ```javascript
+ * //
+ * const input = {
+ *   "CustomActionArn": "arn:aws:chatbot::1234567890:custom-action/my-custom-action"
+ * };
+ * const command = new GetCustomActionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "CustomAction": {
+ *     "ActionName": "my-custom-action",
+ *     "CustomActionArn": "arn:aws:chatbot::1234567890:custom-action/my-custom-action",
+ *     "Definition": {
+ *       "CommandText": "lambda invoke $functionName"
+ *     }
+ *   }
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
+ */
+export declare class GetCustomActionCommand extends GetCustomActionCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetCustomActionRequest;
+            output: GetCustomActionResult;
+        };
+        sdk: {
+            input: GetCustomActionCommandInput;
+            output: GetCustomActionCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,98 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ChatbotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChatbotClient";
+import { ListAssociationsRequest, ListAssociationsResult } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListAssociationsCommand}.
+ */
+export interface ListAssociationsCommandInput extends ListAssociationsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListAssociationsCommand}.
+ */
+export interface ListAssociationsCommandOutput extends ListAssociationsResult, __MetadataBearer {
+}
+declare const ListAssociationsCommand_base: {
+    new (input: ListAssociationsCommandInput): import("@smithy/smithy-client").CommandImpl<ListAssociationsCommandInput, ListAssociationsCommandOutput, ChatbotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: ListAssociationsCommandInput): import("@smithy/smithy-client").CommandImpl<ListAssociationsCommandInput, ListAssociationsCommandOutput, ChatbotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Lists resources associated with a channel configuration.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ChatbotClient, ListAssociationsCommand } from "@aws-sdk/client-chatbot"; // ES Modules import
+ * // const { ChatbotClient, ListAssociationsCommand } = require("@aws-sdk/client-chatbot"); // CommonJS import
+ * const client = new ChatbotClient(config);
+ * const input = { // ListAssociationsRequest
+ *   ChatConfiguration: "STRING_VALUE", // required
+ *   MaxResults: Number("int"),
+ *   NextToken: "STRING_VALUE",
+ * };
+ * const command = new ListAssociationsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListAssociationsResult
+ * //   Associations: [ // AssociationList // required
+ * //     { // AssociationListing
+ * //       Resource: "STRING_VALUE", // required
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListAssociationsCommandInput - {@link ListAssociationsCommandInput}
+ * @returns {@link ListAssociationsCommandOutput}
+ * @see {@link ListAssociationsCommandInput} for command's `input` shape.
+ * @see {@link ListAssociationsCommandOutput} for command's `response` shape.
+ * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape.
+ *
+ * @throws {@link ChatbotServiceException}
+ * <p>Base exception class for all service exceptions from Chatbot service.</p>
+ *
+ * @public
+ * @example List custom actions associated with a configuration
+ * ```javascript
+ * //
+ * const input = {
+ *   "ChatConfiguration": "arn:aws:chatbot::1234567890:chat-configuration/slack-channel/my-channel"
+ * };
+ * const command = new ListAssociationsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Associations": [
+ *     {
+ *       "Resource": "arn:aws:chatbot::1234567890:custom-action/my-custom-action"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
+ */
+export declare class ListAssociationsCommand extends ListAssociationsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListAssociationsRequest;
+            output: ListAssociationsResult;
+        };
+        sdk: {
+            input: ListAssociationsCommandInput;
+            output: ListAssociationsCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,100 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ChatbotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChatbotClient";
+import { ListCustomActionsRequest, ListCustomActionsResult } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListCustomActionsCommand}.
+ */
+export interface ListCustomActionsCommandInput extends ListCustomActionsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListCustomActionsCommand}.
+ */
+export interface ListCustomActionsCommandOutput extends ListCustomActionsResult, __MetadataBearer {
+}
+declare const ListCustomActionsCommand_base: {
+    new (input: ListCustomActionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListCustomActionsCommandInput, ListCustomActionsCommandOutput, ChatbotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [ListCustomActionsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListCustomActionsCommandInput, ListCustomActionsCommandOutput, ChatbotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Lists custom actions defined in this account.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ChatbotClient, ListCustomActionsCommand } from "@aws-sdk/client-chatbot"; // ES Modules import
+ * // const { ChatbotClient, ListCustomActionsCommand } = require("@aws-sdk/client-chatbot"); // CommonJS import
+ * const client = new ChatbotClient(config);
+ * const input = { // ListCustomActionsRequest
+ *   MaxResults: Number("int"),
+ *   NextToken: "STRING_VALUE",
+ * };
+ * const command = new ListCustomActionsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListCustomActionsResult
+ * //   CustomActions: [ // CustomActionArnList // required
+ * //     "STRING_VALUE",
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListCustomActionsCommandInput - {@link ListCustomActionsCommandInput}
+ * @returns {@link ListCustomActionsCommandOutput}
+ * @see {@link ListCustomActionsCommandInput} for command's `input` shape.
+ * @see {@link ListCustomActionsCommandOutput} for command's `response` shape.
+ * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape.
+ *
+ * @throws {@link InternalServiceError} (server fault)
+ *  <p>Unexpected error during processing of request.</p>
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
+ *
+ * @throws {@link UnauthorizedException} (client fault)
+ *  <p>The request was rejected because it doesn't have valid credentials for the target resource.</p>
+ *
+ * @throws {@link ChatbotServiceException}
+ * <p>Base exception class for all service exceptions from Chatbot service.</p>
+ *
+ * @public
+ * @example List custom actions
+ * ```javascript
+ * //
+ * const input = {};
+ * const command = new ListCustomActionsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "CustomActions": [
+ *     "arn:aws:chatbot::1234567890:custom-action/my-custom-action"
+ *   ]
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
+ */
+export declare class ListCustomActionsCommand extends ListCustomActionsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListCustomActionsRequest;
+            output: ListCustomActionsResult;
+        };
+        sdk: {
+            input: ListCustomActionsCommandInput;
+            output: ListCustomActionsCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,122 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ChatbotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChatbotClient";
+import { UpdateCustomActionRequest, UpdateCustomActionResult } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateCustomActionCommand}.
+ */
+export interface UpdateCustomActionCommandInput extends UpdateCustomActionRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateCustomActionCommand}.
+ */
+export interface UpdateCustomActionCommandOutput extends UpdateCustomActionResult, __MetadataBearer {
+}
+declare const UpdateCustomActionCommand_base: {
+    new (input: UpdateCustomActionCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateCustomActionCommandInput, UpdateCustomActionCommandOutput, ChatbotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateCustomActionCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateCustomActionCommandInput, UpdateCustomActionCommandOutput, ChatbotClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates a custom action.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ChatbotClient, UpdateCustomActionCommand } from "@aws-sdk/client-chatbot"; // ES Modules import
+ * // const { ChatbotClient, UpdateCustomActionCommand } = require("@aws-sdk/client-chatbot"); // CommonJS import
+ * const client = new ChatbotClient(config);
+ * const input = { // UpdateCustomActionRequest
+ *   CustomActionArn: "STRING_VALUE", // required
+ *   Definition: { // CustomActionDefinition
+ *     CommandText: "STRING_VALUE", // required
+ *   },
+ *   AliasName: "STRING_VALUE",
+ *   Attachments: [ // CustomActionAttachmentList
+ *     { // CustomActionAttachment
+ *       NotificationType: "STRING_VALUE",
+ *       ButtonText: "STRING_VALUE",
+ *       Criteria: [ // CustomActionAttachmentCriteriaList
+ *         { // CustomActionAttachmentCriteria
+ *           Operator: "HAS_VALUE" || "EQUALS", // required
+ *           VariableName: "STRING_VALUE", // required
+ *           Value: "STRING_VALUE",
+ *         },
+ *       ],
+ *       Variables: { // CustomActionAttachmentVariables
+ *         "<keys>": "STRING_VALUE",
+ *       },
+ *     },
+ *   ],
+ * };
+ * const command = new UpdateCustomActionCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateCustomActionResult
+ * //   CustomActionArn: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateCustomActionCommandInput - {@link UpdateCustomActionCommandInput}
+ * @returns {@link UpdateCustomActionCommandOutput}
+ * @see {@link UpdateCustomActionCommandInput} for command's `input` shape.
+ * @see {@link UpdateCustomActionCommandOutput} for command's `response` shape.
+ * @see {@link ChatbotClientResolvedConfig | config} for ChatbotClient's `config` shape.
+ *
+ * @throws {@link InternalServiceError} (server fault)
+ *  <p>Unexpected error during processing of request.</p>
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>We were unable to find the resource for your request</p>
+ *
+ * @throws {@link UnauthorizedException} (client fault)
+ *  <p>The request was rejected because it doesn't have valid credentials for the target resource.</p>
+ *
+ * @throws {@link ChatbotServiceException}
+ * <p>Base exception class for all service exceptions from Chatbot service.</p>
+ *
+ * @public
+ * @example Update the command definition of an existing action
+ * ```javascript
+ * // Updates the command text of a custom action without altering the existing alias name or attachment criteria
+ * const input = {
+ *   "CustomActionArn": "arn:aws:chatbot::1234567890:custom-action/my-custom-action",
+ *   "Definition": {
+ *     "CommandText": "lambda invoke MyNewFunction"
+ *   }
+ * };
+ * const command = new UpdateCustomActionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "CustomActionArn": "arn:aws:chatbot::1234567890:custom-action/my-custom-action"
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
+ */
+export declare class UpdateCustomActionCommand extends UpdateCustomActionCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateCustomActionRequest;
+            output: UpdateCustomActionResult;
+        };
+        sdk: {
+            input: UpdateCustomActionCommandInput;
+            output: UpdateCustomActionCommandOutput;
+        };
+    };
+}

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

@@ -1,7 +1,10 @@
+export * from "./AssociateToConfigurationCommand";
 export * from "./CreateChimeWebhookConfigurationCommand";
+export * from "./CreateCustomActionCommand";
 export * from "./CreateMicrosoftTeamsChannelConfigurationCommand";
 export * from "./CreateSlackChannelConfigurationCommand";
 export * from "./DeleteChimeWebhookConfigurationCommand";
+export * from "./DeleteCustomActionCommand";
 export * from "./DeleteMicrosoftTeamsChannelConfigurationCommand";
 export * from "./DeleteMicrosoftTeamsConfiguredTeamCommand";
 export * from "./DeleteMicrosoftTeamsUserIdentityCommand";
@@ -12,8 +15,12 @@ export * from "./DescribeChimeWebhookConfigurationsCommand";
 export * from "./DescribeSlackChannelConfigurationsCommand";
 export * from "./DescribeSlackUserIdentitiesCommand";
 export * from "./DescribeSlackWorkspacesCommand";
+export * from "./DisassociateFromConfigurationCommand";
 export * from "./GetAccountPreferencesCommand";
+export * from "./GetCustomActionCommand";
 export * from "./GetMicrosoftTeamsChannelConfigurationCommand";
+export * from "./ListAssociationsCommand";
+export * from "./ListCustomActionsCommand";
 export * from "./ListMicrosoftTeamsChannelConfigurationsCommand";
 export * from "./ListMicrosoftTeamsConfiguredTeamsCommand";
 export * from "./ListMicrosoftTeamsUserIdentitiesCommand";
@@ -22,5 +29,6 @@ export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
 export * from "./UpdateAccountPreferencesCommand";
 export * from "./UpdateChimeWebhookConfigurationCommand";
+export * from "./UpdateCustomActionCommand";
 export * from "./UpdateMicrosoftTeamsChannelConfigurationCommand";
 export * from "./UpdateSlackChannelConfigurationCommand";