Skip to contents

Cancels a job in an Batch job queue

Source: R/batch_operations.R
batch_cancel_job.Rd

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.

See https://www.paws-r-sdk.com/docs/batch_cancel_job/ for full documentation.

Usage

batch_cancel_job(jobId, reason)

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. It is also recorded in the Batch activity logs.

This parameter has as limit of 1024 characters.