AWSIoTDeleteJobExecutionRequest

Objective-C

@interface AWSIoTDeleteJobExecutionRequest

Swift

class AWSIoTDeleteJobExecutionRequest

  • The ID of the job execution to be deleted. The executionNumber refers to the execution of a particular job on a particular device.

    Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be sure you get and use the correct value here.

    Declaration

    Objective-C

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

    Swift

    var executionNumber: NSNumber? { get set }

  • (Optional) When true, you can delete a job execution which is “IN_PROGRESS”. Otherwise, you can only delete a job execution which is in a terminal state (“SUCCEEDED”, “FAILED”, “REJECTED”, “REMOVED” or “CANCELED”) or an exception will occur. The default is false.

    Deleting a job execution which is “IN_PROGRESS”, will cause the device to be unable to access job information or update the job execution status. Use caution and ensure that the device is able to recover to a valid state.

    Declaration

    Objective-C

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

    Swift

    var force: NSNumber? { get set }

  • The ID of the job whose execution on a particular device will be deleted.

    Declaration

    Objective-C

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

    Swift

    var jobId: String? { 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 }

  • The name of the thing whose job execution will be deleted.

    Declaration

    Objective-C

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

    Swift

    var thingName: String? { get set }