Container for the parameters to the TerminateJob operation.
Terminates a job 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
Amazon.Runtime.AmazonWebServiceRequest
Amazon.Batch.AmazonBatchRequest
Amazon.Batch.Model.TerminateJobRequest
Namespace: Amazon.Batch.Model
Assembly: AWSSDK.Batch.dll
Version: 3.x.y.z
Syntax
public class TerminateJobRequest : AmazonBatchRequest IAmazonWebServiceRequest
The TerminateJobRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
TerminateJobRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
JobId | System.String |
Gets and sets the property JobId. The Batch job ID of the job to terminate. |
|
|
Reason | System.String |
Gets and sets the property Reason. A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the Batch activity logs. |
Examples
This example terminates a job with the specified job ID.
To terminate a job
var client = new AmazonBatchClient();
var response = client.TerminateJob(new TerminateJobRequest
{
JobId = "61e743ed-35e4-48da-b2de-5c8333821c84",
Reason = "Terminating job."
});
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5