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
}

The criteria that determine when and how a job abort takes place.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

The type of job action to take to initiate the job abort.

Returns:

  • (String)


72
73
74
75
76
77
78
79
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 72

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

#failure_typeString

The type of job execution failures that can initiate a job abort.

Returns:

  • (String)


72
73
74
75
76
77
78
79
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 72

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

#min_number_of_executed_thingsInteger

The minimum number of things which must receive job execution notifications before the job can be aborted.

Returns:

  • (Integer)


72
73
74
75
76
77
78
79
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 72

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

#threshold_percentageFloat

The minimum percentage of job execution failures that must occur to initiate the 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)


72
73
74
75
76
77
78
79
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 72

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