Amazon SageMaker Service

{'Tags': [{'Key': 'string', 'Value': 'string'}]}

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

client.create_notebook_instance_lifecycle_config(
    NotebookInstanceLifecycleConfigName='string',
    OnCreate=[
        {
            'Content': 'string'
        },
    ],
    OnStart=[
        {
            'Content': 'string'
        },
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type NotebookInstanceLifecycleConfigName:

string

param NotebookInstanceLifecycleConfigName:

[REQUIRED]

The name of the lifecycle configuration.

type OnCreate:

list

param OnCreate:

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.

type OnStart:

list

param 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.

• (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.

type Tags:

list

param Tags:

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.

• (dict) --

  A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

  You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

  For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

  • Key (string) -- [REQUIRED]

    The tag key. Tag keys must be unique per resource.

  • Value (string) -- [REQUIRED]

    The tag value.

rtype:

dict

returns:

Response Syntax

{
    'NotebookInstanceLifecycleConfigArn': 'string'
}

Response Structure

• (dict) --

  • NotebookInstanceLifecycleConfigArn (string) --

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