/AWS1/IF_IOT=>LISTMETRICVALUES()

About ListMetricValues

Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric) by the given thing during the specified time period.

Method Signature

METHODS /AWS1/IF_IOT~LISTMETRICVALUES
  IMPORTING
    !IV_THINGNAME TYPE /AWS1/IOTDEVDEFENDERTHINGNAME OPTIONAL
    !IV_METRICNAME TYPE /AWS1/IOTBEHAVIORMETRIC OPTIONAL
    !IV_DIMENSIONNAME TYPE /AWS1/IOTDIMENSIONNAME OPTIONAL
    !IV_DIMENSIONVALUEOPERATOR TYPE /AWS1/IOTDIMENSIONVALUEOP OPTIONAL
    !IV_STARTTIME TYPE /AWS1/IOTTIMESTAMP OPTIONAL
    !IV_ENDTIME TYPE /AWS1/IOTTIMESTAMP OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/IOTMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/IOTNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iotlistmetricvalsrsp
  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_thingname TYPE /AWS1/IOTDEVDEFENDERTHINGNAME /AWS1/IOTDEVDEFENDERTHINGNAME

The name of the thing for which security profile metric values are returned.

iv_metricname TYPE /AWS1/IOTBEHAVIORMETRIC /AWS1/IOTBEHAVIORMETRIC

The name of the security profile metric for which values are returned.

iv_starttime TYPE /AWS1/IOTTIMESTAMP /AWS1/IOTTIMESTAMP

The start of the time period for which metric values are returned.

iv_endtime TYPE /AWS1/IOTTIMESTAMP /AWS1/IOTTIMESTAMP

The end of the time period for which metric values are returned.

Optional arguments:

iv_dimensionname TYPE /AWS1/IOTDIMENSIONNAME /AWS1/IOTDIMENSIONNAME

The dimension name.

iv_dimensionvalueoperator TYPE /AWS1/IOTDIMENSIONVALUEOP /AWS1/IOTDIMENSIONVALUEOP

The dimension value operator.

iv_maxresults TYPE /AWS1/IOTMAXRESULTS /AWS1/IOTMAXRESULTS

The maximum number of results to return at one time.

iv_nexttoken TYPE /AWS1/IOTNEXTTOKEN /AWS1/IOTNEXTTOKEN

The token for the next set of results.

RETURNING

oo_output TYPE REF TO /aws1/cl_iotlistmetricvalsrsp /AWS1/CL_IOTLISTMETRICVALSRSP

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

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->listmetricvalues(
  iv_dimensionname = |string|
  iv_dimensionvalueoperator = |string|
  iv_endtime = '20150101000000.0000000'
  iv_maxresults = 123
  iv_metricname = |string|
  iv_nexttoken = |string|
  iv_starttime = '20150101000000.0000000'
  iv_thingname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_metricdatumlist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_timestamp = lo_row_1->get_timestamp( ).
      lo_metricvalue = lo_row_1->get_value( ).
      IF lo_metricvalue IS NOT INITIAL.
        lv_unsignedlong = lo_metricvalue->get_count( ).
        LOOP AT lo_metricvalue->get_cidrs( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_cidr = lo_row_3->get_value( ).
          ENDIF.
        ENDLOOP.
        LOOP AT lo_metricvalue->get_ports( ) into lo_row_4.
          lo_row_5 = lo_row_4.
          IF lo_row_5 IS NOT INITIAL.
            lv_port = lo_row_5->get_value( ).
          ENDIF.
        ENDLOOP.
        lv_number = lo_metricvalue->get_number( ).
        LOOP AT lo_metricvalue->get_numbers( ) into lo_row_6.
          lo_row_7 = lo_row_6.
          IF lo_row_7 IS NOT INITIAL.
            lv_number = lo_row_7->get_value( ).
          ENDIF.
        ENDLOOP.
        LOOP AT lo_metricvalue->get_strings( ) into lo_row_8.
          lo_row_9 = lo_row_8.
          IF lo_row_9 IS NOT INITIAL.
            lv_stringvalue = lo_row_9->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.