DescribeNotebookInstanceLifecycleConfig

Returns a description of a notebook instance lifecycle configuration.

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

{
   "[NotebookInstanceLifecycleConfigName](#SageMaker-DescribeNotebookInstanceLifecycleConfig-request-NotebookInstanceLifecycleConfigName)": "string"
}

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

** NotebookInstanceLifecycleConfigName ** The name of the lifecycle configuration to describe.
Type: String
Length Constraints: Maximum length of 63.
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*
Required: Yes

{
   "[CreationTime](#SageMaker-DescribeNotebookInstanceLifecycleConfig-response-CreationTime)": number,
   "[LastModifiedTime](#SageMaker-DescribeNotebookInstanceLifecycleConfig-response-LastModifiedTime)": number,
   "[NotebookInstanceLifecycleConfigArn](#SageMaker-DescribeNotebookInstanceLifecycleConfig-response-NotebookInstanceLifecycleConfigArn)": "string",
   "[NotebookInstanceLifecycleConfigName](#SageMaker-DescribeNotebookInstanceLifecycleConfig-response-NotebookInstanceLifecycleConfigName)": "string",
   "[OnCreate](#SageMaker-DescribeNotebookInstanceLifecycleConfig-response-OnCreate)": [ 
      { 
         "[Content](API_NotebookInstanceLifecycleHook.md#SageMaker-Type-NotebookInstanceLifecycleHook-Content)": "string"
      }
   ],
   "[OnStart](#SageMaker-DescribeNotebookInstanceLifecycleConfig-response-OnStart)": [ 
      { 
         "[Content](API_NotebookInstanceLifecycleHook.md#SageMaker-Type-NotebookInstanceLifecycleHook-Content)": "string"
      }
   ]
}

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

** CreationTime ** A timestamp that tells when the lifecycle configuration was created.
Type: Timestamp

** LastModifiedTime ** A timestamp that tells when the lifecycle configuration was last modified.
Type: Timestamp

** NotebookInstanceLifecycleConfigArn ** The Amazon Resource Name (ARN) of the lifecycle configuration.
Type: String
Length Constraints: Maximum length of 256.

** NotebookInstanceLifecycleConfigName ** The name of the lifecycle configuration.
Type: String
Length Constraints: Maximum length of 63.
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

** OnCreate ** The shell script that runs only once, when you create a notebook instance.
Type: Array of NotebookInstanceLifecycleHook objects
Array Members: Maximum number of 1 item.

** OnStart ** The shell script that runs every time you start a notebook instance, including when you create the notebook instance.
Type: Array of NotebookInstanceLifecycleHook objects
Array Members: Maximum number of 1 item.

For information about the errors that are common to all actions, see Common Errors.

For more information about using this API in one of the language-specific AWS SDKs, see the following: + AWS Command Line Interface + AWS SDK for .NET + AWS SDK for C++ + AWS SDK for Go + AWS SDK for Go - Pilot + AWS SDK for Java + AWS SDK for JavaScript + AWS SDK for PHP V3 + AWS SDK for Python + AWS SDK for Ruby V2