Skip to content

/AWS1/IF_EMR=>LISTNOTEBOOKEXECUTIONS()

About ListNotebookExecutions

Provides summaries of all notebook executions. You can filter the list based on multiple criteria such as status, time range, and editor id. Returns a maximum of 50 notebook executions and a marker to track the paging of a longer notebook execution list across multiple ListNotebookExecutions calls.

Method Signature

METHODS /AWS1/IF_EMR~LISTNOTEBOOKEXECUTIONS
  IMPORTING
    !IV_EDITORID TYPE /AWS1/EMRXMLSTRINGMAXLEN256 OPTIONAL
    !IV_STATUS TYPE /AWS1/EMRNOTEBOOKEXECSTATUS OPTIONAL
    !IV_FROM TYPE /AWS1/EMRDATE OPTIONAL
    !IV_TO TYPE /AWS1/EMRDATE OPTIONAL
    !IV_MARKER TYPE /AWS1/EMRMARKER OPTIONAL
    !IV_EXECUTIONENGINEID TYPE /AWS1/EMRXMLSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_emrlstnotebookexesout
  RAISING
    /AWS1/CX_EMRINTERNALSERVERERR
    /AWS1/CX_EMRINVALIDREQUESTEX
    /AWS1/CX_EMRCLIENTEXC
    /AWS1/CX_EMRSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_editorid TYPE /AWS1/EMRXMLSTRINGMAXLEN256 /AWS1/EMRXMLSTRINGMAXLEN256

The unique ID of the editor associated with the notebook execution.

iv_status TYPE /AWS1/EMRNOTEBOOKEXECSTATUS /AWS1/EMRNOTEBOOKEXECSTATUS

The status filter for listing notebook executions.

  • START_PENDING indicates that the cluster has received the execution request but execution has not begun.

  • STARTING indicates that the execution is starting on the cluster.

  • RUNNING indicates that the execution is being processed by the cluster.

  • FINISHING indicates that execution processing is in the final stages.

  • FINISHED indicates that the execution has completed without error.

  • FAILING indicates that the execution is failing and will not finish successfully.

  • FAILED indicates that the execution failed.

  • STOP_PENDING indicates that the cluster has received a StopNotebookExecution request and the stop is pending.

  • STOPPING indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution request.

  • STOPPED indicates that the execution stopped because of a StopNotebookExecution request.

iv_from TYPE /AWS1/EMRDATE /AWS1/EMRDATE

The beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.

iv_to TYPE /AWS1/EMRDATE /AWS1/EMRDATE

The end of time range filter for listing notebook executions. The default is the current timestamp.

iv_marker TYPE /AWS1/EMRMARKER /AWS1/EMRMARKER

The pagination token, returned by a previous ListNotebookExecutions call, that indicates the start of the list for this ListNotebookExecutions call.

iv_executionengineid TYPE /AWS1/EMRXMLSTRING /AWS1/EMRXMLSTRING

The unique ID of the execution engine.

RETURNING

oo_output TYPE REF TO /aws1/cl_emrlstnotebookexesout /AWS1/CL_EMRLSTNOTEBOOKEXESOUT

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->listnotebookexecutions(
  iv_editorid = |string|
  iv_executionengineid = |string|
  iv_from = '20150101000000.0000000'
  iv_marker = |string|
  iv_status = |string|
  iv_to = '20150101000000.0000000'
).

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_notebookexecutions( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_xmlstringmaxlen256 = lo_row_1->get_notebookexecutionid( ).
      lv_xmlstringmaxlen256 = lo_row_1->get_editorid( ).
      lv_xmlstringmaxlen256 = lo_row_1->get_notebookexecutionname( ).
      lv_notebookexecutionstatus = lo_row_1->get_status( ).
      lv_date = lo_row_1->get_starttime( ).
      lv_date = lo_row_1->get_endtime( ).
      lo_notebooks3locationforou = lo_row_1->get_notebooks3location( ).
      IF lo_notebooks3locationforou IS NOT INITIAL.
        lv_xmlstringmaxlen256 = lo_notebooks3locationforou->get_bucket( ).
        lv_uristring = lo_notebooks3locationforou->get_key( ).
      ENDIF.
      lv_xmlstring = lo_row_1->get_executionengineid( ).
    ENDIF.
  ENDLOOP.
  lv_marker = lo_result->get_marker( ).
ENDIF.