IoT / Paginator / ListMetricValues

ListMetricValues

class IoT.Paginator.ListMetricValues

paginator = client.get_paginator('list_metric_values')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_metric_values().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    thingName='string',
    metricName='string',
    dimensionName='string',
    dimensionValueOperator='IN'|'NOT_IN',
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• thingName (string) –

  [REQUIRED]

  The name of the thing for which security profile metric values are returned.

• metricName (string) –

  [REQUIRED]

  The name of the security profile metric for which values are returned.

• dimensionName (string) – The dimension name.

• dimensionValueOperator (string) – The dimension value operator.

• startTime (datetime) –

  [REQUIRED]

  The start of the time period for which metric values are returned.

• endTime (datetime) –

  [REQUIRED]

  The end of the time period for which metric values are returned.

• 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

{
    'metricDatumList': [
        {
            'timestamp': datetime(2015, 1, 1),
            'value': {
                'count': 123,
                'cidrs': [
                    'string',
                ],
                'ports': [
                    123,
                ],
                'number': 123.0,
                'numbers': [
                    123.0,
                ],
                'strings': [
                    'string',
                ]
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • metricDatumList (list) –

    The data the thing reports for the metric during the specified time period.

    • (dict) –

      A metric.

      • timestamp (datetime) –

        The time the metric value was reported.

      • value (dict) –

        The value reported for the metric.

        • count (integer) –

          If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric .

        • cidrs (list) –

          If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric .

          • (string) –

        • ports (list) –

          If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric .

          • (integer) –

        • number (float) –

          The numeral value of a metric.

        • numbers (list) –

          The numeral values of a metric.

          • (float) –

        • strings (list) –

          The string values of a metric.

          • (string) –

  • NextToken (string) –

    A token to resume pagination.