Skip to content

/AWS1/IF_SGM=>LISTAPPS()

About ListApps

Lists apps.

Method Signature

METHODS /AWS1/IF_SGM~LISTAPPS
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/SGMNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SGMMAXRESULTS OPTIONAL
    !IV_SORTORDER TYPE /AWS1/SGMSORTORDER OPTIONAL
    !IV_SORTBY TYPE /AWS1/SGMAPPSORTKEY OPTIONAL
    !IV_DOMAINIDEQUALS TYPE /AWS1/SGMDOMAINID OPTIONAL
    !IV_USERPROFILENAMEEQUALS TYPE /AWS1/SGMUSERPROFILENAME OPTIONAL
    !IV_SPACENAMEEQUALS TYPE /AWS1/SGMSPACENAME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmlistappsresponse
  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 previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

iv_maxresults TYPE /AWS1/SGMMAXRESULTS /AWS1/SGMMAXRESULTS

This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

iv_sortorder TYPE /AWS1/SGMSORTORDER /AWS1/SGMSORTORDER

The sort order for the results. The default is Ascending.

iv_sortby TYPE /AWS1/SGMAPPSORTKEY /AWS1/SGMAPPSORTKEY

The parameter by which to sort the results. The default is CreationTime.

iv_domainidequals TYPE /AWS1/SGMDOMAINID /AWS1/SGMDOMAINID

A parameter to search for the domain ID.

iv_userprofilenameequals TYPE /AWS1/SGMUSERPROFILENAME /AWS1/SGMUSERPROFILENAME

A parameter to search by user profile name. If SpaceNameEquals is set, then this value cannot be set.

iv_spacenameequals TYPE /AWS1/SGMSPACENAME /AWS1/SGMSPACENAME

A parameter to search by space name. If UserProfileNameEquals is set, then this value cannot be set.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmlistappsresponse /AWS1/CL_SGMLISTAPPSRESPONSE

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->listapps(
  iv_domainidequals = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_sortby = |string|
  iv_sortorder = |string|
  iv_spacenameequals = |string|
  iv_userprofilenameequals = |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_apps( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_domainid = lo_row_1->get_domainid( ).
      lv_userprofilename = lo_row_1->get_userprofilename( ).
      lv_spacename = lo_row_1->get_spacename( ).
      lv_apptype = lo_row_1->get_apptype( ).
      lv_appname = lo_row_1->get_appname( ).
      lv_appstatus = lo_row_1->get_status( ).
      lv_creationtime = lo_row_1->get_creationtime( ).
      lo_resourcespec = lo_row_1->get_resourcespec( ).
      IF lo_resourcespec IS NOT INITIAL.
        lv_imagearn = lo_resourcespec->get_sagemakerimagearn( ).
        lv_imageversionarn = lo_resourcespec->get_sagemakerimageversionarn( ).
        lv_imageversionalias = lo_resourcespec->get_smimageversionalias( ).
        lv_appinstancetype = lo_resourcespec->get_instancetype( ).
        lv_studiolifecycleconfigar = lo_resourcespec->get_lifecycleconfigarn( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.