CancelIngestionJob
Cancels an in-progress ingestion job. Documents that were already indexed before the cancellation remain in the index.
Request Syntax
{
"clientToken": "string",
"collectionId": "string",
"ingestionJobId": "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.
- clientToken
-
Unique, case-sensitive identifier to ensure idempotency of the request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Required: No
- collectionId
-
The unique identifier of the collection that the ingestion job belongs to.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 40.
Pattern:
[a-z0-9]{3,40}Required: Yes
- ingestionJobId
-
The unique identifier of the ingestion job to cancel.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 64.
Pattern:
[a-z0-9]+Required: Yes
Response Syntax
{
"collectionId": "string",
"ingestionJobId": "string",
"ingestionJobName": "string",
"status": "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.
- collectionId
-
The unique identifier of the collection that the ingestion job belongs to.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 40.
Pattern:
[a-z0-9]{3,40} - ingestionJobId
-
The unique identifier of the cancelled ingestion job.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 64.
Pattern:
[a-z0-9]+ - ingestionJobName
-
The name of the cancelled ingestion job.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 32.
Pattern:
[a-z][a-z0-9-]* - status
-
The current status of the ingestion job.
Type: String
Valid Values:
CREATING | ACTIVE | COMPLETED | CANCELLING | CANCELLED | FAILED | CREATE_FAILED | CANCEL_FAILED
Errors
For information about the errors that are common to all actions, see Common Error Types.
- ConflictException
-
When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE, FAILED, or UPDATE_FAILED state.
HTTP Status Code: 400
- InternalServerException
-
Thrown when an error internal to the service occurs while processing a request.
HTTP Status Code: 500
- ResourceNotFoundException
-
Thrown when accessing or deleting a resource that does not exist.
HTTP Status Code: 400
- ValidationException
-
Thrown when the HTTP request contains invalid input or is missing required input.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
