AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

BehaviorCriteria

import "github.com/aws/aws-sdk-go/service/iot"

type BehaviorCriteria struct { ComparisonOperator *string `locationName:"comparisonOperator" type:"string" enum:"ComparisonOperator"` ConsecutiveDatapointsToAlarm *int64 `locationName:"consecutiveDatapointsToAlarm" min:"1" type:"integer"` ConsecutiveDatapointsToClear *int64 `locationName:"consecutiveDatapointsToClear" min:"1" type:"integer"` DurationSeconds *int64 `locationName:"durationSeconds" type:"integer"` StatisticalThreshold *StatisticalThreshold `locationName:"statisticalThreshold" type:"structure"` Value *MetricValue `locationName:"value" type:"structure"` }

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

ComparisonOperator

Type: *string

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

ConsecutiveDatapointsToAlarm

Type: *int64

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

Type: *int64

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

Type: *int64

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.

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.

Value

The value to be compared with the metric.

Method

GoString

func (s BehaviorCriteria) GoString() string

GoString returns the string representation

SetComparisonOperator

func (s *BehaviorCriteria) SetComparisonOperator(v string) *BehaviorCriteria

SetComparisonOperator sets the ComparisonOperator field's value.

SetConsecutiveDatapointsToAlarm

func (s *BehaviorCriteria) SetConsecutiveDatapointsToAlarm(v int64) *BehaviorCriteria

SetConsecutiveDatapointsToAlarm sets the ConsecutiveDatapointsToAlarm field's value.

SetConsecutiveDatapointsToClear

func (s *BehaviorCriteria) SetConsecutiveDatapointsToClear(v int64) *BehaviorCriteria

SetConsecutiveDatapointsToClear sets the ConsecutiveDatapointsToClear field's value.

SetDurationSeconds

func (s *BehaviorCriteria) SetDurationSeconds(v int64) *BehaviorCriteria

SetDurationSeconds sets the DurationSeconds field's value.

SetStatisticalThreshold

func (s *BehaviorCriteria) SetStatisticalThreshold(v *StatisticalThreshold) *BehaviorCriteria

SetStatisticalThreshold sets the StatisticalThreshold field's value.

SetValue

func (s *BehaviorCriteria) SetValue(v *MetricValue) *BehaviorCriteria

SetValue sets the Value field's value.

String

func (s BehaviorCriteria) String() string

String returns the string representation

Validate

func (s *BehaviorCriteria) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: