CreateDataSourceRequest

import type { CreateDataSourceRequest } from "https://aws-api.deno.dev/v0.4/services/kendra.ts?docs=full";

interface CreateDataSourceRequest {

ClientToken?: string | null;

Configuration?: DataSourceConfiguration | null;

CustomDocumentEnrichmentConfiguration?: CustomDocumentEnrichmentConfiguration | null;

Description?: string | null;

IndexId: string;

LanguageCode?: string | null;

Name: string;

RoleArn?: string | null;

Schedule?: string | null;

Tags?: Tag[] | null;

Type: DataSourceType;

VpcConfiguration?: DataSourceVpcConfiguration | null;

}

§Properties

ClientToken?: string | null

[src]

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

Configuration?: DataSourceConfiguration | null

[src]

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.

CustomDocumentEnrichmentConfiguration?: CustomDocumentEnrichmentConfiguration | null

[src]

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.

Description?: string | null

[src]

A description for the data source connector.

IndexId: string

[src]

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

LanguageCode?: string | null

[src]

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.

Name: string

[src]

A name for the data source connector.

RoleArn?: string | null

[src]

The Amazon Resource Name (ARN) of a role with permission to access the data source and required resources. For more information, see IAM 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.

Schedule?: string | null

[src]

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 StartDataSourceSyncJob API to update the index.

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

Tags?: Tag[] | null

[src]

A list of key-value pairs that identify the data source connector. You can use the tags to identify and organize your resources and to control access to resources.

Type: DataSourceType

[src]

The type of data source repository. For example, SHAREPOINT.

VpcConfiguration?: DataSourceVpcConfiguration | null

[src]

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