Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1483595482.8 KB

Get information about an Amazon Q Business data source connector synchronization.

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

Path parameters

dataSourceIdstring required

The identifier of the data source connector.

applicationIdstring required

The identifier of the Amazon Q Business application connected to the data source.

indexIdstring required

The identifier of the index used with the Amazon Q Business data source connector.

Query parameters

nextTokenstring

If the <code>maxResults</code> response was incpmplete because there is more data to retriever, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of responses.

maxResultsinteger

The maximum number of synchronization jobs to return in the response.

startTimestring date-time

The start time of the data source connector sync.

endTimestring date-time

The end time of the data source connector sync.

syncStatus'FAILED' | 'SUCCEEDED' | 'SYNCING' | 'INCOMPLETE' | 'STOPPING' | 'ABORTED' | 'SYNCING_INDEXING'

Only returns synchronization jobs with the <code>Status</code> field equal to the specified status.

Response

Success

nextTokenstring

If the response is truncated, Amazon Q Business returns this token. You can use this token in any subsequent request to retrieve the next set of jobs.