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.

Container for the parameters to the CancelJob operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Batch.AmazonBatchRequest
      Amazon.Batch.Model.CancelJobRequest

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

Syntax

C#
public class CancelJobRequest : AmazonBatchRequest
         IAmazonWebServiceRequest

The CancelJobRequest type exposes the following members

Constructors

NameDescription
Public Method CancelJobRequest()

Properties

NameTypeDescription
Public Property JobId System.String

Gets and sets the property JobId.

A list of up to 100 job IDs to cancel.

Public Property Reason System.String

Gets and sets the property Reason.

A message to attach to the job that explains the reason for cancelling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.

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 Standard:
Supported in: 1.3

.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