IoT / Paginator / ListFleetMetrics

ListFleetMetrics

class IoT.Paginator.ListFleetMetrics

paginator = client.get_paginator('list_fleet_metrics')

paginate(**kwargs)

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

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

{
    'fleetMetrics': [
        {
            'metricName': 'string',
            'metricArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • fleetMetrics (list) –

    The list of fleet metrics objects.

    • (dict) –

      The name and ARN of a fleet metric.

      • metricName (string) –

        The fleet metric name.

      • metricArn (string) –

        The fleet metric ARN.

  • NextToken (string) –

    A token to resume pagination.