Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior, or thing (device).Requires permission to access the ListViolationEvents action.
Request Request Example
Shell
JavaScript
Java
Swift
curl--location-g--request GET 'https://api.iotwireless.{region}.amazonaws.com/violation-events?startTime=&endTime='
Response Response Example
200 - Example 1
{"violationEvents":[],"nextToken":"string"}
Request
Query Params
startTime
stringÂ
required
The start time for the alerts to be listed.
endTime
stringÂ
required
The end time for the alerts to be listed.
thingName
stringÂ
optional
A filter to limit results to those alerts caused by the specified thing.
securityProfileName
stringÂ
optional
A filter to limit results to those alerts generated by the specified security profile.
behaviorCriteriaType
stringÂ
optional
The criteria for a behavior.
listSuppressedAlerts
stringÂ
optional
A list of all suppressed alerts.
nextToken
stringÂ
optional
The token for the next set of results.
maxResults
integerÂ
optional
The maximum number of results to return at one time.
Responses
🟢200Success
application/json
Body
violationEvents
array[object (ViolationEvent) {8}]Â
optional
The security profile violation alerts issued for this account during the given time period, potentially filtered by security profile, behavior violated, or thing (device) violating.
violationId
stringÂ
optional
The ID of the violation event.
>= 1 characters<= 128 characters
Match pattern:
[a-zA-Z0-9\-]+
thingName
stringÂ
optional
The name of the thing responsible for the violation event.
>= 1 characters<= 128 characters
securityProfileName
stringÂ
optional
The name of the security profile whose behavior was violated.
>= 1 characters<= 128 characters
Match pattern:
[a-zA-Z0-9:_-]+
behavior
objectÂ
optional
The behavior that was violated.
metricValue
objectÂ
optional
The value of the metric (the measurement).
violationEventAdditionalInfo
objectÂ
optional
The details of a violation event.
violationEventType
enum<string>Â
optional
The type of violation event.
Allowed values:
in-alarmalarm-clearedalarm-invalidated
violationEventTime
string <date-time>
optional
The time the violation event occurred.
nextToken
stringÂ
optional
A token that can be used to retrieve the next set of results, or null if there are no additional results.