Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListDataSourceSyncJobs

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

Request Syntax


GET /applications/applicationId/indices/indexId/datasources/dataSourceId/syncjobs?endTime=endTime&maxResults=maxResults&nextToken=nextToken&startTime=startTime&syncStatus=statusFilter HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

applicationId

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

Length Constraints: Fixed length of 36.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$

Required: Yes

dataSourceId

The identifier of the data source connector.

Length Constraints: Fixed length of 36.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$

Required: Yes

endTime

The end time of the data source connector sync.

indexId

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

Length Constraints: Fixed length of 36.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$

Required: Yes

maxResults

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

Valid Range: Minimum value of 1. Maximum value of 10.

nextToken

If the maxResults 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.

Length Constraints: Minimum length of 1. Maximum length of 800.

startTime

The start time of the data source connector sync.

statusFilter

Only returns synchronization jobs with the Status field equal to the specified status.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "history": [ 
      { 
         "dataSourceErrorCode": "string",
         "endTime": number,
         "error": { 
            "errorCode": "string",
            "errorMessage": "string"
         },
         "executionId": "string",
         "metrics": { 
            "documentsAdded": "string",
            "documentsDeleted": "string",
            "documentsFailed": "string",
            "documentsModified": "string",
            "documentsScanned": "string"
         },
         "startTime": number,
         "status": "string"
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

history

A history of synchronization jobs for the data source connector.

Type: Array of DataSourceSyncJob objects

nextToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 800.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

HTTP Status Code: 403

InternalServerException

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

HTTP Status Code: 500

ResourceNotFoundException

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

HTTP Status Code: 404

ThrottlingException

The request was denied due to throttling. Reduce the number of requests and try again.

HTTP Status Code: 429

ValidationException

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

HTTP Status Code: 400