IAmazonBatch.TerminateJob Method (TerminateJobRequest)

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to TerminateJobAsync.

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

Syntax

public abstract TerminateJobResponse TerminateJob(
         TerminateJobRequest request
)

Parameters

request: Type: Amazon.Batch.Model.TerminateJobRequest

Container for the necessary parameters to execute the TerminateJob service method.

Return Value

Type: TerminateJobResponse

The response from the TerminateJob service method, as returned by Batch.

Exceptions

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.

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 Framework:
Supported in: 4.5, 4.0, 3.5

IAmazonBatch.TerminateJob (TerminateJobRequest)

Method