Skip to content

/AWS1/IF_EMS=>LISTSESSIONS()

About ListSessions

Lists sessions for the specified application. You can filter sessions by state and creation time.

Method Signature

METHODS /AWS1/IF_EMS~LISTSESSIONS
  IMPORTING
    !IV_APPLICATIONID TYPE /AWS1/EMSAPPLICATIONID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/EMSNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/EMSINTEGER OPTIONAL
    !IT_STATES TYPE /AWS1/CL_EMSSESSIONSTATESET_W=>TT_SESSIONSTATESET OPTIONAL
    !IV_CREATEDATAFTER TYPE /AWS1/EMSDATE OPTIONAL
    !IV_CREATEDATBEFORE TYPE /AWS1/EMSDATE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_emslistsessresponse
  RAISING
    /AWS1/CX_EMSINTERNALSERVEREX
    /AWS1/CX_EMSRESOURCENOTFOUNDEX
    /AWS1/CX_EMSVALIDATIONEX
    /AWS1/CX_EMSCLIENTEXC
    /AWS1/CX_EMSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_applicationid TYPE /AWS1/EMSAPPLICATIONID /AWS1/EMSAPPLICATIONID

The ID of the application to list sessions for.

Optional arguments:

iv_nexttoken TYPE /AWS1/EMSNEXTTOKEN /AWS1/EMSNEXTTOKEN

The token for the next set of session results.

iv_maxresults TYPE /AWS1/EMSINTEGER /AWS1/EMSINTEGER

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

it_states TYPE /AWS1/CL_EMSSESSIONSTATESET_W=>TT_SESSIONSTATESET TT_SESSIONSTATESET

An optional filter for session states. Note that if this filter contains multiple states, the resulting list will be grouped by the state.

iv_createdatafter TYPE /AWS1/EMSDATE /AWS1/EMSDATE

The lower bound of the option to filter by creation date and time.

iv_createdatbefore TYPE /AWS1/EMSDATE /AWS1/EMSDATE

The upper bound of the option to filter by creation date and time.

RETURNING

oo_output TYPE REF TO /aws1/cl_emslistsessresponse /AWS1/CL_EMSLISTSESSRESPONSE

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_states = VALUE /aws1/cl_emssessionstateset_w=>tt_sessionstateset(
    ( new /aws1/cl_emssessionstateset_w( |string| ) )
  )
  iv_applicationid = |string|
  iv_createdatafter = '20150101000000.0000000'
  iv_createdatbefore = '20150101000000.0000000'
  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_applicationid = lo_row_1->get_applicationid( ).
      lv_sessionid = lo_row_1->get_sessionid( ).
      lv_sessionarn = lo_row_1->get_arn( ).
      lv_string256 = lo_row_1->get_name( ).
      lv_sessionstate = lo_row_1->get_state( ).
      lv_string1024 = lo_row_1->get_statedetails( ).
      lv_releaselabel = lo_row_1->get_releaselabel( ).
      lv_iamrolearn = lo_row_1->get_executionrolearn( ).
      lv_requestidentityuserarn = lo_row_1->get_createdby( ).
      lv_date = lo_row_1->get_createdat( ).
      lv_date = lo_row_1->get_updatedat( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.