AWS chatbot documentation change
Summary
Updated documentation to consistently use 'Amazon Q Developer in chat channels' instead of 'Amazon Q Developer' throughout the file, clarifying the chat channel context for service integrations
Security assessment
The changes are purely branding/terminology updates to specify 'in chat channels' context. There is no evidence of addressing security vulnerabilities or adding new security features. The modifications focus on clarifying service naming rather than security-related content.
Diff
diff --git a/chatbot/latest/adminguide/related-services.md b/chatbot/latest/adminguide/related-services.md index 1b3d08e32..a755d0864 100644 --- a//chatbot/latest/adminguide/related-services.md +++ b//chatbot/latest/adminguide/related-services.md @@ -11 +11 @@ AWS Chatbot is now Amazon Q Developer. [Learn more](./service-rename.html) -You can use Amazon Q Developer to monitor and receive notifications about other AWS services. Amazon Q Developer works with a number of AWS services, including [Amazon CloudWatch](https://console.aws.amazon.com/cloudwatch/), [AWS Security Hub](https://console.aws.amazon.com/securityhub/), and [Amazon GuardDuty](https://console.aws.amazon.com/guardduty/). All services that work with Amazon Q Developer use [Amazon SNS topics](https://docs.aws.amazon.com/sns/latest/dg/) as targets to send event and alarm notifications. You may already have established Amazon SNS topics that send notifications to DevOps and development personnel as emails. Because Amazon Q Developer redirects those Amazon SNS topics' notifications to chat rooms, you can map those Amazon SNS topics to an Amazon Chime webhook, Microsoft Teams channel, or Slack channel in the Amazon Q Developer console. +You can use Amazon Q Developer in chat channels to monitor and receive notifications about other AWS services. Amazon Q Developer in chat channels works with a number of AWS services, including [Amazon CloudWatch](https://console.aws.amazon.com/cloudwatch/), [AWS Security Hub](https://console.aws.amazon.com/securityhub/), and [Amazon GuardDuty](https://console.aws.amazon.com/guardduty/). All services that work with Amazon Q Developer in chat channels use [Amazon SNS topics](https://docs.aws.amazon.com/sns/latest/dg/) as targets to send event and alarm notifications. You may already have established Amazon SNS topics that send notifications to DevOps and development personnel as emails. Because Amazon Q Developer in chat channels redirects those Amazon SNS topics' notifications to chat rooms, you can map those Amazon SNS topics to an Amazon Chime webhook, Microsoft Teams channel, or Slack channel in the Amazon Q Developer in chat channels console. @@ -56 +56 @@ You can set up the following AWS services to forward notifications to Amazon Chi -AWS Billing and Cost Management helps AWS account holders plan service usage, service costs, and instance reservations. You do this using several specific types of budgets, which track your unblended costs, subscriptions, refunds, and Reserved Instances. The service sends AWS Budget Alerts to an Amazon SNS topic. You then map the Amazon SNS topic in Amazon Q Developer to send those notifications to your chat rooms. +AWS Billing and Cost Management helps AWS account holders plan service usage, service costs, and instance reservations. You do this using several specific types of budgets, which track your unblended costs, subscriptions, refunds, and Reserved Instances. The service sends AWS Budget Alerts to an Amazon SNS topic. You then map the Amazon SNS topic in Amazon Q Developer in chat channels to send those notifications to your chat rooms. @@ -64 +64 @@ AWS CloudFormation is an infrastructure management service that helps you model -Amazon Q Developer supports AWS CloudFormation notifications through Amazon SNS topics. You enable support for SNS topics that are enabled for use with Amazon Q Developer by selecting them in each AWS CloudFormation stack configuration. For more information, see [Setting AWS CloudFormation Stack Options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-console-add-tags.html) in the _AWS CloudFormation User Guide_. +Amazon Q Developer in chat channels supports AWS CloudFormation notifications through Amazon SNS topics. You enable support for SNS topics that are enabled for use with Amazon Q Developer in chat channels by selecting them in each AWS CloudFormation stack configuration. For more information, see [Setting AWS CloudFormation Stack Options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-console-add-tags.html) in the _AWS CloudFormation User Guide_. @@ -68 +68 @@ Amazon Q Developer supports AWS CloudFormation notifications through Amazon SNS -AWS provides a suite of cloud-based developer tools for creating, managing, and working with software development projects. The AWS development tools suite includes AWS services such as AWS CloudFormation stacks, AWS CodeBuild, AWS CodeCommit, AWS CodeDeploy, AWS CodePipeline, and more. You can redirect Amazon SNS topic subscriptions for these services to Amazon Q Developer. For example, if you want notifications about events in an AWS CodeCommit repository or in a pipeline in AWS CodePipeline to appear in a Microsoft Teams or Slack channel for your development teams, you can set up notifications for those resources in the Developer Tools console, and then integrate the SNS topic used for those notifications with Amazon Q Developer. For more information, see [Configure Integration Between Notifications and Amazon Q Developer](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notifications-chatbot.html) in the _Developer Tools Console User Guide_. +AWS provides a suite of cloud-based developer tools for creating, managing, and working with software development projects. The AWS development tools suite includes AWS services such as AWS CloudFormation stacks, AWS CodeBuild, AWS CodeCommit, AWS CodeDeploy, AWS CodePipeline, and more. You can redirect Amazon SNS topic subscriptions for these services to Amazon Q Developer in chat channels. For example, if you want notifications about events in an AWS CodeCommit repository or in a pipeline in AWS CodePipeline to appear in a Microsoft Teams or Slack channel for your development teams, you can set up notifications for those resources in the Developer Tools console, and then integrate the SNS topic used for those notifications with Amazon Q Developer in chat channels. For more information, see [Configure Integration Between Notifications and Amazon Q Developer in chat channels](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notifications-chatbot.html) in the _Developer Tools Console User Guide_. @@ -74 +74 @@ To monitor performance and operating metrics for AWS services, and send notifica -CloudWatch also features composite alarms. Composite alarms allow you to combine multiple alarms to reduce alarm noise and focus on critical operational issues. You can easily combine multiple alarms together into alarm hierarchies that only trigger once, when multiple alarms fire at the same time. Composite alarms are currently supported by Amazon Q Developer. +CloudWatch also features composite alarms. Composite alarms allow you to combine multiple alarms to reduce alarm noise and focus on critical operational issues. You can easily combine multiple alarms together into alarm hierarchies that only trigger once, when multiple alarms fire at the same time. Composite alarms are currently supported by Amazon Q Developer in chat channels. @@ -78 +78 @@ CloudWatch also features composite alarms. Composite alarms allow you to combine -Parent composite alarms can have multiple triggering children however, the Amazon Q Developer notification will only display a maximum of 3 of the total triggering metric children's alarm states. For example, if you have 10 total children alarms and 5 are currently triggered, the Amazon Q Developer notification will display 3 of those 5. +Parent composite alarms can have multiple triggering children however, the Amazon Q Developer in chat channels notification will only display a maximum of 3 of the total triggering metric children's alarm states. For example, if you have 10 total children alarms and 5 are currently triggered, the Amazon Q Developer in chat channels notification will display 3 of those 5. @@ -80 +80 @@ Parent composite alarms can have multiple triggering children however, the Amazo -Any metric, for any AWS service, that CloudWatch alarm actions can report can also be shared by an SNS topic to chat rooms through Amazon Q Developer. This includes alarms for services such as Amazon Elastic Compute Cloud (Amazon EC2). +Any metric, for any AWS service, that CloudWatch alarm actions can report can also be shared by an SNS topic to chat rooms through Amazon Q Developer in chat channels. This includes alarms for services such as Amazon Elastic Compute Cloud (Amazon EC2). @@ -84 +84 @@ For information about setting up SNS topics to forward CloudWatch alarms, see [S -Because CloudWatch alarms use SNS topics to forward alarm notifications, you need to map only the associated Amazon SNS topic to your Slack channel or Amazon Chime webhook configuration in Amazon Q Developer. +Because CloudWatch alarms use SNS topics to forward alarm notifications, you need to map only the associated Amazon SNS topic to your Slack channel or Amazon Chime webhook configuration in Amazon Q Developer in chat channels. @@ -86 +86 @@ Because CloudWatch alarms use SNS topics to forward alarm notifications, you nee -Amazon Q Developer also supports several AWS services through CloudWatch Events. For more information, see the following section. +Amazon Q Developer in chat channels also supports several AWS services through CloudWatch Events. For more information, see the following section. @@ -90 +90 @@ Amazon Q Developer also supports several AWS services through CloudWatch Events. -Amazon Q Developer supports multiple AWS services through [Amazon EventBridge rules](https://docs.aws.amazon.com/eventbridge/latest/userguide/create-eventbridge-rule.html). EventBridge uses rules to help manage AWS service events and how you respond to them. You can use these rules to associate an Amazon SNS topic (or other actions) with an event type from any AWS service. +Amazon Q Developer in chat channels supports multiple AWS services through [Amazon EventBridge rules](https://docs.aws.amazon.com/eventbridge/latest/userguide/create-eventbridge-rule.html). EventBridge uses rules to help manage AWS service events and how you respond to them. You can use these rules to associate an Amazon SNS topic (or other actions) with an event type from any AWS service. @@ -92 +92 @@ Amazon Q Developer supports multiple AWS services through [Amazon EventBridge ru -You map the Amazon SNS topic to the EventBridge rule, and then map it to a chat channel or Amazon Chime webhook in the Amazon Q Developer console. When a service event matches the rule, the rule's target Amazon SNS topic sends an event to the Amazon Q Developer for processing. The Amazon Q Developer then sends a notification to the chat room. You can also customize the content of your notifications by using the custom notifications event schema and EventBridge [InputTransformers](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-transform-target-input.html). For more information, see [Custom notifications using Amazon Q Developer in chat applications](./custom-notifs.html) and [Creating an EventBridge Rule that sends notifications to Amazon Q Developer](./create-eventbridge-rule.html). +You map the Amazon SNS topic to the EventBridge rule, and then map it to a chat channel or Amazon Chime webhook in the Amazon Q Developer in chat channels console. When a service event matches the rule, the rule's target Amazon SNS topic sends an event to the Amazon Q Developer in chat channels for processing. The Amazon Q Developer in chat channels then sends a notification to the chat room. You can also customize the content of your notifications by using the custom notifications event schema and EventBridge [InputTransformers](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-transform-target-input.html). For more information, see [Custom notifications using Amazon Q Developer in chat applications](./custom-notifs.html) and [Creating an EventBridge Rule that sends notifications to Amazon Q Developer in chat channels](./create-eventbridge-rule.html). @@ -94 +94 @@ You map the Amazon SNS topic to the EventBridge rule, and then map it to a chat -Amazon Q Developer can process most AWS service events handled by EventBridge. This includes AWS Config, Amazon GuardDuty, AWS Health, AWS Security Hub, and AWS Systems Manager. Amazon Q Developer only supports EventBridge events from AWS services. For an exhaustive list of supported service events, see [EventBridge Event Examples from Supported AWS Services](https://docs.aws.amazon.com/eventbridge/latest/userguide/event-types.html) in the _EventBridge User Guide_. +Amazon Q Developer in chat channels can process most AWS service events handled by EventBridge. This includes AWS Config, Amazon GuardDuty, AWS Health, AWS Security Hub, and AWS Systems Manager. Amazon Q Developer in chat channels only supports EventBridge events from AWS services. For an exhaustive list of supported service events, see [EventBridge Event Examples from Supported AWS Services](https://docs.aws.amazon.com/eventbridge/latest/userguide/event-types.html) in the _EventBridge User Guide_. @@ -98 +98 @@ Amazon Q Developer can process most AWS service events handled by EventBridge. T -Event notifications from: CloudWatch Alarms, CodeBuild, CodeCommit, CodeDeploy, and CodePipeline are not currently supported via EventBridge rules. If you want to receive notifications for one of these services, you can go to its console, and configure Amazon SNS notifications that you can then map to your chat channel or Amazon Chime webhook configuration in Amazon Q Developer. For more information, see Amazon CloudWatch alarms or Notifications for AWS developer tools. +Event notifications from: CloudWatch Alarms, CodeBuild, CodeCommit, CodeDeploy, and CodePipeline are not currently supported via EventBridge rules. If you want to receive notifications for one of these services, you can go to its console, and configure Amazon SNS notifications that you can then map to your chat channel or Amazon Chime webhook configuration in Amazon Q Developer in chat channels. For more information, see Amazon CloudWatch alarms or Notifications for AWS developer tools. @@ -104 +104 @@ AWS Config performs resource oversight and tracking for auditing and compliance, -For AWS Config monitoring, [you configure Amazon CloudWatch Events rules](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/Create-CloudWatch-Events-Rule.html) to forward AWS Config events notifications to an Amazon SNS topic. You can then map that topic to Amazon Q Developer to track those event notifications in chat rooms. +For AWS Config monitoring, [you configure Amazon CloudWatch Events rules](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/Create-CloudWatch-Events-Rule.html) to forward AWS Config events notifications to an Amazon SNS topic. You can then map that topic to Amazon Q Developer in chat channels to track those event notifications in chat rooms. @@ -112 +112 @@ Amazon GuardDuty is a security threat monitoring service that detects and report -GuardDuty reports its security incidents and threats through _findings_. Findings appear in the GuardDuty console and automatically appear as CloudWatch Events. You then [create Amazon CloudWatch Events rules](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/Create-CloudWatch-Events-Rule.html), so these events appear as notifications to a selected SNS topic. You then map that SNS topic to a chat channel or Amazon Chime webhook in Amazon Q Developer. +GuardDuty reports its security incidents and threats through _findings_. Findings appear in the GuardDuty console and automatically appear as CloudWatch Events. You then [create Amazon CloudWatch Events rules](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/Create-CloudWatch-Events-Rule.html), so these events appear as notifications to a selected SNS topic. You then map that SNS topic to a chat channel or Amazon Chime webhook in Amazon Q Developer in chat channels. @@ -120 +120 @@ AWS Health provides visibility into the state of your AWS resources, services, a -AWS Health directly supports EventBridge notifications. You configure [CloudWatch Events rules](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/Create-CloudWatch-Events-Rule.html) for AWS Health, and specify an SNS topic mapped in Amazon Q Developer. +AWS Health directly supports EventBridge notifications. You configure [CloudWatch Events rules](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/Create-CloudWatch-Events-Rule.html) for AWS Health, and specify an SNS topic mapped in Amazon Q Developer in chat channels. @@ -128 +128 @@ AWS Security Hub provides a comprehensive view of high-priority security alerts -Security Hub supports two types of integration with [CloudWatch Events rules](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/Create-CloudWatch-Events-Rule.html), both of which Amazon Q Developer supports: +Security Hub supports two types of integration with [CloudWatch Events rules](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/Create-CloudWatch-Events-Rule.html), both of which Amazon Q Developer in chat channels supports: @@ -130 +130 @@ Security Hub supports two types of integration with [CloudWatch Events rules](ht - * **Standard CloudWatch Events**. [Security Hub automatically sends all findings to CloudWatch Events](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-cloudwatch-events.html). You can define CloudWatch Events rules that automatically route generated findings to an Amazon Simple Storage Service (Amazon S3) bucket, a remediation workflow, or an SNS topic. Use this method to automatically send all Security Hub findings, or all findings with specific characteristics, to an SNS topic to which Amazon Q Developer subscribes. + * **Standard CloudWatch Events**. [Security Hub automatically sends all findings to CloudWatch Events](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-cloudwatch-events.html). You can define CloudWatch Events rules that automatically route generated findings to an Amazon Simple Storage Service (Amazon S3) bucket, a remediation workflow, or an SNS topic. Use this method to automatically send all Security Hub findings, or all findings with specific characteristics, to an SNS topic to which Amazon Q Developer in chat channels subscribes. @@ -132 +132 @@ Security Hub supports two types of integration with [CloudWatch Events rules](ht - * **Security Hub Custom Actions**.[ Define custom actions in Security Hub](https://aws.amazon.com/blogs/apn/how-to-enable-custom-actions-in-aws-security-hub/) and configure [CloudWatch Events rules](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/Create-CloudWatch-Events-Rule.html) to respond to those actions. The event rule uses its SNS topic setting to forward its notifications to the SNS topic to which Amazon Q Developer subscribes. + * **Security Hub Custom Actions**.[ Define custom actions in Security Hub](https://aws.amazon.com/blogs/apn/how-to-enable-custom-actions-in-aws-security-hub/) and configure [CloudWatch Events rules](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/Create-CloudWatch-Events-Rule.html) to respond to those actions. The event rule uses its SNS topic setting to forward its notifications to the SNS topic to which Amazon Q Developer in chat channels subscribes. @@ -141 +141 @@ AWS Systems Manager lets you view and control your infrastructure on AWS. Using -Amazon Q Developer supports the following Systems Manager events. +Amazon Q Developer in chat channels supports the following Systems Manager events. @@ -194 +194 @@ For information about monitoring Systems Manager events with CloudWatch, see [Mo -SM runbooks define the actions that Systems Manager performs on your managed instances and other AWS resources when an automation runs. A runbook contains one or more steps that run in sequential order. The process of running these actions and their steps is called the automation. Amazon Q Developer supports the ability to run SM runbooks directly from Microsoft Teams or Slack using CLI commands. You can type a command to list your runbooks and choose a runbook to run. Runbooks can require one or more input parameters before running (for example, Amazon EC2 instances can require inputs such as instance id). Once the runbook begins, it runs in its entirety. For an example of running a runbook using a CLI command, see [Run an Automation runbook](./common-use-cases.html#run-book). +SM runbooks define the actions that Systems Manager performs on your managed instances and other AWS resources when an automation runs. A runbook contains one or more steps that run in sequential order. The process of running these actions and their steps is called the automation. Amazon Q Developer in chat channels supports the ability to run SM runbooks directly from Microsoft Teams or Slack using CLI commands. You can type a command to list your runbooks and choose a runbook to run. Runbooks can require one or more input parameters before running (for example, Amazon EC2 instances can require inputs such as instance id). Once the runbook begins, it runs in its entirety. For an example of running a runbook using a CLI command, see [Run an Automation runbook](./common-use-cases.html#run-book). @@ -202 +202 @@ AWS Systems Manager Incident Manager is an incident management console designed -Amazon Q Developer allows you to communicate through chat channels and receive notifications and incident updates during an incident. You can also interact with the incident directly using chat commands. For more information, see [Chat channels](https://docs.aws.amazon.com/incident-manager/latest/userguide/chat.html) in the _Incident Manager User Guide_. +Amazon Q Developer in chat channels allows you to communicate through chat channels and receive notifications and incident updates during an incident. You can also interact with the incident directly using chat commands. For more information, see [Chat channels](https://docs.aws.amazon.com/incident-manager/latest/userguide/chat.html) in the _Incident Manager User Guide_.