LISTPROFILINGGROUPS()`¶

About ListProfilingGroups¶

Returns a list of profiling groups. The profiling groups are returned as ProfilingGroupDescription objects.

Method Signature¶

METHODS /AWS1/IF_GUP~LISTPROFILINGGROUPS
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/GUPPAGINATIONTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/GUPMAXRESULTS OPTIONAL
    !IV_INCLUDEDESCRIPTION TYPE /AWS1/GUPBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_guplstprofilinggrsrsp
  RAISING
    /AWS1/CX_GUPINTERNALSERVEREX
    /AWS1/CX_GUPTHROTTLINGEX
    /AWS1/CX_GUPCLIENTEXC
    /AWS1/CX_GUPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/GUPPAGINATIONTOKEN` `/AWS1/GUPPAGINATIONTOKEN`¶

The nextToken value returned from a previous paginated ListProfilingGroups request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

`iv_maxresults` `TYPE /AWS1/GUPMAXRESULTS` `/AWS1/GUPMAXRESULTS`¶

The maximum number of profiling groups results returned by ListProfilingGroups in paginated output. When this parameter is used, ListProfilingGroups only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListProfilingGroups request with the returned nextToken value.

`iv_includedescription` `TYPE /AWS1/GUPBOOLEAN` `/AWS1/GUPBOOLEAN`¶

A Boolean value indicating whether to include a description. If true, then a list of ProfilingGroupDescription objects that contain detailed information about profiling groups is returned. If false, then a list of profiling group names is returned.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_guplstprofilinggrsrsp` `/AWS1/CL_GUPLSTPROFILINGGRSRSP`¶

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->listprofilinggroups(
  iv_includedescription = ABAP_TRUE
  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_profilinggroupnames( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_profilinggroupname = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_profilinggroups( ) into lo_row_2.
    lo_row_3 = lo_row_2.
    IF lo_row_3 IS NOT INITIAL.
      lv_profilinggroupname = lo_row_3->get_name( ).
      lo_agentorchestrationconfi = lo_row_3->get_agentorchestrationconfig( ).
      IF lo_agentorchestrationconfi IS NOT INITIAL.
        lv_boolean = lo_agentorchestrationconfi->get_profilingenabled( ).
      ENDIF.
      lv_profilinggrouparn = lo_row_3->get_arn( ).
      lv_timestamp = lo_row_3->get_createdat( ).
      lv_timestamp = lo_row_3->get_updatedat( ).
      lo_profilingstatus = lo_row_3->get_profilingstatus( ).
      IF lo_profilingstatus IS NOT INITIAL.
        lv_timestamp = lo_profilingstatus->get_latestagentpflreportedat( ).
        lo_aggregatedprofiletime = lo_profilingstatus->get_latestaggregatedprofile( ).
        IF lo_aggregatedprofiletime IS NOT INITIAL.
          lv_timestamp = lo_aggregatedprofiletime->get_start( ).
          lv_aggregationperiod = lo_aggregatedprofiletime->get_period( ).
        ENDIF.
        lv_timestamp = lo_profilingstatus->get_latstagentorchestratedat( ).
      ENDIF.
      lv_computeplatform = lo_row_3->get_computeplatform( ).
      LOOP AT lo_row_3->get_tags( ) into ls_row_4.
        lv_key = ls_row_4-key.
        lo_value = ls_row_4-value.
        IF lo_value IS NOT INITIAL.
          lv_string = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_GUP=>LISTPROFILINGGROUPS()¶