Struct aws_sdk_kendra::types::SlackConfiguration

#[non_exhaustive]
pub struct SlackConfiguration {

    pub team_id: String,
    pub secret_arn: String,
    pub vpc_configuration: Option<DataSourceVpcConfiguration>,
    pub slack_entity_list: Vec<SlackEntity>,
    pub use_change_log: bool,
    pub crawl_bot_message: bool,
    pub exclude_archived: bool,
    pub since_crawl_date: String,
    pub look_back_period: Option<i32>,
    pub private_channel_filter: Option<Vec<String>>,
    pub public_channel_filter: Option<Vec<String>>,
    pub inclusion_patterns: Option<Vec<String>>,
    pub exclusion_patterns: Option<Vec<String>>,
    pub field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>,
}

Provides the configuration information to connect to Slack as your data source.

Amazon Kendra now supports an upgraded Slack connector.

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

team_id: String

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/....

secret_arn: String

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.

vpc_configuration: Option<DataSourceVpcConfiguration>

Configuration information for an Amazon Virtual Private Cloud to connect to your Slack. For more information, see Configuring a VPC.

slack_entity_list: Vec<SlackEntity>

Specify whether to index public channels, private channels, group messages, and direct messages. You can specify one or more of these options.

use_change_log: bool

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.

crawl_bot_message: bool

TRUE to index bot messages from your Slack workspace team.

exclude_archived: bool

TRUE to exclude archived messages to index from your Slack workspace team.

since_crawl_date: String

The date to start crawling your data from your Slack workspace team. The date must follow this format: yyyy-mm-dd.

look_back_period: Option<i32>

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.

private_channel_filter: Option<Vec<String>>

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.

public_channel_filter: Option<Vec<String>>

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.

inclusion_patterns: Option<Vec<String>>

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.

exclusion_patterns: Option<Vec<String>>

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.

field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>

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.

Implementations

impl SlackConfiguration

pub fn team_id(&self) -> &str

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/....

pub fn secret_arn(&self) -> &str

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.

pub fn vpc_configuration(&self) -> Option<&DataSourceVpcConfiguration>

Configuration information for an Amazon Virtual Private Cloud to connect to your Slack. For more information, see Configuring a VPC.

pub fn slack_entity_list(&self) -> &[SlackEntity]

Specify whether to index public channels, private channels, group messages, and direct messages. You can specify one or more of these options.

pub fn use_change_log(&self) -> bool

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.

pub fn crawl_bot_message(&self) -> bool

TRUE to index bot messages from your Slack workspace team.

pub fn exclude_archived(&self) -> bool

TRUE to exclude archived messages to index from your Slack workspace team.

pub fn since_crawl_date(&self) -> &str

The date to start crawling your data from your Slack workspace team. The date must follow this format: yyyy-mm-dd.

pub fn look_back_period(&self) -> Option<i32>

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.

pub fn private_channel_filter(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .private_channel_filter.is_none().

pub fn public_channel_filter(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .public_channel_filter.is_none().

pub fn inclusion_patterns(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .inclusion_patterns.is_none().

pub fn exclusion_patterns(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .exclusion_patterns.is_none().

pub fn field_mappings(&self) -> &[DataSourceToIndexFieldMapping]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .field_mappings.is_none().

impl SlackConfiguration

pub fn builder() -> SlackConfigurationBuilder

Creates a new builder-style object to manufacture SlackConfiguration.

Trait Implementations

impl Clone for SlackConfiguration

fn clone(&self) -> SlackConfiguration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SlackConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for SlackConfiguration

fn eq(&self, other: &SlackConfiguration) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SlackConfiguration