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

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

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 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 collapse

Instance Attribute Details

#expected_versionInteger

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


1439
1440
1441
1442
1443
1444
1445
1446
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1439

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

#forceBoolean

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


1439
1440
1441
1442
1443
1444
1445
1446
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1439

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

#job_idString

The ID of the job to be canceled.

Returns:

  • (String)


1439
1440
1441
1442
1443
1444
1445
1446
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1439

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

#status_detailsHash<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>)


1439
1440
1441
1442
1443
1444
1445
1446
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1439

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

#thing_nameString

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

Returns:

  • (String)


1439
1440
1441
1442
1443
1444
1445
1446
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1439

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