You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoT::Types::DeleteJobExecutionRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DeleteJobExecutionRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  job_id: "JobId", # required
  thing_name: "ThingName", # required
  execution_number: 1, # required
  force: false,
  namespace_id: "NamespaceId",
}

Instance Attribute Summary collapse

Instance Attribute Details

#execution_number ⇒ Integer

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.

Returns:

  • (Integer) —

    The ID of the job execution to be deleted.

#force ⇒ Boolean

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

Returns:

  • (Boolean) —

    (Optional) When true, you can delete a job execution which is \"IN_PROGRESS\".

#job_id ⇒ String

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

Returns:

  • (String) —

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

#namespace_id ⇒ String

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS 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 in public preview.

Returns:

  • (String) —

    The namespace used to indicate that a job is a customer-managed job.

#thing_name ⇒ String

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

Returns:

  • (String) —

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