Cancel Job
batch_cancel_job | R Documentation |
Cancels a job in an Batch job queue¶
Description¶
Cancels a job in an Batch job queue. Jobs that are in a SUBMITTED
,
PENDING
, or RUNNABLE
state are cancelled and the job status is
updated to FAILED
.
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
, 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 terminate_job
operation.
Usage¶
Arguments¶
jobId
[required] The Batch job ID of the job to cancel.
reason
[required] A message to attach to the job that explains the reason for canceling it. This message is returned by future
describe_jobs
operations on the job. This message is also recorded in the Batch activity logs.
Value¶
An empty list.