CREATENOTEBOOKINSTLCCONFIG()`¶

About CreateNotebookInstanceLifecycleConfig¶

Creates a lifecycle configuration that you can associate with a notebook instance. A lifecycle configuration is a collection of shell scripts that run when you create or start a notebook instance.

Each lifecycle configuration script has a limit of 16384 characters.

The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.

View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

Method Signature¶

METHODS /AWS1/IF_SGM~CREATENOTEBOOKINSTLCCONFIG
  IMPORTING
    !IV_NOTEBOOKINSTLCCONFIGNAME TYPE /AWS1/SGMNOTEBOOKINSTLCCFGNAME OPTIONAL
    !IT_ONCREATE TYPE /AWS1/CL_SGMNOTEBOOKINSTLCHOOK=>TT_NOTEBOOKINSTLCCONFIGLIST OPTIONAL
    !IT_ONSTART TYPE /AWS1/CL_SGMNOTEBOOKINSTLCHOOK=>TT_NOTEBOOKINSTLCCONFIGLIST OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_SGMTAG=>TT_TAGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmcrenotebookinstl01
  RAISING
    /AWS1/CX_SGMRESOURCELIMITEXCD
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_notebookinstlcconfigname` `TYPE /AWS1/SGMNOTEBOOKINSTLCCFGNAME` `/AWS1/SGMNOTEBOOKINSTLCCFGNAME`¶

The name of the lifecycle configuration.

Optional arguments:¶

`it_oncreate` `TYPE /AWS1/CL_SGMNOTEBOOKINSTLCHOOK=>TT_NOTEBOOKINSTLCCONFIGLIST` `TT_NOTEBOOKINSTLCCONFIGLIST`¶

A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.

`it_onstart` `TYPE /AWS1/CL_SGMNOTEBOOKINSTLCHOOK=>TT_NOTEBOOKINSTLCCONFIGLIST` `TT_NOTEBOOKINSTLCCONFIGLIST`¶

A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.

`it_tags` `TYPE /AWS1/CL_SGMTAG=>TT_TAGLIST` `TT_TAGLIST`¶

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_sgmcrenotebookinstl01` `/AWS1/CL_SGMCRENOTEBOOKINSTL01`¶

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->createnotebookinstlcconfig(
  it_oncreate = VALUE /aws1/cl_sgmnotebookinstlchook=>tt_notebookinstlcconfiglist(
    ( new /aws1/cl_sgmnotebookinstlchook( |string| ) )
  )
  it_onstart = VALUE /aws1/cl_sgmnotebookinstlchook=>tt_notebookinstlcconfiglist(
    ( new /aws1/cl_sgmnotebookinstlchook( |string| ) )
  )
  it_tags = VALUE /aws1/cl_sgmtag=>tt_taglist(
    (
      new /aws1/cl_sgmtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_notebookinstlcconfigname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_notebookinstancelifecyc = lo_result->get_notebookinstlcconfigarn( ).
ENDIF.

/AWS1/IF_SGM=>CREATENOTEBOOKINSTLCCONFIG()¶