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

Class: Aws::IoT::Types::DeleteJobRequest

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

Overview

Note:

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

{
  job_id: "JobId", # required
  force: false,
  namespace_id: "NamespaceId",
}

Instance Attribute Summary collapse

Instance Attribute Details

#force ⇒ Boolean

(Optional) When true, you can delete a job which is \"IN_PROGRESS\". Otherwise, you can only delete a job which is in a terminal state (\"COMPLETED\" or \"CANCELED\") or an exception will occur. The default is false.

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

Returns:

  • (Boolean) —

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

#job_id ⇒ String

The ID of the job to be deleted.

After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.

Returns:

  • (String) —

    The ID of the job to 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.