SageMaker / Client / create_notebook_instance_lifecycle_config

create_notebook_instance_lifecycle_config#

SageMaker.Client.create_notebook_instance_lifecycle_config(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.create_notebook_instance_lifecycle_config(
    NotebookInstanceLifecycleConfigName='string',
    OnCreate=[
        {
            'Content': 'string'
        },
    ],
    OnStart=[
        {
            'Content': 'string'
        },
    ]
)
Parameters:

  • NotebookInstanceLifecycleConfigName (string) –

    [REQUIRED]

    The name of the lifecycle configuration.

  • OnCreate (list) –

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

    • (dict) –

      Contains the notebook instance lifecycle configuration script.

      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.

      • Content (string) –

        A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.

  • OnStart (list) –

    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.

    • (dict) –

      Contains the notebook instance lifecycle configuration script.

      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.

      • Content (string) –

        A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.

Return type:

dict

Returns:

Response Syntax

{
    'NotebookInstanceLifecycleConfigArn': 'string'
}

Response Structure

  • (dict) –

    • NotebookInstanceLifecycleConfigArn (string) –

      The Amazon Resource Name (ARN) of the lifecycle configuration.

Exceptions

  • SageMaker.Client.exceptions.ResourceLimitExceeded