v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1424200374.6 KB

Terminates a job in a job queue. Jobs that are in the <code>STARTING</code> or <code>RUNNING</code> state are terminated, which causes them to transition to <code>FAILED</code>. Jobs that have not progressed to the <code>STARTING</code> state are cancelled.

post/v1/terminatejob

Request body

jobIdstring required

The Batch job ID of the job to terminate.

reasonstring required

A message to attach to the job that explains the reason for canceling it. This message is returned by future <a>DescribeJobs</a> operations on the job. This message is also recorded in the Batch activity logs.

Response

Success

TerminateJobResponse required

Example response

{}