Amazonka.IoT.Types.BehaviorCriteria

Documentation

data BehaviorCriteria

The criteria by which the behavior is determined to be normal.

See: newBehaviorCriteria smart constructor.

Constructors

BehaviorCriteria'

Fields

• comparisonOperator :: Maybe ComparisonOperator

  The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold). Valid operators include:

  • string-list: in-set and not-in-set
  • number-list: in-set and not-in-set
  • ip-address-list: in-cidr-set and not-in-cidr-set
  • number: less-than, less-than-equals, greater-than, and greater-than-equals
• consecutiveDatapointsToAlarm :: Maybe Natural

  If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.

• consecutiveDatapointsToClear :: Maybe Natural

  If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.

• durationSeconds :: Maybe Int

  Use this to specify the time duration over which the behavior is evaluated, for those criteria that have a time dimension (for example, NUM_MESSAGES_SENT). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank. Cannot be used with list-based metric datatypes.

• mlDetectionConfig :: Maybe MachineLearningDetectionConfig

  The configuration of an ML Detect

• statisticalThreshold :: Maybe StatisticalThreshold

  A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

• value :: Maybe MetricValue

  The value to be compared with the metric.

Instances

FromJSON BehaviorCriteria

Defined in Amazonka.IoT.Types.BehaviorCriteria

Methods

parseJSON :: Value -> Parser BehaviorCriteria

parseJSONList :: Value -> Parser [BehaviorCriteria]

ToJSON BehaviorCriteria

Defined in Amazonka.IoT.Types.BehaviorCriteria

Methods

toJSON :: BehaviorCriteria -> Value

toEncoding :: BehaviorCriteria -> Encoding

toJSONList :: [BehaviorCriteria] -> Value

toEncodingList :: [BehaviorCriteria] -> Encoding

Generic BehaviorCriteria

Defined in Amazonka.IoT.Types.BehaviorCriteria

Associated Types

type Rep BehaviorCriteria :: Type -> Type

Methods

from :: BehaviorCriteria -> Rep BehaviorCriteria x

to :: Rep BehaviorCriteria x -> BehaviorCriteria

Read BehaviorCriteria

Defined in Amazonka.IoT.Types.BehaviorCriteria

Methods

readsPrec :: Int -> ReadS BehaviorCriteria

readList :: ReadS [BehaviorCriteria]

readPrec :: ReadPrec BehaviorCriteria

readListPrec :: ReadPrec [BehaviorCriteria]

Show BehaviorCriteria

Defined in Amazonka.IoT.Types.BehaviorCriteria

Methods

showsPrec :: Int -> BehaviorCriteria -> ShowS

show :: BehaviorCriteria -> String

showList :: [BehaviorCriteria] -> ShowS

NFData BehaviorCriteria

Defined in Amazonka.IoT.Types.BehaviorCriteria

Methods

rnf :: BehaviorCriteria -> ()

Eq BehaviorCriteria

Defined in Amazonka.IoT.Types.BehaviorCriteria

Methods

(==) :: BehaviorCriteria -> BehaviorCriteria -> Bool

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

Hashable BehaviorCriteria

Defined in Amazonka.IoT.Types.BehaviorCriteria

Methods

hashWithSalt :: Int -> BehaviorCriteria -> Int

hash :: BehaviorCriteria -> Int

type Rep BehaviorCriteria

Defined in Amazonka.IoT.Types.BehaviorCriteria

type Rep BehaviorCriteria = D1 ('MetaData "BehaviorCriteria" "Amazonka.IoT.Types.BehaviorCriteria" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "BehaviorCriteria'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "comparisonOperator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComparisonOperator)) :*: (S1 ('MetaSel ('Just "consecutiveDatapointsToAlarm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "consecutiveDatapointsToClear") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :*: ((S1 ('MetaSel ('Just "durationSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "mlDetectionConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MachineLearningDetectionConfig))) :*: (S1 ('MetaSel ('Just "statisticalThreshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StatisticalThreshold)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MetricValue))))))

newBehaviorCriteria :: BehaviorCriteria

Create a value of BehaviorCriteria 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:comparisonOperator:BehaviorCriteria', behaviorCriteria_comparisonOperator - The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold). Valid operators include:

• string-list: in-set and not-in-set
• number-list: in-set and not-in-set
• ip-address-list: in-cidr-set and not-in-cidr-set
• number: less-than, less-than-equals, greater-than, and greater-than-equals

$sel:consecutiveDatapointsToAlarm:BehaviorCriteria', behaviorCriteria_consecutiveDatapointsToAlarm - If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.

$sel:consecutiveDatapointsToClear:BehaviorCriteria', behaviorCriteria_consecutiveDatapointsToClear - If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.

$sel:durationSeconds:BehaviorCriteria', behaviorCriteria_durationSeconds - Use this to specify the time duration over which the behavior is evaluated, for those criteria that have a time dimension (for example, NUM_MESSAGES_SENT). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank. Cannot be used with list-based metric datatypes.

$sel:mlDetectionConfig:BehaviorCriteria', behaviorCriteria_mlDetectionConfig - The configuration of an ML Detect

$sel:statisticalThreshold:BehaviorCriteria', behaviorCriteria_statisticalThreshold - A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

$sel:value:BehaviorCriteria', behaviorCriteria_value - The value to be compared with the metric.

behaviorCriteria_comparisonOperator :: Lens' BehaviorCriteria (Maybe ComparisonOperator)

The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold). Valid operators include:

• string-list: in-set and not-in-set
• number-list: in-set and not-in-set
• ip-address-list: in-cidr-set and not-in-cidr-set
• number: less-than, less-than-equals, greater-than, and greater-than-equals

behaviorCriteria_consecutiveDatapointsToAlarm :: Lens' BehaviorCriteria (Maybe Natural)

If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.

behaviorCriteria_consecutiveDatapointsToClear :: Lens' BehaviorCriteria (Maybe Natural)

If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.

behaviorCriteria_durationSeconds :: Lens' BehaviorCriteria (Maybe Int)

Use this to specify the time duration over which the behavior is evaluated, for those criteria that have a time dimension (for example, NUM_MESSAGES_SENT). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank. Cannot be used with list-based metric datatypes.

behaviorCriteria_mlDetectionConfig :: Lens' BehaviorCriteria (Maybe MachineLearningDetectionConfig)

The configuration of an ML Detect

behaviorCriteria_statisticalThreshold :: Lens' BehaviorCriteria (Maybe StatisticalThreshold)

A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

behaviorCriteria_value :: Lens' BehaviorCriteria (Maybe MetricValue)

The value to be compared with the metric.