ResilienceHub / Paginator / ListMetrics

ListMetrics

class ResilienceHub.Paginator.ListMetrics

paginator = client.get_paginator('list_metrics')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ResilienceHub.Client.list_metrics().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    conditions=[
        {
            'field': 'string',
            'operator': 'Equals'|'NotEquals'|'GreaterThen'|'GreaterOrEquals'|'LessThen'|'LessOrEquals',
            'value': 'string'
        },
    ],
    dataSource='string',
    fields=[
        {
            'aggregation': 'Min'|'Max'|'Sum'|'Avg'|'Count',
            'name': 'string'
        },
    ],
    sorts=[
        {
            'ascending': True|False,
            'field': 'string'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• conditions (list) –

  Indicates the list of all the conditions that were applied on the metrics.

  • (dict) –

    Indicates the condition based on which you want to filter the metrics.

    • field (string) – [REQUIRED]

      Indicates the field in the metric.

    • operator (string) – [REQUIRED]

      Indicates the type of operator or comparison to be used when evaluating a condition against the specified field.

    • value (string) –

      Indicates the value or data against which a condition is evaluated.

• dataSource (string) – Indicates the data source of the metrics.

• fields (list) –

  Indicates the list of fields in the data source.

  • (dict) –

    Indicates the field or attribute of a resource or data structure on which a condition is being applied or evaluated.

    • aggregation (string) –

      (Optional) Indicates the type of aggregation or summary operation (such as Sum, Average, and so on) to be performed on a particular field or set of data.

    • name (string) – [REQUIRED]

      Name of the field.

• sorts (list) –

  (Optional) Indicates the order in which you want to sort the fields in the metrics. By default, the fields are sorted in the ascending order.

  • (dict) –

    Indicates the sorting order of the fields in the metrics.

    • ascending (boolean) –

      Indicates the name or identifier of the field or attribute that should be used as the basis for sorting the metrics.

    • field (string) – [REQUIRED]

      Indicates the order in which you want to sort the metrics. By default, the list is sorted in ascending order. To sort the list in descending order, set this field to False.

• 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

{
    'rows': [
        [
            'string',
        ],
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • rows (list) –

    Specifies all the list of metric values for each row of metrics.

    • (list) –

      • (string) –

  • NextToken (string) –

    A token to resume pagination.