DescribeStudioLifecycleConfig
Describes the Amazon SageMaker Studio Lifecycle Configuration.
Request Syntax
{
"StudioLifecycleConfigName": "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.
- StudioLifecycleConfigName
-
The name of the Amazon SageMaker Studio Lifecycle Configuration to describe.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}Required: Yes
Response Syntax
{
"CreationTime": number,
"LastModifiedTime": number,
"StudioLifecycleConfigAppType": "string",
"StudioLifecycleConfigArn": "string",
"StudioLifecycleConfigContent": "string",
"StudioLifecycleConfigName": "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
-
The creation time of the Amazon SageMaker Studio Lifecycle Configuration.
Type: Timestamp
- LastModifiedTime
-
This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle Configurations are immutable.
Type: Timestamp
- StudioLifecycleConfigAppType
-
The App type that the Lifecycle Configuration is attached to.
Type: String
Valid Values:
JupyterServer | KernelGateway | CodeEditor | JupyterLab - StudioLifecycleConfigArn
-
The ARN of the Lifecycle Configuration to describe.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:studio-lifecycle-config/.* - StudioLifecycleConfigContent
-
The content of your Amazon SageMaker Studio Lifecycle Configuration script.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 16384.
Pattern:
[\S\s]+ - StudioLifecycleConfigName
-
The name of the Amazon SageMaker Studio Lifecycle Configuration that is described.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFound
-
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
