Class: Aws::IoT::Types::AbortCriteria

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

Overview

Note:

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

{
  failure_type: "FAILED", # required, accepts FAILED, REJECTED, TIMED_OUT, ALL
  action: "CANCEL", # required, accepts CANCEL
  threshold_percentage: 1.0, # required
  min_number_of_executed_things: 1, # required
}

Details of abort criteria to define rules to abort the job.

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ String

The type of abort action to initiate a job abort.



69
70
71
72
73
74
75
 
# File 'lib/aws-sdk-iot/types.rb', line 69

class AbortCriteria < Struct.new(
  :failure_type,
  :action,
  :threshold_percentage,
  :min_number_of_executed_things)
  include Aws::Structure
end

#failure_type ⇒ String

The type of job execution failure to define a rule to initiate a job abort.



69
70
71
72
73
74
75
 
# File 'lib/aws-sdk-iot/types.rb', line 69

class AbortCriteria < Struct.new(
  :failure_type,
  :action,
  :threshold_percentage,
  :min_number_of_executed_things)
  include Aws::Structure
end

#min_number_of_executed_things ⇒ Integer

Minimum number of executed things before evaluating an abort rule.



69
70
71
72
73
74
75
 
# File 'lib/aws-sdk-iot/types.rb', line 69

class AbortCriteria < Struct.new(
  :failure_type,
  :action,
  :threshold_percentage,
  :min_number_of_executed_things)
  include Aws::Structure
end

#threshold_percentage ⇒ Float

The threshold as a percentage of the total number of executed things that will initiate a job abort.

AWS IoT supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).



69
70
71
72
73
74
75
 
# File 'lib/aws-sdk-iot/types.rb', line 69

class AbortCriteria < Struct.new(
  :failure_type,
  :action,
  :threshold_percentage,
  :min_number_of_executed_things)
  include Aws::Structure
end