list_anomaly_group_summaries

LookoutMetrics.Client.list_anomaly_group_summaries(**kwargs)

Returns a list of anomaly groups.

See also: AWS API Documentation

Request Syntax

response = client.list_anomaly_group_summaries(
    AnomalyDetectorArn='string',
    SensitivityThreshold=123,
    MaxResults=123,
    NextToken='string'
)

Parameters

• AnomalyDetectorArn (string) --

  [REQUIRED]

  The Amazon Resource Name (ARN) of the anomaly detector.

• SensitivityThreshold (integer) --

  [REQUIRED]

  The minimum severity score for inclusion in the output.

• MaxResults (integer) -- The maximum number of results to return.
• NextToken (string) -- Specify the pagination token that's returned by a previous request to retrieve the next page of results.

Return type

dict

Returns

Response Syntax

{
    'AnomalyGroupSummaryList': [
        {
            'StartTime': 'string',
            'EndTime': 'string',
            'AnomalyGroupId': 'string',
            'AnomalyGroupScore': 123.0,
            'PrimaryMetricName': 'string'
        },
    ],
    'AnomalyGroupStatistics': {
        'EvaluationStartDate': 'string',
        'TotalCount': 123,
        'ItemizedMetricStatsList': [
            {
                'MetricName': 'string',
                'OccurrenceCount': 123
            },
        ]
    },
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • AnomalyGroupSummaryList (list) --

    A list of anomaly group summaries.

    • (dict) --

      Details about a group of anomalous metrics.

      • StartTime (string) --

        The start time for the group.

      • EndTime (string) --

        The end time for the group.

      • AnomalyGroupId (string) --

        The ID of the anomaly group.

      • AnomalyGroupScore (float) --

        The severity score of the group.

      • PrimaryMetricName (string) --

        The name of the primary affected measure for the group.

  • AnomalyGroupStatistics (dict) --

    Aggregated details about the anomaly groups.

    • EvaluationStartDate (string) --

      The start of the time range that was searched.

    • TotalCount (integer) --

      The number of groups found.

    • ItemizedMetricStatsList (list) --

      Statistics for individual metrics within the group.

      • (dict) --

        Aggregated statistics about a measure affected by an anomaly.

        • MetricName (string) --

          The name of the measure.

        • OccurrenceCount (integer) --

          The number of times that the measure appears.

  • NextToken (string) --

    The pagination token that's included if more results are available.

Exceptions

• LookoutMetrics.Client.exceptions.ResourceNotFoundException
• LookoutMetrics.Client.exceptions.ValidationException
• LookoutMetrics.Client.exceptions.InternalServerException
• LookoutMetrics.Client.exceptions.AccessDeniedException
• LookoutMetrics.Client.exceptions.TooManyRequestsException