Terminate Job

batch_terminate_job

R Documentation

Terminates a job in a job queue

Description

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.

Usage

batch_terminate_job(jobId, reason)

Arguments

jobId	[required] The Batch job ID of the job to terminate.
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. It is also recorded in the Batch activity logs. This parameter has as limit of 1024 characters.

Value

An empty list.

Request syntax

svc$terminate_job(
  jobId = "string",
  reason = "string"
)

Examples

## Not run: 
# This example terminates a job with the specified job ID.
svc$terminate_job(
  jobId = "61e743ed-35e4-48da-b2de-5c8333821c84",
  reason = "Terminating job."
)

## End(Not run)