mc batch cancel

The mc batch cancel command stops an in-progress batch job.

You can only cancel jobs that are currently running. Attempting to cancel a completed, failed, or non-existent job returns an error.

You must specify the job ID. To find the job ID, use mc batch list.

Syntax

Example Syntax

The command has the following syntax:

mc [GLOBALFLAGS] batch cancel ALIAS JOBID

Brackets [] indicate optional parameters.
Parameters sharing a line are mutually dependent.
Parameters separated using the pipe | operator are mutually exclusive.

Copy the example to a text editor and modify as-needed before running the command in the terminal/shell.

Parameters

ALIAS

Required

The alias for the AIStor deployment on which the job is currently running.

JOBID

Required

The unique identifier of the batch job to cancel. To find the ID of a job, use mc batch list.

Global flags

This command supports any of the global flags.

Example

Cancel an in-progress batch job

The following command cancels the job with ID KwSysDpxcBU9FNhGkn2dCf on the deployment at alias myaistor:

mc batch cancel myaistor KwSysDpxcBU9FNhGkn2dCf

Error handling

If you attempt to cancel a job that has already completed, failed, or does not exist, the command returns an error:

mc: <ERROR> Unable to cancel batch job: The specified batch job is not currently running.

Use mc batch status to check the current state of a job before attempting to cancel it.

S3 compatibility

The mc command-line tool is built for compatibility with the AWS S3 API and is tested with AIStor and AWS S3 for expected functionality and behavior.

MinIO provides no guarantees for other S3-compatible services, as their S3 API implementation is unknown and therefore unsupported.

While mc commands may work as documented, any such usage is at your own risk.