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.

Deletes a job and its related job executions.

Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as "DELETION_IN_PROGRESS". Attempting to delete or cancel a job whose status is already "DELETION_IN_PROGRESS" will result in an error.

Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or a LimitExceededException will occur.

Requires permission to access the DeleteJob action.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDeleteJob and EndDeleteJob.

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

Syntax

C#
public virtual Task<DeleteJobResponse> DeleteJobAsync(
         DeleteJobRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.IoT.Model.DeleteJobRequest

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

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the DeleteJob service method, as returned by IoT.

Exceptions

ExceptionCondition
InvalidRequestException The request is not valid.
InvalidStateTransitionException An attempt was made to change to an invalid state, for example by deleting a job or a job execution which is "IN_PROGRESS" without setting the force parameter.
LimitExceededException A limit has been exceeded.
ResourceNotFoundException The specified resource does not exist.
ServiceUnavailableException The service is temporarily unavailable.
ThrottlingException The rate exceeds the limit.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also