Skip to contents

Creates a data source connector that you want to use with an Amazon Kendra index

Source: R/kendra_operations.R
kendra_create_data_source.Rd

Creates a data source connector that you want to use with an Amazon Kendra index.

See https://www.paws-r-sdk.com/docs/kendra_create_data_source/ for full documentation.

Usage

kendra_create_data_source(
  Name,
  IndexId,
  Type,
  Configuration = NULL,
  VpcConfiguration = NULL,
  Description = NULL,
  Schedule = NULL,
  RoleArn = NULL,
  Tags = NULL,
  ClientToken = NULL,
  LanguageCode = NULL,
  CustomDocumentEnrichmentConfiguration = NULL
)

Arguments

Name

[required] A name for the data source connector.

IndexId

[required] The identifier of the index you want to use with the data source connector.

Type

[required] The type of data source repository. For example, SHAREPOINT.

Configuration

Configuration information to connect to your data source repository.

You can't specify the Configuration parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The Configuration parameter is required for all other data sources.

VpcConfiguration

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

Description

A description for the data source connector.

Schedule

Sets the frequency for Amazon Kendra to check the documents in your data source repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the start_data_source_sync_job API to update the index.

Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand.

You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

RoleArn

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. For more information, see IAM access roles for Amazon Kendra..

You can't specify the RoleArn parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The RoleArn parameter is required for all other data sources.

Tags

A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

ClientToken

A token that you provide to identify the request to create a data source connector. Multiple calls to the create_data_source API with the same client token will create only one data source connector.

LanguageCode

The code for a language. This allows you to support a language for all documents when creating the data source connector. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

CustomDocumentEnrichmentConfiguration

Configuration information for altering document metadata and content during the document ingestion process.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.