AWSIoTCancelJobRequest

Objective-C

@interface AWSIoTCancelJobRequest

Swift

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

    Declaration

    Objective-C

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

    Swift

    var comment: String? { get set }
  • (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

    Objective-C

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

    Swift

    var force: NSNumber? { 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 }
  • (Optional)A reason code string that explains why the job was canceled.

    Declaration

    Objective-C

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

    Swift

    var reasonCode: String? { get set }