AWS SDK Version 3 for .NET
API Reference

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 jobs in an AWS Batch job queue. Jobs that are in the SUBMITTED, PENDING, or RUNNABLE state are cancelled. Jobs that have progressed to STARTING or RUNNING are not cancelled (but the API operation still succeeds, even if no jobs are cancelled); these jobs must be terminated with the TerminateJob operation.

Note:

For PCL 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

C#
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
The response from the CancelJob service method, as returned by Batch.

Exceptions

ExceptionCondition
ClientException These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is 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 response = client.CancelJob(new CancelJobRequest 
{
    JobId = "1d828f65-7a4d-42e8-996d-3b900ed59dc4",
    Reason = "Cancelling job."
});


            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also