NAME

Paws::IoT::BehaviorCriteria

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::IoT::BehaviorCriteria object:

$service_obj->Method(Att1 => { ComparisonOperator => $value, ..., Value => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::IoT::BehaviorCriteria object:

$result = $service_obj->Method(...);
$result->Att1->ComparisonOperator

DESCRIPTION

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

ATTRIBUTES

ComparisonOperator => Str

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 => Int

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 => Int

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 => 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 => Paws::IoT::MachineLearningDetectionConfig

The configuration of an ML Detect

StatisticalThreshold => Paws::IoT::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 => Paws::IoT::MetricValue

The value to be compared with the metric.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::IoT

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues