CloudWatch / Paginator / ListMetricDataQueryDefinitions

ListMetricDataQueryDefinitions

class CloudWatch.Paginator.ListMetricDataQueryDefinitions
paginator = client.get_paginator('list_metric_data_query_definitions')
paginate(**kwargs)

Creates an iterator that will paginate through responses from CloudWatch.Client.list_metric_data_query_definitions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'Id': 'string',
            'Path': 'string',
            'Type': 'PROMQL'|'SQL'|'METRIC_MATH',
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) –

    • Items (list) –

      A list of metric data query definition summaries.

      • (dict) –

        Summary information about a metric data query definition. To get the expression, call GetMetricDataQueryDefinition.

        • Id (string) –

          The ID of the metric data query definition.

        • Path (string) –

          The path of the metric data query definition.

        • Type (string) –

          The language of the expression. Valid values are the following:

          • PROMQL – A PromQL query.

          • SQL – A CloudWatch Metrics Insights query.

          • METRIC_MATH – A metric math expression.

        • UpdatedAt (datetime) –

          The date and time when you last updated the metric data query definition.