DescribeDataSourceResponse

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

interface DescribeDataSourceResponse {

Configuration?: DataSourceConfiguration | null;

CreatedAt?: Date | number | null;

CustomDocumentEnrichmentConfiguration?: CustomDocumentEnrichmentConfiguration | null;

Description?: string | null;

ErrorMessage?: string | null;

Id?: string | null;

IndexId?: string | null;

LanguageCode?: string | null;

Name?: string | null;

RoleArn?: string | null;

Schedule?: string | null;

Status?: DataSourceStatus | null;

Type?: DataSourceType | null;

UpdatedAt?: Date | number | null;

VpcConfiguration?: DataSourceVpcConfiguration | null;

}

§Properties

Configuration?: DataSourceConfiguration | null

[src]

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.

CreatedAt?: Date | number | null

[src]

The Unix timestamp of when the data source connector was created.

CustomDocumentEnrichmentConfiguration?: CustomDocumentEnrichmentConfiguration | null

[src]

Configuration information for altering document metadata and content during the document ingestion process when you describe a data source.

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]

The description for the data source connector.

ErrorMessage?: string | null

[src]

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source to fail.

Id?: string | null

[src]

The identifier of the data source connector.

IndexId?: string | null

[src]

The identifier of the index used with the data source connector.

LanguageCode?: string | null

[src]

The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

Name?: string | null

[src]

The name for the data source connector.

RoleArn?: string | null

[src]

The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.

Schedule?: string | null

[src]

The schedule for Amazon Kendra to update the index.

Status?: DataSourceStatus | null

[src]

The current status of the data source connector. When the status is ACTIVE the data source is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that the data source failed.

Type?: DataSourceType | null

[src]

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

UpdatedAt?: Date | number | null

[src]

The Unix timestamp of when the data source connector was last updated.

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.