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 CancelJobExecution operation. Cancels the execution of a job for a given thing.

Requires permission to access the CancelJobExecution action.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.IoT.AmazonIoTRequest
      Amazon.IoT.Model.CancelJobExecutionRequest

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

Syntax

C#
public class CancelJobExecutionRequest : AmazonIoTRequest
         IAmazonWebServiceRequest

The CancelJobExecutionRequest type exposes the following members

Constructors

NameDescription
Public Method CancelJobExecutionRequest()

Properties

NameTypeDescription
Public Property ExpectedVersion System.Int64

Gets and sets the property ExpectedVersion.

(Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

Public Property Force System.Boolean

Gets and sets the property Force.

(Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false.

Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.

Public Property JobId System.String

Gets and sets the property JobId.

The ID of the job to be canceled.

Public Property StatusDetails System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property StatusDetails.

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

Public Property ThingName System.String

Gets and sets the property ThingName.

The name of the thing whose execution of the job will be canceled.

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