Job

public struct Job : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • Configuration for criteria to abort the job.

    Declaration

    Swift

    public let abortConfig: AbortConfig?

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

    Declaration

    Swift

    public let comment: String?

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

    Declaration

    Swift

    public let completedAt: TimeStamp?

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

    Declaration

    Swift

    public let createdAt: TimeStamp?

  • A short text description of the job.

    Declaration

    Swift

    public let description: String?

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

    Declaration

    Swift

    public let forceCanceled: Bool?

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

    Declaration

    Swift

    public let jobArn: String?

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

    Declaration

    Swift

    public let jobExecutionsRolloutConfig: JobExecutionsRolloutConfig?

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

    Declaration

    Swift

    public let jobId: String?

  • Details about the job process.

    Declaration

    Swift

    public let jobProcessDetails: JobProcessDetails?

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

    Declaration

    Swift

    public let lastUpdatedAt: TimeStamp?

  • Configuration for pre-signed S3 URLs.

    Declaration

    Swift

    public let presignedUrlConfig: PresignedUrlConfig?

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

    Declaration

    Swift

    public let reasonCode: String?

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

    Declaration

    Swift

    public let status: JobStatus?

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

    Declaration

    Swift

    public let targets: [String]?

  • 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

    Swift

    public let targetSelection: TargetSelection?

  • 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

    Swift

    public let timeoutConfig: TimeoutConfig?

  • Undocumented

    Declaration

    Swift

    public init(abortConfig: AbortConfig? = nil, comment: String? = nil, completedAt: TimeStamp? = nil, createdAt: TimeStamp? = nil, description: String? = nil, forceCanceled: Bool? = nil, jobArn: String? = nil, jobExecutionsRolloutConfig: JobExecutionsRolloutConfig? = nil, jobId: String? = nil, jobProcessDetails: JobProcessDetails? = nil, lastUpdatedAt: TimeStamp? = nil, presignedUrlConfig: PresignedUrlConfig? = nil, reasonCode: String? = nil, status: JobStatus? = nil, targets: [String]? = nil, targetSelection: TargetSelection? = nil, timeoutConfig: TimeoutConfig? = nil)