Skip to content

/AWS1/IF_DZN=>GETNOTEBOOKRUN()

About GetNotebookRun

Gets the details of a notebook run in an Amazon DataZone domain.

Method Signature

METHODS /AWS1/IF_DZN~GETNOTEBOOKRUN
  IMPORTING
    !IV_DOMAINIDENTIFIER TYPE /AWS1/DZNDOMAINID OPTIONAL
    !IV_IDENTIFIER TYPE /AWS1/DZNNOTEBOOKRUNID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dzngetnotebookrunout
  RAISING
    /AWS1/CX_DZNACCESSDENIEDEX
    /AWS1/CX_DZNTHROTTLINGEX
    /AWS1/CX_DZNUNAUTHORIZEDEX
    /AWS1/CX_DZNINTERNALSERVEREX
    /AWS1/CX_DZNRESOURCENOTFOUNDEX
    /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 the notebook run exists.

iv_identifier TYPE /AWS1/DZNNOTEBOOKRUNID /AWS1/DZNNOTEBOOKRUNID

The identifier of the notebook run.

RETURNING

oo_output TYPE REF TO /aws1/cl_dzngetnotebookrunout /AWS1/CL_DZNGETNOTEBOOKRUNOUT

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->getnotebookrun(
  iv_domainidentifier = |string|
  iv_identifier = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_notebookrunid = lo_result->get_id( ).
  lv_domainid = lo_result->get_domainid( ).
  lv_projectid = lo_result->get_owningprojectid( ).
  lv_notebookid = lo_result->get_notebookid( ).
  lv_scheduleid = lo_result->get_scheduleid( ).
  lv_notebookrunstatus = lo_result->get_status( ).
  LOOP AT lo_result->get_cellorder( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_metadata( ) into ls_row_2.
    lv_key = ls_row_2-key.
    lo_value = ls_row_2-value.
    IF lo_value IS NOT INITIAL.
      lv_metadatavalue = lo_value->get_value( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_parameters( ) into ls_row_3.
    lv_key_1 = ls_row_3-key.
    lo_value_1 = ls_row_3-value.
    IF lo_value_1 IS NOT INITIAL.
      lv_parametervalue = lo_value_1->get_value( ).
    ENDIF.
  ENDLOOP.
  lo_computeconfig = lo_result->get_computeconfiguration( ).
  IF lo_computeconfig IS NOT INITIAL.
    lv_instancetype = lo_computeconfig->get_instancetype( ).
    lv_string = lo_computeconfig->get_environmentversion( ).
  ENDIF.
  lo_networkconfig = lo_result->get_networkconfiguration( ).
  IF lo_networkconfig IS NOT INITIAL.
    lv_networkaccesstype = lo_networkconfig->get_networkaccesstype( ).
    lv_string = lo_networkconfig->get_vpcid( ).
    LOOP AT lo_networkconfig->get_subnetids( ) into lo_row_4.
      lo_row_5 = lo_row_4.
      IF lo_row_5 IS NOT INITIAL.
        lv_string = lo_row_5->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_networkconfig->get_securitygroupids( ) into lo_row_6.
      lo_row_7 = lo_row_6.
      IF lo_row_7 IS NOT INITIAL.
        lv_string = lo_row_7->get_value( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
  lo_timeoutconfig = lo_result->get_timeoutconfiguration( ).
  IF lo_timeoutconfig IS NOT INITIAL.
    lv_integer = lo_timeoutconfig->get_runtimeoutinminutes( ).
  ENDIF.
  lo_environmentconfig = lo_result->get_environmentconfiguration( ).
  IF lo_environmentconfig IS NOT INITIAL.
    lv_string = lo_environmentconfig->get_imageversion( ).
    lo_packageconfig = lo_environmentconfig->get_packageconfig( ).
    IF lo_packageconfig IS NOT INITIAL.
      lv_packagemanager = lo_packageconfig->get_packagemanager( ).
      lv_string = lo_packageconfig->get_packagespecification( ).
    ENDIF.
  ENDIF.
  lo_storageconfig = lo_result->get_storageconfiguration( ).
  IF lo_storageconfig IS NOT INITIAL.
    lv_s3path = lo_storageconfig->get_projects3path( ).
    lv_kmskeyarn = lo_storageconfig->get_kmskeyarn( ).
  ENDIF.
  lo_triggersource = lo_result->get_triggersource( ).
  IF lo_triggersource IS NOT INITIAL.
    lv_triggersourcetype = lo_triggersource->get_type( ).
    lv_string = lo_triggersource->get_name( ).
  ENDIF.
  lo_notebookrunerror = lo_result->get_error( ).
  IF lo_notebookrunerror IS NOT INITIAL.
    lv_string = lo_notebookrunerror->get_message( ).
  ENDIF.
  lv_createdat = lo_result->get_createdat( ).
  lv_createdby = lo_result->get_createdby( ).
  lv_updatedat = lo_result->get_updatedat( ).
  lv_updatedby = lo_result->get_updatedby( ).
  lv_timestamp = lo_result->get_startedat( ).
  lv_timestamp = lo_result->get_completedat( ).
ENDIF.