IoT / Client / delete_custom_metric

delete_custom_metric¶

IoT.Client.delete_custom_metric(**kwargs)¶

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