LookoutMetrics / Client / list_anomaly_group_related_metrics

list_anomaly_group_related_metrics

LookoutMetrics.Client.list_anomaly_group_related_metrics(**kwargs)

Returns a list of measures that are potential causes or effects of an anomaly group.

See also: AWS API Documentation

Request Syntax

response = client.list_anomaly_group_related_metrics(
    AnomalyDetectorArn='string',
    AnomalyGroupId='string',
    RelationshipTypeFilter='CAUSE_OF_INPUT_ANOMALY_GROUP'|'EFFECT_OF_INPUT_ANOMALY_GROUP',
    MaxResults=123,
    NextToken='string'
)

Parameters:

• AnomalyDetectorArn (string) –

  [REQUIRED]

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

• AnomalyGroupId (string) –

  [REQUIRED]

  The ID of the anomaly group.

• RelationshipTypeFilter (string) – Filter for potential causes ( CAUSE_OF_INPUT_ANOMALY_GROUP) or downstream effects ( EFFECT_OF_INPUT_ANOMALY_GROUP) of the anomaly group.

• 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

{
    'InterMetricImpactList': [
        {
            'MetricName': 'string',
            'AnomalyGroupId': 'string',
            'RelationshipType': 'CAUSE_OF_INPUT_ANOMALY_GROUP'|'EFFECT_OF_INPUT_ANOMALY_GROUP',
            'ContributionPercentage': 123.0
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • InterMetricImpactList (list) –

    Aggregated details about the measures contributing to the anomaly group, and the measures potentially impacted by the anomaly group.

    • (dict) –

      Aggregated details about the measures contributing to the anomaly group, and the measures potentially impacted by the anomaly group.

      • MetricName (string) –

        The name of the measure.

      • AnomalyGroupId (string) –

        The ID of the anomaly group.

      • RelationshipType (string) –

        Whether a measure is a potential cause of the anomaly group ( CAUSE_OF_INPUT_ANOMALY_GROUP), or whether the measure is impacted by the anomaly group ( EFFECT_OF_INPUT_ANOMALY_GROUP).

      • ContributionPercentage (float) –

        For potential causes ( CAUSE_OF_INPUT_ANOMALY_GROUP), the percentage contribution the measure has in causing the anomalies.

  • 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