IoTJobAbortCriteria
Contains criteria that define when and how to cancel a job.
The deployment stops if the following conditions are true:
-
The number of things that receive the deployment exceeds the
minNumberOfExecutedThings
. -
The percentage of failures with type
failureType
exceeds thethresholdPercentage
.
Contents
- action
-
The action to perform when the criteria are met.
Type: String
Valid Values:
CANCEL
Required: Yes
- failureType
-
The type of job deployment failure that can cancel a job.
Type: String
Valid Values:
FAILED | REJECTED | TIMED_OUT | ALL
Required: Yes
- minNumberOfExecutedThings
-
The minimum number of things that receive the configuration before the job can cancel.
Type: Integer
Valid Range: Minimum value of 1.
Required: Yes
- thresholdPercentage
-
The minimum percentage of
failureType
failures that occur before the job can cancel.This parameter supports up to two digits after the decimal (for example, you can specify
10.9
or10.99
, but not10.999
).Type: Double
Valid Range: Maximum value of 100.
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: