DESCRIBECUSTOMMETRIC()`¶

About DescribeCustomMetric¶

The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature, sign up prior to August 31, 2026. To learn about alternatives to IoT Device Defender detect, see IoT Device Defender detect feature availability change in the IoT Device Defender Developer Guide. There is no change to IoT Device Defender audit availability.

Gets information about a Device Defender detect custom metric.

Requires permission to access the DescribeCustomMetric action.

Method Signature¶

METHODS /AWS1/IF_IOT~DESCRIBECUSTOMMETRIC
  IMPORTING
    !IV_METRICNAME TYPE /AWS1/IOTMETRICNAME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iotdescrcustmetricrsp
  RAISING
    /AWS1/CX_IOTINTERNALFAILUREEX
    /AWS1/CX_IOTINVALIDREQUESTEX
    /AWS1/CX_IOTRESOURCENOTFOUNDEX
    /AWS1/CX_IOTTHROTTLINGEX
    /AWS1/CX_IOTCLIENTEXC
    /AWS1/CX_IOTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_metricname` `TYPE /AWS1/IOTMETRICNAME` `/AWS1/IOTMETRICNAME`¶

The name of the custom metric.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_iotdescrcustmetricrsp` `/AWS1/CL_IOTDESCRCUSTMETRICRSP`¶

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->describecustommetric( |string| ).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_metricname = lo_result->get_metricname( ).
  lv_custommetricarn = lo_result->get_metricarn( ).
  lv_custommetrictype = lo_result->get_metrictype( ).
  lv_custommetricdisplayname = lo_result->get_displayname( ).
  lv_timestamp = lo_result->get_creationdate( ).
  lv_timestamp = lo_result->get_lastmodifieddate( ).
ENDIF.

/AWS1/IF_IOT=>DESCRIBECUSTOMMETRIC()¶