configuration
Configuration details for the data source connector. This shows how the data source is configured. The configuration options for a data source depend on the data source provider. | STRUCT(
"s3_configuration" STRUCT(
"bucket_name" VARCHAR,
"inclusion_prefixes" VARCHAR[],
"inclusion_patterns" VARCHAR[],
"exclusion_patterns" VARCHAR[],
"documents_metadata_configuration" STRUCT(
"s3_prefix" VARCHAR
),
"access_control_list_configuration" STRUCT(
"key_path" VARCHAR
)
),
"share_point_configuration" STRUCT(
"share_point_version" VARCHAR,
"urls" VARCHAR[],
"secret_arn" VARCHAR,
"crawl_attachments" BOOLEAN,
"use_change_log" BOOLEAN,
"inclusion_patterns" VARCHAR[],
"exclusion_patterns" VARCHAR[],
"vpc_configuration" STRUCT(
"subnet_ids" VARCHAR[],
"security_group_ids" VARCHAR[]
),
"field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"document_title_field_name" VARCHAR,
"disable_local_groups" BOOLEAN,
"ssl_certificate_s3_path" STRUCT(
"bucket" VARCHAR,
"key" VARCHAR
),
"authentication_type" VARCHAR,
"proxy_configuration" STRUCT(
"host" VARCHAR,
"port" BIGINT,
"credentials" VARCHAR
)
),
"database_configuration" STRUCT(
"database_engine_type" VARCHAR,
"connection_configuration" STRUCT(
"database_host" VARCHAR,
"database_port" BIGINT,
"database_name" VARCHAR,
"table_name" VARCHAR,
"secret_arn" VARCHAR
),
"vpc_configuration" STRUCT(
"subnet_ids" VARCHAR[],
"security_group_ids" VARCHAR[]
),
"column_configuration" STRUCT(
"document_id_column_name" VARCHAR,
"document_data_column_name" VARCHAR,
"document_title_column_name" VARCHAR,
"field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"change_detecting_columns" VARCHAR[]
),
"acl_configuration" STRUCT(
"allowed_groups_column_name" VARCHAR
),
"sql_configuration" STRUCT(
"query_identifiers_enclosing_option" VARCHAR
)
),
"salesforce_configuration" STRUCT(
"server_url" VARCHAR,
"secret_arn" VARCHAR,
"standard_object_configurations" STRUCT(
"name" VARCHAR,
"document_data_field_name" VARCHAR,
"document_title_field_name" VARCHAR,
"field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[]
)[],
"knowledge_article_configuration" STRUCT(
"included_states" VARCHAR[],
"standard_knowledge_article_type_configuration" STRUCT(
"document_data_field_name" VARCHAR,
"document_title_field_name" VARCHAR,
"field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[]
),
"custom_knowledge_article_type_configurations" STRUCT(
"name" VARCHAR,
"document_data_field_name" VARCHAR,
"document_title_field_name" VARCHAR,
"field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[]
)[]
),
"chatter_feed_configuration" STRUCT(
"document_data_field_name" VARCHAR,
"document_title_field_name" VARCHAR,
"field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"include_filter_types" VARCHAR[]
),
"crawl_attachments" BOOLEAN,
"standard_object_attachment_configuration" STRUCT(
"document_title_field_name" VARCHAR,
"field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[]
),
"include_attachment_file_patterns" VARCHAR[],
"exclude_attachment_file_patterns" VARCHAR[]
),
"one_drive_configuration" STRUCT(
"tenant_domain" VARCHAR,
"secret_arn" VARCHAR,
"one_drive_users" STRUCT(
"one_drive_user_list" VARCHAR[],
"one_drive_user_s3_path" STRUCT(
"bucket" VARCHAR,
"key" VARCHAR
)
),
"inclusion_patterns" VARCHAR[],
"exclusion_patterns" VARCHAR[],
"field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"disable_local_groups" BOOLEAN
),
"service_now_configuration" STRUCT(
"host_url" VARCHAR,
"secret_arn" VARCHAR,
"service_now_build_version" VARCHAR,
"knowledge_article_configuration" STRUCT(
"crawl_attachments" BOOLEAN,
"include_attachment_file_patterns" VARCHAR[],
"exclude_attachment_file_patterns" VARCHAR[],
"document_data_field_name" VARCHAR,
"document_title_field_name" VARCHAR,
"field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"filter_query" VARCHAR
),
"service_catalog_configuration" STRUCT(
"crawl_attachments" BOOLEAN,
"include_attachment_file_patterns" VARCHAR[],
"exclude_attachment_file_patterns" VARCHAR[],
"document_data_field_name" VARCHAR,
"document_title_field_name" VARCHAR,
"field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[]
),
"authentication_type" VARCHAR
),
"confluence_configuration" STRUCT(
"server_url" VARCHAR,
"secret_arn" VARCHAR,
"version" VARCHAR,
"space_configuration" STRUCT(
"crawl_personal_spaces" BOOLEAN,
"crawl_archived_spaces" BOOLEAN,
"include_spaces" VARCHAR[],
"exclude_spaces" VARCHAR[],
"space_field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[]
),
"page_configuration" STRUCT(
"page_field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[]
),
"blog_configuration" STRUCT(
"blog_field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[]
),
"attachment_configuration" STRUCT(
"crawl_attachments" BOOLEAN,
"attachment_field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[]
),
"vpc_configuration" STRUCT(
"subnet_ids" VARCHAR[],
"security_group_ids" VARCHAR[]
),
"inclusion_patterns" VARCHAR[],
"exclusion_patterns" VARCHAR[],
"proxy_configuration" STRUCT(
"host" VARCHAR,
"port" BIGINT,
"credentials" VARCHAR
),
"authentication_type" VARCHAR
),
"google_drive_configuration" STRUCT(
"secret_arn" VARCHAR,
"inclusion_patterns" VARCHAR[],
"exclusion_patterns" VARCHAR[],
"field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"exclude_mime_types" VARCHAR[],
"exclude_user_accounts" VARCHAR[],
"exclude_shared_drives" VARCHAR[]
),
"web_crawler_configuration" STRUCT(
"urls" STRUCT(
"seed_url_configuration" STRUCT(
"seed_urls" VARCHAR[],
"web_crawler_mode" VARCHAR
),
"site_maps_configuration" STRUCT(
"site_maps" VARCHAR[]
)
),
"crawl_depth" BIGINT,
"max_links_per_page" BIGINT,
"max_content_size_per_page_in_mega_bytes" DOUBLE,
"max_urls_per_minute_crawl_rate" BIGINT,
"url_inclusion_patterns" VARCHAR[],
"url_exclusion_patterns" VARCHAR[],
"proxy_configuration" STRUCT(
"host" VARCHAR,
"port" BIGINT,
"credentials" VARCHAR
),
"authentication_configuration" STRUCT(
"basic_authentication" STRUCT(
"host" VARCHAR,
"port" BIGINT,
"credentials" VARCHAR
)[]
)
),
"work_docs_configuration" STRUCT(
"organization_id" VARCHAR,
"crawl_comments" BOOLEAN,
"use_change_log" BOOLEAN,
"inclusion_patterns" VARCHAR[],
"exclusion_patterns" VARCHAR[],
"field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[]
),
"fsx_configuration" STRUCT(
"file_system_id" VARCHAR,
"file_system_type" VARCHAR,
"vpc_configuration" STRUCT(
"subnet_ids" VARCHAR[],
"security_group_ids" VARCHAR[]
),
"secret_arn" VARCHAR,
"inclusion_patterns" VARCHAR[],
"exclusion_patterns" VARCHAR[],
"field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[]
),
"slack_configuration" STRUCT(
"team_id" VARCHAR,
"secret_arn" VARCHAR,
"vpc_configuration" STRUCT(
"subnet_ids" VARCHAR[],
"security_group_ids" VARCHAR[]
),
"slack_entity_list" VARCHAR[],
"use_change_log" BOOLEAN,
"crawl_bot_message" BOOLEAN,
"exclude_archived" BOOLEAN,
"since_crawl_date" VARCHAR,
"look_back_period" BIGINT,
"private_channel_filter" VARCHAR[],
"public_channel_filter" VARCHAR[],
"inclusion_patterns" VARCHAR[],
"exclusion_patterns" VARCHAR[],
"field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[]
),
"box_configuration" STRUCT(
"enterprise_id" VARCHAR,
"secret_arn" VARCHAR,
"use_change_log" BOOLEAN,
"crawl_comments" BOOLEAN,
"crawl_tasks" BOOLEAN,
"crawl_web_links" BOOLEAN,
"file_field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"task_field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"comment_field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"web_link_field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"inclusion_patterns" VARCHAR[],
"exclusion_patterns" VARCHAR[],
"vpc_configuration" STRUCT(
"subnet_ids" VARCHAR[],
"security_group_ids" VARCHAR[]
)
),
"quip_configuration" STRUCT(
"domain" VARCHAR,
"secret_arn" VARCHAR,
"crawl_file_comments" BOOLEAN,
"crawl_chat_rooms" BOOLEAN,
"crawl_attachments" BOOLEAN,
"folder_ids" VARCHAR[],
"thread_field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"message_field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"attachment_field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"inclusion_patterns" VARCHAR[],
"exclusion_patterns" VARCHAR[],
"vpc_configuration" STRUCT(
"subnet_ids" VARCHAR[],
"security_group_ids" VARCHAR[]
)
),
"jira_configuration" STRUCT(
"jira_account_url" VARCHAR,
"secret_arn" VARCHAR,
"use_change_log" BOOLEAN,
"project" VARCHAR[],
"issue_type" VARCHAR[],
"status" VARCHAR[],
"issue_sub_entity_filter" VARCHAR[],
"attachment_field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"comment_field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"issue_field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"project_field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"work_log_field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"inclusion_patterns" VARCHAR[],
"exclusion_patterns" VARCHAR[],
"vpc_configuration" STRUCT(
"subnet_ids" VARCHAR[],
"security_group_ids" VARCHAR[]
)
),
"git_hub_configuration" STRUCT(
"saa_s_configuration" STRUCT(
"organization_name" VARCHAR,
"host_url" VARCHAR
),
"on_premise_configuration" STRUCT(
"host_url" VARCHAR,
"organization_name" VARCHAR,
"ssl_certificate_s3_path" STRUCT(
"bucket" VARCHAR,
"key" VARCHAR
)
),
"type" VARCHAR,
"secret_arn" VARCHAR,
"use_change_log" BOOLEAN,
"git_hub_document_crawl_properties" STRUCT(
"crawl_repository_documents" BOOLEAN,
"crawl_issue" BOOLEAN,
"crawl_issue_comment" BOOLEAN,
"crawl_issue_comment_attachment" BOOLEAN,
"crawl_pull_request" BOOLEAN,
"crawl_pull_request_comment" BOOLEAN,
"crawl_pull_request_comment_attachment" BOOLEAN
),
"repository_filter" VARCHAR[],
"inclusion_folder_name_patterns" VARCHAR[],
"inclusion_file_type_patterns" VARCHAR[],
"inclusion_file_name_patterns" VARCHAR[],
"exclusion_folder_name_patterns" VARCHAR[],
"exclusion_file_type_patterns" VARCHAR[],
"exclusion_file_name_patterns" VARCHAR[],
"vpc_configuration" STRUCT(
"subnet_ids" VARCHAR[],
"security_group_ids" VARCHAR[]
),
"git_hub_repository_configuration_field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"git_hub_commit_configuration_field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"git_hub_issue_document_configuration_field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"git_hub_issue_comment_configuration_field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"git_hub_issue_attachment_configuration_field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"git_hub_pull_request_comment_configuration_field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"git_hub_pull_request_document_configuration_field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"git_hub_pull_request_document_attachment_configuration_field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[]
),
"alfresco_configuration" STRUCT(
"site_url" VARCHAR,
"site_id" VARCHAR,
"secret_arn" VARCHAR,
"ssl_certificate_s3_path" STRUCT(
"bucket" VARCHAR,
"key" VARCHAR
),
"crawl_system_folders" BOOLEAN,
"crawl_comments" BOOLEAN,
"entity_filter" VARCHAR[],
"document_library_field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"blog_field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"wiki_field_mappings" STRUCT(
"data_source_field_name" VARCHAR,
"date_field_format" VARCHAR,
"index_field_name" VARCHAR
)[],
"inclusion_patterns" VARCHAR[],
"exclusion_patterns" VARCHAR[],
"vpc_configuration" STRUCT(
"subnet_ids" VARCHAR[],
"security_group_ids" VARCHAR[]
)
),
"template_configuration" STRUCT(
"template" VARCHAR
)
) |
Show child fields- configuration.alfresco_configuration
Provides the configuration information to connect to Alfresco as your data source. Support for AlfrescoConfiguration ended May 2023. We recommend migrating to or using the Alfresco data source template schema/TemplateConfiguration API. Show child fields- configuration.alfresco_configuration.blog_field_mappings[]
Show child fields- configuration.alfresco_configuration.blog_field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.alfresco_configuration.blog_field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.alfresco_configuration.blog_field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.alfresco_configuration.crawl_comments
TRUE to index comments of blogs and other content. - configuration.alfresco_configuration.crawl_system_folders
TRUE to index shared files. - configuration.alfresco_configuration.document_library_field_mappings[]
Show child fields- configuration.alfresco_configuration.document_library_field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.alfresco_configuration.document_library_field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.alfresco_configuration.document_library_field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.alfresco_configuration.entity_filter[]
- configuration.alfresco_configuration.exclusion_patterns[]
- configuration.alfresco_configuration.inclusion_patterns[]
- configuration.alfresco_configuration.secret_arn
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Alfresco data source. The secret must contain a JSON structure with the following keys: - configuration.alfresco_configuration.site_id
The identifier of the Alfresco site. For example, my-site. - configuration.alfresco_configuration.site_url
The URL of the Alfresco site. For example, https://hostname:8080. - configuration.alfresco_configuration.ssl_certificate_s3_path
The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to Alfresco if you require a secure SSL connection. You can simply generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate. Show child fields- configuration.alfresco_configuration.ssl_certificate_s3_path.bucket
The name of the S3 bucket that contains the file. - configuration.alfresco_configuration.ssl_certificate_s3_path.key
The name of the file.
- configuration.alfresco_configuration.vpc_configuration
Configuration information for an Amazon Virtual Private Cloud to connect to your Alfresco. For more information, see Configuring a VPC. Show child fields- configuration.alfresco_configuration.vpc_configuration.security_group_ids[]
- configuration.alfresco_configuration.vpc_configuration.subnet_ids[]
- configuration.alfresco_configuration.wiki_field_mappings[]
Show child fields- configuration.alfresco_configuration.wiki_field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.alfresco_configuration.wiki_field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.alfresco_configuration.wiki_field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.box_configuration
Provides the configuration information to connect to Box as your data source. Show child fields- configuration.box_configuration.comment_field_mappings[]
Show child fields- configuration.box_configuration.comment_field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.box_configuration.comment_field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.box_configuration.comment_field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.box_configuration.crawl_comments
TRUE to index comments. - configuration.box_configuration.crawl_tasks
TRUE to index the contents of tasks. - configuration.box_configuration.crawl_web_links
TRUE to index web links. - configuration.box_configuration.enterprise_id
The identifier of the Box Enterprise platform. You can find the enterprise ID in the Box Developer Console settings or when you create an app in Box and download your authentication credentials. For example, 801234567. - configuration.box_configuration.exclusion_patterns[]
- configuration.box_configuration.file_field_mappings[]
Show child fields- configuration.box_configuration.file_field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.box_configuration.file_field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.box_configuration.file_field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.box_configuration.inclusion_patterns[]
- configuration.box_configuration.secret_arn
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Box platform. The secret must contain a JSON structure with the following keys: -
clientID—The identifier of the client OAuth 2.0 authentication application created in Box. -
clientSecret—A set of characters known only to the OAuth 2.0 authentication application created in Box. -
publicKeyId—The identifier of the public key contained within an identity certificate. -
privateKey—A set of characters that make up an encryption key. -
passphrase—A set of characters that act like a password. You create an application in Box to generate the keys or credentials required for the secret. For more information, see Using a Box data source. - configuration.box_configuration.task_field_mappings[]
Show child fields- configuration.box_configuration.task_field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.box_configuration.task_field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.box_configuration.task_field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.box_configuration.use_change_log
TRUE to use the Slack change log to determine which documents require updating in the index. Depending on the data source change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents. - configuration.box_configuration.vpc_configuration
Configuration information for an Amazon VPC to connect to your Box. For more information, see Configuring a VPC. Show child fields- configuration.box_configuration.vpc_configuration.security_group_ids[]
- configuration.box_configuration.vpc_configuration.subnet_ids[]
- configuration.box_configuration.web_link_field_mappings[]
Show child fields- configuration.box_configuration.web_link_field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.box_configuration.web_link_field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.box_configuration.web_link_field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.confluence_configuration
Provides the configuration information to connect to Confluence as your data source. Show child fields- configuration.confluence_configuration.attachment_configuration
Configuration information for indexing attachments to Confluence blogs and pages. Show child fields- configuration.confluence_configuration.attachment_configuration.attachment_field_mappings[]
Show child fields- configuration.confluence_configuration.attachment_configuration.attachment_field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.confluence_configuration.attachment_configuration.attachment_field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.confluence_configuration.attachment_configuration.attachment_field_mappings[].index_field_name
The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
- configuration.confluence_configuration.attachment_configuration.crawl_attachments
TRUE to index attachments of pages and blogs in Confluence.
- configuration.confluence_configuration.authentication_type
Whether you want to connect to Confluence using basic authentication of user name and password, or a personal access token. You can use a personal access token for Confluence Server. - configuration.confluence_configuration.blog_configuration
Configuration information for indexing Confluence blogs. Show child fields- configuration.confluence_configuration.blog_configuration.blog_field_mappings[]
Show child fields- configuration.confluence_configuration.blog_configuration.blog_field_mappings[].data_source_field_name
The name of the field in the data source. - configuration.confluence_configuration.blog_configuration.blog_field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.confluence_configuration.blog_configuration.blog_field_mappings[].index_field_name
The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
- configuration.confluence_configuration.exclusion_patterns[]
- configuration.confluence_configuration.inclusion_patterns[]
- configuration.confluence_configuration.page_configuration
Configuration information for indexing Confluence pages. Show child fields- configuration.confluence_configuration.page_configuration.page_field_mappings[]
Show child fields- configuration.confluence_configuration.page_configuration.page_field_mappings[].data_source_field_name
The name of the field in the data source. - configuration.confluence_configuration.page_configuration.page_field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.confluence_configuration.page_configuration.page_field_mappings[].index_field_name
The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
- configuration.confluence_configuration.proxy_configuration
Configuration information to connect to your Confluence URL instance via a web proxy. You can use this option for Confluence Server. You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS. Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication of user name and password. To store web proxy credentials, you use a secret in Secrets Manager. It is recommended that you follow best security practices when configuring your web proxy. This includes setting up throttling, setting up logging and monitoring, and applying security patches on a regular basis. If you use your web proxy with multiple data sources, sync jobs that occur at the same time could strain the load on your proxy. It is recommended you prepare your proxy beforehand for any security and load requirements. Show child fields- configuration.confluence_configuration.proxy_configuration.credentials
Your secret ARN, which you can create in Secrets Manager The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials. - configuration.confluence_configuration.proxy_configuration.host
The name of the website host you want to connect to via a web proxy server. For example, the host name of https://a.example.com/page1.html is "a.example.com". - configuration.confluence_configuration.proxy_configuration.port
The port number of the website host you want to connect to via a web proxy server. For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.
- configuration.confluence_configuration.secret_arn
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the Confluence instance. If you use Confluence Cloud, you use a generated API token as the password. You can also provide authentication credentials in the form of a personal access token. For more information, see Using a Confluence data source. - configuration.confluence_configuration.server_url
The URL of your Confluence instance. Use the full URL of the server. For example, https://server.example.com:port/. You can also use an IP address, for example, https://192.168.1.113/. - configuration.confluence_configuration.space_configuration
Configuration information for indexing Confluence spaces. Show child fields- configuration.confluence_configuration.space_configuration.crawl_archived_spaces
TRUE to index archived spaces. - configuration.confluence_configuration.space_configuration.crawl_personal_spaces
TRUE to index personal spaces. You can add restrictions to items in personal spaces. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results. For more information, see Filtering on user context. - configuration.confluence_configuration.space_configuration.exclude_spaces[]
- configuration.confluence_configuration.space_configuration.include_spaces[]
- configuration.confluence_configuration.space_configuration.space_field_mappings[]
Show child fields- configuration.confluence_configuration.space_configuration.space_field_mappings[].data_source_field_name
The name of the field in the data source. - configuration.confluence_configuration.space_configuration.space_field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.confluence_configuration.space_configuration.space_field_mappings[].index_field_name
The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
- configuration.confluence_configuration.version
The version or the type of Confluence installation to connect to. - configuration.confluence_configuration.vpc_configuration
Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC. Show child fields- configuration.confluence_configuration.vpc_configuration.security_group_ids[]
- configuration.confluence_configuration.vpc_configuration.subnet_ids[]
- configuration.database_configuration
Provides the configuration information to connect to a database as your data source. Show child fields- configuration.database_configuration.acl_configuration
Information about the database column that provides information for user context filtering. Show child fields- configuration.database_configuration.acl_configuration.allowed_groups_column_name
A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the UserContext field of the Query API.
- configuration.database_configuration.column_configuration
Information about where the index should get the document information from the database. Show child fields- configuration.database_configuration.column_configuration.change_detecting_columns[]
- configuration.database_configuration.column_configuration.document_data_column_name
The column that contains the contents of the document. - configuration.database_configuration.column_configuration.document_id_column_name
The column that provides the document's identifier. - configuration.database_configuration.column_configuration.document_title_column_name
The column that contains the title of the document. - configuration.database_configuration.column_configuration.field_mappings[]
Show child fields- configuration.database_configuration.column_configuration.field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.database_configuration.column_configuration.field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.database_configuration.column_configuration.field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.database_configuration.connection_configuration
Configuration information that's required to connect to a database. Show child fields- configuration.database_configuration.connection_configuration.database_host
The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address. - configuration.database_configuration.connection_configuration.database_name
The name of the database containing the document data. - configuration.database_configuration.connection_configuration.database_port
The port that the database uses for connections. - configuration.database_configuration.connection_configuration.secret_arn
The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about Secrets Manager, see What Is Secrets Manager in the Secrets Manager user guide. - configuration.database_configuration.connection_configuration.table_name
The name of the table that contains the document data.
- configuration.database_configuration.database_engine_type
The type of database engine that runs the database. - configuration.database_configuration.sql_configuration
Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source. Show child fields- configuration.database_configuration.sql_configuration.query_identifiers_enclosing_option
Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when making a database query. By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source configuration. It does not change the case of identifiers or enclose them in quotes. PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they are quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the character's case. For MySQL databases, you must enable the ansi_quotes option when you set this field to DOUBLE_QUOTES.
- configuration.database_configuration.vpc_configuration
Provides the configuration information to connect to an Amazon VPC. Show child fields- configuration.database_configuration.vpc_configuration.security_group_ids[]
- configuration.database_configuration.vpc_configuration.subnet_ids[]
- configuration.fsx_configuration
Provides the configuration information to connect to Amazon FSx as your data source. Amazon Kendra now supports an upgraded Amazon FSx Windows connector. You must now use the TemplateConfiguration object instead of the FsxConfiguration 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. Show child fields- configuration.fsx_configuration.exclusion_patterns[]
- configuration.fsx_configuration.field_mappings[]
Show child fields- configuration.fsx_configuration.field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.fsx_configuration.field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.fsx_configuration.field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.fsx_configuration.file_system_id
The identifier of the Amazon FSx file system. You can find your file system ID on the file system dashboard in the Amazon FSx console. For information on how to create a file system in Amazon FSx console, using Windows File Server as an example, see Amazon FSx Getting started guide. - configuration.fsx_configuration.file_system_type
The Amazon FSx file system type. Windows is currently the only supported type. - configuration.fsx_configuration.inclusion_patterns[]
- configuration.fsx_configuration.secret_arn
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Amazon FSx file system. Windows is currently the only supported type. The secret must contain a JSON structure with the following keys: -
username—The Active Directory user name, along with the Domain Name System (DNS) domain name. For example, user@corp.example.com. The Active Directory user account must have read and mounting access to the Amazon FSx file system for Windows. -
password—The password of the Active Directory user account with read and mounting access to the Amazon FSx Windows file system. - configuration.fsx_configuration.vpc_configuration
Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon FSx instance must reside inside your VPC. Show child fields- configuration.fsx_configuration.vpc_configuration.security_group_ids[]
- configuration.fsx_configuration.vpc_configuration.subnet_ids[]
- configuration.git_hub_configuration
Provides the configuration information to connect to GitHub as your data source. Amazon Kendra now supports an upgraded GitHub connector. You must now use the TemplateConfiguration object instead of the GitHubConfiguration 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. Show child fields- configuration.git_hub_configuration.exclusion_file_name_patterns[]
- configuration.git_hub_configuration.exclusion_file_type_patterns[]
- configuration.git_hub_configuration.exclusion_folder_name_patterns[]
- configuration.git_hub_configuration.git_hub_commit_configuration_field_mappings[]
Show child fields- configuration.git_hub_configuration.git_hub_commit_configuration_field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.git_hub_configuration.git_hub_commit_configuration_field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.git_hub_configuration.git_hub_commit_configuration_field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.git_hub_configuration.git_hub_document_crawl_properties
Configuration information to include certain types of GitHub content. You can configure to index repository files only, or also include issues and pull requests, comments, and comment attachments. Show child fields- configuration.git_hub_configuration.git_hub_document_crawl_properties.crawl_issue
TRUE to index all issues within a repository. - configuration.git_hub_configuration.git_hub_document_crawl_properties.crawl_issue_comment
TRUE to index all comments on issues. - configuration.git_hub_configuration.git_hub_document_crawl_properties.crawl_issue_comment_attachment
TRUE to include all comment attachments for issues. - configuration.git_hub_configuration.git_hub_document_crawl_properties.crawl_pull_request
TRUE to index all pull requests within a repository. - configuration.git_hub_configuration.git_hub_document_crawl_properties.crawl_pull_request_comment
TRUE to index all comments on pull requests. - configuration.git_hub_configuration.git_hub_document_crawl_properties.crawl_pull_request_comment_attachment
TRUE to include all comment attachments for pull requests. - configuration.git_hub_configuration.git_hub_document_crawl_properties.crawl_repository_documents
TRUE to index all files with a repository.
- configuration.git_hub_configuration.git_hub_issue_attachment_configuration_field_mappings[]
Show child fields- configuration.git_hub_configuration.git_hub_issue_attachment_configuration_field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.git_hub_configuration.git_hub_issue_attachment_configuration_field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.git_hub_configuration.git_hub_issue_attachment_configuration_field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.git_hub_configuration.git_hub_issue_comment_configuration_field_mappings[]
Show child fields- configuration.git_hub_configuration.git_hub_issue_comment_configuration_field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.git_hub_configuration.git_hub_issue_comment_configuration_field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.git_hub_configuration.git_hub_issue_comment_configuration_field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.git_hub_configuration.git_hub_issue_document_configuration_field_mappings[]
Show child fields- configuration.git_hub_configuration.git_hub_issue_document_configuration_field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.git_hub_configuration.git_hub_issue_document_configuration_field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.git_hub_configuration.git_hub_issue_document_configuration_field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.git_hub_configuration.git_hub_pull_request_comment_configuration_field_mappings[]
Show child fields- configuration.git_hub_configuration.git_hub_pull_request_comment_configuration_field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.git_hub_configuration.git_hub_pull_request_comment_configuration_field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.git_hub_configuration.git_hub_pull_request_comment_configuration_field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.git_hub_configuration.git_hub_pull_request_document_attachment_configuration_field_mappings[]
Show child fields- configuration.git_hub_configuration.git_hub_pull_request_document_attachment_configuration_field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.git_hub_configuration.git_hub_pull_request_document_attachment_configuration_field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.git_hub_configuration.git_hub_pull_request_document_attachment_configuration_field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.git_hub_configuration.git_hub_pull_request_document_configuration_field_mappings[]
Show child fields- configuration.git_hub_configuration.git_hub_pull_request_document_configuration_field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.git_hub_configuration.git_hub_pull_request_document_configuration_field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.git_hub_configuration.git_hub_pull_request_document_configuration_field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.git_hub_configuration.git_hub_repository_configuration_field_mappings[]
Show child fields- configuration.git_hub_configuration.git_hub_repository_configuration_field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.git_hub_configuration.git_hub_repository_configuration_field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.git_hub_configuration.git_hub_repository_configuration_field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.git_hub_configuration.inclusion_file_name_patterns[]
- configuration.git_hub_configuration.inclusion_file_type_patterns[]
- configuration.git_hub_configuration.inclusion_folder_name_patterns[]
- configuration.git_hub_configuration.on_premise_configuration
Configuration information to connect to GitHub Enterprise Server (on premises). Show child fields- configuration.git_hub_configuration.on_premise_configuration.host_url
The GitHub host URL or API endpoint URL. For example, https://on-prem-host-url/api/v3/ - configuration.git_hub_configuration.on_premise_configuration.organization_name
The name of the organization of the GitHub Enterprise Server (on-premises) account you want to connect to. You can find your organization name by logging into GitHub desktop and selecting Your organizations under your profile picture dropdown. - configuration.git_hub_configuration.on_premise_configuration.ssl_certificate_s3_path
The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to GitHub if you require a secure SSL connection. You can simply generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate. Show child fields- configuration.git_hub_configuration.on_premise_configuration.ssl_certificate_s3_path.bucket
The name of the S3 bucket that contains the file. - configuration.git_hub_configuration.on_premise_configuration.ssl_certificate_s3_path.key
The name of the file.
- configuration.git_hub_configuration.repository_filter[]
- configuration.git_hub_configuration.saa_s_configuration
Configuration information to connect to GitHub Enterprise Cloud (SaaS). Show child fields- configuration.git_hub_configuration.saa_s_configuration.host_url
The GitHub host URL or API endpoint URL. For example, https://api.github.com. - configuration.git_hub_configuration.saa_s_configuration.organization_name
The name of the organization of the GitHub Enterprise Cloud (SaaS) account you want to connect to. You can find your organization name by logging into GitHub desktop and selecting Your organizations under your profile picture dropdown.
- configuration.git_hub_configuration.secret_arn
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your GitHub. The secret must contain a JSON structure with the following keys: - configuration.git_hub_configuration.type
The type of GitHub service you want to connect to—GitHub Enterprise Cloud (SaaS) or GitHub Enterprise Server (on premises). - configuration.git_hub_configuration.use_change_log
TRUE to use the GitHub change log to determine which documents require updating in the index. Depending on the GitHub change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in GitHub. - configuration.git_hub_configuration.vpc_configuration
Configuration information of an Amazon Virtual Private Cloud to connect to your GitHub. For more information, see Configuring a VPC. Show child fields- configuration.git_hub_configuration.vpc_configuration.security_group_ids[]
- configuration.git_hub_configuration.vpc_configuration.subnet_ids[]
- configuration.google_drive_configuration
Provides the configuration information to connect to Google Drive as your data source. Show child fields- configuration.google_drive_configuration.exclude_mime_types[]
- configuration.google_drive_configuration.exclude_shared_drives[]
- configuration.google_drive_configuration.exclude_user_accounts[]
- configuration.google_drive_configuration.exclusion_patterns[]
- configuration.google_drive_configuration.field_mappings[]
Show child fields- configuration.google_drive_configuration.field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.google_drive_configuration.field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.google_drive_configuration.field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.google_drive_configuration.inclusion_patterns[]
- configuration.google_drive_configuration.secret_arn
The Amazon Resource Name (ARN) of a Secrets Managersecret that contains the credentials required to connect to Google Drive. For more information, see Using a Google Workspace Drive data source.
- configuration.jira_configuration
Provides the configuration information to connect to Jira as your data source. Show child fields- configuration.jira_configuration.attachment_field_mappings[]
Show child fields- configuration.jira_configuration.attachment_field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.jira_configuration.attachment_field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.jira_configuration.attachment_field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.jira_configuration.comment_field_mappings[]
Show child fields- configuration.jira_configuration.comment_field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.jira_configuration.comment_field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.jira_configuration.comment_field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.jira_configuration.exclusion_patterns[]
- configuration.jira_configuration.inclusion_patterns[]
- configuration.jira_configuration.issue_field_mappings[]
Show child fields- configuration.jira_configuration.issue_field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.jira_configuration.issue_field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.jira_configuration.issue_field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.jira_configuration.issue_sub_entity_filter[]
- configuration.jira_configuration.issue_type[]
- configuration.jira_configuration.jira_account_url
The URL of the Jira account. For example, company.atlassian.net. - configuration.jira_configuration.project[]
- configuration.jira_configuration.project_field_mappings[]
Show child fields- configuration.jira_configuration.project_field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.jira_configuration.project_field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.jira_configuration.project_field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.jira_configuration.secret_arn
The Amazon Resource Name (ARN) of a secret in Secrets Manager contains the key-value pairs required to connect to your Jira data source. The secret must contain a JSON structure with the following keys: -
jiraId—The Jira user name or email. -
jiraCredentials—The Jira API token. For more information, see Using a Jira data source. - configuration.jira_configuration.status[]
- configuration.jira_configuration.use_change_log
TRUE to use the Jira change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Jira. - configuration.jira_configuration.vpc_configuration
Configuration information for an Amazon Virtual Private Cloud to connect to your Jira. For more information, see Configuring a VPC. Show child fields- configuration.jira_configuration.vpc_configuration.security_group_ids[]
- configuration.jira_configuration.vpc_configuration.subnet_ids[]
- configuration.jira_configuration.work_log_field_mappings[]
Show child fields- configuration.jira_configuration.work_log_field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.jira_configuration.work_log_field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.jira_configuration.work_log_field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.one_drive_configuration
Provides the configuration information to connect to Microsoft OneDrive as your data source. Show child fields- configuration.one_drive_configuration.disable_local_groups
TRUE to disable local groups information. - configuration.one_drive_configuration.exclusion_patterns[]
- configuration.one_drive_configuration.field_mappings[]
Show child fields- configuration.one_drive_configuration.field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.one_drive_configuration.field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.one_drive_configuration.field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.one_drive_configuration.inclusion_patterns[]
- configuration.one_drive_configuration.one_drive_users
A list of user accounts whose documents should be indexed. Show child fields- configuration.one_drive_configuration.one_drive_users.one_drive_user_list[]
- configuration.one_drive_configuration.one_drive_users.one_drive_user_s3_path
The S3 bucket location of a file containing a list of users whose documents should be indexed. Show child fields- configuration.one_drive_configuration.one_drive_users.one_drive_user_s3_path.bucket
The name of the S3 bucket that contains the file. - configuration.one_drive_configuration.one_drive_users.one_drive_user_s3_path.key
The name of the file.
- configuration.one_drive_configuration.secret_arn
The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the user name and password to connect to OneDrive. The user name should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application. - configuration.one_drive_configuration.tenant_domain
The Azure Active Directory domain of the organization.
- configuration.quip_configuration
Provides the configuration information to connect to Quip as your data source. Show child fields- configuration.quip_configuration.attachment_field_mappings[]
Show child fields- configuration.quip_configuration.attachment_field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.quip_configuration.attachment_field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.quip_configuration.attachment_field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.quip_configuration.crawl_attachments
TRUE to index attachments. - configuration.quip_configuration.crawl_chat_rooms
TRUE to index the contents of chat rooms. - configuration.quip_configuration.crawl_file_comments
TRUE to index file comments. - configuration.quip_configuration.domain
The Quip site domain. For example, https://quip-company.quipdomain.com/browse. The domain in this example is "quipdomain". - configuration.quip_configuration.exclusion_patterns[]
- configuration.quip_configuration.folder_ids[]
- configuration.quip_configuration.inclusion_patterns[]
- configuration.quip_configuration.message_field_mappings[]
Show child fields- configuration.quip_configuration.message_field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.quip_configuration.message_field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.quip_configuration.message_field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.quip_configuration.secret_arn
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs that are required to connect to your Quip. The secret must contain a JSON structure with the following keys: - configuration.quip_configuration.thread_field_mappings[]
Show child fields- configuration.quip_configuration.thread_field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.quip_configuration.thread_field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.quip_configuration.thread_field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.quip_configuration.vpc_configuration
Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip. For more information, see Configuring a VPC. Show child fields- configuration.quip_configuration.vpc_configuration.security_group_ids[]
- configuration.quip_configuration.vpc_configuration.subnet_ids[]
- configuration.s3_configuration
Provides the configuration information to connect to an Amazon S3 bucket as your data source. Amazon Kendra now supports an upgraded Amazon S3 connector. You must now use the TemplateConfiguration object instead of the S3DataSourceConfiguration 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. Show child fields- configuration.s3_configuration.access_control_list_configuration
Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see Access control for S3 data sources. Show child fields- configuration.s3_configuration.access_control_list_configuration.key_path
Path to the Amazon S3 bucket that contains the ACL files.
- configuration.s3_configuration.bucket_name
The name of the bucket that contains the documents. - configuration.s3_configuration.documents_metadata_configuration
Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document. Show child fields- configuration.s3_configuration.documents_metadata_configuration.s3_prefix
A prefix used to filter metadata configuration files in the Amazon Web Services S3 bucket. The S3 bucket might contain multiple metadata files. Use S3Prefix to include only the desired metadata files.
- configuration.s3_configuration.exclusion_patterns[]
- configuration.s3_configuration.inclusion_patterns[]
- configuration.s3_configuration.inclusion_prefixes[]
- configuration.salesforce_configuration
Provides the configuration information to connect to Salesforce as your data source. Show child fields- configuration.salesforce_configuration.chatter_feed_configuration
Configuration information for Salesforce chatter feeds. Show child fields- configuration.salesforce_configuration.chatter_feed_configuration.document_data_field_name
The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the Body column. - configuration.salesforce_configuration.chatter_feed_configuration.document_title_field_name
The name of the column in the Salesforce FeedItem table that contains the title of the document. This is typically the Title column. - configuration.salesforce_configuration.chatter_feed_configuration.field_mappings[]
Show child fields- configuration.salesforce_configuration.chatter_feed_configuration.field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.salesforce_configuration.chatter_feed_configuration.field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.salesforce_configuration.chatter_feed_configuration.field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.salesforce_configuration.chatter_feed_configuration.include_filter_types[]
- configuration.salesforce_configuration.crawl_attachments
Indicates whether Amazon Kendra should index attachments to Salesforce objects. - configuration.salesforce_configuration.exclude_attachment_file_patterns[]
- configuration.salesforce_configuration.include_attachment_file_patterns[]
- configuration.salesforce_configuration.knowledge_article_configuration
Configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both. Show child fields- configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[]
Show child fields- configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[].document_data_field_name
The name of the field in the custom knowledge article that contains the document data to index. - configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[].document_title_field_name
The name of the field in the custom knowledge article that contains the document title. - configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[].field_mappings[]
Show child fields- configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[].field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[].field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[].field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[].name
The name of the configuration.
- configuration.salesforce_configuration.knowledge_article_configuration.included_states[]
- configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration
Configuration information for standard Salesforce knowledge articles. Show child fields- configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.document_data_field_name
The name of the field that contains the document data to index. - configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.document_title_field_name
The name of the field that contains the document title. - configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.field_mappings[]
Show child fields- configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.salesforce_configuration.secret_arn
The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys: -
authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token. -
consumerKey - The application public key generated when you created your Salesforce application. -
consumerSecret - The application private key generated when you created your Salesforce application. -
password - The password associated with the user logging in to the Salesforce instance. -
securityToken - The token associated with the user logging in to the Salesforce instance. -
username - The user name of the user logging in to the Salesforce instance. - configuration.salesforce_configuration.server_url
The instance URL for the Salesforce site that you want to index. - configuration.salesforce_configuration.standard_object_attachment_configuration
Configuration information for processing attachments to Salesforce standard objects. Show child fields- configuration.salesforce_configuration.standard_object_attachment_configuration.document_title_field_name
The name of the field used for the document title. - configuration.salesforce_configuration.standard_object_attachment_configuration.field_mappings[]
Show child fields- configuration.salesforce_configuration.standard_object_attachment_configuration.field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.salesforce_configuration.standard_object_attachment_configuration.field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.salesforce_configuration.standard_object_attachment_configuration.field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.salesforce_configuration.standard_object_configurations[]
Show child fields- configuration.salesforce_configuration.standard_object_configurations[].document_data_field_name
The name of the field in the standard object table that contains the document contents. - configuration.salesforce_configuration.standard_object_configurations[].document_title_field_name
The name of the field in the standard object table that contains the document title. - configuration.salesforce_configuration.standard_object_configurations[].field_mappings[]
Show child fields- configuration.salesforce_configuration.standard_object_configurations[].field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.salesforce_configuration.standard_object_configurations[].field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.salesforce_configuration.standard_object_configurations[].field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.salesforce_configuration.standard_object_configurations[].name
The name of the standard object.
- configuration.service_now_configuration
Provides the configuration information to connect to ServiceNow as your data source. Show child fields- configuration.service_now_configuration.authentication_type
The type of authentication used to connect to the ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is authenticated using the user name and password provided in the Secrets Manager secret in the SecretArn field. If you choose OAUTH2, Amazon Kendra is authenticated using the credentials of client ID, client secret, user name and password. When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source. - configuration.service_now_configuration.host_url
The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com. - configuration.service_now_configuration.knowledge_article_configuration
Configuration information for crawling knowledge articles in the ServiceNow site. Show child fields- configuration.service_now_configuration.knowledge_article_configuration.crawl_attachments
TRUE to index attachments to knowledge articles. - configuration.service_now_configuration.knowledge_article_configuration.document_data_field_name
The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index. - configuration.service_now_configuration.knowledge_article_configuration.document_title_field_name
The name of the ServiceNow field that is mapped to the index document title field. - configuration.service_now_configuration.knowledge_article_configuration.exclude_attachment_file_patterns[]
- configuration.service_now_configuration.knowledge_article_configuration.field_mappings[]
Show child fields- configuration.service_now_configuration.knowledge_article_configuration.field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.service_now_configuration.knowledge_article_configuration.field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.service_now_configuration.knowledge_article_configuration.field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.service_now_configuration.knowledge_article_configuration.filter_query
A query that selects the knowledge articles to index. The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private. The query string must be one generated by the ServiceNow console. For more information, see Specifying documents to index with a query. - configuration.service_now_configuration.knowledge_article_configuration.include_attachment_file_patterns[]
- configuration.service_now_configuration.secret_arn
The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance. You can also provide OAuth authentication credentials of user name, password, client ID, and client secret. For more information, see Using a ServiceNow data source. - configuration.service_now_configuration.service_catalog_configuration
Configuration information for crawling service catalogs in the ServiceNow site. Show child fields- configuration.service_now_configuration.service_catalog_configuration.crawl_attachments
TRUE to index attachments to service catalog items. - configuration.service_now_configuration.service_catalog_configuration.document_data_field_name
The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index. - configuration.service_now_configuration.service_catalog_configuration.document_title_field_name
The name of the ServiceNow field that is mapped to the index document title field. - configuration.service_now_configuration.service_catalog_configuration.exclude_attachment_file_patterns[]
- configuration.service_now_configuration.service_catalog_configuration.field_mappings[]
Show child fields- configuration.service_now_configuration.service_catalog_configuration.field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.service_now_configuration.service_catalog_configuration.field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.service_now_configuration.service_catalog_configuration.field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.service_now_configuration.service_catalog_configuration.include_attachment_file_patterns[]
- configuration.service_now_configuration.service_now_build_version
The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS.
- configuration.share_point_configuration
Provides the configuration information to connect to Microsoft SharePoint as your data source. Show child fields- configuration.share_point_configuration.authentication_type
Whether you want to connect to SharePoint Online using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret, or AD App-only authentication of client secret. - configuration.share_point_configuration.crawl_attachments
TRUE to index document attachments. - configuration.share_point_configuration.disable_local_groups
TRUE to disable local groups information. - configuration.share_point_configuration.document_title_field_name
The Microsoft SharePoint attribute field that contains the title of the document. - configuration.share_point_configuration.exclusion_patterns[]
- configuration.share_point_configuration.field_mappings[]
Show child fields- configuration.share_point_configuration.field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.share_point_configuration.field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.share_point_configuration.field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.share_point_configuration.inclusion_patterns[]
- configuration.share_point_configuration.proxy_configuration
Configuration information to connect to your Microsoft SharePoint site URLs via instance via a web proxy. You can use this option for SharePoint Server. You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS. Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication of user name and password. To store web proxy credentials, you use a secret in Secrets Manager. It is recommended that you follow best security practices when configuring your web proxy. This includes setting up throttling, setting up logging and monitoring, and applying security patches on a regular basis. If you use your web proxy with multiple data sources, sync jobs that occur at the same time could strain the load on your proxy. It is recommended you prepare your proxy beforehand for any security and load requirements. Show child fields- configuration.share_point_configuration.proxy_configuration.credentials
Your secret ARN, which you can create in Secrets Manager The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials. - configuration.share_point_configuration.proxy_configuration.host
The name of the website host you want to connect to via a web proxy server. For example, the host name of https://a.example.com/page1.html is "a.example.com". - configuration.share_point_configuration.proxy_configuration.port
The port number of the website host you want to connect to via a web proxy server. For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.
- configuration.share_point_configuration.secret_arn
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance. For more information, see Microsoft SharePoint. - configuration.share_point_configuration.share_point_version
The version of Microsoft SharePoint that you use. - configuration.share_point_configuration.ssl_certificate_s3_path
The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to SharePoint Server if you require a secure SSL connection. You can generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate. Show child fields- configuration.share_point_configuration.ssl_certificate_s3_path.bucket
The name of the S3 bucket that contains the file. - configuration.share_point_configuration.ssl_certificate_s3_path.key
The name of the file.
- configuration.share_point_configuration.urls[]
- configuration.share_point_configuration.use_change_log
TRUE to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint. - configuration.share_point_configuration.vpc_configuration
Configuration information for an Amazon Virtual Private Cloud to connect to your Microsoft SharePoint. For more information, see Configuring a VPC. Show child fields- configuration.share_point_configuration.vpc_configuration.security_group_ids[]
- configuration.share_point_configuration.vpc_configuration.subnet_ids[]
- configuration.slack_configuration
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. Show child fields- configuration.slack_configuration.crawl_bot_message
TRUE to index bot messages from your Slack workspace team. - configuration.slack_configuration.exclude_archived
TRUE to exclude archived messages to index from your Slack workspace team. - configuration.slack_configuration.exclusion_patterns[]
- configuration.slack_configuration.field_mappings[]
Show child fields- configuration.slack_configuration.field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.slack_configuration.field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.slack_configuration.field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.slack_configuration.inclusion_patterns[]
- configuration.slack_configuration.look_back_period
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. - configuration.slack_configuration.private_channel_filter[]
- configuration.slack_configuration.public_channel_filter[]
- configuration.slack_configuration.secret_arn
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: - configuration.slack_configuration.since_crawl_date
The date to start crawling your data from your Slack workspace team. The date must follow this format: yyyy-mm-dd. - configuration.slack_configuration.slack_entity_list[]
- configuration.slack_configuration.team_id
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/.... - configuration.slack_configuration.use_change_log
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. - configuration.slack_configuration.vpc_configuration
Configuration information for an Amazon Virtual Private Cloud to connect to your Slack. For more information, see Configuring a VPC. Show child fields- configuration.slack_configuration.vpc_configuration.security_group_ids[]
- configuration.slack_configuration.vpc_configuration.subnet_ids[]
- configuration.template_configuration
Provides a template for the configuration information to connect to your data source. Show child fields- configuration.template_configuration.template
The template schema used for the data source, where templates schemas are supported. See Data source template schemas.
- configuration.web_crawler_configuration
Provides the configuration information required for Amazon Kendra Web Crawler. Show child fields- configuration.web_crawler_configuration.authentication_configuration
Configuration information required to connect to websites using authentication. You can connect to websites using basic authentication of user name and password. You use a secret in Secrets Manager to store your authentication credentials. You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS. Show child fields- configuration.web_crawler_configuration.authentication_configuration.basic_authentication[]
Show child fields- configuration.web_crawler_configuration.authentication_configuration.basic_authentication[].credentials
Your secret ARN, which you can create in Secrets Manager You use a secret if basic authentication credentials are required to connect to a website. The secret stores your credentials of user name and password. - configuration.web_crawler_configuration.authentication_configuration.basic_authentication[].host
The name of the website host you want to connect to using authentication credentials. For example, the host name of https://a.example.com/page1.html is "a.example.com". - configuration.web_crawler_configuration.authentication_configuration.basic_authentication[].port
The port number of the website host you want to connect to using authentication credentials. For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.
- configuration.web_crawler_configuration.crawl_depth
The 'depth' or number of levels from the seed level to crawl. For example, the seed URL page is depth 1 and any hyperlinks on this page that are also crawled are depth 2. - configuration.web_crawler_configuration.max_content_size_per_page_in_mega_bytes
The maximum size (in MB) of a web page or attachment to crawl. Files larger than this size (in MB) are skipped/not crawled. The default maximum size of a web page or attachment is set to 50 MB. - configuration.web_crawler_configuration.max_links_per_page
The maximum number of URLs on a web page to include when crawling a website. This number is per web page. As a website’s web pages are crawled, any URLs the web pages link to are also crawled. URLs on a web page are crawled in order of appearance. The default maximum links per page is 100. - configuration.web_crawler_configuration.max_urls_per_minute_crawl_rate
The maximum number of URLs crawled per website host per minute. A minimum of one URL is required. The default maximum number of URLs crawled per website host per minute is 300. - configuration.web_crawler_configuration.proxy_configuration
Configuration information required to connect to your internal websites via a web proxy. You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS. Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in Secrets Manager. Show child fields- configuration.web_crawler_configuration.proxy_configuration.credentials
Your secret ARN, which you can create in Secrets Manager The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials. - configuration.web_crawler_configuration.proxy_configuration.host
The name of the website host you want to connect to via a web proxy server. For example, the host name of https://a.example.com/page1.html is "a.example.com". - configuration.web_crawler_configuration.proxy_configuration.port
The port number of the website host you want to connect to via a web proxy server. For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.
- configuration.web_crawler_configuration.url_exclusion_patterns[]
- configuration.web_crawler_configuration.url_inclusion_patterns[]
- configuration.web_crawler_configuration.urls
Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl. You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs. You can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling. When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own web pages, or web pages that you have authorization to index. Show child fields- configuration.web_crawler_configuration.urls.seed_url_configuration
Configuration of the seed or starting point URLs of the websites you want to crawl. You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the web pages link to. You can list up to 100 seed URLs. Show child fields- configuration.web_crawler_configuration.urls.seed_url_configuration.seed_urls[]
- configuration.web_crawler_configuration.urls.seed_url_configuration.web_crawler_mode
You can choose one of the following modes: -
HOST_ONLY—crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled. -
SUBDOMAINS—crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled. -
EVERYTHING—crawl the website host names with subdomains and other domains that the web pages link to. The default mode is set to HOST_ONLY.
- configuration.web_crawler_configuration.urls.site_maps_configuration
Configuration of the sitemap URLs of the websites you want to crawl. Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs. Show child fields- configuration.web_crawler_configuration.urls.site_maps_configuration.site_maps[]
- configuration.work_docs_configuration
Provides the configuration information to connect to Amazon WorkDocs as your data source. Show child fields- configuration.work_docs_configuration.crawl_comments
TRUE to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on. The default is set to FALSE. - configuration.work_docs_configuration.exclusion_patterns[]
- configuration.work_docs_configuration.field_mappings[]
Show child fields- configuration.work_docs_configuration.field_mappings[].data_source_field_name
The name of the field in the data source. You must first create the index field using the UpdateIndex API. - configuration.work_docs_configuration.field_mappings[].date_field_format
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown. - configuration.work_docs_configuration.field_mappings[].index_field_name
The name of the index field to map to the data source field. The index field type must match the data source field type.
- configuration.work_docs_configuration.inclusion_patterns[]
- configuration.work_docs_configuration.organization_id
The identifier of the directory corresponding to your Amazon WorkDocs site repository. You can find the organization ID in the Directory Service by going to Active Directory, then Directories. Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console. - configuration.work_docs_configuration.use_change_log
TRUE to use the Amazon WorkDocs change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Amazon WorkDocs.
|