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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#comment ⇒ String

An optional comment string describing why the job was canceled.

Returns:

  • (String) 


1790
1791
1792
1793
1794
1795
1796
1797
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1790

class CancelJobRequest < Struct.new(
  :job_id,
  :reason_code,
  :comment,
  :force)
  SENSITIVE = []
  include Aws::Structure
end

#force ⇒ Boolean

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


1790
1791
1792
1793
1794
1795
1796
1797
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1790

class CancelJobRequest < Struct.new(
  :job_id,
  :reason_code,
  :comment,
  :force)
  SENSITIVE = []
  include Aws::Structure
end

#job_id ⇒ String

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

Returns:

  • (String) 


1790
1791
1792
1793
1794
1795
1796
1797
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1790

class CancelJobRequest < Struct.new(
  :job_id,
  :reason_code,
  :comment,
  :force)
  SENSITIVE = []
  include Aws::Structure
end

#reason_code ⇒ String

(Optional)A reason code string that explains why the job was canceled.

Returns:

  • (String) 


1790
1791
1792
1793
1794
1795
1796
1797
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1790

class CancelJobRequest < Struct.new(
  :job_id,
  :reason_code,
  :comment,
  :force)
  SENSITIVE = []
  include Aws::Structure
end