AWS chatbot documentation change
Summary
Updated documentation to consistently use 'Amazon Q Developer in chat channels' branding throughout the file, clarifying the service's scope and naming
Security assessment
The changes are purely branding/naming updates (adding 'in chat channels' qualifier) without introducing new security concepts or addressing vulnerabilities. Existing security references to IAM policies and guardrails remain functionally unchanged.
Diff
diff --git a/chatbot/latest/adminguide/what-is.md b/chatbot/latest/adminguide/what-is.md index d988e3e77..41c4ac787 100644 --- a//chatbot/latest/adminguide/what-is.md +++ b//chatbot/latest/adminguide/what-is.md @@ -11 +11 @@ AWS Chatbot is now Amazon Q Developer. [Learn more](./service-rename.html) -Amazon Q Developer enables DevOps and software development teams to use messaging program chat channels to monitor and respond to operational events in their AWS Cloud. Amazon Q Developer processes AWS service notifications from Amazon Simple Notification Service (Amazon SNS), and forwards them to chat channels so teams can analyze and act on them immediately, regardless of location. +Amazon Q Developer in chat channels enables DevOps and software development teams to use messaging program chat channels to monitor and respond to operational events in their AWS Cloud. Amazon Q Developer in chat channels processes AWS service notifications from Amazon Simple Notification Service (Amazon SNS), and forwards them to chat channels so teams can analyze and act on them immediately, regardless of location. @@ -13 +13 @@ Amazon Q Developer enables DevOps and software development teams to use messagin -Amazon Q Developer also supports AWS CLI commands so you can manage AWS resources directly from your chat channels. +Amazon Q Developer in chat channels also supports AWS CLI commands so you can manage AWS resources directly from your chat channels. @@ -36 +36 @@ Amazon Q Developer also supports AWS CLI commands so you can manage AWS resource -Amazon Q Developer enables ChatOps for AWS. _ChatOps_ speeds software development and operations by enabling DevOps teams to use chat clients and chatbots to communicate and execute tasks. Amazon Q Developer notifies chat users about events in their AWS services, so teams can collaboratively monitor and resolve issues in real time, instead of addressing emails from their SNS topics. Amazon Q Developer also allows you to format incident metrics from Amazon CloudWatch as charts for viewing in chat notifications. +Amazon Q Developer in chat channels enables ChatOps for AWS. _ChatOps_ speeds software development and operations by enabling DevOps teams to use chat clients and chatbots to communicate and execute tasks. Amazon Q Developer in chat channels notifies chat users about events in their AWS services, so teams can collaboratively monitor and resolve issues in real time, instead of addressing emails from their SNS topics. Amazon Q Developer in chat channels also allows you to format incident metrics from Amazon CloudWatch as charts for viewing in chat notifications. @@ -38 +38 @@ Amazon Q Developer enables ChatOps for AWS. _ChatOps_ speeds software developmen -Important features of the Amazon Q Developer service include the following: +Important features of the Amazon Q Developer in chat channels service include the following: @@ -42 +42 @@ Important features of the Amazon Q Developer service include the following: - * **Supports Amazon Chime, Microsoft Teams, and Slack** – You can add Amazon Q Developer to your Amazon Chime chat rooms, Microsoft Teams channels, or Slack channels in just a few clicks. + * **Supports Amazon Chime, Microsoft Teams, and Slack** – You can add Amazon Q Developer in chat channels to your Amazon Chime chat rooms, Microsoft Teams channels, or Slack channels in just a few clicks. @@ -44 +44 @@ Important features of the Amazon Q Developer service include the following: - * **Predefined AWS Identity and Access Management (IAM) policy templates** – Amazon Q Developer provides chat room-specific permission controls through AWS Identity and Access Management (IAM). The available predefined templates make it easy to select and set up the permissions you want associated with a given channel or chat room. + * **Predefined AWS Identity and Access Management (IAM) policy templates** – Amazon Q Developer in chat channels provides chat room-specific permission controls through AWS Identity and Access Management (IAM). The available predefined templates make it easy to select and set up the permissions you want associated with a given channel or chat room. @@ -46 +46 @@ Important features of the Amazon Q Developer service include the following: - * **Receive notifications** – Use Amazon Q Developer to receive notifications about operational incidents and other events from supported sources, such as operational alarms, security alerts, or budget deviations. To set up notifications in the Amazon Q Developer console, choose the channels or chat rooms you want to receive notifications and then choose which Amazon Simple Notification Service (Amazon SNS) topics should trigger notifications. + * **Receive notifications** – Use Amazon Q Developer in chat channels to receive notifications about operational incidents and other events from supported sources, such as operational alarms, security alerts, or budget deviations. To set up notifications in the Amazon Q Developer in chat channels console, choose the channels or chat rooms you want to receive notifications and then choose which Amazon Simple Notification Service (Amazon SNS) topics should trigger notifications. @@ -52 +52 @@ Important features of the Amazon Q Developer service include the following: - * **Monitor and manage AWS resources through the AWS CLI with Microsoft Teams and Slack** – Amazon Q Developer supports CLI commands for most AWS services, making it easy to monitor and manage your AWS resources from your chat clients on desktop and mobile devices. Your teams can retrieve diagnostic information in real-time, change your AWS resources, run AWS SSM runbooks, and start long running jobs from a centralized location. Amazon Q Developer commands use the standard AWS Command Line Interface syntax. + * **Monitor and manage AWS resources through the AWS CLI with Microsoft Teams and Slack** – Amazon Q Developer in chat channels supports CLI commands for most AWS services, making it easy to monitor and manage your AWS resources from your chat clients on desktop and mobile devices. Your teams can retrieve diagnostic information in real-time, change your AWS resources, run AWS SSM runbooks, and start long running jobs from a centralized location. Amazon Q Developer in chat channels commands use the standard AWS Command Line Interface syntax. @@ -54 +54 @@ Important features of the Amazon Q Developer service include the following: - * **Supports developer tools** – You can manage your Amazon Q Developer resources using developer tools such as AWS software development kits (SDKs), the AWS Cloud Development Kit (AWS CDK), AWS CloudFormation, and AWS Cloud Control API. You can also use third party infrastructure as code (IaaC) providers such as [Terraform](https://www.hashicorp.com/blog/managing-resources-with-the-terraform-aws-cloud-control-provider). + * **Supports developer tools** – You can manage your Amazon Q Developer in chat channels resources using developer tools such as AWS software development kits (SDKs), the AWS Cloud Development Kit (AWS CDK), AWS CloudFormation, and AWS Cloud Control API. You can also use third party infrastructure as code (IaaC) providers such as [Terraform](https://www.hashicorp.com/blog/managing-resources-with-the-terraform-aws-cloud-control-provider). @@ -61 +61 @@ Important features of the Amazon Q Developer service include the following: -Amazon Q Developer uses Amazon Simple Notification Service (Amazon SNS) topics to send event and alarm notifications from AWS services to your chat channels. Once an SNS topic is associated with a configured chat client, events and alarms from various services are processed and notifications are delivered to the specified chat channels and webhooks. For Microsoft Teams and Slack, after an administrator approves Amazon Q Developer support for the tenant or workspace, anyone in the team or workspace can add Amazon Q Developer to their chat channels. For Amazon Chime, users with AWS Identity and Access Management (IAM) permissions to use Amazon Chime can add Amazon Q Developer to their webhooks. You use the Amazon Q Developer console to configure chat clients to receive notifications from SNS topics. +Amazon Q Developer in chat channels uses Amazon Simple Notification Service (Amazon SNS) topics to send event and alarm notifications from AWS services to your chat channels. Once an SNS topic is associated with a configured chat client, events and alarms from various services are processed and notifications are delivered to the specified chat channels and webhooks. For Microsoft Teams and Slack, after an administrator approves Amazon Q Developer in chat channels support for the tenant or workspace, anyone in the team or workspace can add Amazon Q Developer in chat channels to their chat channels. For Amazon Chime, users with AWS Identity and Access Management (IAM) permissions to use Amazon Chime can add Amazon Q Developer in chat channels to their webhooks. You use the Amazon Q Developer in chat channels console to configure chat clients to receive notifications from SNS topics. @@ -63 +63 @@ Amazon Q Developer uses Amazon Simple Notification Service (Amazon SNS) topics t -You can also run AWS CLI commands directly in chat channels using Amazon Q Developer. You can retrieve diagnostic information, configure AWS resources, and run workflows. To run a command, Amazon Q Developer checks that all required parameters are entered. If any are missing, Amazon Q Developer prompts you for the required information. Amazon Q Developer then confirms if the command is permissible by checking the command against what is allowed by the configured IAM roles and the channel guardrail policies. For more information, see [Running AWS CLI commands from chat channels](./chatbot-cli-commands.html) and [Understanding permissions](./understanding-permissions.html). +You can also run AWS CLI commands directly in chat channels using Amazon Q Developer. You can retrieve diagnostic information, configure AWS resources, and run workflows. To run a command, Amazon Q Developer in chat channels checks that all required parameters are entered. If any are missing, Amazon Q Developer in chat channels prompts you for the required information. Amazon Q Developer in chat channels then confirms if the command is permissible by checking the command against what is allowed by the configured IAM roles and the channel guardrail policies. For more information, see [Running AWS CLI commands from chat channels](./chatbot-cli-commands.html) and [Understanding permissions](./understanding-permissions.html). @@ -67 +67 @@ You can also run AWS CLI commands directly in chat channels using Amazon Q Devel -To use Amazon Q Developer, you need the following: +To use Amazon Q Developer in chat channels, you need the following: @@ -69 +69 @@ To use Amazon Q Developer, you need the following: - * An AWS account to associate with Amazon Chime, Microsoft Teams, or Slack chat clients during Amazon Q Developer setup. + * An AWS account to associate with Amazon Chime, Microsoft Teams, or Slack chat clients during Amazon Q Developer in chat channels setup. @@ -71 +71 @@ To use Amazon Q Developer, you need the following: - * Administrative privileges for your Amazon Chime chat room, Microsoft Teams tenant, or Slack workspace. You can be the Slack workspace owner or have the ability to work with workspace owners to get approval for installing Amazon Q Developer. + * Administrative privileges for your Amazon Chime chat room, Microsoft Teams tenant, or Slack workspace. You can be the Slack workspace owner or have the ability to work with workspace owners to get approval for installing Amazon Q Developer in chat channels. @@ -75 +75 @@ To use Amazon Q Developer, you need the following: - * Experience with the AWS services supported by Amazon Q Developer, including experience configuring those services to subscribe to Amazon Simple Notification Service (Amazon SNS) topics to send notifications. For information about supported services, see [Using Amazon Q Developer with Other AWS Services](./related-services.html). + * Experience with the AWS services supported by Amazon Q Developer in chat channels, including experience configuring those services to subscribe to Amazon Simple Notification Service (Amazon SNS) topics to send notifications. For information about supported services, see [Using Amazon Q Developer in chat channels with Other AWS Services](./related-services.html). @@ -80 +80 @@ To use Amazon Q Developer, you need the following: -To access Amazon CloudWatch metrics, Amazon Q Developer requires an AWS Identity and Access Management (IAM) role with a permissions policy and a trust policy. You create this IAM role, with the required policies, [using the Amazon Q Developer console](https://us-east-2.console.aws.amazon.com/chatbot/home?region=us-east-2#/chat-clients). You can use an existing IAM role, but it must have the required policies. +To access Amazon CloudWatch metrics, Amazon Q Developer in chat channels requires an AWS Identity and Access Management (IAM) role with a permissions policy and a trust policy. You create this IAM role, with the required policies, [using the Amazon Q Developer in chat channels console](https://us-east-2.console.aws.amazon.com/chatbot/home?region=us-east-2#/chat-clients). You can use an existing IAM role, but it must have the required policies. @@ -84 +84 @@ To access Amazon CloudWatch metrics, Amazon Q Developer requires an AWS Identity -You access and configure Amazon Q Developer through the Amazon Q Developer in chat applications console at [https://console.aws.amazon.com/chatbot/](https://console.aws.amazon.com/chatbot/). +You access and configure Amazon Q Developer in chat channels through the Amazon Q Developer in chat applications console at [https://console.aws.amazon.com/chatbot/](https://console.aws.amazon.com/chatbot/). @@ -86 +86 @@ You access and configure Amazon Q Developer through the Amazon Q Developer in ch -You can also access the Amazon Q Developer app from the [Slack app directory](https://amzn-aws.slack.com/apps/A6L22LZNH-aws-chatbot?settings=1). +You can also access the Amazon Q Developer in chat channels app from the [Slack app directory](https://amzn-aws.slack.com/apps/A6L22LZNH-aws-chatbot?settings=1). @@ -94 +94 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -Amazon Q Developer service rename +Amazon Q Developer in chat channels service rename