Module Values_1.DeleteJobExecutionRequestSource

Deletes a job execution. Requires permission to access the DeleteJobExecution action.

Sourcetype nonrec t = {
  1. jobId : Values_0.JobId.t;
    (*

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

    *)
  2. thingName : Values_0.ThingName.t;
    (*

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

    *)
  3. executionNumber : Values_0.ExecutionNumber.t;
    (*

    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.

    *)
  4. force : Values_0.ForceFlag.t option;
    (*

    (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.

    *)
  5. namespaceId : Values_0.NamespaceId.t option;
    (*

    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.

    *)
}
Sourceval context_ : string
Sourceval make : ?force:??? -> ?namespaceId:??? -> jobId:Values_0.JobId.t -> thingName:Values_0.ThingName.t -> executionNumber:Values_0.ExecutionNumber.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of Values_0.ForceFlag.t | `Long of Values_0.ExecutionNumber.t | `String of Values_0.JobId.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t