Amazonka.IoT.Types.AbortCriteria

Documentation

data AbortCriteria

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

See: newAbortCriteria smart constructor.

Constructors

AbortCriteria'

Fields

• failureType :: JobExecutionFailureType

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

• action :: AbortAction

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

• thresholdPercentage :: Double

  The minimum percentage of job execution failures that must occur to initiate the job abort.

  Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

• minNumberOfExecutedThings :: Natural

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

Instances

FromJSON AbortCriteria

Defined in Amazonka.IoT.Types.AbortCriteria

Methods

parseJSON :: Value -> Parser AbortCriteria

parseJSONList :: Value -> Parser [AbortCriteria]

ToJSON AbortCriteria

Defined in Amazonka.IoT.Types.AbortCriteria

Methods

toJSON :: AbortCriteria -> Value

toEncoding :: AbortCriteria -> Encoding

toJSONList :: [AbortCriteria] -> Value

toEncodingList :: [AbortCriteria] -> Encoding

Generic AbortCriteria

Defined in Amazonka.IoT.Types.AbortCriteria

Associated Types

type Rep AbortCriteria :: Type -> Type

Methods

from :: AbortCriteria -> Rep AbortCriteria x

to :: Rep AbortCriteria x -> AbortCriteria

Read AbortCriteria

Defined in Amazonka.IoT.Types.AbortCriteria

Methods

readsPrec :: Int -> ReadS AbortCriteria

readList :: ReadS [AbortCriteria]

readPrec :: ReadPrec AbortCriteria

readListPrec :: ReadPrec [AbortCriteria]

Show AbortCriteria

Defined in Amazonka.IoT.Types.AbortCriteria

Methods

showsPrec :: Int -> AbortCriteria -> ShowS

show :: AbortCriteria -> String

showList :: [AbortCriteria] -> ShowS

NFData AbortCriteria

Defined in Amazonka.IoT.Types.AbortCriteria

Methods

rnf :: AbortCriteria -> ()

Eq AbortCriteria

Defined in Amazonka.IoT.Types.AbortCriteria

Methods

(==) :: AbortCriteria -> AbortCriteria -> Bool

(/=) :: AbortCriteria -> AbortCriteria -> Bool

Hashable AbortCriteria

Defined in Amazonka.IoT.Types.AbortCriteria

Methods

hashWithSalt :: Int -> AbortCriteria -> Int

hash :: AbortCriteria -> Int

type Rep AbortCriteria

Defined in Amazonka.IoT.Types.AbortCriteria

type Rep AbortCriteria = D1 ('MetaData "AbortCriteria" "Amazonka.IoT.Types.AbortCriteria" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "AbortCriteria'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "failureType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobExecutionFailureType) :*: S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AbortAction)) :*: (S1 ('MetaSel ('Just "thresholdPercentage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "minNumberOfExecutedThings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))))

newAbortCriteria

Arguments

:: JobExecutionFailureType

$sel:failureType:AbortCriteria'

-> AbortAction

$sel:action:AbortCriteria'

-> Double

$sel:thresholdPercentage:AbortCriteria'

-> Natural

$sel:minNumberOfExecutedThings:AbortCriteria'

-> AbortCriteria

Create a value of AbortCriteria with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:failureType:AbortCriteria', abortCriteria_failureType - The type of job execution failures that can initiate a job abort.

$sel:action:AbortCriteria', abortCriteria_action - The type of job action to take to initiate the job abort.

$sel:thresholdPercentage:AbortCriteria', abortCriteria_thresholdPercentage - The minimum percentage of job execution failures that must occur to initiate the job abort.

Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

$sel:minNumberOfExecutedThings:AbortCriteria', abortCriteria_minNumberOfExecutedThings - The minimum number of things which must receive job execution notifications before the job can be aborted.

abortCriteria_failureType :: Lens' AbortCriteria JobExecutionFailureType

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

abortCriteria_action :: Lens' AbortCriteria AbortAction

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

abortCriteria_thresholdPercentage :: Lens' AbortCriteria Double

The minimum percentage of job execution failures that must occur to initiate the job abort.

Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

abortCriteria_minNumberOfExecutedThings :: Lens' AbortCriteria Natural

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