class Aws::GreengrassV2::Types::IoTJobAbortCriteria

Contains criteria that define when and how to cancel a job.

The deployment stops if the following conditions are true:

  1. The number of things that receive the deployment exceeds the `minNumberOfExecutedThings`.

  2. The percentage of failures with type `failureType` exceeds the `thresholdPercentage`.

@note When making an API call, you may pass IoTJobAbortCriteria

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
    }

@!attribute [rw] failure_type

The type of job deployment failure that can cancel a job.
@return [String]

@!attribute [rw] action

The action to perform when the criteria are met.
@return [String]

@!attribute [rw] threshold_percentage

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` or `10.99`, but not `10.999`).
@return [Float]

@!attribute [rw] min_number_of_executed_things

The minimum number of things that receive the configuration before
the job can cancel.
@return [Integer]

@see docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/IoTJobAbortCriteria AWS API Documentation

Constants

SENSITIVE