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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iot/types.rb

Overview

Note:

When making an API call, you may pass DeleteJobExecutionRequest data as a hash:

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

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) 


3247
3248
3249
3250
3251
3252
3253
 
# File 'lib/aws-sdk-iot/types.rb', line 3247

class DeleteJobExecutionRequest < Struct.new(
  :job_id,
  :thing_name,
  :execution_number,
  :force)
  include Aws::Structure
end

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

<note markdown=“1”> 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.

</note>

Returns:

  • (Boolean) 


3247
3248
3249
3250
3251
3252
3253
 
# File 'lib/aws-sdk-iot/types.rb', line 3247

class DeleteJobExecutionRequest < Struct.new(
  :job_id,
  :thing_name,
  :execution_number,
  :force)
  include Aws::Structure
end

#job_id ⇒ String

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

Returns:

  • (String) 


3247
3248
3249
3250
3251
3252
3253
 
# File 'lib/aws-sdk-iot/types.rb', line 3247

class DeleteJobExecutionRequest < Struct.new(
  :job_id,
  :thing_name,
  :execution_number,
  :force)
  include Aws::Structure
end

#thing_name ⇒ String

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

Returns:

  • (String) 


3247
3248
3249
3250
3251
3252
3253
 
# File 'lib/aws-sdk-iot/types.rb', line 3247

class DeleteJobExecutionRequest < Struct.new(
  :job_id,
  :thing_name,
  :execution_number,
  :force)
  include Aws::Structure
end