CancelJobRequest

public struct CancelJobRequest : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • An optional comment string describing why the job was canceled.

    Declaration

    Swift

    public let comment: String?

  • (Optional) If true job executions with status “IN_PROGRESS” and “QUEUED” are canceled, otherwise only job executions with status “QUEUED” are canceled. The default is false. Canceling a job which is “IN_PROGRESS”, will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

    Declaration

    Swift

    public let force: Bool?

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

    Declaration

    Swift

    public let jobId: String

  • (Optional)A reason code string that explains why the job was canceled.

    Declaration

    Swift

    public let reasonCode: String?

  • Undocumented

    Declaration

    Swift

    public init(comment: String? = nil, force: Bool? = nil, jobId: String, reasonCode: String? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws