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

Class: Aws::IoT::Types::CancelJobRequest

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 CancelJobRequest data as a hash:

{
  job_id: "JobId", # required
  comment: "Comment",
  force: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#commentString

An optional comment string describing why the job was canceled.

Returns:

  • (String)


724
725
726
727
728
729
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 724

class CancelJobRequest < Struct.new(
  :job_id,
  :comment,
  :force)
  include Aws::Structure
end

#forceBoolean

(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

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

Returns:

  • (Boolean)


724
725
726
727
728
729
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 724

class CancelJobRequest < Struct.new(
  :job_id,
  :comment,
  :force)
  include Aws::Structure
end

#job_idString

The unique identifier you assigned to this job when it was created.

Returns:

  • (String)


724
725
726
727
728
729
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 724

class CancelJobRequest < Struct.new(
  :job_id,
  :comment,
  :force)
  include Aws::Structure
end