AWSIoTJob Class Reference

Inherits from AWSModel : AWSMTLModel
Declared in AWSIoTModel.h
AWSIoTModel.m

Overview

The Job object contains details about a job.

  abortConfig

Configuration for criteria to abort the job.

@property (nonatomic, strong) AWSIoTAbortConfig *abortConfig

Declared In

AWSIoTModel.h

  comment

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

@property (nonatomic, strong) NSString *comment

Declared In

AWSIoTModel.h

  completedAt

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

@property (nonatomic, strong) NSDate *completedAt

Declared In

AWSIoTModel.h

  createdAt

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

@property (nonatomic, strong) NSDate *createdAt

Declared In

AWSIoTModel.h

  detail

A short text description of the job.

@property (nonatomic, strong) NSString *detail

Declared In

AWSIoTModel.h

  forceCanceled

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

@property (nonatomic, strong) NSNumber *forceCanceled

Declared In

AWSIoTModel.h

  jobArn

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

@property (nonatomic, strong) NSString *jobArn

Declared In

AWSIoTModel.h

  jobExecutionsRolloutConfig

Allows you to create a staged rollout of a job.

@property (nonatomic, strong) AWSIoTJobExecutionsRolloutConfig *jobExecutionsRolloutConfig

Declared In

AWSIoTModel.h

  jobId

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

@property (nonatomic, strong) NSString *jobId

Declared In

AWSIoTModel.h

  jobProcessDetails

Details about the job process.

@property (nonatomic, strong) AWSIoTJobProcessDetails *jobProcessDetails

Declared In

AWSIoTModel.h

  lastUpdatedAt

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

@property (nonatomic, strong) NSDate *lastUpdatedAt

Declared In

AWSIoTModel.h

  presignedUrlConfig

Configuration for pre-signed S3 URLs.

@property (nonatomic, strong) AWSIoTPresignedUrlConfig *presignedUrlConfig

Declared In

AWSIoTModel.h

  reasonCode

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

@property (nonatomic, strong) NSString *reasonCode

Declared In

AWSIoTModel.h

  status

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

@property (nonatomic, assign) AWSIoTJobStatus status

Declared In

AWSIoTModel.h

  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.

@property (nonatomic, assign) AWSIoTTargetSelection targetSelection

Declared In

AWSIoTModel.h

  targets

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

@property (nonatomic, strong) NSArray<NSString*> *targets

Declared In

AWSIoTModel.h

  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.

@property (nonatomic, strong) AWSIoTTimeoutConfig *timeoutConfig

Declared In

AWSIoTModel.h