AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Cancels a job in an Batch job queue. Jobs that are in the
A
When you try to cancel an array parent job in SUBMITTED or PENDING
are canceled. A job inRUNNABLE remains in RUNNABLE until it reaches
the head of the job queue. Then the job status is updated to FAILED.
PENDING job is canceled after all dependency jobs are completed. Therefore,
it may take longer than expected to cancel a job in PENDING status.
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.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginCancelJob and EndCancelJob.
Namespace: Amazon.Batch
Assembly: AWSSDK.Batch.dll
Version: 3.x.y.z
public virtual Task<CancelJobResponse> CancelJobAsync( CancelJobRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the CancelJob service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| 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. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5