CREATENOTEBOOK()`¶

About CreateNotebook¶

Creates an empty ipynb file in the specified Apache Spark enabled workgroup. Throws an error if a file in the workgroup with the same name already exists.

Method Signature¶

METHODS /AWS1/IF_ATH~CREATENOTEBOOK
  IMPORTING
    !IV_WORKGROUP TYPE /AWS1/ATHWORKGROUPNAME OPTIONAL
    !IV_NAME TYPE /AWS1/ATHNOTEBOOKNAME OPTIONAL
    !IV_CLIENTREQUESTTOKEN TYPE /AWS1/ATHCLIENTREQUESTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_athcreatenotebookout
  RAISING
    /AWS1/CX_ATHINTERNALSERVEREX
    /AWS1/CX_ATHINVALIDREQUESTEX
    /AWS1/CX_ATHTOOMANYREQUESTSEX
    /AWS1/CX_ATHCLIENTEXC
    /AWS1/CX_ATHSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_workgroup` `TYPE /AWS1/ATHWORKGROUPNAME` `/AWS1/ATHWORKGROUPNAME`¶

The name of the Spark enabled workgroup in which the notebook will be created.

`iv_name` `TYPE /AWS1/ATHNOTEBOOKNAME` `/AWS1/ATHNOTEBOOKNAME`¶

The name of the ipynb file to be created in the Spark workgroup, without the .ipynb extension.

Optional arguments:¶

`iv_clientrequesttoken` `TYPE /AWS1/ATHCLIENTREQUESTTOKEN` `/AWS1/ATHCLIENTREQUESTTOKEN`¶

A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once).

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_athcreatenotebookout` `/AWS1/CL_ATHCREATENOTEBOOKOUT`¶

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->createnotebook(
  iv_clientrequesttoken = |string|
  iv_name = |string|
  iv_workgroup = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_notebookid = lo_result->get_notebookid( ).
ENDIF.

/AWS1/IF_ATH=>CREATENOTEBOOK()¶