Skip to content

Create Notebook Instance Lifecycle Config

sagemaker_create_notebook_instance_lifecycle_config R Documentation

Creates a lifecycle configuration that you can associate with a notebook instance

Description

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.

Usage

sagemaker_create_notebook_instance_lifecycle_config(
  NotebookInstanceLifecycleConfigName, OnCreate, OnStart)

Arguments

NotebookInstanceLifecycleConfigName

[required] The name of the lifecycle configuration.

OnCreate

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

OnStart

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.

Value

A list with the following syntax:

list(
  NotebookInstanceLifecycleConfigArn = "string"
)

Request syntax

svc$create_notebook_instance_lifecycle_config(
  NotebookInstanceLifecycleConfigName = "string",
  OnCreate = list(
    list(
      Content = "string"
    )
  ),
  OnStart = list(
    list(
      Content = "string"
    )
  )
)