CancelJob
Cancels a job in an AWS Batch job queue. Jobs that are in a SUBMITTED, PENDING, or RUNNABLE state are cancelled and the job status is updated to FAILED.
Note
A PENDING job is canceled after all dependency jobs are completed.
Therefore, it may take longer than expected to cancel a job in PENDING
status.
When you try to cancel an array parent job in PENDING, AWS Batch attempts to
cancel all child jobs. The array parent job is canceled when all child jobs are
completed.
Jobs that progressed to the STARTING or
RUNNING state aren't canceled. However, the API operation still succeeds, even
if no job is canceled. These jobs must be terminated with the TerminateJob
operation.
Request Syntax
POST /v1/canceljob HTTP/1.1
Content-type: application/json
{
"jobId": "string",
"reason": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- jobId
-
The AWS Batch job ID of the job to cancel.
Type: String
Required: Yes
- reason
-
A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. It is also recorded in the AWS Batch activity logs.
This parameter has as limit of 1024 characters.
Type: String
Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
- ClientException
-
These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.
HTTP Status Code: 400
- ServerException
-
These errors are usually caused by a server issue.
HTTP Status Code: 500
Examples
In the following example or examples, the Authorization header contents
(
[authorization-params]
) must be replaced with an AWS Signature Version 4
signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the
AWS
General Reference.
You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI)
Example
This example cancels a job with the specified job ID.
Sample Request
POST /v1/canceljob HTTP/1.1
Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: [content-length]
Authorization: [authorization-params]
X-Amz-Date: 20161130T001258Z
User-Agent: aws-cli/1.11.22 Python/2.7.12 Darwin/16.1.0 botocore/1.4.79
{
"reason": "Cancelling job.",
"jobId": "1d828f65-7a4d-42e8-996d-3b900ed59dc4"
}Sample Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2
Connection: keep-alive
Date: Wed, 30 Nov 2016 00:12:59 GMT
x-amzn-RequestId: [request-id]
X-Amzn-Trace-Id: [trace-id]
X-Cache: Miss from cloudfront
Via: 1.1 bfdd5909914586f5bc4851846228c27f.cloudfront.net (CloudFront)
X-Amz-Cf-Id: whn1dX1uTx34Lvao7-7ZdkDXEbCZ_sjn3v3hHVFgbo1ORJtXyeggSw==
{}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
