Skip to content

SpaceSettings

Source code in docs_src/capo_sagemaker/types/space_settings.py
class SpaceSettings(TypedDict, closed=True):
    jupyter_server_app_settings: NotRequired[
        "capo_sagemaker.types.jupyter_server_app_settings.JupyterServerAppSettings"
    ]
    kernel_gateway_app_settings: NotRequired[
        "capo_sagemaker.types.kernel_gateway_app_settings.KernelGatewayAppSettings"
    ]
    code_editor_app_settings: NotRequired[
        "capo_sagemaker.types.space_code_editor_app_settings.SpaceCodeEditorAppSettings"
    ]
    """<p>The Code Editor application settings.</p>"""
    jupyter_lab_app_settings: NotRequired[
        "capo_sagemaker.types.space_jupyter_lab_app_settings.SpaceJupyterLabAppSettings"
    ]
    """<p>The settings for the JupyterLab application.</p>"""
    app_type: NotRequired["capo_sagemaker.types.app_type.AppType"]
    """<p>The type of app created within the space.</p> <p>If using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateSpace.html"> UpdateSpace</a> API, you can't change the app type of your space by specifying a different value for this field.</p>"""
    space_storage_settings: NotRequired[
        "capo_sagemaker.types.space_storage_settings.SpaceStorageSettings"
    ]
    """<p>The storage settings for a space.</p>"""
    space_managed_resources: NotRequired[
        "capo_sagemaker.types.feature_status.FeatureStatus"
    ]
    """<p>If you enable this option, SageMaker AI creates the following resources on your behalf when you create the space:</p> <ul> <li> <p>The user profile that possesses the space.</p> </li> <li> <p>The app that the space contains.</p> </li> </ul>"""
    custom_file_systems: NotRequired[
        "capo_sagemaker.types.custom_file_systems.CustomFileSystems"
    ]
    """<p>A file system, created by you, that you assign to a space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.</p>"""
    remote_access: NotRequired["capo_sagemaker.types.feature_status.FeatureStatus"]
    """<p>A setting that enables or disables remote access for a SageMaker space. When enabled, this allows you to connect to the remote space from your local IDE.</p>"""

app_type instance-attribute

app_type: NotRequired[AppType]

The type of app created within the space.

If using the UpdateSpace API, you can't change the app type of your space by specifying a different value for this field.

code_editor_app_settings instance-attribute

code_editor_app_settings: NotRequired[SpaceCodeEditorAppSettings]

The Code Editor application settings.

custom_file_systems instance-attribute

custom_file_systems: NotRequired[CustomFileSystems]

A file system, created by you, that you assign to a space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.

jupyter_lab_app_settings instance-attribute

jupyter_lab_app_settings: NotRequired[SpaceJupyterLabAppSettings]

The settings for the JupyterLab application.

jupyter_server_app_settings instance-attribute

jupyter_server_app_settings: NotRequired[JupyterServerAppSettings]

kernel_gateway_app_settings instance-attribute

kernel_gateway_app_settings: NotRequired[KernelGatewayAppSettings]

remote_access instance-attribute

remote_access: NotRequired[FeatureStatus]

A setting that enables or disables remote access for a SageMaker space. When enabled, this allows you to connect to the remote space from your local IDE.

space_managed_resources instance-attribute

space_managed_resources: NotRequired[FeatureStatus]

If you enable this option, SageMaker AI creates the following resources on your behalf when you create the space:

  • The user profile that possesses the space.

  • The app that the space contains.

space_storage_settings instance-attribute

space_storage_settings: NotRequired[SpaceStorageSettings]

The storage settings for a space.