AWS chatbot documentation change
Summary
Updated terminology from 'chat channels' to 'chat applications' throughout the document to reflect product naming changes
Security assessment
The changes are purely terminological updates without any indication of addressing security vulnerabilities or introducing new security features. The modifications maintain existing security concepts (like IAM roles and permissions) but do not alter their implementation or documentation.
Diff
diff --git a/chatbot/latest/adminguide/teams-setup.md b/chatbot/latest/adminguide/teams-setup.md index c0842755e..cb9b91b55 100644 --- a//chatbot/latest/adminguide/teams-setup.md +++ b//chatbot/latest/adminguide/teams-setup.md @@ -11 +11 @@ 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, follow the steps below to set up Amazon Q Developer in chat channels with chat channels and Amazon SNS topic subscriptions. Note that Amazon Q Developer in chat channels is approved by your Microsoft Teams administrator. +To get started using Amazon Q Developer in chat applications to help manage your AWS infrastructure, follow the steps below to set up Amazon Q Developer in chat applications with chat channels and Amazon SNS topic subscriptions. Note that Amazon Q Developer in chat applications is approved by your Microsoft Teams administrator. @@ -32 +32 @@ 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 should also ensure Microsoft Teams is installed and approved by your organization administrator. 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 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 should also ensure Microsoft Teams is installed and approved by your organization administrator. 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 channel to be used in your Amazon Q Developer in chat applications configuration. This channel is used to monitor and operate your AWS resources. @@ -51 +51 @@ If you have less than administrative permissions, ensure you have the aforementi -To allow Amazon Q Developer in chat channels to send notifications or run commands in your Microsoft Teams channel, you must configure Amazon Q Developer in chat channels with Microsoft Teams. +To allow Amazon Q Developer in chat applications to send notifications or run commands in your Microsoft Teams channel, you must configure Amazon Q Developer in chat applications with Microsoft Teams. @@ -55 +55 @@ To allow Amazon Q Developer in chat channels to send notifications or run comman - 1. Add Amazon Q Developer in chat channels to your team: + 1. Add Amazon Q Developer in chat applications to your team: @@ -61 +61 @@ To allow Amazon Q Developer in chat channels to send notifications or run comman - 3. Enter `Amazon Q Developer` in the search bar to find Amazon Q Developer in chat channels. + 3. Enter `Amazon Q Developer` in the search bar to find Amazon Q Developer in chat applications. @@ -83 +83 @@ For example, the bolded portion of the following channel URL is its channel ID: -After choosing **Configure** , you're redirected to Microsoft Team'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're redirected to Microsoft Team'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). @@ -92 +92 @@ After choosing **Configure** , you're redirected to Microsoft Team's authorizati -To allow Amazon Q Developer in chat channels to send notifications or run commands in your Microsoft Teams channel, you must also configure Amazon Q Developer in chat channels with a Microsoft Teams channel. Channel configuration consists of: +To allow Amazon Q Developer in chat applications to send notifications or run commands in your Microsoft Teams channel, you must also configure Amazon Q Developer in chat applications with a Microsoft Teams channel. Channel configuration consists of: @@ -98 +98 @@ 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 @@ -105 +105 @@ To allow Amazon Q Developer in chat channels to send notifications or run comman -Microsoft Teams doesn't currently support Amazon Q Developer in chat channels in private channels. For more information, see [Private channel limitations](https://learn.microsoft.com/en-us/microsoftteams/private-channels#private-channel-limitations). +Microsoft Teams doesn't currently support Amazon Q Developer in chat applications in private channels. For more information, see [Private channel limitations](https://learn.microsoft.com/en-us/microsoftteams/private-channels#private-channel-limitations). @@ -111 +111 @@ Microsoft Teams doesn't currently support Amazon Q Developer in chat channels in - 1. On the **Team details** page in the Amazon Q Developer in chat channels console, choose **Configure new channel**. + 1. On the **Team details** page in the Amazon Q Developer in chat applications console, choose **Configure new channel**. @@ -115 +115 @@ Microsoft Teams doesn't currently support Amazon Q Developer in chat channels in - 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). @@ -136 +136 @@ 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). @@ -165 +165 @@ If you want to receive notifications in your Microsoft Teams channel, complete t - 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. @@ -167 +167 @@ If you want to receive notifications in your Microsoft Teams channel, complete t - 2. For **SNS topic** , choose the Amazon SNS topic for the client subscription. This topic determines the content that's sent to the Microsoft Teams channel. If the region has additional SNS topics, you can choose them from the same dropdown list. The SNS topics you choose must be configured in the services for which you want to receive notifications. For more information, see [Monitoring AWS services using Amazon Q Developer in chat channels](./related-services.html). + 2. For **SNS topic** , choose the Amazon SNS topic for the client subscription. This topic determines the content that's sent to the Microsoft Teams channel. If the region has additional SNS topics, you can choose them from the same dropdown list. The SNS topics you choose must be configured in the services for which you want to receive notifications. For more information, see [Monitoring AWS services using Amazon Q Developer in chat applications](./related-services.html). @@ -173 +173 @@ If you want to receive notifications in your Microsoft Teams channel, complete t -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). @@ -190 +190 @@ 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 Microsoft Teams 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 Microsoft Teams using CloudWatch](./test-notifications-cw.html). +To verify that an Amazon Simple Notification Service (Amazon SNS) topic sends notifications to your Microsoft Teams 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 Microsoft Teams using CloudWatch](./test-notifications-cw.html). @@ -194 +194 @@ 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/). @@ -211 +211 @@ To verify that an Amazon Simple Notification Service (Amazon SNS) topic sends no -You can automate Microsoft Teams channel configuration by using an AWS CloudFormation template. To use an AWS CloudFormation template, you need the **Team ID** and **Tenant ID** found under **Team details** in the Amazon Q Developer in chat channels console. For more information, see [AWS::Chatbot::MicrosoftTeamsChannelConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html) in the _AWS CloudFormation User Guide_. +You can automate Microsoft Teams channel configuration by using an AWS CloudFormation template. To use an AWS CloudFormation template, you need the **Team ID** and **Tenant ID** found under **Team details** in the Amazon Q Developer in chat applications console. For more information, see [AWS::Chatbot::MicrosoftTeamsChannelConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html) in the _AWS CloudFormation User Guide_. @@ -217 +217 @@ 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). @@ -219 +219 @@ 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). @@ -221 +221 @@ 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). @@ -223 +223 @@ 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).