Skip to content

/AWS1/IF_EMR=>LISTSESSIONS()

About ListSessions

Lists the sessions on a cluster. You can filter the results by session state. Newer sessions are returned first.

Method Signature

METHODS /AWS1/IF_EMR~LISTSESSIONS
  IMPORTING
    !IV_CLUSTERID TYPE /AWS1/EMRCLUSTERID OPTIONAL
    !IT_SESSIONSTATES TYPE /AWS1/CL_EMRSESSIONSTATELIST_W=>TT_SESSIONSTATELIST OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/EMRSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/EMRMAXRESULTSNUMBER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_emrlistsessionsoutput
  RAISING
    /AWS1/CX_EMRINTERNALSERVEREX
    /AWS1/CX_EMRINVALIDREQUESTEX
    /AWS1/CX_EMRCLIENTEXC
    /AWS1/CX_EMRSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_clusterid TYPE /AWS1/EMRCLUSTERID /AWS1/EMRCLUSTERID

The ID of the cluster to list sessions for.

Optional arguments:

it_sessionstates TYPE /AWS1/CL_EMRSESSIONSTATELIST_W=>TT_SESSIONSTATELIST TT_SESSIONSTATELIST

An optional filter that limits the results to sessions in the specified states.

iv_nexttoken TYPE /AWS1/EMRSTRING /AWS1/EMRSTRING

The pagination token returned by a previous ListSessions call. Use it to retrieve the next page of results.

iv_maxresults TYPE /AWS1/EMRMAXRESULTSNUMBER /AWS1/EMRMAXRESULTSNUMBER

The maximum number of sessions to return in each page of results.

RETURNING

oo_output TYPE REF TO /aws1/cl_emrlistsessionsoutput /AWS1/CL_EMRLISTSESSIONSOUTPUT

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->listsessions(
  it_sessionstates = VALUE /aws1/cl_emrsessionstatelist_w=>tt_sessionstatelist(
    ( new /aws1/cl_emrsessionstatelist_w( |string| ) )
  )
  iv_clusterid = |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_sessions( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_sessionid = lo_row_1->get_id( ).
      lv_clusterid = lo_row_1->get_clusterid( ).
      lv_xmlstringmaxlen256 = lo_row_1->get_name( ).
      lv_arntype = lo_row_1->get_arn( ).
      lv_sessionstate = lo_row_1->get_state( ).
      lv_xmlstring = lo_row_1->get_statechangereason( ).
      lv_xmlstringmaxlen256 = lo_row_1->get_releaselabel( ).
      lv_iamrolearn = lo_row_1->get_executionrolearn( ).
      lv_xmlstringmaxlen256 = lo_row_1->get_accountid( ).
      lv_date = lo_row_1->get_createdat( ).
      lv_date = lo_row_1->get_updatedat( ).
      lv_date = lo_row_1->get_startedat( ).
      lv_date = lo_row_1->get_endedat( ).
      lv_date = lo_row_1->get_idlesince( ).
      LOOP AT lo_row_1->get_engineconfigurations( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_classification( ).
          LOOP AT lo_row_3->get_configurations( ) into lo_row_4.
            lo_row_5 = lo_row_4.
            IF lo_row_5 IS NOT INITIAL.
              lv_string = lo_row_5->get_classification( ).
              " Skipping lo_row_4 to avoid recursion
              LOOP AT lo_row_5->get_properties( ) into ls_row_6.
                lv_key = ls_row_6-key.
                lo_value = ls_row_6-value.
                IF lo_value IS NOT INITIAL.
                  lv_string = lo_value->get_value( ).
                ENDIF.
              ENDLOOP.
            ENDIF.
          ENDLOOP.
          LOOP AT lo_row_3->get_properties( ) into ls_row_6.
            lv_key = ls_row_6-key.
            lo_value = ls_row_6-value.
            IF lo_value IS NOT INITIAL.
              lv_string = lo_value->get_value( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
      lo_sessionmonitoringconfig = lo_row_1->get_monitoringconfiguration( ).
      IF lo_sessionmonitoringconfig IS NOT INITIAL.
        lo_sessioncloudwatchloggin = lo_sessionmonitoringconfig->get_cloudwatchloggingconf( ).
        IF lo_sessioncloudwatchloggin IS NOT INITIAL.
          lv_boolean = lo_sessioncloudwatchloggin->get_enabled( ).
          lv_xmlstring = lo_sessioncloudwatchloggin->get_loggroup( ).
          lv_xmlstring = lo_sessioncloudwatchloggin->get_logstreamnameprefix( ).
          lv_xmlstring = lo_sessioncloudwatchloggin->get_encryptionkeyarn( ).
          LOOP AT lo_sessioncloudwatchloggin->get_logtypes( ) into ls_row_7.
            lv_key_1 = ls_row_7-key.
            LOOP AT ls_row_7-value into lo_row_8.
              lo_row_9 = lo_row_8.
              IF lo_row_9 IS NOT INITIAL.
                lv_xmlstring = lo_row_9->get_value( ).
              ENDIF.
            ENDLOOP.
          ENDLOOP.
        ENDIF.
        lo_sessionmanagedloggingco = lo_sessionmonitoringconfig->get_managedloggingconf( ).
        IF lo_sessionmanagedloggingco IS NOT INITIAL.
          lv_boolean = lo_sessionmanagedloggingco->get_enabled( ).
          lv_xmlstring = lo_sessionmanagedloggingco->get_encryptionkeyarn( ).
        ENDIF.
        lo_sessions3loggingconfigu = lo_sessionmonitoringconfig->get_s3loggingconfiguration( ).
        IF lo_sessions3loggingconfigu IS NOT INITIAL.
          lv_boolean = lo_sessions3loggingconfigu->get_enabled( ).
          lv_xmlstring = lo_sessions3loggingconfigu->get_loguri( ).
          lv_xmlstring = lo_sessions3loggingconfigu->get_encryptionkeyarn( ).
          LOOP AT lo_sessions3loggingconfigu->get_logtypes( ) into ls_row_7.
            lv_key_1 = ls_row_7-key.
            LOOP AT ls_row_7-value into lo_row_8.
              lo_row_9 = lo_row_8.
              IF lo_row_9 IS NOT INITIAL.
                lv_xmlstring = lo_row_9->get_value( ).
              ENDIF.
            ENDLOOP.
          ENDLOOP.
        ENDIF.
      ENDIF.
      lv_long = lo_row_1->get_sessionidletimeoutinmins( ).
      lo_certificateauthority = lo_row_1->get_certificateauthority( ).
      IF lo_certificateauthority IS NOT INITIAL.
        lv_xmlstring = lo_certificateauthority->get_certificatearn( ).
        lv_xmlstring = lo_certificateauthority->get_certificatedata( ).
      ENDIF.
      lv_xmlstring = lo_row_1->get_serverurl( ).
      LOOP AT lo_row_1->get_tags( ) into lo_row_10.
        lo_row_11 = lo_row_10.
        IF lo_row_11 IS NOT INITIAL.
          lv_string = lo_row_11->get_key( ).
          lv_string = lo_row_11->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.