AWS chatbot documentation change
Summary
Updated terminology from 'chat channels' to 'chat applications' throughout the document and added JSON code block formatting
Security assessment
Changes are primarily branding/terminology updates (chat channels → chat applications) and formatting improvements. No security vulnerabilities, mitigations, or new security features are introduced. The mention of IAM policy requirements for Support cases is an existing security control, not a new addition.
Diff
diff --git a/chatbot/latest/adminguide/Things-to-know-about-cli.md b/chatbot/latest/adminguide/Things-to-know-about-cli.md index f58e83c06..86ea0356c 100644 --- a//chatbot/latest/adminguide/Things-to-know-about-cli.md +++ b//chatbot/latest/adminguide/Things-to-know-about-cli.md @@ -11 +11 @@ AWS Chatbot is now Amazon Q Developer. [Learn more](./service-rename.html) -Amazon Q Developer in chat channels tracks your use of command options and prompts you for any missing parameters before it runs the command you want. +Amazon Q Developer in chat applications tracks your use of command options and prompts you for any missing parameters before it runs the command you want. @@ -13 +13 @@ Amazon Q Developer in chat channels tracks your use of command options and promp -For example, if you enter `@Amazon Q lambda get-function` with no further arguments, you're prompted for the function name. You can run the `@Amazon Q lambda list-functions` command, find the function name you need, and re-run the first command with the corrected option. You can add more parameters for the initial command with `@Amazon Q function-name `name``. Amazon Q Developer in chat channels parses your commands and helps you complete the correct syntax so it can run the complete AWS CLI command. +For example, if you enter `@Amazon Q lambda get-function` with no further arguments, you're prompted for the function name. You can run the `@Amazon Q lambda list-functions` command, find the function name you need, and re-run the first command with the corrected option. You can add more parameters for the initial command with `@Amazon Q function-name `name``. Amazon Q Developer in chat applications parses your commands and helps you complete the correct syntax so it can run the complete AWS CLI command. @@ -17 +17 @@ For example, if you enter `@Amazon Q lambda get-function` with no further argume - * Getting help for AWS services in Amazon Q Developer in chat channels + * Getting help for AWS services in Amazon Q Developer in chat applications @@ -19 +19 @@ For example, if you enter `@Amazon Q lambda get-function` with no further argume - * Formatting data and viewing logs in Amazon Q Developer in chat channels + * Formatting data and viewing logs in Amazon Q Developer in chat applications @@ -21 +21 @@ For example, if you enter `@Amazon Q lambda get-function` with no further argume - * Displaying Amazon CloudWatch Logs information using Amazon Q Developer in chat channels + * Displaying Amazon CloudWatch Logs information using Amazon Q Developer in chat applications @@ -23 +23 @@ For example, if you enter `@Amazon Q lambda get-function` with no further argume - * Creating an AWS Support case using Amazon Q Developer in chat channels + * Creating an AWS Support case using Amazon Q Developer in chat applications @@ -28 +28 @@ For example, if you enter `@Amazon Q lambda get-function` with no further argume -## Getting help for AWS services in Amazon Q Developer in chat channels +## Getting help for AWS services in Amazon Q Developer in chat applications @@ -36 +36 @@ To get help about commands for any AWS service, enter **@Amazon Q** followed by -## Formatting data and viewing logs in Amazon Q Developer in chat channels +## Formatting data and viewing logs in Amazon Q Developer in chat applications @@ -64 +64 @@ You can also filter AWS CLI output by using the optional `query` parameter. A qu -## Displaying Amazon CloudWatch Logs information using Amazon Q Developer in chat channels +## Displaying Amazon CloudWatch Logs information using Amazon Q Developer in chat applications @@ -68 +68 @@ CloudWatch alarm notifications show buttons in chat client notifications to view -You can view CloudWatch logs, including error logs, that are associated with the CloudWatch alarm by choosing **Show logs** at the bottom of the alarm notification. Amazon Q Developer in chat channels displays the first 30 log entries from the start of the alarm evaluation period. Amazon Q Developer in chat channels uses CloudWatch Log Insights to query for logs. The query results contain a link to the CloudWatch Log Insights console, where a user can dive deeper into logs details. +You can view CloudWatch logs, including error logs, that are associated with the CloudWatch alarm by choosing **Show logs** at the bottom of the alarm notification. Amazon Q Developer in chat applications displays the first 30 log entries from the start of the alarm evaluation period. Amazon Q Developer in chat applications uses CloudWatch Log Insights to query for logs. The query results contain a link to the CloudWatch Log Insights console, where a user can dive deeper into logs details. @@ -74 +74 @@ The log shows a command that a user can copy, paste, and edit to re-run the quer -## Creating an AWS Support case using Amazon Q Developer in chat channels +## Creating an AWS Support case using Amazon Q Developer in chat applications @@ -82 +82 @@ You can quickly create a new AWS support case by entering the following: -Follow the prompts from Amazon Q Developer in chat channels to fill out the support case with its needed parameters. When you complete the case information entry, Amazon Q Developer in chat channels asks for confirmation. You will not be able to use file attachments. +Follow the prompts from Amazon Q Developer in chat applications to fill out the support case with its needed parameters. When you complete the case information entry, Amazon Q Developer in chat applications asks for confirmation. You will not be able to use file attachments. @@ -86 +86 @@ Follow the prompts from Amazon Q Developer in chat channels to fill out the supp -Amazon Q Developer in chat channels requires `UpperCamelCase` for the `--query` parameter. In `UpperCamelCase`, the first letter of every word is capitalized. +Amazon Q Developer in chat applications requires `UpperCamelCase` for the `--query` parameter. In `UpperCamelCase`, the first letter of every word is capitalized. @@ -88 +88 @@ Amazon Q Developer in chat channels requires `UpperCamelCase` for the `--query` -For any Amazon Q Developer in chat channels role that creates Support cases, you need to attach the **AWS Support command permissions** policy to the role. For existing roles, you will need to attach the policy in the IAM console. +For any Amazon Q Developer in chat applications role that creates Support cases, you need to attach the **AWS Support command permissions** policy to the role. For existing roles, you will need to attach the policy in the IAM console. @@ -92 +92 @@ In the IAM console, this policy appears as **AWSSupportAccess**. -It is an AWS managed policy. Attach this policy in IAM to any role for Amazon Q Developer in chat channels usage. You can define your own policy with greater restrictions, using this policy as a template. +It is an AWS managed policy. Attach this policy in IAM to any role for Amazon Q Developer in chat applications usage. You can define your own policy with greater restrictions, using this policy as a template. @@ -97,0 +98,6 @@ The policy's JSON code is shown following: +JSON + + +**** + +