LookoutMetrics / Client / list_alerts

list_alerts#

LookoutMetrics.Client.list_alerts(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.list_alerts(
    AnomalyDetectorArn='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • AnomalyDetectorArn (string) – The ARN of the alert’s detector.

  • NextToken (string) – 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.

  • MaxResults (integer) – The maximum number of results that will be displayed by the request.

Return type:

dict

Returns:

Response Syntax

{
    'AlertSummaryList': [
        {
            'AlertArn': 'string',
            'AnomalyDetectorArn': 'string',
            'AlertName': 'string',
            'AlertSensitivityThreshold': 123,
            'AlertType': 'SNS'|'LAMBDA',
            'AlertStatus': 'ACTIVE'|'INACTIVE',
            'LastModificationTime': datetime(2015, 1, 1),
            'CreationTime': datetime(2015, 1, 1),
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • AlertSummaryList (list) –

      Contains information about an alert.

      • (dict) –

        Provides a summary of an alert’s configuration.

        • AlertArn (string) –

          The ARN of the alert.

        • AnomalyDetectorArn (string) –

          The ARN of the detector to which the alert is attached.

        • AlertName (string) –

          The name of the alert.

        • AlertSensitivityThreshold (integer) –

          The minimum severity for an anomaly to trigger the alert.

        • AlertType (string) –

          The type of the alert.

        • AlertStatus (string) –

          The status of the alert.

        • LastModificationTime (datetime) –

          The time at which the alert was last modified.

        • CreationTime (datetime) –

          The time at which the alert was created.

        • Tags (dict) –

          The alert’s tags.

          • (string) –

            • (string) –

    • NextToken (string) –

      If the response is truncated, the service returns this token. To retrieve the next set of results, use this token in the next request.

Exceptions