AWS chatbot documentation change
Summary
Updated terminology from 'chat channels' to 'chat applications' throughout the document, added installation note, and adjusted instructions to reflect product rebranding.
Security assessment
The changes primarily involve rebranding (Amazon Q Developer in chat channels → chat applications) and clarifying setup steps. No concrete evidence of addressing security vulnerabilities or weaknesses. Existing security-related content (permissions, IAM roles, workspace approvals) remains unchanged except for terminology updates.
Diff
diff --git a/chatbot/latest/adminguide/slack-setup.md b/chatbot/latest/adminguide/slack-setup.md index 646ea9ba5..c485da987 100644 --- a//chatbot/latest/adminguide/slack-setup.md +++ b//chatbot/latest/adminguide/slack-setup.md @@ -11 +11,5 @@ AWS Chatbot is now Amazon Q Developer. [Learn more](./service-rename.html) -To get started using Amazon Q Developer in chat channels to help manage your AWS infrastructure, use the following steps to set up Amazon Q Developer in chat channels with chat channels and Amazon SNS topic subscriptions. +###### Note + +To install the Slack application, sign in to your AWS account in the AWS Management Console. Then navigate to the Amazon Q Developer in chat applications console and choose **Configure new client**. The following steps detail the full setup process. + +To get started using Amazon Q Developer in chat applications to help manage your AWS infrastructure, use the following steps to set up Amazon Q Developer in chat applications with chat channels and Amazon SNS topic subscriptions. @@ -32 +36 @@ To get started using Amazon Q Developer in chat channels to help manage your AWS -Before you get started, make sure you've completed the tasks in [Setting up Amazon Q Developer in chat applications](./getting-started.html#setting-up). You will need to choose a permissions scheme in the following procedure. This scheme determines the permissions your channel members will have and what Amazon Q Developer in chat channels can do on your behalf. For more information about Amazon Q Developer in chat channels permissions, see [Understanding permissions](./understanding-permissions.html). You must also create or choose a Slack channel to be used in your Amazon Q Developer in chat channels configuration. This channel is used to monitor and operate your AWS resources. +Before you get started, make sure you've completed the tasks in [Setting up Amazon Q Developer in chat applications](./getting-started.html#setting-up). You will need to choose a permissions scheme in the following procedure. This scheme determines the permissions your channel members will have and what Amazon Q Developer in chat applications can do on your behalf. For more information about Amazon Q Developer in chat applications permissions, see [Understanding permissions](./understanding-permissions.html). You must also create or choose a Slack channel to be used in your Amazon Q Developer in chat applications configuration. This channel is used to monitor and operate your AWS resources. @@ -36 +40 @@ Before you get started, make sure you've completed the tasks in [Setting up Amaz -To allow Amazon Q Developer in chat channels to send notifications or run commands, you must configure Amazon Q Developer in chat channels with Slack. Workspace administrators must approve the use of the Amazon Q Developer in chat channels app in the workspace. Members can request to install apps if app approval is turned on by the workspace administrator. For more information, see [Add apps to your Slack workspace](https://slack.com/help/articles/202035138-Add-apps-to-your-Slack-workspace). +To allow Amazon Q Developer in chat applications to send notifications or run commands, you must configure Amazon Q Developer in chat applications with Slack. Workspace administrators must approve the use of the Amazon Q Developer in chat applications app in the workspace. Members can request to install apps if app approval is turned on by the workspace administrator. For more information, see [Add apps to your Slack workspace](https://slack.com/help/articles/202035138-Add-apps-to-your-Slack-workspace). @@ -40 +44 @@ To allow Amazon Q Developer in chat channels to send notifications or run comman - 1. Add Amazon Q Developer in chat channels to the Slack workspace: + 1. Add Amazon Q Developer in chat applications to the Slack workspace: @@ -48 +52 @@ If you do not see **Automations** in the left navigation pane, choose **More** , - 2. If Amazon Q Developer in chat channels is not listed, choose the **Browse Apps Directory** button. + 2. If Amazon Q Developer in chat applications is not listed, choose the **Browse Apps Directory** button. @@ -50 +54 @@ If you do not see **Automations** in the left navigation pane, choose **More** , - 3. Browse the directory for the Amazon Q Developer in chat channels app and then choose **Add** to add Amazon Q Developer in chat channels to your workspace. + 3. Browse the directory for the Amazon Q Developer in chat applications app and then choose **Add** to add Amazon Q Developer in chat applications to your workspace. @@ -58 +62 @@ If you do not see **Automations** in the left navigation pane, choose **More** , -After choosing **Configure** , you'll be redirected to Slack's authorization page to request permission for Amazon Q Developer in chat channels to access your information. For more information, see [Chat client application permissions for Amazon Q Developer in chat applications](./app-permissions.html). +After choosing **Configure** , you'll be redirected to Slack's authorization page to request permission for Amazon Q Developer in chat applications to access your information. For more information, see [Chat client application permissions for Amazon Q Developer in chat applications](./app-permissions.html). @@ -60 +64 @@ After choosing **Configure** , you'll be redirected to Slack's authorization pag - 4. From the dropdown list at the top right, choose the Slack workspace that you want to use with Amazon Q Developer in chat channels. + 4. From the dropdown list at the top right, choose the Slack workspace that you want to use with Amazon Q Developer in chat applications. @@ -62 +66 @@ After choosing **Configure** , you'll be redirected to Slack's authorization pag -There's no limit to the number of workspaces that you can set up for Amazon Q Developer in chat channels, but you can set up only one at a time. +There's no limit to the number of workspaces that you can set up for Amazon Q Developer in chat applications, but you can set up only one at a time. @@ -71 +75 @@ There's no limit to the number of workspaces that you can set up for Amazon Q De -To allow Amazon Q Developer in chat channels to send notifications or run commands in your Slack channel, you must also configure Amazon Q Developer in chat channels with a Slack channel. Configuring a channel consists of: +To allow Amazon Q Developer in chat applications to send notifications or run commands in your Slack channel, you must also configure Amazon Q Developer in chat applications with a Slack channel. Configuring a channel consists of: @@ -73 +77 @@ To allow Amazon Q Developer in chat channels to send notifications or run comman - * Adding Amazon Q Developer in chat channels to your Slack channel + * Adding Amazon Q Developer in chat applications to your Slack channel @@ -79 +83 @@ To allow Amazon Q Developer in chat channels to send notifications or run comman - * (Optional) Adding Amazon SNS topics, which Amazon Q Developer in chat channels uses to send notifications to your channel + * (Optional) Adding Amazon SNS topics, which Amazon Q Developer in chat applications uses to send notifications to your channel @@ -86 +90 @@ To allow Amazon Q Developer in chat channels to send notifications or run comman - 1. Add Amazon Q Developer in chat channels to the Slack channel: + 1. Add Amazon Q Developer in chat applications to the Slack channel: @@ -98 +102 @@ If copying and pasting this command in Slack, ensure you have the correct format - 1. On the **Workspace details** page in the Amazon Q Developer in chat channels console, choose **Configure new channel**. + 1. On the **Workspace details** page in the Amazon Q Developer in chat applications console, choose **Configure new channel**. @@ -102 +106 @@ If copying and pasting this command in Slack, ensure you have the correct format - 3. If you want to enable logging for this configuration, choose **Publish logs to Amazon CloudWatch Logs**. For more information, see [Amazon CloudWatch Logs for Amazon Q Developer in chat channels](./cloudwatch-logs.html). + 3. If you want to enable logging for this configuration, choose **Publish logs to Amazon CloudWatch Logs**. For more information, see [Amazon CloudWatch Logs for Amazon Q Developer in chat applications](./cloudwatch-logs.html). @@ -108 +112 @@ There is an extra charge for using CloudWatch Logs. - 4. For **Slack channel** , choose the channel you used in step 1. Amazon Q Developer in chat channels supports both public and private channels. + 4. For **Slack channel** , choose the channel you used in step 1. Amazon Q Developer in chat applications supports both public and private channels. @@ -110 +114 @@ There is an extra charge for using CloudWatch Logs. -(Optional) To configure a private channel with Amazon Q Developer in chat channels: +(Optional) To configure a private channel with Amazon Q Developer in chat applications: @@ -114 +118 @@ There is an extra charge for using CloudWatch Logs. - 2. In Amazon Q Developer in chat channels, paste the ID into the **Channel URL** field. (If you copy the URL of the private Slack channel, the Amazon Q Developer in chat channels console shows only the Channel ID value when you paste it into the field.) + 2. In Amazon Q Developer in chat applications, paste the ID into the **Channel URL** field. (If you copy the URL of the private Slack channel, the Amazon Q Developer in chat applications console shows only the Channel ID value when you paste it into the field.) @@ -129 +133 @@ Channel role - 2. For **Channel role** , choose **Create an IAM role using a template**. If you want to use an existing role instead, choose **Use an existing IAM role**. To use an existing IAM role, you will need to modify it for use with Amazon Q Developer in chat channels. For more information, see [Configuring an IAM Role for Amazon Q Developer in chat channels](./editing-iam-roles-for-chatbot.html). + 2. For **Channel role** , choose **Create an IAM role using a template**. If you want to use an existing role instead, choose **Use an existing IAM role**. To use an existing IAM role, you will need to modify it for use with Amazon Q Developer in chat applications. For more information, see [Configuring an IAM Role for Amazon Q Developer in chat applications](./editing-iam-roles-for-chatbot.html). @@ -158 +162 @@ If you want to receive notifications in your Slack channel, complete these steps - 1. For **SNS Region** , choose the AWS Region that hosts the SNS topics for this Amazon Q Developer in chat channels subscription. + 1. For **SNS Region** , choose the AWS Region that hosts the SNS topics for this Amazon Q Developer in chat applications subscription. @@ -166 +170 @@ If you want to receive notifications in your Slack channel, complete these steps -For a tutorial on subscribing existing Amazon SNS topics to Amazon Q Developer in chat channels, see [Tutorial: Subscribing an Amazon SNS topic to Amazon Q Developer in chat channels](./subscribe-sns-topic.html). +For a tutorial on subscribing existing Amazon SNS topics to Amazon Q Developer in chat applications, see [Tutorial: Subscribing an Amazon SNS topic to Amazon Q Developer in chat applications](./subscribe-sns-topic.html). @@ -183 +187 @@ You can configure as many channels with as many topics as you need. -To verify that an Amazon Simple Notification Service (Amazon SNS) topic sends notifications to your Slack channel, you can test your setup by sending a notification. Ensure your Amazon Q Developer in chat channels configuration is subscribed to at least one Amazon SNS topic and that your topics are assigned to a service supported by Amazon Q Developer in chat channels. For a list of supported services, see [Monitoring AWS services using Amazon Q Developer in chat applications](./related-services.html). You can also test notifications by using CloudWatch. For more information, see [Test notifications from AWS services to Amazon Chime or Slack using CloudWatch](./test-notifications-cw.html). +To verify that an Amazon Simple Notification Service (Amazon SNS) topic sends notifications to your Slack channel, you can test your setup by sending a notification. Ensure your Amazon Q Developer in chat applications configuration is subscribed to at least one Amazon SNS topic and that your topics are assigned to a service supported by Amazon Q Developer in chat applications. For a list of supported services, see [Monitoring AWS services using Amazon Q Developer in chat applications](./related-services.html). You can also test notifications by using CloudWatch. For more information, see [Test notifications from AWS services to Amazon Chime or Slack using CloudWatch](./test-notifications-cw.html). @@ -187 +191 @@ To verify that an Amazon Simple Notification Service (Amazon SNS) topic sends no - 1. Open the [Amazon Q Developer in chat channels console](https://console.aws.amazon.com/chatbot/). + 1. Open the [Amazon Q Developer in chat applications console](https://console.aws.amazon.com/chatbot/). @@ -204 +208 @@ To verify that an Amazon Simple Notification Service (Amazon SNS) topic sends no -You can automate Slack channel configuration by using an AWS CloudFormation template. To use an AWS CloudFormation template, you need the **Workspace ID** found under **Workspace details** in the Amazon Q Developer in chat channels console. For more information, see [AWS::Chatbot::SlackChannelConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html) in the _AWS CloudFormation User Guide_. +You can automate Slack channel configuration by using an AWS CloudFormation template. To use an AWS CloudFormation template, you need the **Workspace ID** found under **Workspace details** in the Amazon Q Developer in chat applications console. For more information, see [AWS::Chatbot::SlackChannelConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html) in the _AWS CloudFormation User Guide_. @@ -210 +214 @@ After you configure your chat clients and test that your notifications are worki - * Learn about which other AWS services you can integrate with Amazon Q Developer in chat channels in [Monitoring AWS services using Amazon Q Developer in chat applications](./related-services.html). + * Learn about which other AWS services you can integrate with Amazon Q Developer in chat applications in [Monitoring AWS services using Amazon Q Developer in chat applications](./related-services.html). @@ -212 +216 @@ After you configure your chat clients and test that your notifications are worki - * Learn about what you can customize using Amazon Q Developer in chat channels in [Customizing Amazon Q Developer in chat applications](./customizing-chatbot.html). + * Learn about what you can customize using Amazon Q Developer in chat applications in [Customizing Amazon Q Developer in chat applications](./customizing-chatbot.html). @@ -214 +218 @@ After you configure your chat clients and test that your notifications are worki - * Learn about what actions you can perform using Amazon Q Developer in chat channels in [Performing actions using Amazon Q Developer in chat applications](./performing-actions.html). + * Learn about what actions you can perform using Amazon Q Developer in chat applications in [Performing actions using Amazon Q Developer in chat applications](./performing-actions.html). @@ -216 +220 @@ After you configure your chat clients and test that your notifications are worki - * Learn what questions you can ask Amazon Q Developer in chat channels in [Chatting with Amazon Q Developer in chat channels](./asking-questions.html). + * Learn what questions you can ask Amazon Q Developer in chat applications in [Chatting with Amazon Q Developer in chat channels](./asking-questions.html).