JupyterLabAppSettings - Amazon SageMaker (original) (raw)

The settings for the JupyterLab application.

Contents

AppLifecycleManagement

Indicates whether idle shutdown is activated for JupyterLab applications.

Type: AppLifecycleManagement object

Required: No

BuiltInLifecycleConfigArn

The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default lifecycle configuration.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: (arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)

Required: No

CodeRepositories

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.

Type: Array of CodeRepository objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Required: No

CustomImages

A list of custom SageMaker images that are configured to run as a JupyterLab app.

Type: Array of CustomImage objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

DefaultResourceSpec

Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on.

Note

When both SageMakerImageVersionArn and SageMakerImageArn are passed, SageMakerImageVersionArn is used. Any updates to SageMakerImageArn will not take effect if SageMakerImageVersionArn already exists in the ResourceSpec because SageMakerImageVersionArn always takes precedence. To clear the value set for SageMakerImageVersionArn, pass None as the value.

Type: ResourceSpec object

Required: No

EmrSettings

The configuration parameters that specify the IAM roles assumed by the execution role of SageMaker (assumable roles) and the cluster instances or job execution environments (execution roles or runtime roles) to manage and access resources required for running Amazon EMR clusters or Amazon EMR Serverless applications.

Type: EmrSettings object

Required: No

LifecycleConfigArns

The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set LifecycleConfigArns to an empty list.

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: (arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++
• AWS SDK for Java V2
• AWS SDK for Ruby V3

JupyterLabAppImageConfig

JupyterServerAppSettings

Did this page help you? - Yes

Thanks for letting us know we're doing a good job!

If you've got a moment, please tell us what we did right so we can do more of it.

Did this page help you? - No

Thanks for letting us know this page needs work. We're sorry we let you down.

If you've got a moment, please tell us how we can make the documentation better.