AmazonBatchClient.CancelJob Method (CancelJobRequest)

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 TerminateJob operation.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to CancelJobAsync.

Namespace: Amazon.Batch
Assembly: AWSSDK.Batch.dll
Version: 3.x.y.z

Syntax

public virtual CancelJobResponse CancelJob(
         CancelJobRequest request
)

Parameters

request: Type: Amazon.Batch.Model.CancelJobRequest

Container for the necessary parameters to execute the CancelJob service method.

Return Value

Type: CancelJobResponse

The response from the CancelJob service method, as returned by Batch.

Exceptions

Exception	Condition
ClientException	These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.
ServerException	These errors are usually caused by a server issue.

Examples

This example cancels a job with the specified job ID.

To cancel a job


var client = new AmazonBatchClient();
var response = client.CancelJob(new CancelJobRequest 
{
    JobId = "1d828f65-7a4d-42e8-996d-3b900ed59dc4",
    Reason = "Cancelling job."
});

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

AmazonBatchClient.CancelJob (CancelJobRequest)

Method