@aws-sdk/client-chatbot 3.699.0 → 3.700.0

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

@@ -63,6 +63,18 @@ declare const AssociateToConfigurationCommand_base: {
  * <p>Base exception class for all service exceptions from Chatbot service.</p>
  *
  * @public
+ * @example Associate a custom action to a configuration
+ * ```javascript
+ * // Associate a custom action to a channel configuration, allowing it to be used in that channel
+ * const input = {
+ *   "ChatConfiguration": "arn:aws:chatbot::1234567890:chat-configuration/slack-channel/my-channel",
+ *   "Resource": "arn:aws:chatbot::1234567890:custom-action/my-custom-action"
+ * };
+ * const command = new AssociateToConfigurationCommand(input);
+ * await client.send(command);
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class AssociateToConfigurationCommand extends AssociateToConfigurationCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -97,6 +97,51 @@ declare const CreateCustomActionCommand_base: {
  * <p>Base exception class for all service exceptions from Chatbot service.</p>
  *
  * @public
+ * @example Create an alias that invokes a Lambda function
+ * ```javascript
+ * // Creates an alias that invokes a Lambda function from chat channels. You can use this alias by entering 'run invoke', after which you're prompted for the function name.
+ * const input = {
+ *   "ActionName": "my-custom-action",
+ *   "AliasName": "invoke",
+ *   "Definition": {
+ *     "CommandText": "lambda invoke $functionName"
+ *   }
+ * };
+ * const command = new CreateCustomActionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "CustomActionArn": "arn:aws:chatbot::1234567890:custom-action/my-custom-action"
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
+ * @example Create a custom action to list alarms
+ * ```javascript
+ * // Creates a button on all Cloudwatch notifications that lists alarms in the ‘ALARM’ state.
+ * const input = {
+ *   "ActionName": "describe-alarms",
+ *   "Attachments": [
+ *     {
+ *       "ButtonText": "List alarms",
+ *       "NotificationType": "CloudWatch"
+ *     }
+ *   ],
+ *   "Definition": {
+ *     "CommandText": "cloudwatch describe-alarms --state-value ALARM"
+ *   }
+ * };
+ * const command = new CreateCustomActionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "CustomActionArn": "arn:aws:chatbot::1234567890:custom-action/describe-alarms"
+ * }
+ * *\/
+ * // example id: example-2
+ * ```
+ *
  */
 export declare class CreateCustomActionCommand extends CreateCustomActionCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -65,6 +65,17 @@ declare const DeleteCustomActionCommand_base: {
  * <p>Base exception class for all service exceptions from Chatbot service.</p>
  *
  * @public
+ * @example Delete a custom action
+ * ```javascript
+ * //
+ * const input = {
+ *   "CustomActionArn": "arn:aws:chatbot::1234567890:custom-action/my-custom-action"
+ * };
+ * const command = new DeleteCustomActionCommand(input);
+ * await client.send(command);
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class DeleteCustomActionCommand extends DeleteCustomActionCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -63,6 +63,18 @@ declare const DisassociateFromConfigurationCommand_base: {
  * <p>Base exception class for all service exceptions from Chatbot service.</p>
  *
  * @public
+ * @example Disassociate a custom action from a configuration
+ * ```javascript
+ * //
+ * const input = {
+ *   "ChatConfiguration": "arn:aws:chatbot::1234567890:chat-configuration/slack-channel/my-channel",
+ *   "Resource": "arn:aws:chatbot::1234567890:custom-action/my-custom-action"
+ * };
+ * const command = new DisassociateFromConfigurationCommand(input);
+ * await client.send(command);
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class DisassociateFromConfigurationCommand extends DisassociateFromConfigurationCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -90,6 +90,28 @@ declare const GetCustomActionCommand_base: {
  * <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. */

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

@@ -62,6 +62,26 @@ declare const ListAssociationsCommand_base: {
  * <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. */

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

@@ -68,6 +68,22 @@ declare const ListCustomActionsCommand_base: {
  * <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. */

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

@@ -87,6 +87,25 @@ declare const UpdateCustomActionCommand_base: {
  * <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. */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-chatbot",
   "description": "AWS SDK for JavaScript Chatbot Client for Node.js, Browser and React Native",
-  "version": "3.699.0",
+  "version": "3.700.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",