SageMaker / Client / update_notebook_instance_lifecycle_config

update_notebook_instance_lifecycle_config

SageMaker.Client.update_notebook_instance_lifecycle_config(**kwargs)

Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.

Note

Updates to lifecycle configurations affect all notebook instances using that configuration upon their next start. Lifecycle configuration scripts execute with root access and the notebook instance’s IAM execution role privileges. Grant this permission only to trusted principals. See Customize a Notebook Instance Using a Lifecycle Configuration Script for security best practices.

See also: AWS API Documentation

Request Syntax

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

  • NotebookInstanceLifecycleConfigName (string) –

    [REQUIRED]

    The name of the lifecycle configuration.

  • OnCreate (list) –

    The 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) –

    The 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

{}

Response Structure

  • (dict) –

Exceptions

  • SageMaker.Client.exceptions.ResourceLimitExceeded