amazonka-greengrassv2-2.0: Amazon IoT Greengrass V2 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.GreengrassV2.Types.IoTJobAbortCriteria

Description

 
Synopsis

Documentation

data IoTJobAbortCriteria Source #

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.

See: newIoTJobAbortCriteria smart constructor.

Constructors

IoTJobAbortCriteria' 

Fields

Instances

Instances details
FromJSON IoTJobAbortCriteria Source # 
Instance details

Defined in Amazonka.GreengrassV2.Types.IoTJobAbortCriteria

Methods

parseJSON :: Value -> Parser IoTJobAbortCriteria #

parseJSONList :: Value -> Parser [IoTJobAbortCriteria] #

ToJSON IoTJobAbortCriteria Source # 
Instance details

Defined in Amazonka.GreengrassV2.Types.IoTJobAbortCriteria

Methods

toJSON :: IoTJobAbortCriteria -> Value #

toEncoding :: IoTJobAbortCriteria -> Encoding #

toJSONList :: [IoTJobAbortCriteria] -> Value #

toEncodingList :: [IoTJobAbortCriteria] -> Encoding #

Generic IoTJobAbortCriteria Source # 
Instance details

Defined in Amazonka.GreengrassV2.Types.IoTJobAbortCriteria

Associated Types

type Rep IoTJobAbortCriteria :: Type -> Type #

Methods

from :: IoTJobAbortCriteria -> Rep IoTJobAbortCriteria x #

to :: Rep IoTJobAbortCriteria x -> IoTJobAbortCriteria #

Read IoTJobAbortCriteria Source # 
Instance details

Defined in Amazonka.GreengrassV2.Types.IoTJobAbortCriteria

Methods

readsPrec :: Int -> ReadS IoTJobAbortCriteria #

readList :: ReadS [IoTJobAbortCriteria] #

readPrec :: ReadPrec IoTJobAbortCriteria #

readListPrec :: ReadPrec [IoTJobAbortCriteria] #

Show IoTJobAbortCriteria Source # 
Instance details

Defined in Amazonka.GreengrassV2.Types.IoTJobAbortCriteria

Methods

showsPrec :: Int -> IoTJobAbortCriteria -> ShowS #

show :: IoTJobAbortCriteria -> String #

showList :: [IoTJobAbortCriteria] -> ShowS #

NFData IoTJobAbortCriteria Source # 
Instance details

Defined in Amazonka.GreengrassV2.Types.IoTJobAbortCriteria

Methods

rnf :: IoTJobAbortCriteria -> () #

Eq IoTJobAbortCriteria Source # 
Instance details

Defined in Amazonka.GreengrassV2.Types.IoTJobAbortCriteria

Methods

(==) :: IoTJobAbortCriteria -> IoTJobAbortCriteria -> Bool #

(/=) :: IoTJobAbortCriteria -> IoTJobAbortCriteria -> Bool #

Hashable IoTJobAbortCriteria Source # 
Instance details

Defined in Amazonka.GreengrassV2.Types.IoTJobAbortCriteria

Methods

hashWithSalt :: Int -> IoTJobAbortCriteria -> Int #

hash :: IoTJobAbortCriteria -> Int #

type Rep IoTJobAbortCriteria Source # 
Instance details

Defined in Amazonka.GreengrassV2.Types.IoTJobAbortCriteria

type Rep IoTJobAbortCriteria = D1 ('MetaData "IoTJobAbortCriteria" "Amazonka.GreengrassV2.Types.IoTJobAbortCriteria" "amazonka-greengrassv2-2.0-CXiJQl197i43YI1Cz5IpiZ" 'False) (C1 ('MetaCons "IoTJobAbortCriteria'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "failureType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IoTJobExecutionFailureType) :*: S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IoTJobAbortAction)) :*: (S1 ('MetaSel ('Just "thresholdPercentage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "minNumberOfExecutedThings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))))

newIoTJobAbortCriteria Source #

Arguments

:: IoTJobExecutionFailureType

$sel:failureType:IoTJobAbortCriteria'

-> IoTJobAbortAction

$sel:action:IoTJobAbortCriteria'

-> Double

$sel:thresholdPercentage:IoTJobAbortCriteria'

-> Natural

$sel:minNumberOfExecutedThings:IoTJobAbortCriteria'

-> IoTJobAbortCriteria 

Create a value of IoTJobAbortCriteria 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:IoTJobAbortCriteria', ioTJobAbortCriteria_failureType - The type of job deployment failure that can cancel a job.

$sel:action:IoTJobAbortCriteria', ioTJobAbortCriteria_action - The action to perform when the criteria are met.

$sel:thresholdPercentage:IoTJobAbortCriteria', ioTJobAbortCriteria_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 or 10.99, but not 10.999).

$sel:minNumberOfExecutedThings:IoTJobAbortCriteria', ioTJobAbortCriteria_minNumberOfExecutedThings - The minimum number of things that receive the configuration before the job can cancel.

ioTJobAbortCriteria_failureType :: Lens' IoTJobAbortCriteria IoTJobExecutionFailureType Source #

The type of job deployment failure that can cancel a job.

ioTJobAbortCriteria_action :: Lens' IoTJobAbortCriteria IoTJobAbortAction Source #

The action to perform when the criteria are met.

ioTJobAbortCriteria_thresholdPercentage :: Lens' IoTJobAbortCriteria Double Source #

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).

ioTJobAbortCriteria_minNumberOfExecutedThings :: Lens' IoTJobAbortCriteria Natural Source #

The minimum number of things that receive the configuration before the job can cancel.