Skip to content

/AWS1/IF_DZN=>LISTNOTEBOOKRUNS()

About ListNotebookRuns

Lists notebook runs in an Amazon DataZone domain.

Method Signature

METHODS /AWS1/IF_DZN~LISTNOTEBOOKRUNS
  IMPORTING
    !IV_DOMAINIDENTIFIER TYPE /AWS1/DZNDOMAINID OPTIONAL
    !IV_OWNINGPROJECTIDENTIFIER TYPE /AWS1/DZNPROJECTID OPTIONAL
    !IV_NOTEBOOKIDENTIFIER TYPE /AWS1/DZNNOTEBOOKID OPTIONAL
    !IV_STATUS TYPE /AWS1/DZNNOTEBOOKRUNSTATUS OPTIONAL
    !IV_SCHEDULEIDENTIFIER TYPE /AWS1/DZNSCHEDULEID OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/DZNMAXRESULTS OPTIONAL
    !IV_SORTORDER TYPE /AWS1/DZNSORTORDER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/DZNPAGINATIONTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dznlstnotebookrunsout
  RAISING
    /AWS1/CX_DZNACCESSDENIEDEX
    /AWS1/CX_DZNTHROTTLINGEX
    /AWS1/CX_DZNUNAUTHORIZEDEX
    /AWS1/CX_DZNINTERNALSERVEREX
    /AWS1/CX_DZNVALIDATIONEX
    /AWS1/CX_DZNCLIENTEXC
    /AWS1/CX_DZNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_domainidentifier TYPE /AWS1/DZNDOMAINID /AWS1/DZNDOMAINID

The identifier of the Amazon DataZone domain in which to list notebook runs.

iv_owningprojectidentifier TYPE /AWS1/DZNPROJECTID /AWS1/DZNPROJECTID

The identifier of the project that owns the notebook runs.

Optional arguments:

iv_notebookidentifier TYPE /AWS1/DZNNOTEBOOKID /AWS1/DZNNOTEBOOKID

The identifier of the notebook to filter runs by.

iv_status TYPE /AWS1/DZNNOTEBOOKRUNSTATUS /AWS1/DZNNOTEBOOKRUNSTATUS

The status to filter notebook runs by.

iv_scheduleidentifier TYPE /AWS1/DZNSCHEDULEID /AWS1/DZNSCHEDULEID

The identifier of the schedule to filter notebook runs by.

iv_maxresults TYPE /AWS1/DZNMAXRESULTS /AWS1/DZNMAXRESULTS

The maximum number of notebook runs to return in a single call. When the number of notebook runs exceeds the value of MaxResults, the response contains a NextToken value.

iv_sortorder TYPE /AWS1/DZNSORTORDER /AWS1/DZNSORTORDER

The sort order for the results.

iv_nexttoken TYPE /AWS1/DZNPAGINATIONTOKEN /AWS1/DZNPAGINATIONTOKEN

When the number of notebook runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of notebook runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListNotebookRuns to list the next set of notebook runs.

RETURNING

oo_output TYPE REF TO /aws1/cl_dznlstnotebookrunsout /AWS1/CL_DZNLSTNOTEBOOKRUNSOUT

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->listnotebookruns(
  iv_domainidentifier = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_notebookidentifier = |string|
  iv_owningprojectidentifier = |string|
  iv_scheduleidentifier = |string|
  iv_sortorder = |string|
  iv_status = |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_items( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_notebookrunid = lo_row_1->get_id( ).
      lv_domainid = lo_row_1->get_domainid( ).
      lv_projectid = lo_row_1->get_owningprojectid( ).
      lv_notebookid = lo_row_1->get_notebookid( ).
      lv_scheduleid = lo_row_1->get_scheduleid( ).
      lv_notebookrunstatus = lo_row_1->get_status( ).
      lo_triggersource = lo_row_1->get_triggersource( ).
      IF lo_triggersource IS NOT INITIAL.
        lv_triggersourcetype = lo_triggersource->get_type( ).
        lv_string = lo_triggersource->get_name( ).
      ENDIF.
      lv_createdat = lo_row_1->get_createdat( ).
      lv_createdby = lo_row_1->get_createdby( ).
      lv_updatedat = lo_row_1->get_updatedat( ).
      lv_updatedby = lo_row_1->get_updatedby( ).
      lv_timestamp = lo_row_1->get_startedat( ).
      lv_timestamp = lo_row_1->get_completedat( ).
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.