Class: Aws::IoT::Types::BehaviorCriteria

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Overview

Note:

When making an API call, you may pass BehaviorCriteria data as a hash:

{
  comparison_operator: "less-than", # accepts less-than, less-than-equals, greater-than, greater-than-equals, in-cidr-set, not-in-cidr-set, in-port-set, not-in-port-set, in-set, not-in-set
  value: {
    count: 1,
    cidrs: ["Cidr"],
    ports: [1],
    number: 1.0,
    numbers: [1.0],
    strings: ["stringValue"],
  },
  duration_seconds: 1,
  consecutive_datapoints_to_alarm: 1,
  consecutive_datapoints_to_clear: 1,
  statistical_threshold: {
    statistic: "EvaluationStatistic",
  },
  ml_detection_config: {
    confidence_level: "LOW", # required, accepts LOW, MEDIUM, HIGH
  },
}

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

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#comparison_operator ⇒ String

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

Returns:

  • (String) 


1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1872

class BehaviorCriteria < Struct.new(
  :comparison_operator,
  :value,
  :duration_seconds,
  :consecutive_datapoints_to_alarm,
  :consecutive_datapoints_to_clear,
  :statistical_threshold,
  :ml_detection_config)
  SENSITIVE = []
  include Aws::Structure
end

#consecutive_datapoints_to_alarm ⇒ Integer

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.

Returns:

  • (Integer) 


1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1872

class BehaviorCriteria < Struct.new(
  :comparison_operator,
  :value,
  :duration_seconds,
  :consecutive_datapoints_to_alarm,
  :consecutive_datapoints_to_clear,
  :statistical_threshold,
  :ml_detection_config)
  SENSITIVE = []
  include Aws::Structure
end

#consecutive_datapoints_to_clear ⇒ Integer

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.

Returns:

  • (Integer) 


1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1872

class BehaviorCriteria < Struct.new(
  :comparison_operator,
  :value,
  :duration_seconds,
  :consecutive_datapoints_to_alarm,
  :consecutive_datapoints_to_clear,
  :statistical_threshold,
  :ml_detection_config)
  SENSITIVE = []
  include Aws::Structure
end

#duration_seconds ⇒ Integer

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.

Returns:

  • (Integer) 


1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1872

class BehaviorCriteria < Struct.new(
  :comparison_operator,
  :value,
  :duration_seconds,
  :consecutive_datapoints_to_alarm,
  :consecutive_datapoints_to_clear,
  :statistical_threshold,
  :ml_detection_config)
  SENSITIVE = []
  include Aws::Structure
end

#ml_detection_config ⇒ Types::MachineLearningDetectionConfig

The configuration of an ML Detect

Returns:



1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1872

class BehaviorCriteria < Struct.new(
  :comparison_operator,
  :value,
  :duration_seconds,
  :consecutive_datapoints_to_alarm,
  :consecutive_datapoints_to_clear,
  :statistical_threshold,
  :ml_detection_config)
  SENSITIVE = []
  include Aws::Structure
end

#statistical_threshold ⇒ Types::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.

Returns:



1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1872

class BehaviorCriteria < Struct.new(
  :comparison_operator,
  :value,
  :duration_seconds,
  :consecutive_datapoints_to_alarm,
  :consecutive_datapoints_to_clear,
  :statistical_threshold,
  :ml_detection_config)
  SENSITIVE = []
  include Aws::Structure
end

#value ⇒ Types::MetricValue

The value to be compared with the metric.

Returns:



1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1872

class BehaviorCriteria < Struct.new(
  :comparison_operator,
  :value,
  :duration_seconds,
  :consecutive_datapoints_to_alarm,
  :consecutive_datapoints_to_clear,
  :statistical_threshold,
  :ml_detection_config)
  SENSITIVE = []
  include Aws::Structure
end