Skip to content

/AWS1/CL_IOTDESCRCUSTMETRICRSP

DescribeCustomMetricResponse

CONSTRUCTOR

IMPORTING

Optional arguments:

IV_METRICNAME TYPE /AWS1/IOTMETRICNAME /AWS1/IOTMETRICNAME

The name of the custom metric.

IV_METRICARN TYPE /AWS1/IOTCUSTOMMETRICARN /AWS1/IOTCUSTOMMETRICARN

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

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 while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.

IV_DISPLAYNAME TYPE /AWS1/IOTCUSTOMMETRICDSPNAME /AWS1/IOTCUSTOMMETRICDSPNAME

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

IV_CREATIONDATE TYPE /AWS1/IOTTIMESTAMP /AWS1/IOTTIMESTAMP

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

IV_LASTMODIFIEDDATE TYPE /AWS1/IOTTIMESTAMP /AWS1/IOTTIMESTAMP

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


Queryable Attributes

metricName

The name of the custom metric.

Accessible with the following methods

Method Description
GET_METRICNAME() Getter for METRICNAME, with configurable default
ASK_METRICNAME() Getter for METRICNAME w/ exceptions if field has no value
HAS_METRICNAME() Determine if METRICNAME has a value

metricArn

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

Accessible with the following methods

Method Description
GET_METRICARN() Getter for METRICARN, with configurable default
ASK_METRICARN() Getter for METRICARN w/ exceptions if field has no value
HAS_METRICARN() Determine if METRICARN has a value

metricType

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.

Accessible with the following methods

Method Description
GET_METRICTYPE() Getter for METRICTYPE, with configurable default
ASK_METRICTYPE() Getter for METRICTYPE w/ exceptions if field has no value
HAS_METRICTYPE() Determine if METRICTYPE has a value

displayName

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

Accessible with the following methods

Method Description
GET_DISPLAYNAME() Getter for DISPLAYNAME, with configurable default
ASK_DISPLAYNAME() Getter for DISPLAYNAME w/ exceptions if field has no value
HAS_DISPLAYNAME() Determine if DISPLAYNAME has a value

creationDate

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

Accessible with the following methods

Method Description
GET_CREATIONDATE() Getter for CREATIONDATE, with configurable default
ASK_CREATIONDATE() Getter for CREATIONDATE w/ exceptions if field has no value
HAS_CREATIONDATE() Determine if CREATIONDATE has a value

lastModifiedDate

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

Accessible with the following methods

Method Description
GET_LASTMODIFIEDDATE() Getter for LASTMODIFIEDDATE, with configurable default
ASK_LASTMODIFIEDDATE() Getter for LASTMODIFIEDDATE w/ exceptions if field has no va
HAS_LASTMODIFIEDDATE() Determine if LASTMODIFIEDDATE has a value