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 TerminateJob operation. Terminates jobs in a job queue. Jobs that are in the STARTING or RUNNING state are terminated, which causes them to transition to FAILED. Jobs that have not progressed to the STARTING state are cancelled.

Inheritance Hierarchy

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

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

Syntax

C#
public class TerminateJobRequest : AmazonBatchRequest
         IAmazonWebServiceRequest

The TerminateJobRequest type exposes the following members

Constructors

NameDescription
Public Method TerminateJobRequest()

Properties

NameTypeDescription
Public Property JobId System.String

Gets and sets the property JobId.

Job IDs to be terminated. Up to 100 jobs can be specified.

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 terminates a job with the specified job ID.

To terminate a job


var response = client.TerminateJob(new TerminateJobRequest 
{
    JobId = "61e743ed-35e4-48da-b2de-5c8333821c84",
    Reason = "Terminating 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