Class: Aws::IoT::Types::CancelJobExecutionRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::CancelJobExecutionRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Overview

Note:

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

{
  job_id: "JobId", # required
  thing_name: "ThingName", # required
  force: false,
  expected_version: 1,
  status_details: {
    "DetailsKey" => "DetailsValue",
  },
}

Instance Attribute Summary

• #expected_version ⇒ Integer

  (Optional) The expected current version of the job execution.

• #force ⇒ Boolean

  (Optional) If ‘true` the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED.

• #job_id ⇒ String

  The ID of the job to be canceled.

• #status_details ⇒ Hash<String,String>

  A collection of name/value pairs that describe the status of the job execution.

• #thing_name ⇒ String

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

Instance Attribute Details

#expected_version ⇒ Integer

(Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

Returns:

• (Integer)

# File 'lib/aws-sdk-iot/types.rb', line 1230

class CancelJobExecutionRequest < Struct.new(
  :job_id,
  :thing_name,
  :force,
  :expected_version,
  :status_details)
  include Aws::Structure
end

#force ⇒ Boolean

(Optional) If ‘true` the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set `force` to `true`, then an `InvalidStateTransitionException` will be thrown. The default is `false`.

Canceling a job execution which is “IN_PROGRESS”, will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.

Returns:

• (Boolean)

# File 'lib/aws-sdk-iot/types.rb', line 1230

class CancelJobExecutionRequest < Struct.new(
  :job_id,
  :thing_name,
  :force,
  :expected_version,
  :status_details)
  include Aws::Structure
end

#job_id ⇒ String

The ID of the job to be canceled.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 1230

class CancelJobExecutionRequest < Struct.new(
  :job_id,
  :thing_name,
  :force,
  :expected_version,
  :status_details)
  include Aws::Structure
end

#status_details ⇒ Hash<String,String>

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-iot/types.rb', line 1230

class CancelJobExecutionRequest < Struct.new(
  :job_id,
  :thing_name,
  :force,
  :expected_version,
  :status_details)
  include Aws::Structure
end

#thing_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 1230

class CancelJobExecutionRequest < Struct.new(
  :job_id,
  :thing_name,
  :force,
  :expected_version,
  :status_details)
  include Aws::Structure
end