ViolationEvent - AWS IoT

ViolationEvent

Information about a Device Defender security profile behavior violation.

Contents

behavior

The behavior that was violated.

Type: Behavior object

Required: No

metricValue

The value of the metric (the measurement).

Type: MetricValue object

Required: No

securityProfileName

The name of the security profile whose behavior was violated.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9:_-]+

Required: No

thingName

The name of the thing responsible for the violation event.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

verificationState

The verification state of the violation (detect alarm).

Type: String

Valid Values: FALSE_POSITIVE | BENIGN_POSITIVE | TRUE_POSITIVE | UNKNOWN

Required: No

verificationStateDescription

The description of the verification state of the violation.

Type: String

Length Constraints: Maximum length of 1000.

Pattern: [\p{Graph}\x20]*

Required: No

violationEventAdditionalInfo

The details of a violation event.

Type: ViolationEventAdditionalInfo object

Required: No

violationEventTime

The time the violation event occurred.

Type: Timestamp

Required: No

violationEventType

The type of violation event.

Type: String

Valid Values: in-alarm | alarm-cleared | alarm-invalidated

Required: No

violationId

The ID of the violation event.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9\-]+

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: