DeleteCustomMetric
Note
The Amazon 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 Amazon IoT Device Defender detect, see Amazon IoT Device Defender detect feature availability change. There is no change to Amazon 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
DELETE /custom-metric/metricName HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- metricName
-
The name of the custom metric.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9:_-]+Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
- InternalFailureException
-
An unexpected error has occurred.
- message
-
The message for the exception.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
- message
-
The message for the exception.
HTTP Status Code: 400
- ThrottlingException
-
The rate exceeds the limit.
- message
-
The message for the exception.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: