Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iot ]



Deletes a Device Defender detect custom metric.

Requires permission to access the DeleteCustomMetric action.


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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--metric-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--metric-name (string)

The name of the custom metric.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


To delete a custom metric

The following delete-custom-metric example deletes a custom metric.

aws iot delete-custom-metric \
    --metric-name batteryPercentage \
    --region us-east-1


HTTP 200

For more information, see Custom metrics in the AWS IoT Core Developer Guide.