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.

The Job object contains details about a job.

Inheritance Hierarchy

System.Object
  Amazon.IoT.Model.Job

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

Syntax

C#
public class Job

The Job type exposes the following members

Constructors

NameDescription
Public Method Job()

Properties

NameTypeDescription
Public Property AbortConfig Amazon.IoT.Model.AbortConfig

Gets and sets the property AbortConfig.

Configuration for criteria to abort the job.

Public Property Comment System.String

Gets and sets the property Comment.

If the job was updated, describes the reason for the update.

Public Property CompletedAt System.DateTime

Gets and sets the property CompletedAt.

The time, in seconds since the epoch, when the job was completed.

Public Property CreatedAt System.DateTime

Gets and sets the property CreatedAt.

The time, in seconds since the epoch, when the job was created.

Public Property Description System.String

Gets and sets the property Description.

A short text description of the job.

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

Gets and sets the property DocumentParameters.

A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

Public Property ForceCanceled System.Boolean

Gets and sets the property ForceCanceled.

Will be true if the job was canceled with the optional force parameter set to true.

Public Property JobArn System.String

Gets and sets the property JobArn.

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

Public Property JobExecutionsRolloutConfig Amazon.IoT.Model.JobExecutionsRolloutConfig

Gets and sets the property JobExecutionsRolloutConfig.

Allows you to create a staged rollout of a job.

Public Property JobId System.String

Gets and sets the property JobId.

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

Public Property JobProcessDetails Amazon.IoT.Model.JobProcessDetails

Gets and sets the property JobProcessDetails.

Details about the job process.

Public Property JobTemplateArn System.String

Gets and sets the property JobTemplateArn.

The ARN of the job template used to create the job.

Public Property LastUpdatedAt System.DateTime

Gets and sets the property LastUpdatedAt.

The time, in seconds since the epoch, when the job was last updated.

Public Property NamespaceId System.String

Gets and sets the property NamespaceId.

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Public Property PresignedUrlConfig Amazon.IoT.Model.PresignedUrlConfig

Gets and sets the property PresignedUrlConfig.

Configuration for pre-signed S3 URLs.

Public Property ReasonCode System.String

Gets and sets the property ReasonCode.

If the job was updated, provides the reason code for the update.

Public Property Status Amazon.IoT.JobStatus

Gets and sets the property Status.

The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

Public Property Targets System.Collections.Generic.List<System.String>

Gets and sets the property Targets.

A list of IoT things and thing groups to which the job should be sent.

Public Property TargetSelection Amazon.IoT.TargetSelection

Gets and sets the property TargetSelection.

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.

Public Property TimeoutConfig Amazon.IoT.Model.TimeoutConfig

Gets and sets the property TimeoutConfig.

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

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