You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::IoT::Types::AwsJobAbortCriteria
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoT::Types::AwsJobAbortCriteria
- Defined in:
- (unknown)
Overview
When passing AwsJobAbortCriteria as input to an Aws::Client method, you can use a vanilla 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.
Instance Attribute Summary collapse
-
#action ⇒ String
The type of job action to take to initiate the job abort.
-
#failure_type ⇒ String
The type of job execution failures that can initiate a job abort.
-
#min_number_of_executed_things ⇒ Integer
The minimum number of things which must receive job execution notifications before the job can be aborted.
-
#threshold_percentage ⇒ Float
The minimum percentage of job execution failures that must occur to initiate the job abort.
Instance Attribute Details
#action ⇒ String
The type of job action to take to initiate the job abort.
Possible values:
- CANCEL
#failure_type ⇒ String
The type of job execution failures that can initiate a job abort.
Possible values:
- FAILED
- REJECTED
- TIMED_OUT
- ALL
#min_number_of_executed_things ⇒ Integer
The minimum number of things which must receive job execution notifications before the job can be aborted.
#threshold_percentage ⇒ Float
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).