LookoutMetrics / Client / get_anomaly_group

get_anomaly_group

LookoutMetrics.Client.get_anomaly_group(**kwargs)

Returns details about a group of anomalous metrics.

See also: AWS API Documentation

Request Syntax

response = client.get_anomaly_group(
    AnomalyGroupId='string',
    AnomalyDetectorArn='string'
)

Parameters:

• AnomalyGroupId (string) –

  [REQUIRED]

  The ID of the anomaly group.

• AnomalyDetectorArn (string) –

  [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'AnomalyGroup': {
        'StartTime': 'string',
        'EndTime': 'string',
        'AnomalyGroupId': 'string',
        'AnomalyGroupScore': 123.0,
        'PrimaryMetricName': 'string',
        'MetricLevelImpactList': [
            {
                'MetricName': 'string',
                'NumTimeSeries': 123,
                'ContributionMatrix': {
                    'DimensionContributionList': [
                        {
                            'DimensionName': 'string',
                            'DimensionValueContributionList': [
                                {
                                    'DimensionValue': 'string',
                                    'ContributionScore': 123.0
                                },
                            ]
                        },
                    ]
                }
            },
        ]
    }
}

Response Structure

• (dict) –

  • AnomalyGroup (dict) –

    Details about the anomaly group.

    • 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.

    • MetricLevelImpactList (list) –

      A list of measures affected by the anomaly.

      • (dict) –

        Details about a measure affected by an anomaly.

        • MetricName (string) –

          The name of the measure.

        • NumTimeSeries (integer) –

          The number of anomalous metrics for the measure.

        • ContributionMatrix (dict) –

          Details about the dimensions that contributed to the anomaly.

          • DimensionContributionList (list) –

            A list of contributing dimensions.

            • (dict) –

              Details about a dimension that contributed to an anomaly.

              • DimensionName (string) –

                The name of the dimension.

              • DimensionValueContributionList (list) –

                A list of dimension values that contributed to the anomaly.

                • (dict) –

                  The severity of a value of a dimension that contributed to an anomaly.

                  • DimensionValue (string) –

                    The value of the dimension.

                  • ContributionScore (float) –

                    The severity score of the value.

Exceptions

• LookoutMetrics.Client.exceptions.ResourceNotFoundException

• LookoutMetrics.Client.exceptions.ValidationException

• LookoutMetrics.Client.exceptions.InternalServerException

• LookoutMetrics.Client.exceptions.AccessDeniedException

• LookoutMetrics.Client.exceptions.TooManyRequestsException