Slack
Slack is an enterprise communications app that lets users send messages and
attachments through various public and private channels. You can use Amazon Kendra to
index your Slack public and private channels, bot and archive messages, files
and attachments, direct and group messages. You can also choose specific content to
filter.
Amazon Kendra now supports an upgraded Slack connector.
The console has been automatically upgraded for you. Any new connectors you create in
the console will use the upgraded architecture. If you use the API, you must now use the
TemplateConfiguration object instead of the
SlackConfiguration
object to configure your connector.
Connectors configured using the older console and API architecture will continue to
function as configured. However, you won’t be able to edit or update them. If you want
to edit or update your connector configuration, you must create a new connector.
We recommended migrating your connector workflow to the upgraded version. Support for
connectors configured using the older architecture is scheduled to end by June 2024.
You can connect Amazon Kendra to your Slack data source using the Amazon Kendra console or the TemplateConfiguration API.
For troubleshooting your Amazon Kendra Slack data source connector, see Troubleshooting data sources.
Supported features
Amazon Kendra Slack data source connector supports the following
features:
-
Field mappings
-
User access control
-
Inclusion/exclusion filters
-
Full and incremental content syncs
-
Virtual private cloud (VPC)
Prerequisites
Before you can use Amazon Kendra to index your Slack data source,
make these changes in your Slack and AWS accounts.
In Slack, make sure you have:
-
Configured a Slack Bot User OAuth token or Slack User
OAuth token. You can choose either token to connect Amazon Kendra to your
Slack data source. A token is required to use as your authentication
credentials. See Slack documentation
on access tokens for more information.
If you use the bot token as part of your Slack credentials,
you cannot index direct messages and group messages and you must add the bot
token to the channel you want to index.
We recommend that you regularly refresh or rotate your credentials
and secret. Provide only the necessary access level for your own security.
We do not recommend that you re-use
credentials and secrets across data sources, and connector versions 1.0 and
2.0 (where applicable).
-
Noted your Slack workspace team ID from your Slack
workspace main page URL. For example,
https://app.slack.com/client/T0123456789/...
where T0123456789
is the team ID.
-
Added the following Oauth scopes/permissions:
User token
scope |
Bot token
scope |
-
channels:history
-
channels:read
-
emoji:read
-
files:read
-
groups:history
-
groups:read
-
im:history
-
im:read
-
mpim:history
-
mpim:read
-
team:read
-
users.profile:read
-
users:read
-
users:read.email
|
|
-
Checked each document is unique in Slack and across other
data sources you plan to use for the same index. Each data source that you
want to use for an index must not contain the same document across the data
sources. Document IDs are global to an index and must be unique per index.
In your AWS account, make sure you
have:
-
Created
an Amazon Kendra index and, if using the API, noted the index
ID.
-
Created an IAM role for your data source and, if
using the API, noted the ARN of the IAM role.
If you change your authentication type and credentials, you must
update your IAM role to access the correct AWS Secrets Manager secret ID.
-
Stored your Slack authentication credentials in an
AWS Secrets Manager secret and, if using the API, noted the ARN of the
secret.
We recommend that you regularly refresh or rotate your credentials
and secret. Provide only the necessary access level for your own security.
We do not recommend that you re-use
credentials and secrets across data sources, and connector versions 1.0 and
2.0 (where applicable).
If you don’t have an existing IAM role or secret, you can use the
console to create a new IAM role and Secrets Manager secret when you
connect your Slack data source to Amazon Kendra. If you are using the
API, you must provide the ARN of an existing IAM role and Secrets Manager secret, and an index ID.
Connection instructions
To connect Amazon Kendra to your Slack data source, you must provide
the necessary details of your Slack data source so that Amazon Kendra can access
your data. If you have not yet configured Slack for Amazon Kendra,
see Prerequisites.
- Console
-
To connect Amazon Kendra to
Slack
-
Sign in to the AWS Management Console and open the Amazon Kendra console.
-
From the left navigation pane, choose Indexes and then choose the index you want to use from the list of indexes.
You can choose to configure or edit your User access control settings under Index settings.
-
On the Getting started page, choose Add data source.
-
On the Add data source page, choose Slack connector, and then choose Add connector.
If using version 2 (if applicable), choose Slack connector with the "V2.0" tag.
-
On the Specify data source details page, enter the following information:
-
In Name and description, for Data source name—Enter a name for your data source. You can include hyphens but not spaces.
-
(Optional) Description—Enter an optional description for your data source.
-
In Default language—Choose a language to filter your documents for the index. Unless you specify otherwise,
the language defaults to English. Language specified in the document metadata overrides the selected language.
-
In Tags, for Add new tag—Include optional tags to search and filter your resources or track your AWS costs.
-
Choose Next.
-
On the Define access and security page,
enter the following information:
-
For Slack workspace team ID—The
team ID of your Slack workspace. You can find your
team ID in your Slack
workspace main page URL. For example,
https://app.slack.com/client/T0123456789/...
where T0123456789
is the team ID.
-
Authorization—Turn on or off access control list (ACL) information for your
documents, if you have an ACL and want to use it for access control. The ACL specifies which documents that users
and groups can access. The ACL information is used to filter search results based on the user or
their group access to documents. For more information, see User context filtering.
-
AWS Secrets Manager secret—Choose an existing secret or create a new
Secrets Manager secret to store your Slack authentication
credentials. If you choose to create a new secret an AWS Secrets Manager
secret window opens.
-
Enter following information in the
Create an AWS
Secrets Manager secret
window:
-
Secret name—A
name for your secret. The prefix
‘AmazonKendra-Slack-’ is
automatically added to your secret name.
-
For Slack
token—Enter the authentication
credential values you configured
Slack.
-
Save and add your secret.
-
Virtual Private Cloud (VPC)—You can choose to use a VPC. If
so, you must add Subnets and VPC security groups.
-
Identity crawler—Specify whether to turn on
Amazon Kendra’s identity crawler. The identity crawler uses the access control list
(ACL) information for your documents to filter search results based on the user or their
group access to documents. If you have an ACL for your documents and choose to use your ACL,
you can then also choose to turn on Amazon Kendra’s identity crawler to configure
user
context filtering of search results. Otherwise, if identity crawler is turned off,
all documents can be publicly searched. If you want to use access control for your documents
and identity crawler is turned off, you can alternatively use the
PutPrincipalMapping
API to upload user and group access information for user context filtering.
-
IAM role—Choose an existing IAM
role or create a new IAM role to access your repository credentials and index content.
IAM roles used for indexes cannot be used for data sources. If you are unsure
if an existing role is used for an index or FAQ, choose Create a new role to avoid
errors.
-
Choose Next.
-
On the Configure sync settings page,
enter the following information:
-
Select type of content—Select
the Slack entities
or content types you want to crawl. You can choose from
all channels, public channels, private channels, group
messages, and private messages.
-
Select crawl start
date—Enter the date you want to start
crawling your content.
-
For Additional configuration—Choose
to include bot and archived messages and use regular expression
patterns to include or exclude certain content.
If you choose to include for both channel IDs and channel names,
the Amazon Kendra Slack connector will
prioritize channel IDs over channel names.
If you've chosen to include certain private and group messages, the
Amazon Kendra Slack connector will ignore all private
and group messages and only crawl the private and group messages you
specify.
-
Sync mode—Choose how you want to update
your index when your data source content changes. When you sync your
data source with Amazon Kendra for the first time, all content
is crawled and indexed by default. You must run a full sync of your
data if your initial sync failed, even if you don't choose full sync
as your sync mode option.
-
Full sync: Freshly index all content, replacing existing
content each time your data source syncs with your index.
-
New, modified, deleted sync: Index only new, modified,
and deleted content each time your data source syncs with
your index. Amazon Kendra can use your data source's
mechanism for tracking content changes and index content
that changed since the last sync.
-
In Sync run schedule, for
Frequency—Choose how often to sync your
data source content and update your index.
-
Choose Next.
-
On the Set field mappings page, enter the
following information:
-
Default data source
fields—Select from the Amazon Kendra generated
default data source fields you want to map to your index.
-
Add field—To add custom data
source fields to create an index field name to map to
and the field data type.
-
Choose Next.
-
On the Review and create page, check that
the information you have entered is correct and then select
Add data source. You can also choose to edit your information from this page.
Your data source will appear on the Data sources page after the data source has been
added successfully.
- API
-
To connect Amazon Kendra to
Slack
You must specify a JSON of the data source
schema using the TemplateConfiguration API. You must
provide the following information:
-
Data
source—Specify the data source type as
SLACK
when you use the TemplateConfiguration JSON
schema. Also specify the data source as
TEMPLATE
when you call
the CreateDataSource API.
-
Slack workspace team
ID—The Slack team ID you
copied from your Slack main page URL.
-
Since date—The date to
start crawling your data from your Slack workspace team. The
date must follow this format: yyyy-mm-dd.
-
Sync mode—Specify
how Amazon Kendra should update your index when your data source
content changes. When you sync your data source with Amazon Kendra
for the first time, all content is crawled and indexed by default.
You must run a full sync of your data if your initial sync failed,
even if you don't choose full sync as your sync mode option. You can
choose between:
-
FORCED_FULL_CRAWL
to freshly index all content,
replacing existing content each time your data source syncs with
your index.
-
FULL_CRAWL
to index only new, modified, and deleted
content each time your data source syncs with your index. Amazon Kendra
can use your data source’s mechanism for tracking content changes and
index content that changed since the last sync.
-
CHANGE_LOG
to index only new and modified
content each time your data source syncs with your index. Amazon Kendra
can use your data source’s mechanism for tracking content changes and
index content that changed since the last sync.
-
Identity crawler—Specify whether to turn on
Amazon Kendra’s identity crawler. The identity crawler uses the access control list
(ACL) information for your documents to filter search results based on the user or their
group access to documents. If you have an ACL for your documents and choose to use your ACL,
you can then also choose to turn on Amazon Kendra’s identity crawler to configure
user
context filtering of search results. Otherwise, if identity crawler is turned off,
all documents can be publicly searched. If you want to use access control for your documents
and identity crawler is turned off, you can alternatively use the
PutPrincipalMapping
API to upload user and group access information for user context filtering.
-
Secret Amazon Resource Name
(ARN)—Provide the Amazon Resource
Name (ARN) of an Secrets Manager secret that contains the
authentication credentials for your Slack account.
The secret is stored in a JSON structure with the following keys:
{
"slackToken": "token
"
}
-
IAM role—Specify RoleArn
when you call CreateDataSource
to provide an IAM role with permissions to access
your Secrets Manager secret and to call the required public
APIs for the Slack connector and Amazon Kendra.
For more information, see IAM roles for Slack
data sources.
You can also add the following optional features:
-
Virtual Private Cloud
(VPC)—Specify
VpcConfiguration
when you call CreateDataSource
.
For more information, see Configuring Amazon Kendra to use an Amazon VPC.
-
Specific channels—Filter by public or
private channels, and specify certain channels by their ID.
-
Types of channels and messages—Whether
Amazon Kendra should index
your public and private channels, your group and direct
messages, and your bot and archived messages. If you use a bot token as part of
your Slack authentication credentials, you must add the bot
token to the channel you want to index. You cannot index direct
messages and group messages using a bot token.
-
Look back—You can
choose to configure a lookBack
parameter so that
the Slack connector crawls updated or deleted content up to a
specified number of hours before your last connector
sync.
-
Inclusion and exclusion
filters—Specify whether to include or exclude
certain Slack content. If you use a bot token as part of
your Slack authentication credentials, you must add the bot
token to the channel you want to index. You cannot index direct
messages and group messages using a bot token.
Most data sources use regular expression patterns,
which are inclusion or exclusion patterns referred to as filters.
If you specify an inclusion filter, only content that
matches the inclusion filter is indexed. Any document that
doesn’t match the inclusion filter isn’t indexed. If you
specify an inclusion and exclusion filter, documents that
match the exclusion filter are not indexed, even if they
match the inclusion filter.
-
Field mappings—Choose to map your Slack
data source fields to your
Amazon Kendra index fields. For more information, see
Mapping data
source fields.
The document body field or the document body equivalent for your documents is required
in order for Amazon Kendra to search your documents. You must map your document body
field name in your data source to the index field name _document_body
. All other
fields are optional.
For a list of other important JSON keys to configure, see Slack template schema.
Learn more
To learn more about integrating Amazon Kendra with your Slack data
source, see: