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 UpdateJobExecution operation. Updates the status of a job execution.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.IoTJobsDataPlane.AmazonIoTJobsDataPlaneRequest
      Amazon.IoTJobsDataPlane.Model.UpdateJobExecutionRequest

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

Syntax

C#
public class UpdateJobExecutionRequest : AmazonIoTJobsDataPlaneRequest
         IAmazonWebServiceRequest

The UpdateJobExecutionRequest type exposes the following members

Constructors

NameDescription
Public Method UpdateJobExecutionRequest()

Properties

NameTypeDescription
Public Property ExecutionNumber System.Int64

Gets and sets the property ExecutionNumber.

Optional. A number that identifies a particular job execution on a particular device.

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 IncludeJobDocument System.Boolean

Gets and sets the property IncludeJobDocument.

Optional. When set to true, the response contains the job document. The default is false.

Public Property IncludeJobExecutionState System.Boolean

Gets and sets the property IncludeJobExecutionState.

Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

Public Property JobId System.String

Gets and sets the property JobId.

The unique identifier assigned to this job when it was created.

Public Property Status Amazon.IoTJobsDataPlane.JobExecutionStatus

Gets and sets the property Status.

The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

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

Gets and sets the property StatusDetails.

Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

Public Property ThingName System.String

Gets and sets the property ThingName.

The name of the thing associated with the device.

Version Information

.NET Standard:
Supported in: 1.3

.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