LookoutMetrics / Client / list_anomaly_group_time_series

list_anomaly_group_time_series#

LookoutMetrics.Client.list_anomaly_group_time_series(**kwargs)#

Gets a list of anomalous metrics for a measure in an anomaly group.

See also: AWS API Documentation

Request Syntax

response = client.list_anomaly_group_time_series(
    AnomalyDetectorArn='string',
    AnomalyGroupId='string',
    MetricName='string',
    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.

  • MetricName (string) –

    [REQUIRED]

    The name of the measure field.

  • 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

{
    'AnomalyGroupId': 'string',
    'MetricName': 'string',
    'TimestampList': [
        'string',
    ],
    'NextToken': 'string',
    'TimeSeriesList': [
        {
            'TimeSeriesId': 'string',
            'DimensionList': [
                {
                    'DimensionName': 'string',
                    'DimensionValue': 'string'
                },
            ],
            'MetricValueList': [
                123.0,
            ]
        },
    ]
}

Response Structure

  • (dict) –

    • AnomalyGroupId (string) –

      The ID of the anomaly group.

    • MetricName (string) –

      The name of the measure field.

    • TimestampList (list) –

      Timestamps for the anomalous metrics.

      • (string) –

    • NextToken (string) –

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

    • TimeSeriesList (list) –

      A list of anomalous metrics.

      • (dict) –

        Details about a metric. A metric is an aggregation of the values of a measure for a dimension value, such as availability in the us-east-1 Region.

        • TimeSeriesId (string) –

          The ID of the metric.

        • DimensionList (list) –

          The dimensions of the metric.

          • (dict) –

            A dimension name and value.

            • DimensionName (string) –

              The name of the dimension.

            • DimensionValue (string) –

              The value of the dimension.

        • MetricValueList (list) –

          The values for the metric.

          • (float) –

Exceptions

  • LookoutMetrics.Client.exceptions.InternalServerException

  • LookoutMetrics.Client.exceptions.AccessDeniedException

  • LookoutMetrics.Client.exceptions.ValidationException

  • LookoutMetrics.Client.exceptions.ResourceNotFoundException

  • LookoutMetrics.Client.exceptions.TooManyRequestsException