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.
Request Syntax
{
"NotebookInstanceLifecycleConfigName": "string"
}Request Parameters
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
Response Syntax
{
"CreationTime": number,
"LastModifiedTime": number,
"NotebookInstanceLifecycleConfigArn": "string",
"NotebookInstanceLifecycleConfigName": "string",
"OnCreate": [
{
"Content": "string"
}
],
"OnStart": [
{
"Content": "string"
}
]
}Response Elements
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.
Errors
For information about the errors that are common to all actions, see Common Errors.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
