TerminateJob
Terminates a job in a job queue. Jobs that are in the STARTING
or
RUNNING
state are terminated, which causes them to transition to
FAILED
. Jobs that have not progressed to the STARTING
state are
cancelled.
Request Syntax
POST /v1/terminatejob 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 Amazon Batch job ID of the job to terminate.
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 Amazon 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 Amazon Signature Version 4
signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the
Amazon
General Reference.
You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the Amazon Command Line Interface (Amazon CLI)
Example
This example terminates a job with the specified job ID.
Sample Request
POST /v1/terminatejob HTTP/1.1
Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: [content-length]
Authorization: [authorization-params]
X-Amz-Date: 20161129T202905Z
User-Agent: aws-cli/1.11.22 Python/2.7.12 Darwin/16.1.0 botocore/1.4.79
{
"reason": "Terminating job.",
"jobId": "61e743ed-35e4-48da-b2de-5c8333821c84"
}
Sample Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2
Connection: keep-alive
Date: Tue, 29 Nov 2016 20:29:06 GMT
x-amzn-RequestId: [request-id]
X-Amzn-Trace-Id: [trace-id]
X-Cache: Miss from cloudfront
Via: 1.1 16d2657cebef5191828b055567b4efeb.cloudfront.net (CloudFront)
X-Amz-Cf-Id: 681NTs_bPulMwja2HekWMwngcUzx2a8w_oaG27W0L4Pjct7W1T-Fvw==
{}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: