Skip to content

/AWS1/CL_IOT=>CREATECUSTOMMETRIC()

About CreateCustomMetric

Use this API to define a Custom Metric published by your devices to Device Defender.

Requires permission to access the CreateCustomMetric action.

Method Signature

IMPORTING

Required arguments:

IV_METRICNAME TYPE /AWS1/IOTMETRICNAME /AWS1/IOTMETRICNAME

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.

IV_METRICTYPE TYPE /AWS1/IOTCUSTOMMETRICTYPE /AWS1/IOTCUSTOMMETRICTYPE

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.

IV_CLIENTREQUESTTOKEN TYPE /AWS1/IOTCLIENTREQUESTTOKEN /AWS1/IOTCLIENTREQUESTTOKEN

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.

Optional arguments:

IV_DISPLAYNAME TYPE /AWS1/IOTCUSTOMMETRICDSPNAME /AWS1/IOTCUSTOMMETRICDSPNAME

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.

IT_TAGS TYPE /AWS1/CL_IOTTAG=>TT_TAGLIST TT_TAGLIST

Metadata that can be used to manage the custom metric.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_IOTCRECUSTMETRICRSP /AWS1/CL_IOTCRECUSTMETRICRSP