AWSIoTJob

Objective-C

@interface AWSIoTJob

Swift

class AWSIoTJob

The Job object contains details about a job.

  • Configuration for criteria to abort the job.

    Declaration

    Objective-C

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

    Swift

    var abortConfig: AWSIoTAbortConfig? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) 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 (nonatomic, strong) 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 (nonatomic, strong) NSDate *_Nullable createdAt;

    Swift

    var createdAt: Date? { get set }

  • A short text description of the job.

    Declaration

    Objective-C

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

    Swift

    var detail: String? { get set }

  • The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

    Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

    Declaration

    Objective-C

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

    Swift

    var destinationPackageVersions: [String]? { get set }

  • 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.

    documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can’t be used with custom job templates or to create jobs from them.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable documentParameters;

    Swift

    var documentParameters: [String : String]? { get set }

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

    Declaration

    Objective-C

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

    Swift

    var forceCanceled: NSNumber? { get set }

  • Indicates whether a job is concurrent. Will be true when a job is rolling out new job executions or canceling previously created executions, otherwise false.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable isConcurrent;

    Swift

    var isConcurrent: NSNumber? { get set }

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

    Declaration

    Objective-C

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

    Swift

    var jobArn: String? { get set }

  • The configuration for the criteria to retry the job.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSIoTJobExecutionsRetryConfig *_Nullable jobExecutionsRetryConfig;

    Swift

    var jobExecutionsRetryConfig: AWSIoTJobExecutionsRetryConfig? { get set }

  • Allows you to create a staged rollout of a job.

    Declaration

    Objective-C

    @property (nonatomic, strong) 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 (nonatomic, strong) NSString *_Nullable jobId;

    Swift

    var jobId: String? { get set }

  • Details about the job process.

    Declaration

    Objective-C

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

    Swift

    var jobProcessDetails: AWSIoTJobProcessDetails? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable jobTemplateArn;

    Swift

    var jobTemplateArn: String? { get set }

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

    Declaration

    Objective-C

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

    Swift

    var lastUpdatedAt: Date? { get set }

  • 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 only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable namespaceId;

    Swift

    var namespaceId: String? { get set }

  • Configuration for pre-signed S3 URLs.

    Declaration

    Objective-C

    @property (nonatomic, strong) 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 (nonatomic, strong) NSString *_Nullable reasonCode;

    Swift

    var reasonCode: String? { get set }

  • Displays the next seven maintenance window occurrences and their start times.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSIoTScheduledJobRollout *> *_Nullable scheduledJobRollouts;

    Swift

    var scheduledJobRollouts: [AWSIoTScheduledJobRollout]? { get set }

  • The configuration that allows you to schedule a job for a future date and time in addition to specifying the end behavior for each job execution.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSIoTSchedulingConfig *_Nullable schedulingConfig;

    Swift

    var schedulingConfig: AWSIoTSchedulingConfig? { get set }

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

    Declaration

    Objective-C

    @property (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.

    We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.

    Declaration

    Objective-C

    @property (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 (nonatomic, strong) 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 (nonatomic, strong) AWSIoTTimeoutConfig *_Nullable timeoutConfig;

    Swift

    var timeoutConfig: AWSIoTTimeoutConfig? { get set }