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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/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,
  namespace_id: "NamespaceId",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#execution_numberInteger

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)


5863
5864
5865
5866
5867
5868
5869
5870
5871
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5863

class DeleteJobExecutionRequest < Struct.new(
  :job_id,
  :thing_name,
  :execution_number,
  :force,
  :namespace_id)
  SENSITIVE = []
  include Aws::Structure
end

#forceBoolean

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


5863
5864
5865
5866
5867
5868
5869
5870
5871
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5863

class DeleteJobExecutionRequest < Struct.new(
  :job_id,
  :thing_name,
  :execution_number,
  :force,
  :namespace_id)
  SENSITIVE = []
  include Aws::Structure
end

#job_idString

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

Returns:

  • (String)


5863
5864
5865
5866
5867
5868
5869
5870
5871
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5863

class DeleteJobExecutionRequest < Struct.new(
  :job_id,
  :thing_name,
  :execution_number,
  :force,
  :namespace_id)
  SENSITIVE = []
  include Aws::Structure
end

#namespace_idString

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 in public preview.

Returns:

  • (String)


5863
5864
5865
5866
5867
5868
5869
5870
5871
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5863

class DeleteJobExecutionRequest < Struct.new(
  :job_id,
  :thing_name,
  :execution_number,
  :force,
  :namespace_id)
  SENSITIVE = []
  include Aws::Structure
end

#thing_nameString

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

Returns:

  • (String)


5863
5864
5865
5866
5867
5868
5869
5870
5871
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5863

class DeleteJobExecutionRequest < Struct.new(
  :job_id,
  :thing_name,
  :execution_number,
  :force,
  :namespace_id)
  SENSITIVE = []
  include Aws::Structure
end