@aws-sdk/client-iot

CreateCustomMetricCommandInput Interface

Members

Name
Type
Details
metricName Requiredstring | undefined

The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can't begin with aws:. You can't change the name after you define it.

metricType RequiredCustomMetricType | undefined

The type of the custom metric.

The type number only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.

clientRequestToken string | undefined

Each custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

displayName string | undefined

The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.

tags Tag[] | undefined

Metadata that can be used to manage the custom metric.

Full Signature

export interface CreateCustomMetricCommandInput extends CreateCustomMetricRequest