DescribeDataSourceResponse

import type { DescribeDataSourceResponse } from "https://aws-api.deno.dev/v0.3/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;

}

§Properties

Configuration?: DataSourceConfiguration | null

[src]

Information that describes where the data source is located and how the data source is configured. The specific information in the description depends on the data source provider.

CreatedAt?: Date | number | null

[src]

The Unix timestamp of when the data source 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 of the data source.

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.

IndexId?: string | null

[src]

The identifier of the index that contains the data source.

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 that you gave the data source when it was created.

RoleArn?: string | null

[src]

The Amazon Resource Name (ARN) of the role that enables the data source to access its resources.

Schedule?: string | null

[src]

The schedule that Amazon Kendra will update the data source.

Status?: DataSourceStatus | null

[src]

The current status of the data source. 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.

UpdatedAt?: Date | number | null

[src]

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