AWSIoTJob

@interface AWSIoTJob

The Job object contains details about a job.

  • Configuration for criteria to abort the job.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic)
        AWSIoTAbortConfig *_Nullable abortConfig;

    Swift

    var abortConfig: AWSIoTAbortConfig? { get set }
  • If the job was updated, describes the reason for the update.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable comment;

    Swift

    var comment: String? { get set }
  • The time, in seconds since the epoch, when the job was completed.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSDate *_Nullable completedAt;

    Swift

    var completedAt: Date? { get set }
  • The time, in seconds since the epoch, when the job was created.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSDate *_Nullable createdAt;

    Swift

    var createdAt: Date? { get set }
  • A short text description of the job.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable detail;

    Swift

    var detail: String? { get set }
  • Will be true if the job was canceled with the optional force parameter set to true.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSNumber *_Nullable forceCanceled;

    Swift

    var forceCanceled: NSNumber? { get set }
  • An ARN identifying the job with format “arn:aws:iot:region:account:job/jobId”.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable jobArn;

    Swift

    var jobArn: String? { get set }
  • Allows you to create a staged rollout of a job.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic)
        AWSIoTJobExecutionsRolloutConfig *_Nullable jobExecutionsRolloutConfig;

    Swift

    var jobExecutionsRolloutConfig: AWSIoTJobExecutionsRolloutConfig? { get set }
  • The unique identifier you assigned to this job when it was created.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable jobId;

    Swift

    var jobId: String? { get set }
  • Details about the job process.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic)
        AWSIoTJobProcessDetails *_Nullable jobProcessDetails;

    Swift

    var jobProcessDetails: AWSIoTJobProcessDetails? { get set }
  • The time, in seconds since the epoch, when the job was last updated.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSDate *_Nullable lastUpdatedAt;

    Swift

    var lastUpdatedAt: Date? { get set }
  • Configuration for pre-signed S3 URLs.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic)
        AWSIoTPresignedUrlConfig *_Nullable presignedUrlConfig;

    Swift

    var presignedUrlConfig: AWSIoTPresignedUrlConfig? { get set }
  • If the job was updated, provides the reason code for the update.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable reasonCode;

    Swift

    var reasonCode: String? { get set }
  • The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) AWSIoTJobStatus status;

    Swift

    var status: AWSIoTJobStatus { get set }
  • 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.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) AWSIoTTargetSelection targetSelection;

    Swift

    var targetSelection: AWSIoTTargetSelection { get set }
  • A list of IoT things and thing groups to which the job should be sent.

    Declaration

    Objective-C

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

    Swift

    var targets: [String]? { get set }
  • 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.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic)
        AWSIoTTimeoutConfig *_Nullable timeoutConfig;

    Swift

    var timeoutConfig: AWSIoTTimeoutConfig? { get set }