Skip to content

/AWS1/IF_SGM=>LISTNOTEBOOKINSTANCES()

About ListNotebookInstances

Returns a list of the SageMaker AI notebook instances in the requester's account in an Amazon Web Services Region.

Method Signature

METHODS /AWS1/IF_SGM~LISTNOTEBOOKINSTANCES
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/SGMNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SGMMAXRESULTS OPTIONAL
    !IV_SORTBY TYPE /AWS1/SGMNOTEBOOKINSTSORTKEY OPTIONAL
    !IV_SORTORDER TYPE /AWS1/SGMNOTEBOOKINSTSORTORDER OPTIONAL
    !IV_NAMECONTAINS TYPE /AWS1/SGMNOTEBOOKINSTNAMECON00 OPTIONAL
    !IV_CREATIONTIMEBEFORE TYPE /AWS1/SGMCREATIONTIME OPTIONAL
    !IV_CREATIONTIMEAFTER TYPE /AWS1/SGMCREATIONTIME OPTIONAL
    !IV_LASTMODIFIEDTIMEBEFORE TYPE /AWS1/SGMLASTMODIFIEDTIME OPTIONAL
    !IV_LASTMODIFIEDTIMEAFTER TYPE /AWS1/SGMLASTMODIFIEDTIME OPTIONAL
    !IV_STATUSEQUALS TYPE /AWS1/SGMNOTEBOOKINSTSTATUS OPTIONAL
    !IV_NOTEBOOKINSTLCCFGNAMECO00 TYPE /AWS1/SGMNOTEBOOKINSTLCCFGNAME OPTIONAL
    !IV_DEFCODEREPOSITORYCONTAINS TYPE /AWS1/SGMCODEREPOSITORYCONTA00 OPTIONAL
    !IV_ADDLCODEREPOSITORYEQUALS TYPE /AWS1/SGMCODEREPOSITORYNAMEO00 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmlstnotebookinsts01
  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 call to the ListNotebookInstances is truncated, the response includes a NextToken. You can use this token in your subsequent ListNotebookInstances request to fetch the next set of notebook instances.

You might specify a filter or a sort order in your request. When response is truncated, you must use the same values for the filer and sort order in the next request.

iv_maxresults TYPE /AWS1/SGMMAXRESULTS /AWS1/SGMMAXRESULTS

The maximum number of notebook instances to return.

iv_sortby TYPE /AWS1/SGMNOTEBOOKINSTSORTKEY /AWS1/SGMNOTEBOOKINSTSORTKEY

The field to sort results by. The default is Name.

iv_sortorder TYPE /AWS1/SGMNOTEBOOKINSTSORTORDER /AWS1/SGMNOTEBOOKINSTSORTORDER

The sort order for results.

iv_namecontains TYPE /AWS1/SGMNOTEBOOKINSTNAMECON00 /AWS1/SGMNOTEBOOKINSTNAMECON00

A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.

iv_creationtimebefore TYPE /AWS1/SGMCREATIONTIME /AWS1/SGMCREATIONTIME

A filter that returns only notebook instances that were created before the specified time (timestamp).

iv_creationtimeafter TYPE /AWS1/SGMCREATIONTIME /AWS1/SGMCREATIONTIME

A filter that returns only notebook instances that were created after the specified time (timestamp).

iv_lastmodifiedtimebefore TYPE /AWS1/SGMLASTMODIFIEDTIME /AWS1/SGMLASTMODIFIEDTIME

A filter that returns only notebook instances that were modified before the specified time (timestamp).

iv_lastmodifiedtimeafter TYPE /AWS1/SGMLASTMODIFIEDTIME /AWS1/SGMLASTMODIFIEDTIME

A filter that returns only notebook instances that were modified after the specified time (timestamp).

iv_statusequals TYPE /AWS1/SGMNOTEBOOKINSTSTATUS /AWS1/SGMNOTEBOOKINSTSTATUS

A filter that returns only notebook instances with the specified status.

iv_notebookinstlccfgnameco00 TYPE /AWS1/SGMNOTEBOOKINSTLCCFGNAME /AWS1/SGMNOTEBOOKINSTLCCFGNAME

A string in the name of a notebook instances lifecycle configuration associated with this notebook instance. This filter returns only notebook instances associated with a lifecycle configuration with a name that contains the specified string.

iv_defcoderepositorycontains TYPE /AWS1/SGMCODEREPOSITORYCONTA00 /AWS1/SGMCODEREPOSITORYCONTA00

A string in the name or URL of a Git repository associated with this notebook instance. This filter returns only notebook instances associated with a git repository with a name that contains the specified string.

iv_addlcoderepositoryequals TYPE /AWS1/SGMCODEREPOSITORYNAMEO00 /AWS1/SGMCODEREPOSITORYNAMEO00

A filter that returns only notebook instances with associated with the specified git repository.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmlstnotebookinsts01 /AWS1/CL_SGMLSTNOTEBOOKINSTS01

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->listnotebookinstances(
  iv_addlcoderepositoryequals = |string|
  iv_creationtimeafter = '20150101000000.0000000'
  iv_creationtimebefore = '20150101000000.0000000'
  iv_defcoderepositorycontains = |string|
  iv_lastmodifiedtimeafter = '20150101000000.0000000'
  iv_lastmodifiedtimebefore = '20150101000000.0000000'
  iv_maxresults = 123
  iv_namecontains = |string|
  iv_nexttoken = |string|
  iv_notebookinstlccfgnameco00 = |string|
  iv_sortby = |string|
  iv_sortorder = |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_notebookinstances( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_notebookinstancename = lo_row_1->get_notebookinstancename( ).
      lv_notebookinstancearn = lo_row_1->get_notebookinstancearn( ).
      lv_notebookinstancestatus = lo_row_1->get_notebookinstancestatus( ).
      lv_notebookinstanceurl = lo_row_1->get_url( ).
      lv_instancetype = lo_row_1->get_instancetype( ).
      lv_creationtime = lo_row_1->get_creationtime( ).
      lv_lastmodifiedtime = lo_row_1->get_lastmodifiedtime( ).
      lv_notebookinstancelifecyc = lo_row_1->get_notebookinstlcconfigname( ).
      lv_coderepositorynameorurl = lo_row_1->get_defaultcoderepository( ).
      LOOP AT lo_row_1->get_addlcoderepositories( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_coderepositorynameorurl = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
ENDIF.