[ aws . iot ]

update-custom-metric

Description

Updates a Device Defender detect custom metric.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-custom-metric
--metric-name <value>
--display-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--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 | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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.

Output

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. Types include string-list , ip-address-list , number-list , and number .

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.