STARTNOTEBOOKRUN()`¶

About StartNotebookRun¶

Starts a notebook run in an Amazon DataZone domain. A notebook run represents the execution of a Amazon DataZone notebook within a project. You can configure compute, network, timeout, and environment settings for the run.

Method Signature¶

METHODS /AWS1/IF_DZN~STARTNOTEBOOKRUN
  IMPORTING
    !IV_DOMAINIDENTIFIER TYPE /AWS1/DZNDOMAINID OPTIONAL
    !IV_OWNINGPROJECTIDENTIFIER TYPE /AWS1/DZNPROJECTID OPTIONAL
    !IV_NOTEBOOKIDENTIFIER TYPE /AWS1/DZNNOTEBOOKID OPTIONAL
    !IV_SCHEDULEIDENTIFIER TYPE /AWS1/DZNSCHEDULEID OPTIONAL
    !IO_COMPUTECONFIGURATION TYPE REF TO /AWS1/CL_DZNCOMPUTECONFIG OPTIONAL
    !IO_NETWORKCONFIGURATION TYPE REF TO /AWS1/CL_DZNNETWORKCONFIG OPTIONAL
    !IO_TIMEOUTCONFIGURATION TYPE REF TO /AWS1/CL_DZNTIMEOUTCONFIG OPTIONAL
    !IO_TRIGGERSOURCE TYPE REF TO /AWS1/CL_DZNTRIGGERSOURCE OPTIONAL
    !IT_METADATA TYPE /AWS1/CL_DZNMETADATA_W=>TT_METADATA OPTIONAL
    !IT_PARAMETERS TYPE /AWS1/CL_DZNPARAMETERS_W=>TT_PARAMETERS OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/DZNCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dznstrtnotebookrunout
  RAISING
    /AWS1/CX_DZNACCESSDENIEDEX
    /AWS1/CX_DZNTHROTTLINGEX
    /AWS1/CX_DZNUNAUTHORIZEDEX
    /AWS1/CX_DZNCONFLICTEXCEPTION
    /AWS1/CX_DZNINTERNALSERVEREX
    /AWS1/CX_DZNRESOURCENOTFOUNDEX
    /AWS1/CX_DZNSERVICEQUOTAEXCDEX
    /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 is started.

`iv_owningprojectidentifier` `TYPE /AWS1/DZNPROJECTID` `/AWS1/DZNPROJECTID`¶

The identifier of the project that owns the notebook run.

`iv_notebookidentifier` `TYPE /AWS1/DZNNOTEBOOKID` `/AWS1/DZNNOTEBOOKID`¶

The identifier of the notebook to run.

Optional arguments:¶

`iv_scheduleidentifier` `TYPE /AWS1/DZNSCHEDULEID` `/AWS1/DZNSCHEDULEID`¶

The identifier of the schedule associated with the notebook run.

`io_computeconfiguration` `TYPE REF TO /AWS1/CL_DZNCOMPUTECONFIG` `/AWS1/CL_DZNCOMPUTECONFIG`¶

The compute configuration for the notebook run, including instance type and environment version.

`io_networkconfiguration` `TYPE REF TO /AWS1/CL_DZNNETWORKCONFIG` `/AWS1/CL_DZNNETWORKCONFIG`¶

The network configuration for the notebook run, including network access type and optional VPC settings.

`io_timeoutconfiguration` `TYPE REF TO /AWS1/CL_DZNTIMEOUTCONFIG` `/AWS1/CL_DZNTIMEOUTCONFIG`¶

The timeout configuration for the notebook run. The default timeout is 720 minutes (12 hours) and the maximum is 1440 minutes (24 hours).

`io_triggersource` `TYPE REF TO /AWS1/CL_DZNTRIGGERSOURCE` `/AWS1/CL_DZNTRIGGERSOURCE`¶

The source that triggered the notebook run.

`it_metadata` `TYPE /AWS1/CL_DZNMETADATA_W=>TT_METADATA` `TT_METADATA`¶

The metadata for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.

`it_parameters` `TYPE /AWS1/CL_DZNPARAMETERS_W=>TT_PARAMETERS` `TT_PARAMETERS`¶

The sensitive parameters for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.

`iv_clienttoken` `TYPE /AWS1/DZNCLIENTTOKEN` `/AWS1/DZNCLIENTTOKEN`¶

A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_dznstrtnotebookrunout` `/AWS1/CL_DZNSTRTNOTEBOOKRUNOUT`¶

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->startnotebookrun(
  io_computeconfiguration = new /aws1/cl_dzncomputeconfig(
    iv_environmentversion = |string|
    iv_instancetype = |string|
  )
  io_networkconfiguration = new /aws1/cl_dznnetworkconfig(
    it_securitygroupids = VALUE /aws1/cl_dznsecuritygroupids_w=>tt_securitygroupids(
      ( new /aws1/cl_dznsecuritygroupids_w( |string| ) )
    )
    it_subnetids = VALUE /aws1/cl_dznsubnetids_w=>tt_subnetids(
      ( new /aws1/cl_dznsubnetids_w( |string| ) )
    )
    iv_networkaccesstype = |string|
    iv_vpcid = |string|
  )
  io_timeoutconfiguration = new /aws1/cl_dzntimeoutconfig( 123 )
  io_triggersource = new /aws1/cl_dzntriggersource(
    iv_name = |string|
    iv_type = |string|
  )
  it_metadata = VALUE /aws1/cl_dznmetadata_w=>tt_metadata(
    (
      VALUE /aws1/cl_dznmetadata_w=>ts_metadata_maprow(
        value = new /aws1/cl_dznmetadata_w( |string| )
        key = |string|
      )
    )
  )
  it_parameters = VALUE /aws1/cl_dznparameters_w=>tt_parameters(
    (
      VALUE /aws1/cl_dznparameters_w=>ts_parameters_maprow(
        value = new /aws1/cl_dznparameters_w( |string| )
        key = |string|
      )
    )
  )
  iv_clienttoken = |string|
  iv_domainidentifier = |string|
  iv_notebookidentifier = |string|
  iv_owningprojectidentifier = |string|
  iv_scheduleidentifier = |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.

/AWS1/IF_DZN=>STARTNOTEBOOKRUN()¶

About StartNotebookRun¶

Method Signature¶

IMPORTING¶

Required arguments:¶

iv_domainidentifier TYPE /AWS1/DZNDOMAINID /AWS1/DZNDOMAINID¶

iv_owningprojectidentifier TYPE /AWS1/DZNPROJECTID /AWS1/DZNPROJECTID¶

iv_notebookidentifier TYPE /AWS1/DZNNOTEBOOKID /AWS1/DZNNOTEBOOKID¶

Optional arguments:¶

iv_scheduleidentifier TYPE /AWS1/DZNSCHEDULEID /AWS1/DZNSCHEDULEID¶

io_computeconfiguration TYPE REF TO /AWS1/CL_DZNCOMPUTECONFIG /AWS1/CL_DZNCOMPUTECONFIG¶

io_networkconfiguration TYPE REF TO /AWS1/CL_DZNNETWORKCONFIG /AWS1/CL_DZNNETWORKCONFIG¶

io_timeoutconfiguration TYPE REF TO /AWS1/CL_DZNTIMEOUTCONFIG /AWS1/CL_DZNTIMEOUTCONFIG¶

io_triggersource TYPE REF TO /AWS1/CL_DZNTRIGGERSOURCE /AWS1/CL_DZNTRIGGERSOURCE¶

it_metadata TYPE /AWS1/CL_DZNMETADATA_W=>TT_METADATA TT_METADATA¶

it_parameters TYPE /AWS1/CL_DZNPARAMETERS_W=>TT_PARAMETERS TT_PARAMETERS¶

iv_clienttoken TYPE /AWS1/DZNCLIENTTOKEN /AWS1/DZNCLIENTTOKEN¶