/AWS1/IF_DZN=>CREATENOTEBOOK()

About CreateNotebook

Creates a notebook in Amazon SageMaker Unified Studio. A notebook is a collaborative document within a project that contains code cells for interactive computing.

Method Signature

METHODS /AWS1/IF_DZN~CREATENOTEBOOK
  IMPORTING
    !IV_DOMAINIDENTIFIER TYPE /AWS1/DZNDOMAINID OPTIONAL
    !IV_OWNINGPROJECTIDENTIFIER TYPE /AWS1/DZNPROJECTID OPTIONAL
    !IV_NAME TYPE /AWS1/DZNNOTEBOOKNAME OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/DZNDESCRIPTION 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_dzncreatenotebookout
  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 SageMaker Unified Studio domain in which to create the notebook.

iv_owningprojectidentifier TYPE /AWS1/DZNPROJECTID /AWS1/DZNPROJECTID

The identifier of the project that owns the notebook.

iv_name TYPE /AWS1/DZNNOTEBOOKNAME /AWS1/DZNNOTEBOOKNAME

The name of the notebook. The name must be between 1 and 256 characters.

Optional arguments:

iv_description TYPE /AWS1/DZNDESCRIPTION /AWS1/DZNDESCRIPTION

The description of the notebook.

it_metadata TYPE /AWS1/CL_DZNMETADATA_W=>TT_METADATA TT_METADATA

The metadata for the notebook, 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, 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_dzncreatenotebookout /AWS1/CL_DZNCREATENOTEBOOKOUT

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(
  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_description = |string|
  iv_domainidentifier = |string|
  iv_name = |string|
  iv_owningprojectidentifier = |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_id( ).
  lv_notebookname = lo_result->get_name( ).
  lv_projectid = lo_result->get_owningprojectid( ).
  lv_domainid = lo_result->get_domainid( ).
  LOOP AT lo_result->get_cellorder( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
    ENDIF.
  ENDLOOP.
  lv_notebookstatus = lo_result->get_status( ).
  lv_description = lo_result->get_description( ).
  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_string = lo_result->get_lockedby( ).
  lv_timestamp = lo_result->get_lockedat( ).
  lv_timestamp = lo_result->get_lockexpiresat( ).
  lv_computeid = lo_result->get_computeid( ).
  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_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_notebookerror = lo_result->get_error( ).
  IF lo_notebookerror IS NOT INITIAL.
    lv_string = lo_notebookerror->get_message( ).
  ENDIF.
ENDIF.