IoT / Client / list_fleet_metrics

list_fleet_metrics#

IoT.Client.list_fleet_metrics(**kwargs)#

Lists all your fleet metrics.

Requires permission to access the ListFleetMetrics action.

See also: AWS API Documentation

Request Syntax

response = client.list_fleet_metrics(
    nextToken='string',
    maxResults=123
)
Parameters:

  • nextToken (string) – To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

  • maxResults (integer) – The maximum number of results to return in this operation.

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) –

      The token for the next set of results. Will not be returned if the operation has returned all results.

Exceptions