Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1465566486.4 KB

Gets information about an Amazon Kendra data source connector.

post/#X-Amz-Target=AWSKendraFrontendService.DescribeDataSource

Headers

X-Amz-Target'AWSKendraFrontendService.DescribeDataSource' required

Request body

Idstring required

The identifier of the data source connector.

IndexIdstring required

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

Response

Success

Idstring

The identifier of the data source connector.

IndexIdstring

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

Namestring

The name for the data source connector.

Type'S3' | 'SHAREPOINT' | 'DATABASE' | 'SALESFORCE' | 'ONEDRIVE' | 'SERVICENOW' | 'CUSTOM' | 'CONFLUENCE' | 'GOOGLEDRIVE' | 'WEBCRAWLER' | 'WORKDOCS' | 'FSX' | 'SLACK' | 'BOX' | 'QUIP' | 'JIRA' | 'GITHUB' | 'ALFRESCO' | 'TEMPLATE'

The type of the data source. For example, <code>SHAREPOINT</code>.

CreatedAtstring date-time

The Unix timestamp when the data source connector was created.

UpdatedAtstring date-time

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

Descriptionstring

The description for the data source connector.

Status'CREATING' | 'DELETING' | 'FAILED' | 'UPDATING' | 'ACTIVE'

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

Schedulestring

The schedule for Amazon Kendra to update the index.

RoleArnstring

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

ErrorMessagestring

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

LanguageCodestring

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 <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html">Adding documents in languages other than English</a>.