Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1483595482.8 KB

Gets information about an existing Amazon Q Business data source connector.

get/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}

Path parameters

applicationIdstring required

The identifier of the Amazon Q Business application.

indexIdstring required

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

dataSourceIdstring required

The identifier of the data source connector.

Response

Success

applicationIdstring

The identifier of the Amazon Q Business application.

indexIdstring

The identifier of the index linked to the data source connector.

dataSourceIdstring

The identifier of the data source connector.

dataSourceArnstring

The Amazon Resource Name (ARN) of the data source.

displayNamestring

The name for the data source connector.

typestring

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

configurationobject

The details of how the data source connector is configured.

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'PENDING_CREATION' | 'CREATING' | 'ACTIVE' | 'DELETING' | 'FAILED' | 'UPDATING'

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

syncSchedulestring

The schedule for Amazon Q Business to update the index.

roleArnstring

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