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.

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.

Note:

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

C#
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
The response from the TerminateJob 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 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 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