Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data SlackConfiguration = SlackConfiguration' {
- crawlBotMessage :: Maybe Bool
- excludeArchived :: Maybe Bool
- exclusionPatterns :: Maybe [Text]
- fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- inclusionPatterns :: Maybe [Text]
- lookBackPeriod :: Maybe Natural
- privateChannelFilter :: Maybe [Text]
- publicChannelFilter :: Maybe [Text]
- useChangeLog :: Maybe Bool
- vpcConfiguration :: Maybe DataSourceVpcConfiguration
- teamId :: Text
- secretArn :: Text
- slackEntityList :: NonEmpty SlackEntity
- sinceCrawlDate :: Text
- newSlackConfiguration :: Text -> Text -> NonEmpty SlackEntity -> Text -> SlackConfiguration
- slackConfiguration_crawlBotMessage :: Lens' SlackConfiguration (Maybe Bool)
- slackConfiguration_excludeArchived :: Lens' SlackConfiguration (Maybe Bool)
- slackConfiguration_exclusionPatterns :: Lens' SlackConfiguration (Maybe [Text])
- slackConfiguration_fieldMappings :: Lens' SlackConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
- slackConfiguration_inclusionPatterns :: Lens' SlackConfiguration (Maybe [Text])
- slackConfiguration_lookBackPeriod :: Lens' SlackConfiguration (Maybe Natural)
- slackConfiguration_privateChannelFilter :: Lens' SlackConfiguration (Maybe [Text])
- slackConfiguration_publicChannelFilter :: Lens' SlackConfiguration (Maybe [Text])
- slackConfiguration_useChangeLog :: Lens' SlackConfiguration (Maybe Bool)
- slackConfiguration_vpcConfiguration :: Lens' SlackConfiguration (Maybe DataSourceVpcConfiguration)
- slackConfiguration_teamId :: Lens' SlackConfiguration Text
- slackConfiguration_secretArn :: Lens' SlackConfiguration Text
- slackConfiguration_slackEntityList :: Lens' SlackConfiguration (NonEmpty SlackEntity)
- slackConfiguration_sinceCrawlDate :: Lens' SlackConfiguration Text
Documentation
data SlackConfiguration Source #
Provides the configuration information to connect to Slack as your data source.
See: newSlackConfiguration
smart constructor.
SlackConfiguration' | |
|
Instances
newSlackConfiguration Source #
:: Text | |
-> Text | |
-> NonEmpty SlackEntity | |
-> Text | |
-> SlackConfiguration |
Create a value of SlackConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:crawlBotMessage:SlackConfiguration'
, slackConfiguration_crawlBotMessage
- TRUE
to index bot messages from your Slack workspace team.
$sel:excludeArchived:SlackConfiguration'
, slackConfiguration_excludeArchived
- TRUE
to exclude archived messages to index from your Slack workspace
team.
$sel:exclusionPatterns:SlackConfiguration'
, slackConfiguration_exclusionPatterns
- A list of regular expression patterns to exclude certain attached files
in your Slack workspace team. Files that match the patterns are excluded
from the index. Files that don’t match the patterns are included in the
index. If a file matches both an inclusion and exclusion pattern, the
exclusion pattern takes precedence and the file isn't included in the
index.
$sel:fieldMappings:SlackConfiguration'
, slackConfiguration_fieldMappings
- A list of DataSourceToIndexFieldMapping
objects that map Slack data
source attributes or field names to Amazon Kendra index field names. To
create custom fields, use the UpdateIndex
API before you map to Slack
fields. For more information, see
Mapping data source fields.
The Slack data source field names must exist in your Slack custom
metadata.
$sel:inclusionPatterns:SlackConfiguration'
, slackConfiguration_inclusionPatterns
- A list of regular expression patterns to include certain attached files
in your Slack workspace team. Files that match the patterns are included
in the index. Files that don't match the patterns are excluded from the
index. If a file matches both an inclusion and exclusion pattern, the
exclusion pattern takes precedence and the file isn't included in the
index.
$sel:lookBackPeriod:SlackConfiguration'
, slackConfiguration_lookBackPeriod
- The number of hours for change log to look back from when you last
synchronized your data. You can look back up to 7 days or 168 hours.
Change log updates your index only if new content was added since you
last synced your data. Updated or deleted content from before you last
synced does not get updated in your index. To capture updated or deleted
content before you last synced, set the LookBackPeriod
to the number
of hours you want change log to look back.
$sel:privateChannelFilter:SlackConfiguration'
, slackConfiguration_privateChannelFilter
- The list of private channel names from your Slack workspace team. You
use this if you want to index specific private channels, not all private
channels. You can also use regular expression patterns to filter private
channels.
$sel:publicChannelFilter:SlackConfiguration'
, slackConfiguration_publicChannelFilter
- The list of public channel names to index from your Slack workspace
team. You use this if you want to index specific public channels, not
all public channels. You can also use regular expression patterns to
filter public channels.
$sel:useChangeLog:SlackConfiguration'
, slackConfiguration_useChangeLog
- TRUE
to use the Slack change log to determine which documents require
updating in the index. Depending on the Slack change log's size, it may
take longer for Amazon Kendra to use the change log than to scan all of
your documents in Slack.
$sel:vpcConfiguration:SlackConfiguration'
, slackConfiguration_vpcConfiguration
- Configuration information for an Amazon Virtual Private Cloud to connect
to your Slack. For more information, see
Configuring a VPC.
$sel:teamId:SlackConfiguration'
, slackConfiguration_teamId
- The identifier of the team in the Slack workspace. For example,
T0123456789.
You can find your team ID in the URL of the main page of your Slack workspace. When you log in to Slack via a browser, you are directed to the URL of the main page. For example, https://app.slack.com/client/T0123456789/....
$sel:secretArn:SlackConfiguration'
, slackConfiguration_secretArn
- The Amazon Resource Name (ARN) of an Secrets Manager secret that
contains the key-value pairs required to connect to your Slack workspace
team. The secret must contain a JSON structure with the following keys:
- slackToken—The user or bot token created in Slack. For more information on creating a token in Slack, see Authentication for a Slack data source.
$sel:slackEntityList:SlackConfiguration'
, slackConfiguration_slackEntityList
- Specify whether to index public channels, private channels, group
messages, and direct messages. You can specify one or more of these
options.
$sel:sinceCrawlDate:SlackConfiguration'
, slackConfiguration_sinceCrawlDate
- The date to start crawling your data from your Slack workspace team. The
date must follow this format: yyyy-mm-dd
.
slackConfiguration_crawlBotMessage :: Lens' SlackConfiguration (Maybe Bool) Source #
TRUE
to index bot messages from your Slack workspace team.
slackConfiguration_excludeArchived :: Lens' SlackConfiguration (Maybe Bool) Source #
TRUE
to exclude archived messages to index from your Slack workspace
team.
slackConfiguration_exclusionPatterns :: Lens' SlackConfiguration (Maybe [Text]) Source #
A list of regular expression patterns to exclude certain attached files in your Slack workspace team. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
slackConfiguration_fieldMappings :: Lens' SlackConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #
A list of DataSourceToIndexFieldMapping
objects that map Slack data
source attributes or field names to Amazon Kendra index field names. To
create custom fields, use the UpdateIndex
API before you map to Slack
fields. For more information, see
Mapping data source fields.
The Slack data source field names must exist in your Slack custom
metadata.
slackConfiguration_inclusionPatterns :: Lens' SlackConfiguration (Maybe [Text]) Source #
A list of regular expression patterns to include certain attached files in your Slack workspace team. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
slackConfiguration_lookBackPeriod :: Lens' SlackConfiguration (Maybe Natural) Source #
The number of hours for change log to look back from when you last synchronized your data. You can look back up to 7 days or 168 hours.
Change log updates your index only if new content was added since you
last synced your data. Updated or deleted content from before you last
synced does not get updated in your index. To capture updated or deleted
content before you last synced, set the LookBackPeriod
to the number
of hours you want change log to look back.
slackConfiguration_privateChannelFilter :: Lens' SlackConfiguration (Maybe [Text]) Source #
The list of private channel names from your Slack workspace team. You use this if you want to index specific private channels, not all private channels. You can also use regular expression patterns to filter private channels.
slackConfiguration_publicChannelFilter :: Lens' SlackConfiguration (Maybe [Text]) Source #
The list of public channel names to index from your Slack workspace team. You use this if you want to index specific public channels, not all public channels. You can also use regular expression patterns to filter public channels.
slackConfiguration_useChangeLog :: Lens' SlackConfiguration (Maybe Bool) Source #
TRUE
to use the Slack change log to determine which documents require
updating in the index. Depending on the Slack change log's size, it may
take longer for Amazon Kendra to use the change log than to scan all of
your documents in Slack.
slackConfiguration_vpcConfiguration :: Lens' SlackConfiguration (Maybe DataSourceVpcConfiguration) Source #
Configuration information for an Amazon Virtual Private Cloud to connect to your Slack. For more information, see Configuring a VPC.
slackConfiguration_teamId :: Lens' SlackConfiguration Text Source #
The identifier of the team in the Slack workspace. For example, T0123456789.
You can find your team ID in the URL of the main page of your Slack workspace. When you log in to Slack via a browser, you are directed to the URL of the main page. For example, https://app.slack.com/client/T0123456789/....
slackConfiguration_secretArn :: Lens' SlackConfiguration Text Source #
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Slack workspace team. The secret must contain a JSON structure with the following keys:
- slackToken—The user or bot token created in Slack. For more information on creating a token in Slack, see Authentication for a Slack data source.
slackConfiguration_slackEntityList :: Lens' SlackConfiguration (NonEmpty SlackEntity) Source #
Specify whether to index public channels, private channels, group messages, and direct messages. You can specify one or more of these options.
slackConfiguration_sinceCrawlDate :: Lens' SlackConfiguration Text Source #
The date to start crawling your data from your Slack workspace team. The
date must follow this format: yyyy-mm-dd
.