GET

/violation-events#startTime&endTime

http://iot.{region}.amazonaws.com/violation-events#startTime&endTime

<p>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).</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListViolationEvents</a> action.</p>

Access Token Required: API Key

Query Params

startTimestringrequired

The start time for the alerts to be listed.

endTimestringrequired

The end time for the alerts to be listed.

thingNamestring

A filter to limit results to those alerts caused by the specified thing.

securityProfileNamestring

A filter to limit results to those alerts generated by the specified security profile.

behaviorCriteriaTypestring

The criteria for a behavior.

Allowed:

listSuppressedAlertsboolean

A list of all suppressed alerts.

verificationStatestring

The verification state of the violation (detect alarm).

Allowed:

nextTokenstring

The token for the next set of results.

maxResultsinteger

The maximum number of results to return at one time.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://iot.{region}.amazonaws.com/violation-events#startTime&endTime' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}