Skip to content

/AWS1/IF_CUS=>LISTRECOMMENDERS()

About ListRecommenders

Returns a list of recommenders in the specified domain.

Method Signature

METHODS /AWS1/IF_CUS~LISTRECOMMENDERS
  IMPORTING
    !IV_DOMAINNAME TYPE /AWS1/CUSNAME OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/CUSLSTRECOMMENDERSREQM00 OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CUSTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cuslstrecommendersrsp
  RAISING
    /AWS1/CX_CUSACCESSDENIEDEX
    /AWS1/CX_CUSBADREQUESTEX
    /AWS1/CX_CUSINTERNALSERVEREX
    /AWS1/CX_CUSRESOURCENOTFOUNDEX
    /AWS1/CX_CUSTHROTTLINGEX
    /AWS1/CX_CUSCLIENTEXC
    /AWS1/CX_CUSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_domainname TYPE /AWS1/CUSNAME /AWS1/CUSNAME

The unique name of the domain.

Optional arguments:

iv_maxresults TYPE /AWS1/CUSLSTRECOMMENDERSREQM00 /AWS1/CUSLSTRECOMMENDERSREQM00

The maximum number of recommenders to return in the response. The default value is 100.

iv_nexttoken TYPE /AWS1/CUSTOKEN /AWS1/CUSTOKEN

A token received from a previous ListRecommenders call to retrieve the next page of results.

RETURNING

oo_output TYPE REF TO /aws1/cl_cuslstrecommendersrsp /AWS1/CL_CUSLSTRECOMMENDERSRSP

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->listrecommenders(
  iv_domainname = |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.
  lv_token = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_recommenders( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_name = lo_row_1->get_recommendername( ).
      lv_recommenderrecipename = lo_row_1->get_recipename( ).
      lo_recommenderconfig = lo_row_1->get_recommenderconfig( ).
      IF lo_recommenderconfig IS NOT INITIAL.
        lo_eventsconfig = lo_recommenderconfig->get_eventsconfig( ).
        IF lo_eventsconfig IS NOT INITIAL.
          LOOP AT lo_eventsconfig->get_eventparameterslist( ) into lo_row_2.
            lo_row_3 = lo_row_2.
            IF lo_row_3 IS NOT INITIAL.
              lv_eventparameterseventtyp = lo_row_3->get_eventtype( ).
              lv_double = lo_row_3->get_eventvaluethreshold( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
        lv_recommenderconfigtraini = lo_recommenderconfig->get_trainingfrequency( ).
      ENDIF.
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_sensitivetext = lo_row_1->get_description( ).
      lv_recommenderstatus = lo_row_1->get_status( ).
      lv_timestamp = lo_row_1->get_lastupdatedat( ).
      LOOP AT lo_row_1->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_tagvalue = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_row_1->get_failurereason( ).
      lo_recommenderupdate = lo_row_1->get_latestrecommenderupdate( ).
      IF lo_recommenderupdate IS NOT INITIAL.
        lo_recommenderconfig = lo_recommenderupdate->get_recommenderconfig( ).
        IF lo_recommenderconfig IS NOT INITIAL.
          lo_eventsconfig = lo_recommenderconfig->get_eventsconfig( ).
          IF lo_eventsconfig IS NOT INITIAL.
            LOOP AT lo_eventsconfig->get_eventparameterslist( ) into lo_row_2.
              lo_row_3 = lo_row_2.
              IF lo_row_3 IS NOT INITIAL.
                lv_eventparameterseventtyp = lo_row_3->get_eventtype( ).
                lv_double = lo_row_3->get_eventvaluethreshold( ).
              ENDIF.
            ENDLOOP.
          ENDIF.
          lv_recommenderconfigtraini = lo_recommenderconfig->get_trainingfrequency( ).
        ENDIF.
        lv_recommenderstatus = lo_recommenderupdate->get_status( ).
        lv_timestamp = lo_recommenderupdate->get_createdat( ).
        lv_timestamp = lo_recommenderupdate->get_lastupdatedat( ).
        lv_string = lo_recommenderupdate->get_failurereason( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
ENDIF.