You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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
  value: {
    count: 1,
    cidrs: ["Cidr"],
    ports: [1],
  },
  duration_seconds: 1,
  consecutive_datapoints_to_alarm: 1,
  consecutive_datapoints_to_clear: 1,
  statistical_threshold: {
    statistic: "EvaluationStatistic",
  },
}

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

Instance Attribute Summary collapse

Instance Attribute Details

#comparison_operatorString

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

Returns:

  • (String)


1202
1203
1204
1205
1206
1207
1208
1209
1210
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1202

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

#consecutive_datapoints_to_alarmInteger

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)


1202
1203
1204
1205
1206
1207
1208
1209
1210
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1202

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

#consecutive_datapoints_to_clearInteger

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)


1202
1203
1204
1205
1206
1207
1208
1209
1210
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1202

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

#duration_secondsInteger

Use this to specify the time duration over which the behavior is evaluated, for those criteria which 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.

Returns:

  • (Integer)


1202
1203
1204
1205
1206
1207
1208
1209
1210
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1202

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

#statistical_thresholdTypes::StatisticalThreshold

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



1202
1203
1204
1205
1206
1207
1208
1209
1210
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1202

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

#valueTypes::MetricValue

The value to be compared with the metric.

Returns:



1202
1203
1204
1205
1206
1207
1208
1209
1210
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1202

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