BATCHGETRUMMETRICDEFINITIONS()`¶

About BatchGetRumMetricDefinitions¶

Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination.

Method Signature¶

METHODS /AWS1/IF_RUM~BATCHGETRUMMETRICDEFINITIONS
  IMPORTING
    !IV_APPMONITORNAME TYPE /AWS1/RUMAPPMONITORNAME OPTIONAL
    !IV_DESTINATION TYPE /AWS1/RUMMETRICDESTINATION OPTIONAL
    !IV_DESTINATIONARN TYPE /AWS1/RUMDESTINATIONARN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/RUMMAXRESULTSINTEGER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/RUMSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_rumbtcgetrummetricd01
  RAISING
    /AWS1/CX_RUMACCESSDENIEDEX
    /AWS1/CX_RUMINTERNALSERVEREX
    /AWS1/CX_RUMRESOURCENOTFOUNDEX
    /AWS1/CX_RUMVALIDATIONEX
    /AWS1/CX_RUMCLIENTEXC
    /AWS1/CX_RUMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_appmonitorname` `TYPE /AWS1/RUMAPPMONITORNAME` `/AWS1/RUMAPPMONITORNAME`¶

The name of the CloudWatch RUM app monitor that is sending the metrics.

`iv_destination` `TYPE /AWS1/RUMMETRICDESTINATION` `/AWS1/RUMMETRICDESTINATION`¶

The type of destination that you want to view metrics for. Valid values are CloudWatch and Evidently.

Optional arguments:¶

`iv_destinationarn` `TYPE /AWS1/RUMDESTINATIONARN` `/AWS1/RUMDESTINATIONARN`¶

This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.

This parameter specifies the ARN of the Evidently experiment that corresponds to the destination.

`iv_maxresults` `TYPE /AWS1/RUMMAXRESULTSINTEGER` `/AWS1/RUMMAXRESULTSINTEGER`¶

The maximum number of results to return in one operation. The default is 50. The maximum that you can specify is 100.

To retrieve the remaining results, make another call with the returned NextToken value.

`iv_nexttoken` `TYPE /AWS1/RUMSTRING` `/AWS1/RUMSTRING`¶

Use the token returned by the previous operation to request the next page of results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_rumbtcgetrummetricd01` `/AWS1/CL_RUMBTCGETRUMMETRICD01`¶

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->batchgetrummetricdefinitions(
  iv_appmonitorname = |string|
  iv_destination = |string|
  iv_destinationarn = |string|
  iv_maxresults = 123
  iv_nexttoken = |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_metricdefinitions( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_metricdefinitionid = lo_row_1->get_metricdefinitionid( ).
      lv_metricname = lo_row_1->get_name( ).
      lv_valuekey = lo_row_1->get_valuekey( ).
      lv_unitlabel = lo_row_1->get_unitlabel( ).
      LOOP AT lo_row_1->get_dimensionkeys( ) into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_dimensionname = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_eventpattern = lo_row_1->get_eventpattern( ).
      lv_namespace = lo_row_1->get_namespace( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_RUM=>BATCHGETRUMMETRICDEFINITIONS()¶