/AWS1/CL_EMR=>STARTNOTEBOOKEXECUTION()

About StartNotebookExecution

Starts a notebook execution.

Method Signature

IMPORTING

Required arguments:

io_executionengine TYPE REF TO /AWS1/CL_EMREXECENGINECONFIG /AWS1/CL_EMREXECENGINECONFIG

Specifies the execution engine (cluster) that runs the notebook execution.

iv_servicerole TYPE /AWS1/EMRXMLSTRING /AWS1/EMRXMLSTRING

The name or ARN of the IAM role that is used as the service role for Amazon EMR (the Amazon EMR role) for the notebook execution.

Optional arguments:

iv_editorid TYPE /AWS1/EMRXMLSTRINGMAXLEN256 /AWS1/EMRXMLSTRINGMAXLEN256

The unique identifier of the Amazon EMR Notebook to use for notebook execution.

iv_relativepath TYPE /AWS1/EMRXMLSTRING /AWS1/EMRXMLSTRING

The path and file name of the notebook file for this execution, relative to the path specified for the Amazon EMR Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks when you create an Amazon EMR Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD (the EditorID of this request), and you specify a RelativePath of my_notebook_executions/notebook_execution.ipynb, the location of the file for the notebook execution is s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb.

iv_notebookexecutionname TYPE /AWS1/EMRXMLSTRINGMAXLEN256 /AWS1/EMRXMLSTRINGMAXLEN256

An optional name for the notebook execution.

iv_notebookparams TYPE /AWS1/EMRXMLSTRING /AWS1/EMRXMLSTRING

Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.

iv_notebookinstsecgroupid TYPE /AWS1/EMRXMLSTRINGMAXLEN256 /AWS1/EMRXMLSTRINGMAXLEN256

The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this notebook execution.

it_tags TYPE /AWS1/CL_EMRTAG=>TT_TAGLIST TT_TAGLIST

A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.

io_notebooks3location TYPE REF TO /AWS1/CL_EMRNOTEBOOKS3LOCFRM00 /AWS1/CL_EMRNOTEBOOKS3LOCFRM00

The Amazon S3 location for the notebook execution input.

io_outputnotebooks3location TYPE REF TO /AWS1/CL_EMROUTNOTEBOOKS3LOC01 /AWS1/CL_EMROUTNOTEBOOKS3LOC01

The Amazon S3 location for the notebook execution output.

iv_outputnotebookformat TYPE /AWS1/EMROUTPUTNOTEBOOKFORMAT /AWS1/EMROUTPUTNOTEBOOKFORMAT

The output format for the notebook execution.

it_environmentvariables TYPE /AWS1/CL_EMRENVIRONMENTVARIA00=>TT_ENVIRONMENTVARIABLESMAP TT_ENVIRONMENTVARIABLESMAP

The environment variables associated with the notebook execution.

RETURNING

oo_output TYPE REF TO /aws1/cl_emrstrtnotebookexeout /AWS1/CL_EMRSTRTNOTEBOOKEXEOUT

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->/aws1/if_emr~startnotebookexecution(
  io_executionengine = new /aws1/cl_emrexecengineconfig(
    iv_executionrolearn = |string|
    iv_id = |string|
    iv_masterinstsecuritygroupid = |string|
    iv_type = |string|
  )
  io_notebooks3location = new /aws1/cl_emrnotebooks3locfrm00(
    iv_bucket = |string|
    iv_key = |string|
  )
  io_outputnotebooks3location = new /aws1/cl_emroutnotebooks3loc01(
    iv_bucket = |string|
    iv_key = |string|
  )
  it_environmentvariables = VALUE /aws1/cl_emrenvironmentvaria00=>tt_environmentvariablesmap(
    (
      VALUE /aws1/cl_emrenvironmentvaria00=>ts_environmentvariabl00_maprow(
        value = new /aws1/cl_emrenvironmentvaria00( |string| )
        key = |string|
      )
    )
  )
  it_tags = VALUE /aws1/cl_emrtag=>tt_taglist(
    (
      new /aws1/cl_emrtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_editorid = |string|
  iv_notebookexecutionname = |string|
  iv_notebookinstsecgroupid = |string|
  iv_notebookparams = |string|
  iv_outputnotebookformat = |string|
  iv_relativepath = |string|
  iv_servicerole = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_xmlstringmaxlen256 = lo_result->get_notebookexecutionid( ).
ENDIF.