CreateJobRequest

public struct CreateJobRequest : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • Allows you to create criteria to abort a job.

    Declaration

    Swift

    public let abortConfig: AbortConfig?

  • A short text description of the job.

    Declaration

    Swift

    public let description: String?

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

    Declaration

    Swift

    public let document: String?

  • An S3 link to the job document.

    Declaration

    Swift

    public let documentSource: String?

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

    Declaration

    Swift

    public let jobExecutionsRolloutConfig: JobExecutionsRolloutConfig?

  • A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric characters, “-” and “_” are valid for use here.

    Declaration

    Swift

    public let jobId: String

  • Configuration information for pre-signed S3 URLs.

    Declaration

    Swift

    public let presignedUrlConfig: PresignedUrlConfig?

  • Metadata which can be used to manage the job.

    Declaration

    Swift

    public let tags: [Tag]?

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

    Declaration

    Swift

    public let timeoutConfig: TimeoutConfig?

  • Undocumented

    Declaration

    Swift

    public init(abortConfig: AbortConfig? = nil, description: String? = nil, document: String? = nil, documentSource: String? = nil, jobExecutionsRolloutConfig: JobExecutionsRolloutConfig? = nil, jobId: String, presignedUrlConfig: PresignedUrlConfig? = nil, tags: [Tag]? = nil, targets: [String], targetSelection: TargetSelection? = nil, timeoutConfig: TimeoutConfig? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws