Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListDataSourceSyncJobs

Gets statistics about synchronizing Amazon Kendra with a data source.

Request Syntax


{
   "Id": "string",
   "IndexId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "StartTimeFilter": { 
      "EndTime": number,
      "StartTime": number
   },
   "StatusFilter": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Id

The identifier of the data source.

Type: String

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

Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*

Required: Yes

IndexId

The identifier of the index that contains the data source.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]*

Required: Yes

MaxResults

The maximum number of synchronization jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

Type: Integer

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

Required: No

NextToken

If the result of the previous request to GetDataSourceSyncJobHistory was truncated, include the NextToken to fetch the next set of jobs.

Type: String

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

Required: No

StartTimeFilter

When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.

Type: TimeRange object

Required: No

StatusFilter

When specified, only returns synchronization jobs with the Status field equal to the specified status.

Type: String

Required: No

Response Syntax


{
   "History": [ 
      { 
         "DataSourceErrorCode": "string",
         "EndTime": number,
         "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.

Type: Array of DataSourceSyncJob objects

NextToken

The GetDataSourceSyncJobHistory operation returns a page of vocabularies at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Kendra returns the NextPage token. Include the token in the next request to the GetDataSourceSyncJobHistory operation to return in the next page 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: HTTP Status Code: 400
ConflictException: HTTP Status Code: 400
InternalServerException: HTTP Status Code: 500
ResourceNotFoundException: HTTP Status Code: 400
ThrottlingException: HTTP Status Code: 400
ValidationException: HTTP Status Code: 400