IoT / Client / delete_custom_metric

delete_custom_metric¶

IoT.Client.delete_custom_metric(**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.

Deletes a Device Defender detect custom metric.

Requires permission to access the DeleteCustomMetric action.

Note

Before you can delete a custom metric, you must first remove the custom metric from all security profiles it’s a part of. The security profile associated with the custom metric can be found using the ListSecurityProfiles API with metricName set to your custom metric name.

Request Syntax

response = client.delete_custom_metric(
    metricName='string'
)

Parameters:

metricName (string) –

[REQUIRED]

The name of the custom metric.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

Exceptions

IoT.Client.exceptions.InvalidRequestException
IoT.Client.exceptions.ThrottlingException
IoT.Client.exceptions.InternalFailureException