batch_terminate_job: Terminates a job in a job queue

Description Usage Arguments Value Request syntax Examples

View source: R/batch_operations.R

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

1
batch_terminate_job(jobId, reason)

Arguments

jobId

[required] The AWS 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. This message is also recorded in the AWS Batch activity logs.

Value

An empty list.

Request syntax

1
2
3
4
svc$terminate_job(
  jobId = "string",
  reason = "string"
)

Examples

1
2
3
4
5
6
7
8
## 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)

paws.compute documentation built on March 7, 2021, 5:10 p.m.