Class: Aws::IoT::Types::DeleteJobExecutionRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoT::Types::DeleteJobExecutionRequest
- Defined in:
- gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#execution_number ⇒ 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".
-
#job_id ⇒ 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.
-
#thing_name ⇒ String
The name of the thing whose job execution will be deleted.
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.
4525 4526 4527 4528 4529 4530 4531 4532 4533 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4525 class DeleteJobExecutionRequest < Struct.new( :job_id, :thing_name, :execution_number, :force, :namespace_id) SENSITIVE = [] 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.
4525 4526 4527 4528 4529 4530 4531 4532 4533 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4525 class DeleteJobExecutionRequest < Struct.new( :job_id, :thing_name, :execution_number, :force, :namespace_id) SENSITIVE = [] include Aws::Structure end |
#job_id ⇒ String
The ID of the job whose execution on a particular device will be deleted.
4525 4526 4527 4528 4529 4530 4531 4532 4533 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4525 class DeleteJobExecutionRequest < Struct.new( :job_id, :thing_name, :execution_number, :force, :namespace_id) SENSITIVE = [] include Aws::Structure end |
#namespace_id ⇒ String
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/
namespaceId
feature is only supported by IoT Greengrass at
this time. For more information, see Setting up IoT Greengrass core
devices.
4525 4526 4527 4528 4529 4530 4531 4532 4533 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4525 class DeleteJobExecutionRequest < Struct.new( :job_id, :thing_name, :execution_number, :force, :namespace_id) SENSITIVE = [] include Aws::Structure end |
#thing_name ⇒ String
The name of the thing whose job execution will be deleted.
4525 4526 4527 4528 4529 4530 4531 4532 4533 |
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4525 class DeleteJobExecutionRequest < Struct.new( :job_id, :thing_name, :execution_number, :force, :namespace_id) SENSITIVE = [] include Aws::Structure end |