IoT / Client / list_custom_metrics

list_custom_metrics

IoT.Client.list_custom_metrics(**kwargs)

Note

The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature, sign up prior to August 31, 2026. To learn about alternatives to IoT Device Defender detect, see IoT Device Defender detect feature availability change in the IoT Device Defender Developer Guide. There is no change to IoT Device Defender audit availability.

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