AWS Chatbot is now Amazon Q Developer. Learn more
Tutorial: Get started with Slack
To get started using Amazon Q Developer to help manage your AWS infrastructure, use the following steps to set up Amazon Q Developer with chat channels and Amazon SNS topic subscriptions.
Topics
Prerequisites
Before you get started, make sure you've completed the tasks in Setting up Amazon Q Developer in chat applications. 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 can do on your behalf. For more information about Amazon Q Developer permissions, see Understanding permissions. You must also create or choose a Slack channel to be used in your Amazon Q Developer configuration. This channel is used to monitor and operate your AWS resources.
Step 1: Configure a Slack client
To allow Amazon Q Developer to send notifications or run commands, you must configure
Amazon Q Developer with Slack. Workspace administrators must approve the use of the Amazon Q Developer 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
To configure a Slack client
-
Add Amazon Q Developer to the Slack workspace:
In Slack, on the left navigation pane, choose Automations.
Note
If you do not see Automations in the left navigation pane, choose More, then choose Automations.
If Amazon Q Developer is not listed, choose the Browse Apps Directory button.
Browse the directory for the Amazon Q Developer app and then choose Add to add Amazon Q Developer to your workspace.
-
Open the Amazon Q Developer in chat applications console at https://console.aws.amazon.com/chatbot/
. -
Under Configure a chat client, choose Slack, then choose Configure.
Note
After choosing Configure, you'll be redirected to Slack's authorization page to request permission for Amazon Q Developer to access your information. For more information, see Chat client application permissions for Amazon Q Developer in chat applications.
-
From the dropdown list at the top right, choose the Slack workspace that you want to use with Amazon Q Developer.
There's no limit to the number of workspaces that you can set up for Amazon Q Developer, but you can set up only one at a time.
-
Choose Allow.
Step 2: Configure a Slack channel
To allow Amazon Q Developer to send notifications or run commands in your Slack channel, you must also configure Amazon Q Developer with a Slack channel. Configuring a channel consists of:
-
Adding Amazon Q Developer to your Slack channel
-
Associating a channel with the configuration
-
Defining user permissions, which dictate what tasks users can perform in a channel
-
(Optional) Adding Amazon SNS topics, which Amazon Q Developer uses to send notifications to your channel
To configure a Slack channel
-
Add Amazon Q Developer to the Slack channel:
In your Slack channel, enter
invite @aws
.Choose Invite Them.
-
Associate a channel with your configuration:
-
On the Workspace details page in the Amazon Q Developer console, choose Configure new channel.
-
Under Configuration details, enter a name for your configuration. The name must be unique across your account and can't be edited later.
-
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.
Note
There is an extra charge for using CloudWatch Logs.
-
For Slack channel, choose the channel you used in step 1. Amazon Q Developer supports both public and private channels.
(Optional) To configure a private channel with Amazon Q Developer:
In Slack, copy the Channel ID of the private channel by right-clicking on the channel name in the left pane and choosing Copy Link. The Channel ID is the string at the end of the URL (for example,
AB3BBLZZ8YY
).In Amazon Q Developer, paste the ID into the Channel URL field. (If you copy the URL of the private Slack channel, the Amazon Q Developer console shows only the Channel ID value when you paste it into the field.)
-
-
Define user permissions:
-
Choose your Role Setting.
Tip
Your role setting dictates what permissions your channel members have. A channel role gives all members the same permissions. This is useful if your channel members typically perform the same actions in Slack. A user role requires your channel members to choose their own roles. As such, different users in your channels can have different permissions. This is useful if your channel members are diverse or you don’t want new channel members to perform actions as soon as they join the channel. For more information, see Role setting.
-
Select the policies that will make up your channel guardrails. Your channel guardrails control what actions are available to your channel members.
(Optional) Add AmazonQDeveloperAccess as a channel guardrail to allow your users to chat with Amazon Q Developer from your Slack channel.
-
-
(Optional) Add Amazon SNS topics:
Note
If you want to receive notifications in your Slack channel, complete these steps.
-
Choose your notification settings:
-
For SNS Region, choose the AWS Region that hosts the SNS topics for this Amazon Q Developer subscription.
-
For SNS topic, choose the Amazon SNS topic for the client subscription. This topic determines the content that's sent to the Slack 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.
-
To add an Amazon SNS topic from another AWS Region to the notification subscription, choose Add another Region.
Note
For a tutorial on subscribing existing Amazon SNS topics to Amazon Q Developer, see Tutorial: Subscribing an Amazon SNS topic to Amazon Q Developer.
Notifications from supported services that publish to the chosen Amazon SNS topics will now appear in the Slack channel.
-
-
-
Choose Save.
Note
You can configure a Slack channel to run commands to your AWS account. For more information, see Running AWS CLI commands from chat channels.
You can configure as many channels with as many topics as you need.
(Optional) Step 3: Test notifications from AWS services to Slack
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 configuration is subscribed to at least one Amazon SNS topic and that your topics are assigned to a service supported by Amazon Q Developer. For a list of supported services, see Monitoring AWS services using Amazon Q Developer in chat applications. You can also test notifications by using CloudWatch. For more information, see Test notifications from AWS services to Amazon Chime or Slack using CloudWatch.
Testing notifications with configured clients
Open the Amazon Q Developer console
. Choose the configured client you want to test.
In the configured client, choose the channel to send a test notification to.
Choose Send test message.
View the confirmation message at the top of the screen that shows a message was sent to your Amazon SNS topic.
Confirm the test message in your Slack channel.
Configuring Slack channels using AWS CloudFormation
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 console. For more information, see AWS::Chatbot::SlackChannelConfiguration in the AWS CloudFormation User Guide.
Next steps
After you configure your chat clients and test that your notifications are working, you might want to explore some of the following topics:
-
Learn about which other AWS services you can integrate with Amazon Q Developer in Monitoring AWS services using Amazon Q Developer in chat applications.
-
Learn about what you can customize using Amazon Q Developer in Customizing Amazon Q Developer in chat applications.
-
Learn about what actions you can perform using Amazon Q Developer in Performing actions using .
-
Learn what questions you can ask Amazon Q Developer and Amazon Q in Chatting with Amazon Q Developer in chat channels.