Skip to content

/AWS1/IF_SGM=>LISTTRAININGSESSIONS()

About ListTrainingSessions

Lists training sessions in your account. You can filter results by creation time, name, and status. The operation paginates results. To retrieve additional results, use the NextToken parameter.

The following operations are related to ListTrainingSessions:

  • CreateTrainingSession

  • DescribeTrainingSession

Method Signature

METHODS /AWS1/IF_SGM~LISTTRAININGSESSIONS
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/SGMNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SGMMAXRESULTS OPTIONAL
    !IV_CREATIONTIMEAFTER TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_CREATIONTIMEBEFORE TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_NAMECONTAINS TYPE /AWS1/SGMNAMECONTAINS OPTIONAL
    !IV_STATUSEQUALS TYPE /AWS1/SGMTRAININGSESSIONSTATUS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmlisttrnsessrsp
  RAISING
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_nexttoken TYPE /AWS1/SGMNEXTTOKEN /AWS1/SGMNEXTTOKEN

If the response was truncated, use the token returned in the previous response to retrieve the next page of results.

iv_maxresults TYPE /AWS1/SGMMAXRESULTS /AWS1/SGMMAXRESULTS

The maximum number of training sessions to return in the response.

iv_creationtimeafter TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A filter that returns only training sessions created after the specified time.

iv_creationtimebefore TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A filter that returns only training sessions created before the specified time.

iv_namecontains TYPE /AWS1/SGMNAMECONTAINS /AWS1/SGMNAMECONTAINS

A string in the training session name to filter results. Only sessions whose name contains the specified string are returned.

iv_statusequals TYPE /AWS1/SGMTRAININGSESSIONSTATUS /AWS1/SGMTRAININGSESSIONSTATUS

A filter that returns only training sessions with the specified status.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmlisttrnsessrsp /AWS1/CL_SGMLISTTRNSESSRSP

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->listtrainingsessions(
  iv_creationtimeafter = '20150101000000.0000000'
  iv_creationtimebefore = '20150101000000.0000000'
  iv_maxresults = 123
  iv_namecontains = |string|
  iv_nexttoken = |string|
  iv_statusequals = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_nexttoken = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_trainingsessionsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_trainingsessionarn = lo_row_1->get_trainingsessionarn( ).
      lv_trainingsessionstatus = lo_row_1->get_trainingsessionstatus( ).
      lv_timestamp = lo_row_1->get_creationtime( ).
      lv_timestamp = lo_row_1->get_lastmodifiedtime( ).
    ENDIF.
  ENDLOOP.
ENDIF.