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 CreateJob operation. Creates a job.

Requires permission to access the CreateJob action.

Inheritance Hierarchy

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

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

Syntax

C#
public class CreateJobRequest : AmazonIoTRequest
         IAmazonWebServiceRequest

The CreateJobRequest type exposes the following members

Constructors

NameDescription
Public Method CreateJobRequest()

Properties

NameTypeDescription
Public Property AbortConfig Amazon.IoT.Model.AbortConfig

Gets and sets the property AbortConfig.

Allows you to create criteria to abort a job.

Public Property Description System.String

Gets and sets the property Description.

A short text description of the job.

Public Property Document System.String

Gets and sets the property Document.

The job document. Required if you don't specify a value for documentSource.

Public Property DocumentSource System.String

Gets and sets the property DocumentSource.

An S3 link to the job document. Required if you don't specify a value for document.

If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

The placeholder link is of the following form:

${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}

where bucket is your bucket name and key is the object in the bucket to which you are linking.

Public Property JobExecutionsRolloutConfig Amazon.IoT.Model.JobExecutionsRolloutConfig

Gets and sets the property JobExecutionsRolloutConfig.

Allows you to create a staged rollout of the job.

Public Property JobId System.String

Gets and sets the property JobId.

A job identifier which must be unique for your Amazon Web Services account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.

Public Property JobTemplateArn System.String

Gets and sets the property JobTemplateArn.

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

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 information for pre-signed S3 URLs.

Public Property Tags System.Collections.Generic.List<Amazon.IoT.Model.Tag>

Gets and sets the property Tags.

Metadata which can be used to manage the job.

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

Gets and sets the property Targets.

A list of 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 thing when the thing 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. The 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 time 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