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

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

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

#actionString

The type of abort action to initiate a job abort.

Returns:

  • (String)


69
70
71
72
73
74
75
# File 'gems/aws-sdk-iot/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_typeString

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

Returns:

  • (String)


69
70
71
72
73
74
75
# File 'gems/aws-sdk-iot/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_thingsInteger

Minimum number of executed things before evaluating an abort rule.

Returns:

  • (Integer)


69
70
71
72
73
74
75
# File 'gems/aws-sdk-iot/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_percentageFloat

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

Returns:

  • (Float)


69
70
71
72
73
74
75
# File 'gems/aws-sdk-iot/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