---
title: "GET /applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/syncjobs"
method: GET
path: "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/syncjobs"
---

# GET /applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/syncjobs

`GET /applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/syncjobs`

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

## Path parameters

- `dataSourceId` string, required
- `applicationId` string, required
- `indexId` string, required

## Query parameters

- `nextToken` string
- `maxResults` integer
- `startTime` string, date-time
- `endTime` string, date-time
- `syncStatus` 'FAILED' | 'SUCCEEDED' | 'SYNCING' | 'INCOMPLETE' | 'STOPPING' | 'ABORTED' | 'SYNCING_INDEXING'

## Response `200`

Success

- ListDataSourceSyncJobsResponse
  - `history` DataSourceSyncJob[] — A history of synchronization jobs for the data source connector.
    - `executionId` string — The identifier of a data source synchronization job.
    - `startTime` string, date-time — The Unix time stamp when the data source synchronization job started.
    - `endTime` string, date-time — The Unix timestamp when the synchronization job completed.
    - `status` 'FAILED' | 'SUCCEEDED' | 'SYNCING' | 'INCOMPLETE' | 'STOPPING' | 'ABORTED' | 'SYNCING_INDEXING' — The status of the synchronization job. When the <code>Status</code> field is set to <code>SUCCEEDED</code>, the synchronization job is done. If the status code is <code>FAILED</code>, the <code>ErrorCode</code> and <code>ErrorMessage</code> fields give you the reason for the failure.
    - `error` object — If the <code>Status</code> field is set to <code>FAILED</code>, the <code>ErrorCode</code> field indicates the reason the synchronization failed.
      - `errorMessage` string — The message explaining the Amazon Q Business request error.
      - `errorCode` 'InternalError' | 'InvalidRequest' | 'ResourceInactive' | 'ResourceNotFound' — The code associated with the Amazon Q Business request error.
    - `dataSourceErrorCode` string — If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.
    - `metrics` object — Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.
      - `documentsAdded` string — The current count of documents added from the data source during the data source sync.
      - `documentsModified` string — The current count of documents modified in the data source during the data source sync.
      - `documentsDeleted` string — The current count of documents deleted from the data source during the data source sync.
      - `documentsFailed` string — The current count of documents that failed to sync from the data source during the data source sync.
      - `documentsScanned` string — The current count of documents crawled by the ongoing sync job in the data source.
  - `nextToken` string — 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.

## Other responses

- `480` — InternalServerException
- `481` — ResourceNotFoundException
- `482` — ConflictException
- `483` — ThrottlingException
- `484` — ValidationException
- `485` — AccessDeniedException

---

[API](https://skmtc.net/aws/apis/qbusiness.md) · [All operations](https://skmtc.net/aws/apis/qbusiness/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/qbusiness/revisions/82966d6c4053/schema)