IoT / Client / list_custom_metrics

list_custom_metrics#

IoT.Client.list_custom_metrics(**kwargs)#

Lists your Device Defender detect custom metrics.

Requires permission to access the ListCustomMetrics action.

See also: AWS API Documentation

Request Syntax

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

  • nextToken (string) – The token for the next set of results.

  • maxResults (integer) – The maximum number of results to return at one time. The default is 25.

Return type:

dict

Returns:

Response Syntax

{
    'metricNames': [
        'string',
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • metricNames (list) –

      The name of the custom metric.

      • (string) –

    • nextToken (string) –

      A token that can be used to retrieve the next set of results, or null if there are no additional results.

Exceptions

  • IoT.Client.exceptions.InvalidRequestException

  • IoT.Client.exceptions.ThrottlingException

  • IoT.Client.exceptions.InternalFailureException