AWS chatbot documentation change
Summary
Updated custom action documentation to include Automation runbooks, restructured Lambda action section, and added IAM role selection guidance
Security assessment
Adds security-related documentation about IAM role selection for Automation runbooks but shows no evidence of addressing a specific security vulnerability
Diff
diff --git a/chatbot/latest/adminguide/creating-custom-actions.md b/chatbot/latest/adminguide/creating-custom-actions.md index 8cd02ea23..52cd9367e 100644 --- a//chatbot/latest/adminguide/creating-custom-actions.md +++ b//chatbot/latest/adminguide/creating-custom-actions.md @@ -9 +9 @@ AWS Chatbot is now Amazon Q Developer. [Learn more](./service-rename.html) -You can create custom actions using Lambda functions in your account, using the [Amazon Q Developer API](https://docs.aws.amazon.com/chatbot/latest/APIReference/Welcome.html), or by entering AWS CLI commands. AWS CLI command Shortcuts function similarly to [Command aliases](./creating-aliases.html). +You can create custom actions using AWS CLI commands, Automation runbooks and Lambda functions in your account, or by using the [Amazon Q Developer in chat applications API](https://docs.aws.amazon.com/chatbot/latest/APIReference/Welcome.html). AWS CLI command Shortcuts function similarly to [Command aliases](./creating-aliases.html). @@ -11 +11 @@ You can create custom actions using Lambda functions in your account, using the -Lambda action +Automation action @@ -14 +14 @@ Lambda action -###### To create a Lambda action +###### To create an Automation action @@ -16 +16 @@ Lambda action - 1. Choose the vertical ellipsis button on the bottom of a notification in your chat channel. + 1. Choose the vertical ellipsis button (**⋮**) on the bottom of a notification in your chat channel. @@ -24 +24 @@ Lambda action - 5. For **Custom action type** , select **Lambda action**. + 5. For **Custom action type** , select **Automation runbook action**. @@ -34 +34 @@ Lambda action -The available Lambda functions are populated from this account and Region. +The available Automation runbooks are populated from this account and Region. @@ -36 +36 @@ The available Lambda functions are populated from this account and Region. - 9. Choose **Load Lambdas**. + 9. Select an Automation runbook owner. This value defaults to **Owned by me**. @@ -38 +38 @@ The available Lambda functions are populated from this account and Region. - 10. In **Define Lambda Function** , select a Lambda function. +###### Note @@ -40 +40,7 @@ The available Lambda functions are populated from this account and Region. - 11. Enter your payload. +You can filter runbooks by owner. For more information about owner types, see [Editing an existing Systems Manager automation document](https://docs.aws.amazon.com/cloud9/latest/user-guide/systems-manager-automation-docs.html#systems-manager-open) in the _AWS Cloud9 User Guide_. + + 10. Choose **Load Automation runbooks**. + + 11. In **Define Automation runbook** , select an Automation runbook. + + 12. Enter your input parameters. @@ -46 +52 @@ We expose predefined variables from your custom notifications as useable variabl - 12. (Optional) Add more variables by choosing **\+ Add more variables**. + 13. (Optional) Add more variables by choosing **\+ Add more variables**. @@ -48 +54 @@ We expose predefined variables from your custom notifications as useable variabl - 13. Choose **Next**. + 14. Choose **Next**. @@ -50 +56 @@ We expose predefined variables from your custom notifications as useable variabl - 14. (Optional) Add additional display criteria: + 15. (Optional) Add additional display criteria: @@ -58 +64 @@ We expose predefined variables from your custom notifications as useable variabl - 15. Choose **Save**. + 16. Choose **Save**. @@ -63 +69,3 @@ We expose predefined variables from your custom notifications as useable variabl -AWS CLI command action +When you run a runbook, you're prompted to select the IAM role used to run it. You can select from assumable roles in the account configured with your chat channel. If you don't select a role, the runbook runs using your channel role. + +CLI action @@ -68 +76 @@ AWS CLI command action - 1. Choose the vertical ellipsis button on the bottom of a notification in your chat channel. + 1. Choose the vertical ellipsis button (**⋮**) on the bottom of a notification in your chat channel. @@ -100,0 +109,52 @@ We expose predefined variables from your custom notifications as useable variabl +Lambda action + + +###### To create a Lambda action + + 1. Choose the vertical ellipsis button (**⋮**) on the bottom of a notification in your chat channel. + + 2. In **Manage actions** , choose **Create**. + + 3. Enter a custom action name. This name is a unique identifier for your custom action. + + 4. Enter a name for your custom action button. This name is shown on a button on your notification. This name should be 20 characters or less and can incorporate emojis. + + 5. For **Custom action type** , select **Lambda action**. + + 6. Choose **Next**. + + 7. Select an AWS account. + + 8. Select a Region. + +###### Note + +The available Lambda functions are populated from this account and Region. + + 9. Choose **Load Lambdas**. + + 10. In **Define Lambda Function** , select a Lambda function. + + 11. Enter your payload. + +###### Note + +We expose predefined variables from your custom notifications as useable variables. + + 12. (Optional) Add more variables by choosing **\+ Add more variables**. + + 13. Choose **Next**. + + 14. (Optional) Add additional display criteria: + + 1. Select a variable. + + 2. Select a condition. + + 3. Choose **Add**. + + 15. Choose **Save**. + + + +