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 ]



Updates a Device Defender detect custom metric.

Requires permission to access the UpdateCustomMetric action.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


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


--metric-name (string)

The name of the custom metric. Cannot be updated.

--display-name (string)

Field represents a friendly name in the console for the custom metric, it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated.

--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 update a custom metric

The following update-custom-metric example updates a custom metric to have a new display-name.

aws iot update-custom-metric \
    --metric-name batteryPercentage \
    --display-name 'remaining battery percentage on device' \
    --region us-east-1


    "metricName": "batteryPercentage",
    "metricArn": "arn:aws:iot:us-east-1:1234564789012:custommetric/batteryPercentage",
    "metricType": "number",
    "displayName": "remaining battery percentage on device",
    "creationDate": "2020-11-17T23:01:35.110000-08:00",
    "lastModifiedDate": "2020-11-17T23:02:12.879000-08:00"

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


metricName -> (string)

The name of the custom metric.

metricArn -> (string)

The Amazon Resource Number (ARN) of the custom metric.

metricType -> (string)

The type of the custom metric.


The type number only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.

displayName -> (string)

A friendly name in the console for the custom metric

creationDate -> (timestamp)

The creation date of the custom metric in milliseconds since epoch.

lastModifiedDate -> (timestamp)

The time the custom metric was last modified in milliseconds since epoch.