Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeAlert

Describes an alert.

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 /DescribeAlert HTTP/1.1
Content-type: application/json

{
   "AlertArn": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AlertArn

The ARN of the alert to describe.

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:([a-z\d-]+):.*:.*:.*:.+

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Alert": { 
      "Action": { 
         "LambdaConfiguration": { 
            "LambdaArn": "string",
            "RoleArn": "string"
         },
         "SNSConfiguration": { 
            "RoleArn": "string",
            "SnsFormat": "string",
            "SnsTopicArn": "string"
         }
      },
      "AlertArn": "string",
      "AlertDescription": "string",
      "AlertFilters": { 
         "DimensionFilterList": [ 
            { 
               "DimensionName": "string",
               "DimensionValueList": [ "string" ]
            }
         ],
         "MetricList": [ "string" ]
      },
      "AlertName": "string",
      "AlertSensitivityThreshold": number,
      "AlertStatus": "string",
      "AlertType": "string",
      "AnomalyDetectorArn": "string",
      "CreationTime": number,
      "LastModificationTime": number
   }
}

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.

Alert

Contains information about an alert.

Type: Alert object

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