amazonka-iot-2.0: Amazon IoT SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IoT.Types.AbortCriteria

Description

 
Synopsis

Documentation

data AbortCriteria Source #

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

Instances details
FromJSON AbortCriteria Source # 
Instance details

Defined in Amazonka.IoT.Types.AbortCriteria

ToJSON AbortCriteria Source # 
Instance details

Defined in Amazonka.IoT.Types.AbortCriteria

Generic AbortCriteria Source # 
Instance details

Defined in Amazonka.IoT.Types.AbortCriteria

Associated Types

type Rep AbortCriteria :: Type -> Type #

Read AbortCriteria Source # 
Instance details

Defined in Amazonka.IoT.Types.AbortCriteria

Show AbortCriteria Source # 
Instance details

Defined in Amazonka.IoT.Types.AbortCriteria

NFData AbortCriteria Source # 
Instance details

Defined in Amazonka.IoT.Types.AbortCriteria

Methods

rnf :: AbortCriteria -> () #

Eq AbortCriteria Source # 
Instance details

Defined in Amazonka.IoT.Types.AbortCriteria

Hashable AbortCriteria Source # 
Instance details

Defined in Amazonka.IoT.Types.AbortCriteria

type Rep AbortCriteria Source # 
Instance details

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 Source #

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 Source #

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

abortCriteria_action :: Lens' AbortCriteria AbortAction Source #

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

abortCriteria_thresholdPercentage :: Lens' AbortCriteria Double Source #

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 Source #

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