Adding an Amazon Q Business integration for Slack
To use the Amazon Q Business Slack integration, you must allow it to connect to your Amazon Q Business application environment and web experience. To do this, admins can use the Amazon Q Business console, API, SDK, or AWS CLI.
Note
This integration can only be added using the AWS Management Console at this time.
Using the console
-
Sign in to the Amazon Q console.
-
Choose Applications, then select the name of your application environment from the list.
-
Choose Integrations under Enhancements.
-
Choose Add integration from the Integrations section on the main page.
-
Choose Slack as your integration.
-
On the Add Slack integration page, enter the Name of your integration. This is the display name for the integration resource in AWS.
-
Add a description (optional).
-
Enter your Slack workspace ID. This is a unique identifier of your Slack workspace starting and can be found using the Slack developer tools app. To find your workspace ID:
Navigate to your Slack workspace and in “Apps” search for “Slack Developer Tools”.
Open the Slack Developer Tools app and run the command /sdt whoami
You will receive a response that contains your Workspace ID starting with a “T”
For other ways to locate your workspace ID, refer to Locate your Slack URL or ID
in the Slack help center.
-
Choose the type of Service access method that you want the Slack integration to use as authorization while accessing your service. You can Create a new service role or Use an existing service role. For more information, see IAM role for allowing the integration to call Amazon Q Business on your end user's behalf.
-
Choose the Access management access for the Slack integration to authorize to connect to IAM Identity center. For more information, see IAM role for allowing Amazon Q Business to monitor the resources that the integration creates in your account.
-
Optionally, add any Tags that are relevant for this Slack integration.
-
Choose Add integration.
-
Once the integration has been successfully created, you will move to the Integration details page.
-
Choose Deploy integration.
-
Choose Access Slack.
Note
This link will take you to the Slack domain outside of AWS.
-
You will continue this procedure within the Slack domain.
Installing the Amazon Q Business App in your Slack workspace
The following instructions show how to install the Amazon Q Business App in your Slack workspace using a link from the Amazon Q console as shown in the previous topic.
Note
-
Only a Slack workspace owner can use the link to install the Amazon Q App into your Slack workspace.
-
There can be only one instance of the Amazon Q App per Slack workspace. That instance will be connected to the application environment that integration was configured with in the previous topic.
-
You may see a "This app is not approved by Slack banner." This message can be ignored.
-
The link will open to a Slack login page where after you login (as admin) you will need to find and be asked to install the Amazon Q app within your Slack workspace.
-
Choose Allow to install your Amazon Q App for Slack.
-
Once the installation is complete, you will see the page confirming that the Congratulations! Your Slack App has been successfully installed.
-
Choose Open the Amazon Q Business App in Slack.
-
This will open your Slack workspace where all users will be required to sign-in.