AWSIoTBehaviorCriteria

Objective-C

@interface AWSIoTBehaviorCriteria

Swift

class AWSIoTBehaviorCriteria

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

  • 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

    Declaration

    Objective-C

    @property (nonatomic) AWSIoTComparisonOperator comparisonOperator;

    Swift

    var comparisonOperator: AWSIoTComparisonOperator { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable consecutiveDatapointsToAlarm;

    Swift

    var consecutiveDatapointsToAlarm: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable consecutiveDatapointsToClear;

    Swift

    var consecutiveDatapointsToClear: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable durationSeconds;

    Swift

    var durationSeconds: NSNumber? { get set }

  • The configuration of an ML Detect

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSIoTMachineLearningDetectionConfig *_Nullable mlDetectionConfig;

    Swift

    var mlDetectionConfig: AWSIoTMachineLearningDetectionConfig? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSIoTStatisticalThreshold *_Nullable statisticalThreshold;

    Swift

    var statisticalThreshold: AWSIoTStatisticalThreshold? { get set }

  • The value to be compared with the metric.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSIoTMetricValue *_Nullable value;

    Swift

    var value: AWSIoTMetricValue? { get set }