Skip to content

/AWS1/IF_CWS=>LISTINSTRCONFIGURATIONS()

About ListInstrumentationConfigurations

Returns all active instrumentation configurations for a service and environment. SDKs use this operation to sync configurations and apply client-side filters locally.

Include the previous SyncedAt value to perform incremental syncs. When no changes are detected, the response sets Changed to false and omits configuration details.

Method Signature

METHODS /AWS1/IF_CWS~LISTINSTRCONFIGURATIONS
  IMPORTING
    !IV_SERVICE TYPE /AWS1/CWSSTRING OPTIONAL
    !IV_ENVIRONMENT TYPE /AWS1/CWSSTRING OPTIONAL
    !IV_INSTRUMENTATIONTYPE TYPE /AWS1/CWSINSTRUMENTATIONTYPE OPTIONAL
    !IV_SYNCEDAT TYPE /AWS1/CWSTIMESTAMP OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/CWSINTEGER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CWSNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cwsinstrconfspage
  RAISING
    /AWS1/CX_CWSRESOURCENOTFOUNDEX
    /AWS1/CX_CWSTHROTTLINGEX
    /AWS1/CX_CWSVALIDATIONEX
    /AWS1/CX_CWSCLIENTEXC
    /AWS1/CX_CWSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_service TYPE /AWS1/CWSSTRING /AWS1/CWSSTRING

The name of the service to retrieve instrumentation configurations for.

iv_environment TYPE /AWS1/CWSSTRING /AWS1/CWSSTRING

The environment that the service is running in.

iv_instrumentationtype TYPE /AWS1/CWSINSTRUMENTATIONTYPE /AWS1/CWSINSTRUMENTATIONTYPE

Type of instrumentation configuration (BREAKPOINT or PROBE). Required to determine which backing store to query.

Optional arguments:

iv_syncedat TYPE /AWS1/CWSTIMESTAMP /AWS1/CWSTIMESTAMP

The timestamp from the last successful sync. When provided, the response returns Changed as false if nothing is new since this time, or returns the latest configurations when changes exist.

iv_maxresults TYPE /AWS1/CWSINTEGER /AWS1/CWSINTEGER

The maximum number of configurations to return in one call. The default is 50 and the maximum is 100.

iv_nexttoken TYPE /AWS1/CWSNEXTTOKEN /AWS1/CWSNEXTTOKEN

Use the token returned by a previous call to retrieve the next page of configurations.

RETURNING

oo_output TYPE REF TO /aws1/cl_cwsinstrconfspage /AWS1/CL_CWSINSTRCONFSPAGE

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->listinstrconfigurations(
  iv_environment = |string|
  iv_instrumentationtype = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_service = |string|
  iv_syncedat = '20150101000000.0000000'
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_service( ).
  lv_string = lo_result->get_environment( ).
  lv_boolean = lo_result->get_changed( ).
  LOOP AT lo_result->get_latestconfigurations( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_instrumentationtype = lo_row_1->get_instrumentationtype( ).
      lv_dynamicinstrumentations = lo_row_1->get_signaltype( ).
      lo_location = lo_row_1->get_location( ).
      IF lo_location IS NOT INITIAL.
        lo_codelocation = lo_location->get_codelocation( ).
        IF lo_codelocation IS NOT INITIAL.
          lv_programminglanguage = lo_codelocation->get_language( ).
          lv_string = lo_codelocation->get_codeunit( ).
          lv_string = lo_codelocation->get_classname( ).
          lv_string = lo_codelocation->get_methodname( ).
          lv_string = lo_codelocation->get_filepath( ).
          lv_integer = lo_codelocation->get_linenumber( ).
        ENDIF.
      ENDIF.
      lv_string = lo_row_1->get_locationhash( ).
      lv_string = lo_row_1->get_description( ).
      lv_timestamp = lo_row_1->get_expiresat( ).
      LOOP AT lo_row_1->get_attributefilters( ) into lt_row_2.
        LOOP AT lt_row_2 into ls_row_3.
          lv_key = ls_row_3-key.
          lo_value = ls_row_3-value.
          IF lo_value IS NOT INITIAL.
            lv_string = lo_value->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDLOOP.
      lo_captureconfiguration = lo_row_1->get_captureconfiguration( ).
      IF lo_captureconfiguration IS NOT INITIAL.
        lo_codecaptureconfiguratio = lo_captureconfiguration->get_codecapture( ).
        IF lo_codecaptureconfiguratio IS NOT INITIAL.
          LOOP AT lo_codecaptureconfiguratio->get_capturearguments( ) into lo_row_4.
            lo_row_5 = lo_row_4.
            IF lo_row_5 IS NOT INITIAL.
              lv_string = lo_row_5->get_value( ).
            ENDIF.
          ENDLOOP.
          lv_boolean = lo_codecaptureconfiguratio->get_capturereturn( ).
          lv_boolean = lo_codecaptureconfiguratio->get_capturestacktrace( ).
          LOOP AT lo_codecaptureconfiguratio->get_capturelocals( ) into lo_row_4.
            lo_row_5 = lo_row_4.
            IF lo_row_5 IS NOT INITIAL.
              lv_string = lo_row_5->get_value( ).
            ENDIF.
          ENDLOOP.
          lo_capturelimitsconfig = lo_codecaptureconfiguratio->get_capturelimits( ).
          IF lo_capturelimitsconfig IS NOT INITIAL.
            lv_integer = lo_capturelimitsconfig->get_maxhits( ).
            lv_integer = lo_capturelimitsconfig->get_maxstringlength( ).
            lv_integer = lo_capturelimitsconfig->get_maxcollectionwidth( ).
            lv_integer = lo_capturelimitsconfig->get_maxcollectiondepth( ).
            lv_integer = lo_capturelimitsconfig->get_maxstackframes( ).
            lv_integer = lo_capturelimitsconfig->get_maxstacktracesize( ).
            lv_integer = lo_capturelimitsconfig->get_maxobjectdepth( ).
            lv_integer = lo_capturelimitsconfig->get_maxfieldsperobject( ).
          ENDIF.
        ENDIF.
      ENDIF.
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_instrumentationconfigur = lo_row_1->get_arn( ).
    ENDIF.
  ENDLOOP.
  lv_timestamp = lo_result->get_syncedat( ).
  lv_integer = lo_result->get_syncinterval( ).
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.