ListAlerts
Lists the alerts attached to a detector.
Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
Request Syntax
POST /ListAlerts HTTP/1.1
Content-type: application/json
{
"AnomalyDetectorArn": "string",
"MaxResults": number,
"NextToken": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- AnomalyDetectorArn
-
The ARN of the alert's detector.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):.*:.*:.*:.+Required: No
- MaxResults
-
The maximum number of results that will be displayed by the request.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
If the result of the previous request is truncated, the response includes a
NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.Type: String
Length Constraints: Minimum length of 1. Maximum length of 3000.
Pattern:
.*\S.*Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"AlertSummaryList": [
{
"AlertArn": "string",
"AlertName": "string",
"AlertSensitivityThreshold": number,
"AlertStatus": "string",
"AlertType": "string",
"AnomalyDetectorArn": "string",
"CreationTime": number,
"LastModificationTime": number,
"Tags": {
"string" : "string"
}
}
],
"NextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- AlertSummaryList
-
Contains information about an alert.
Type: Array of AlertSummary objects
- NextToken
-
If the response is truncated, the service returns this token. To retrieve the next set of results, use this token in the next request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 3000.
Pattern:
.*\S.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient permissions to perform this action.
HTTP Status Code: 403
- InternalServerException
-
The request processing has failed because of an unknown error, exception, or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource cannot be found. Check the ARN of the resource and try again.
HTTP Status Code: 400
- TooManyRequestsException
-
The request was denied due to too many requests being submitted at the same time.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
