Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

StartDataSourceSyncJob

Starts a synchronization job for a data source. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception.

Request Syntax


{
   "Id": "string",
   "IndexId": "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 to synchronize.

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

Response Syntax


{
   "ExecutionId": "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.

ExecutionId

Identifies a particular synchronization job.

Type: String

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

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
ResourceInUseException: HTTP Status Code: 400
ResourceNotFoundException: HTTP Status Code: 400
ThrottlingException: HTTP Status Code: 400
ValidationException: HTTP Status Code: 400