Amazon SageMaker Service

2025/07/03 - Amazon SageMaker Service - 2 new4 updated api methods

Changes  Changes include new StartSession API for SageMaker Studio spaces and CreateHubContentPresignedUrls API for SageMaker JumpStart.

CreateHubContentPresignedUrls (new) Link ¶

Creates presigned URLs for accessing hub content artifacts. This operation generates time-limited, secure URLs that allow direct download of model artifacts and associated files from Amazon SageMaker hub content, including gated models that require end-user license agreement acceptance.

See also: AWS API Documentation

Request Syntax

client.create_hub_content_presigned_urls(
    HubName='string',
    HubContentType='Model'|'Notebook'|'ModelReference',
    HubContentName='string',
    HubContentVersion='string',
    AccessConfig={
        'AcceptEula': True|False,
        'ExpectedS3Url': 'string'
    },
    MaxResults=123,
    NextToken='string'
)
type HubName:

string

param HubName:

[REQUIRED]

The name or Amazon Resource Name (ARN) of the hub that contains the content. For public content, use SageMakerPublicHub.

type HubContentType:

string

param HubContentType:

[REQUIRED]

The type of hub content to access. Valid values include Model, Notebook, and ModelReference.

type HubContentName:

string

param HubContentName:

[REQUIRED]

The name of the hub content for which to generate presigned URLs. This identifies the specific model or content within the hub.

type HubContentVersion:

string

param HubContentVersion:

The version of the hub content. If not specified, the latest version is used.

type AccessConfig:

dict

param AccessConfig:

Configuration settings for accessing the hub content, including end-user license agreement acceptance for gated models and expected S3 URL validation.

  • AcceptEula (boolean) --

    Indicates acceptance of the End User License Agreement (EULA) for gated models. Set to true to acknowledge acceptance of the license terms required for accessing gated content.

  • ExpectedS3Url (string) --

    The expected S3 URL prefix for validation purposes. This parameter helps ensure consistency between the resolved S3 URIs and the deployment configuration, reducing potential compatibility issues.

type MaxResults:

integer

param MaxResults:

The maximum number of presigned URLs to return in the response. Default value is 100. Large models may contain hundreds of files, requiring pagination to retrieve all URLs.

type NextToken:

string

param NextToken:

A token for pagination. Use this token to retrieve the next set of presigned URLs when the response is truncated.

rtype:

dict

returns:

Response Syntax

{
    'AuthorizedUrlConfigs': [
        {
            'Url': 'string',
            'LocalPath': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • AuthorizedUrlConfigs (list) --

      An array of authorized URL configurations, each containing a presigned URL and its corresponding local file path for proper file organization during download.

      • (dict) --

        Contains a presigned URL and its associated local file path for downloading hub content artifacts.

        • Url (string) --

          The presigned S3 URL that provides temporary, secure access to download the file. URLs expire within 15 minutes for security purposes.

        • LocalPath (string) --

          The recommended local file path where the downloaded file should be stored to maintain proper directory structure and file organization.

    • NextToken (string) --

      A token for pagination. If present, indicates that more presigned URLs are available. Use this token in a subsequent request to retrieve additional URLs.

StartSession (new) Link ¶

Initiates a remote connection session between a local integrated development environments (IDEs) and a remote SageMaker space.

See also: AWS API Documentation

Request Syntax

client.start_session(
    ResourceIdentifier='string'
)
type ResourceIdentifier:

string

param ResourceIdentifier:

[REQUIRED]

The Amazon Resource Name (ARN) of the resource to which the remote connection will be established. For example, this identifies the specific ARN space application you want to connect to from your local IDE.

rtype:

dict

returns:

Response Syntax

{
    'SessionId': 'string',
    'StreamUrl': 'string',
    'TokenValue': 'string'
}

Response Structure

  • (dict) --

    • SessionId (string) --

      A unique identifier for the established remote connection session.

    • StreamUrl (string) --

      A WebSocket URL used to establish a SSH connection between the local IDE and remote SageMaker space.

    • TokenValue (string) --

      An encrypted token value containing session and caller information.

CreateSpace (updated) Link ¶
Changes (request)
{'SpaceSettings': {'RemoteAccess': 'ENABLED | DISABLED'}}

Creates a private space or a space used for real time collaboration in a domain.

See also: AWS API Documentation

Request Syntax

client.create_space(
    DomainId='string',
    SpaceName='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    SpaceSettings={
        'JupyterServerAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.12xlarge'|'ml.g6.16xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.12xlarge'|'ml.g6e.16xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.p5.48xlarge'|'ml.p5en.48xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.c7i.large'|'ml.c7i.xlarge'|'ml.c7i.2xlarge'|'ml.c7i.4xlarge'|'ml.c7i.8xlarge'|'ml.c7i.12xlarge'|'ml.c7i.16xlarge'|'ml.c7i.24xlarge'|'ml.c7i.48xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.m6id.large'|'ml.m6id.xlarge'|'ml.m6id.2xlarge'|'ml.m6id.4xlarge'|'ml.m6id.8xlarge'|'ml.m6id.12xlarge'|'ml.m6id.16xlarge'|'ml.m6id.24xlarge'|'ml.m6id.32xlarge'|'ml.c6id.large'|'ml.c6id.xlarge'|'ml.c6id.2xlarge'|'ml.c6id.4xlarge'|'ml.c6id.8xlarge'|'ml.c6id.12xlarge'|'ml.c6id.16xlarge'|'ml.c6id.24xlarge'|'ml.c6id.32xlarge'|'ml.r6id.large'|'ml.r6id.xlarge'|'ml.r6id.2xlarge'|'ml.r6id.4xlarge'|'ml.r6id.8xlarge'|'ml.r6id.12xlarge'|'ml.r6id.16xlarge'|'ml.r6id.24xlarge'|'ml.r6id.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.12xlarge'|'ml.g6.16xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.12xlarge'|'ml.g6e.16xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.p5.48xlarge'|'ml.p5en.48xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.c7i.large'|'ml.c7i.xlarge'|'ml.c7i.2xlarge'|'ml.c7i.4xlarge'|'ml.c7i.8xlarge'|'ml.c7i.12xlarge'|'ml.c7i.16xlarge'|'ml.c7i.24xlarge'|'ml.c7i.48xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.m6id.large'|'ml.m6id.xlarge'|'ml.m6id.2xlarge'|'ml.m6id.4xlarge'|'ml.m6id.8xlarge'|'ml.m6id.12xlarge'|'ml.m6id.16xlarge'|'ml.m6id.24xlarge'|'ml.m6id.32xlarge'|'ml.c6id.large'|'ml.c6id.xlarge'|'ml.c6id.2xlarge'|'ml.c6id.4xlarge'|'ml.c6id.8xlarge'|'ml.c6id.12xlarge'|'ml.c6id.16xlarge'|'ml.c6id.24xlarge'|'ml.c6id.32xlarge'|'ml.r6id.large'|'ml.r6id.xlarge'|'ml.r6id.2xlarge'|'ml.r6id.4xlarge'|'ml.r6id.8xlarge'|'ml.r6id.12xlarge'|'ml.r6id.16xlarge'|'ml.r6id.24xlarge'|'ml.r6id.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ]
        },
        'CodeEditorAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.12xlarge'|'ml.g6.16xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.12xlarge'|'ml.g6e.16xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.p5.48xlarge'|'ml.p5en.48xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.c7i.large'|'ml.c7i.xlarge'|'ml.c7i.2xlarge'|'ml.c7i.4xlarge'|'ml.c7i.8xlarge'|'ml.c7i.12xlarge'|'ml.c7i.16xlarge'|'ml.c7i.24xlarge'|'ml.c7i.48xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.m6id.large'|'ml.m6id.xlarge'|'ml.m6id.2xlarge'|'ml.m6id.4xlarge'|'ml.m6id.8xlarge'|'ml.m6id.12xlarge'|'ml.m6id.16xlarge'|'ml.m6id.24xlarge'|'ml.m6id.32xlarge'|'ml.c6id.large'|'ml.c6id.xlarge'|'ml.c6id.2xlarge'|'ml.c6id.4xlarge'|'ml.c6id.8xlarge'|'ml.c6id.12xlarge'|'ml.c6id.16xlarge'|'ml.c6id.24xlarge'|'ml.c6id.32xlarge'|'ml.r6id.large'|'ml.r6id.xlarge'|'ml.r6id.2xlarge'|'ml.r6id.4xlarge'|'ml.r6id.8xlarge'|'ml.r6id.12xlarge'|'ml.r6id.16xlarge'|'ml.r6id.24xlarge'|'ml.r6id.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'AppLifecycleManagement': {
                'IdleSettings': {
                    'IdleTimeoutInMinutes': 123
                }
            }
        },
        'JupyterLabAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.12xlarge'|'ml.g6.16xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.12xlarge'|'ml.g6e.16xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.p5.48xlarge'|'ml.p5en.48xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.c7i.large'|'ml.c7i.xlarge'|'ml.c7i.2xlarge'|'ml.c7i.4xlarge'|'ml.c7i.8xlarge'|'ml.c7i.12xlarge'|'ml.c7i.16xlarge'|'ml.c7i.24xlarge'|'ml.c7i.48xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.m6id.large'|'ml.m6id.xlarge'|'ml.m6id.2xlarge'|'ml.m6id.4xlarge'|'ml.m6id.8xlarge'|'ml.m6id.12xlarge'|'ml.m6id.16xlarge'|'ml.m6id.24xlarge'|'ml.m6id.32xlarge'|'ml.c6id.large'|'ml.c6id.xlarge'|'ml.c6id.2xlarge'|'ml.c6id.4xlarge'|'ml.c6id.8xlarge'|'ml.c6id.12xlarge'|'ml.c6id.16xlarge'|'ml.c6id.24xlarge'|'ml.c6id.32xlarge'|'ml.r6id.large'|'ml.r6id.xlarge'|'ml.r6id.2xlarge'|'ml.r6id.4xlarge'|'ml.r6id.8xlarge'|'ml.r6id.12xlarge'|'ml.r6id.16xlarge'|'ml.r6id.24xlarge'|'ml.r6id.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ],
            'AppLifecycleManagement': {
                'IdleSettings': {
                    'IdleTimeoutInMinutes': 123
                }
            }
        },
        'AppType': 'JupyterServer'|'KernelGateway'|'DetailedProfiler'|'TensorBoard'|'CodeEditor'|'JupyterLab'|'RStudioServerPro'|'RSessionGateway'|'Canvas',
        'SpaceStorageSettings': {
            'EbsStorageSettings': {
                'EbsVolumeSizeInGb': 123
            }
        },
        'SpaceManagedResources': 'ENABLED'|'DISABLED',
        'CustomFileSystems': [
            {
                'EFSFileSystem': {
                    'FileSystemId': 'string'
                },
                'FSxLustreFileSystem': {
                    'FileSystemId': 'string'
                }
            },
        ],
        'RemoteAccess': 'ENABLED'|'DISABLED'
    },
    OwnershipSettings={
        'OwnerUserProfileName': 'string'
    },
    SpaceSharingSettings={
        'SharingType': 'Private'|'Shared'
    },
    SpaceDisplayName='string'
)
type DomainId:

string

param DomainId:

[REQUIRED]

The ID of the associated domain.

type SpaceName:

string

param SpaceName:

[REQUIRED]

The name of the space.

type Tags:

list

param Tags:

Tags to associated with the space. Each tag consists of a key and an optional value. Tag keys must be unique for each resource. Tags are searchable using the Search API.

  • (dict) --

    A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

    You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

    For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

    • Key (string) -- [REQUIRED]

      The tag key. Tag keys must be unique per resource.

    • Value (string) -- [REQUIRED]

      The tag value.

type SpaceSettings:

dict

param SpaceSettings:

A collection of space settings.

  • JupyterServerAppSettings (dict) --

    The JupyterServer app settings.

    • DefaultResourceSpec (dict) --

      The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also required.

      • SageMakerImageArn (string) --

        The ARN of the SageMaker AI image that the image version belongs to.

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance. To clear the value set for SageMakerImageVersionArn, pass None as the value.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

      • InstanceType (string) --

        The instance type that the image version runs on.

      • LifecycleConfigArn (string) --

        The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

    • LifecycleConfigArns (list) --

      The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is also required.

      • (string) --

    • CodeRepositories (list) --

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

      • (dict) --

        A Git repository that SageMaker AI automatically displays to users for cloning in the JupyterServer application.

        • RepositoryUrl (string) -- [REQUIRED]

          The URL of the Git repository.

  • KernelGatewayAppSettings (dict) --

    The KernelGateway app settings.

    • DefaultResourceSpec (dict) --

      The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the KernelGateway app.

      • SageMakerImageArn (string) --

        The ARN of the SageMaker AI image that the image version belongs to.

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance. To clear the value set for SageMakerImageVersionArn, pass None as the value.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

      • InstanceType (string) --

        The instance type that the image version runs on.

      • LifecycleConfigArn (string) --

        The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

    • CustomImages (list) --

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

      The maximum number of custom images are as follows.

      • On a domain level: 200

      • On a space level: 5

      • On a user profile level: 5

      • (dict) --

        A custom SageMaker AI image. For more information, see Bring your own SageMaker AI image.

        • ImageName (string) -- [REQUIRED]

          The name of the CustomImage. Must be unique to your account.

        • ImageVersionNumber (integer) --

          The version number of the CustomImage.

        • AppImageConfigName (string) -- [REQUIRED]

          The name of the AppImageConfig.

    • LifecycleConfigArns (list) --

      The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.

      • (string) --

  • CodeEditorAppSettings (dict) --

    The Code Editor application settings.

    • DefaultResourceSpec (dict) --

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

      • SageMakerImageArn (string) --

        The ARN of the SageMaker AI image that the image version belongs to.

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance. To clear the value set for SageMakerImageVersionArn, pass None as the value.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

      • InstanceType (string) --

        The instance type that the image version runs on.

      • LifecycleConfigArn (string) --

        The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

    • AppLifecycleManagement (dict) --

      Settings that are used to configure and manage the lifecycle of CodeEditor applications in a space.

      • IdleSettings (dict) --

        Settings related to idle shutdown of Studio applications.

        • IdleTimeoutInMinutes (integer) --

          The time that SageMaker waits after the application becomes idle before shutting it down.

  • JupyterLabAppSettings (dict) --

    The settings for the JupyterLab application.

    • DefaultResourceSpec (dict) --

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

      • SageMakerImageArn (string) --

        The ARN of the SageMaker AI image that the image version belongs to.

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance. To clear the value set for SageMakerImageVersionArn, pass None as the value.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

      • InstanceType (string) --

        The instance type that the image version runs on.

      • LifecycleConfigArn (string) --

        The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

    • CodeRepositories (list) --

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

      • (dict) --

        A Git repository that SageMaker AI automatically displays to users for cloning in the JupyterServer application.

        • RepositoryUrl (string) -- [REQUIRED]

          The URL of the Git repository.

    • AppLifecycleManagement (dict) --

      Settings that are used to configure and manage the lifecycle of JupyterLab applications in a space.

      • IdleSettings (dict) --

        Settings related to idle shutdown of Studio applications.

        • IdleTimeoutInMinutes (integer) --

          The time that SageMaker waits after the application becomes idle before shutting it down.

  • AppType (string) --

    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.

  • SpaceStorageSettings (dict) --

    The storage settings for a space.

    • EbsStorageSettings (dict) --

      A collection of EBS storage settings for a space.

      • EbsVolumeSizeInGb (integer) -- [REQUIRED]

        The size of an EBS storage volume for a space.

  • SpaceManagedResources (string) --

    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.

  • CustomFileSystems (list) --

    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.

    • (dict) --

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

      • EFSFileSystem (dict) --

        A custom file system in Amazon EFS.

        • FileSystemId (string) -- [REQUIRED]

          The ID of your Amazon EFS file system.

      • FSxLustreFileSystem (dict) --

        A custom file system in Amazon FSx for Lustre.

        • FileSystemId (string) -- [REQUIRED]

          Amazon FSx for Lustre file system ID.

  • RemoteAccess (string) --

    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.

type OwnershipSettings:

dict

param OwnershipSettings:

A collection of ownership settings.

  • OwnerUserProfileName (string) -- [REQUIRED]

    The user profile who is the owner of the space.

type SpaceSharingSettings:

dict

param SpaceSharingSettings:

A collection of space sharing settings.

  • SharingType (string) -- [REQUIRED]

    Specifies the sharing type of the space.

type SpaceDisplayName:

string

param SpaceDisplayName:

The name of the space that appears in the SageMaker Studio UI.

rtype:

dict

returns:

Response Syntax

{
    'SpaceArn': 'string'
}

Response Structure

  • (dict) --

    • SpaceArn (string) --

      The space's Amazon Resource Name (ARN).

DescribeSpace (updated) Link ¶
Changes (response)
{'SpaceSettings': {'RemoteAccess': 'ENABLED | DISABLED'}}

Describes the space.

See also: AWS API Documentation

Request Syntax

client.describe_space(
    DomainId='string',
    SpaceName='string'
)
type DomainId:

string

param DomainId:

[REQUIRED]

The ID of the associated domain.

type SpaceName:

string

param SpaceName:

[REQUIRED]

The name of the space.

rtype:

dict

returns:

Response Syntax

{
    'DomainId': 'string',
    'SpaceArn': 'string',
    'SpaceName': 'string',
    'HomeEfsFileSystemUid': 'string',
    'Status': 'Deleting'|'Failed'|'InService'|'Pending'|'Updating'|'Update_Failed'|'Delete_Failed',
    'LastModifiedTime': datetime(2015, 1, 1),
    'CreationTime': datetime(2015, 1, 1),
    'FailureReason': 'string',
    'SpaceSettings': {
        'JupyterServerAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.12xlarge'|'ml.g6.16xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.12xlarge'|'ml.g6e.16xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.p5.48xlarge'|'ml.p5en.48xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.c7i.large'|'ml.c7i.xlarge'|'ml.c7i.2xlarge'|'ml.c7i.4xlarge'|'ml.c7i.8xlarge'|'ml.c7i.12xlarge'|'ml.c7i.16xlarge'|'ml.c7i.24xlarge'|'ml.c7i.48xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.m6id.large'|'ml.m6id.xlarge'|'ml.m6id.2xlarge'|'ml.m6id.4xlarge'|'ml.m6id.8xlarge'|'ml.m6id.12xlarge'|'ml.m6id.16xlarge'|'ml.m6id.24xlarge'|'ml.m6id.32xlarge'|'ml.c6id.large'|'ml.c6id.xlarge'|'ml.c6id.2xlarge'|'ml.c6id.4xlarge'|'ml.c6id.8xlarge'|'ml.c6id.12xlarge'|'ml.c6id.16xlarge'|'ml.c6id.24xlarge'|'ml.c6id.32xlarge'|'ml.r6id.large'|'ml.r6id.xlarge'|'ml.r6id.2xlarge'|'ml.r6id.4xlarge'|'ml.r6id.8xlarge'|'ml.r6id.12xlarge'|'ml.r6id.16xlarge'|'ml.r6id.24xlarge'|'ml.r6id.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.12xlarge'|'ml.g6.16xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.12xlarge'|'ml.g6e.16xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.p5.48xlarge'|'ml.p5en.48xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.c7i.large'|'ml.c7i.xlarge'|'ml.c7i.2xlarge'|'ml.c7i.4xlarge'|'ml.c7i.8xlarge'|'ml.c7i.12xlarge'|'ml.c7i.16xlarge'|'ml.c7i.24xlarge'|'ml.c7i.48xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.m6id.large'|'ml.m6id.xlarge'|'ml.m6id.2xlarge'|'ml.m6id.4xlarge'|'ml.m6id.8xlarge'|'ml.m6id.12xlarge'|'ml.m6id.16xlarge'|'ml.m6id.24xlarge'|'ml.m6id.32xlarge'|'ml.c6id.large'|'ml.c6id.xlarge'|'ml.c6id.2xlarge'|'ml.c6id.4xlarge'|'ml.c6id.8xlarge'|'ml.c6id.12xlarge'|'ml.c6id.16xlarge'|'ml.c6id.24xlarge'|'ml.c6id.32xlarge'|'ml.r6id.large'|'ml.r6id.xlarge'|'ml.r6id.2xlarge'|'ml.r6id.4xlarge'|'ml.r6id.8xlarge'|'ml.r6id.12xlarge'|'ml.r6id.16xlarge'|'ml.r6id.24xlarge'|'ml.r6id.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ]
        },
        'CodeEditorAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.12xlarge'|'ml.g6.16xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.12xlarge'|'ml.g6e.16xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.p5.48xlarge'|'ml.p5en.48xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.c7i.large'|'ml.c7i.xlarge'|'ml.c7i.2xlarge'|'ml.c7i.4xlarge'|'ml.c7i.8xlarge'|'ml.c7i.12xlarge'|'ml.c7i.16xlarge'|'ml.c7i.24xlarge'|'ml.c7i.48xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.m6id.large'|'ml.m6id.xlarge'|'ml.m6id.2xlarge'|'ml.m6id.4xlarge'|'ml.m6id.8xlarge'|'ml.m6id.12xlarge'|'ml.m6id.16xlarge'|'ml.m6id.24xlarge'|'ml.m6id.32xlarge'|'ml.c6id.large'|'ml.c6id.xlarge'|'ml.c6id.2xlarge'|'ml.c6id.4xlarge'|'ml.c6id.8xlarge'|'ml.c6id.12xlarge'|'ml.c6id.16xlarge'|'ml.c6id.24xlarge'|'ml.c6id.32xlarge'|'ml.r6id.large'|'ml.r6id.xlarge'|'ml.r6id.2xlarge'|'ml.r6id.4xlarge'|'ml.r6id.8xlarge'|'ml.r6id.12xlarge'|'ml.r6id.16xlarge'|'ml.r6id.24xlarge'|'ml.r6id.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'AppLifecycleManagement': {
                'IdleSettings': {
                    'IdleTimeoutInMinutes': 123
                }
            }
        },
        'JupyterLabAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.12xlarge'|'ml.g6.16xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.12xlarge'|'ml.g6e.16xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.p5.48xlarge'|'ml.p5en.48xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.c7i.large'|'ml.c7i.xlarge'|'ml.c7i.2xlarge'|'ml.c7i.4xlarge'|'ml.c7i.8xlarge'|'ml.c7i.12xlarge'|'ml.c7i.16xlarge'|'ml.c7i.24xlarge'|'ml.c7i.48xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.m6id.large'|'ml.m6id.xlarge'|'ml.m6id.2xlarge'|'ml.m6id.4xlarge'|'ml.m6id.8xlarge'|'ml.m6id.12xlarge'|'ml.m6id.16xlarge'|'ml.m6id.24xlarge'|'ml.m6id.32xlarge'|'ml.c6id.large'|'ml.c6id.xlarge'|'ml.c6id.2xlarge'|'ml.c6id.4xlarge'|'ml.c6id.8xlarge'|'ml.c6id.12xlarge'|'ml.c6id.16xlarge'|'ml.c6id.24xlarge'|'ml.c6id.32xlarge'|'ml.r6id.large'|'ml.r6id.xlarge'|'ml.r6id.2xlarge'|'ml.r6id.4xlarge'|'ml.r6id.8xlarge'|'ml.r6id.12xlarge'|'ml.r6id.16xlarge'|'ml.r6id.24xlarge'|'ml.r6id.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ],
            'AppLifecycleManagement': {
                'IdleSettings': {
                    'IdleTimeoutInMinutes': 123
                }
            }
        },
        'AppType': 'JupyterServer'|'KernelGateway'|'DetailedProfiler'|'TensorBoard'|'CodeEditor'|'JupyterLab'|'RStudioServerPro'|'RSessionGateway'|'Canvas',
        'SpaceStorageSettings': {
            'EbsStorageSettings': {
                'EbsVolumeSizeInGb': 123
            }
        },
        'SpaceManagedResources': 'ENABLED'|'DISABLED',
        'CustomFileSystems': [
            {
                'EFSFileSystem': {
                    'FileSystemId': 'string'
                },
                'FSxLustreFileSystem': {
                    'FileSystemId': 'string'
                }
            },
        ],
        'RemoteAccess': 'ENABLED'|'DISABLED'
    },
    'OwnershipSettings': {
        'OwnerUserProfileName': 'string'
    },
    'SpaceSharingSettings': {
        'SharingType': 'Private'|'Shared'
    },
    'SpaceDisplayName': 'string',
    'Url': 'string'
}

Response Structure

  • (dict) --

    • DomainId (string) --

      The ID of the associated domain.

    • SpaceArn (string) --

      The space's Amazon Resource Name (ARN).

    • SpaceName (string) --

      The name of the space.

    • HomeEfsFileSystemUid (string) --

      The ID of the space's profile in the Amazon EFS volume.

    • Status (string) --

      The status.

    • LastModifiedTime (datetime) --

      The last modified time.

    • CreationTime (datetime) --

      The creation time.

    • FailureReason (string) --

      The failure reason.

    • SpaceSettings (dict) --

      A collection of space settings.

      • JupyterServerAppSettings (dict) --

        The JupyterServer app settings.

        • DefaultResourceSpec (dict) --

          The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also required.

          • SageMakerImageArn (string) --

            The ARN of the SageMaker AI image that the image version belongs to.

          • SageMakerImageVersionArn (string) --

            The ARN of the image version created on the instance. To clear the value set for SageMakerImageVersionArn, pass None as the value.

          • SageMakerImageVersionAlias (string) --

            The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

          • InstanceType (string) --

            The instance type that the image version runs on.

          • LifecycleConfigArn (string) --

            The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

        • LifecycleConfigArns (list) --

          The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is also required.

          • (string) --

        • CodeRepositories (list) --

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

          • (dict) --

            A Git repository that SageMaker AI automatically displays to users for cloning in the JupyterServer application.

            • RepositoryUrl (string) --

              The URL of the Git repository.

      • KernelGatewayAppSettings (dict) --

        The KernelGateway app settings.

        • DefaultResourceSpec (dict) --

          The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the KernelGateway app.

          • SageMakerImageArn (string) --

            The ARN of the SageMaker AI image that the image version belongs to.

          • SageMakerImageVersionArn (string) --

            The ARN of the image version created on the instance. To clear the value set for SageMakerImageVersionArn, pass None as the value.

          • SageMakerImageVersionAlias (string) --

            The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

          • InstanceType (string) --

            The instance type that the image version runs on.

          • LifecycleConfigArn (string) --

            The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

        • CustomImages (list) --

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

          The maximum number of custom images are as follows.

          • On a domain level: 200

          • On a space level: 5

          • On a user profile level: 5

          • (dict) --

            A custom SageMaker AI image. For more information, see Bring your own SageMaker AI image.

            • ImageName (string) --

              The name of the CustomImage. Must be unique to your account.

            • ImageVersionNumber (integer) --

              The version number of the CustomImage.

            • AppImageConfigName (string) --

              The name of the AppImageConfig.

        • LifecycleConfigArns (list) --

          The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.

          • (string) --

      • CodeEditorAppSettings (dict) --

        The Code Editor application settings.

        • DefaultResourceSpec (dict) --

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

          • SageMakerImageArn (string) --

            The ARN of the SageMaker AI image that the image version belongs to.

          • SageMakerImageVersionArn (string) --

            The ARN of the image version created on the instance. To clear the value set for SageMakerImageVersionArn, pass None as the value.

          • SageMakerImageVersionAlias (string) --

            The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

          • InstanceType (string) --

            The instance type that the image version runs on.

          • LifecycleConfigArn (string) --

            The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

        • AppLifecycleManagement (dict) --

          Settings that are used to configure and manage the lifecycle of CodeEditor applications in a space.

          • IdleSettings (dict) --

            Settings related to idle shutdown of Studio applications.

            • IdleTimeoutInMinutes (integer) --

              The time that SageMaker waits after the application becomes idle before shutting it down.

      • JupyterLabAppSettings (dict) --

        The settings for the JupyterLab application.

        • DefaultResourceSpec (dict) --

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

          • SageMakerImageArn (string) --

            The ARN of the SageMaker AI image that the image version belongs to.

          • SageMakerImageVersionArn (string) --

            The ARN of the image version created on the instance. To clear the value set for SageMakerImageVersionArn, pass None as the value.

          • SageMakerImageVersionAlias (string) --

            The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

          • InstanceType (string) --

            The instance type that the image version runs on.

          • LifecycleConfigArn (string) --

            The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

        • CodeRepositories (list) --

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

          • (dict) --

            A Git repository that SageMaker AI automatically displays to users for cloning in the JupyterServer application.

            • RepositoryUrl (string) --

              The URL of the Git repository.

        • AppLifecycleManagement (dict) --

          Settings that are used to configure and manage the lifecycle of JupyterLab applications in a space.

          • IdleSettings (dict) --

            Settings related to idle shutdown of Studio applications.

            • IdleTimeoutInMinutes (integer) --

              The time that SageMaker waits after the application becomes idle before shutting it down.

      • AppType (string) --

        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.

      • SpaceStorageSettings (dict) --

        The storage settings for a space.

        • EbsStorageSettings (dict) --

          A collection of EBS storage settings for a space.

          • EbsVolumeSizeInGb (integer) --

            The size of an EBS storage volume for a space.

      • SpaceManagedResources (string) --

        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.

      • CustomFileSystems (list) --

        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.

        • (dict) --

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

          • EFSFileSystem (dict) --

            A custom file system in Amazon EFS.

            • FileSystemId (string) --

              The ID of your Amazon EFS file system.

          • FSxLustreFileSystem (dict) --

            A custom file system in Amazon FSx for Lustre.

            • FileSystemId (string) --

              Amazon FSx for Lustre file system ID.

      • RemoteAccess (string) --

        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.

    • OwnershipSettings (dict) --

      The collection of ownership settings for a space.

      • OwnerUserProfileName (string) --

        The user profile who is the owner of the space.

    • SpaceSharingSettings (dict) --

      The collection of space sharing settings for a space.

      • SharingType (string) --

        Specifies the sharing type of the space.

    • SpaceDisplayName (string) --

      The name of the space that appears in the Amazon SageMaker Studio UI.

    • Url (string) --

      Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through Amazon Web Services IAM Identity Center.

      The following application types are supported:

      • Studio Classic: &redirect=JupyterServer

      • JupyterLab: &redirect=JupyterLab

      • Code Editor, based on Code-OSS, Visual Studio Code - Open Source: &redirect=CodeEditor

ListSpaces (updated) Link ¶
Changes (response)
{'Spaces': {'SpaceSettingsSummary': {'RemoteAccess': 'ENABLED | DISABLED'}}}

Lists spaces.

See also: AWS API Documentation

Request Syntax

client.list_spaces(
    NextToken='string',
    MaxResults=123,
    SortOrder='Ascending'|'Descending',
    SortBy='CreationTime'|'LastModifiedTime',
    DomainIdEquals='string',
    SpaceNameContains='string'
)
type NextToken:

string

param NextToken:

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

type MaxResults:

integer

param MaxResults:

This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

type SortOrder:

string

param SortOrder:

The sort order for the results. The default is Ascending.

type SortBy:

string

param SortBy:

The parameter by which to sort the results. The default is CreationTime.

type DomainIdEquals:

string

param DomainIdEquals:

A parameter to search for the domain ID.

type SpaceNameContains:

string

param SpaceNameContains:

A parameter by which to filter the results.

rtype:

dict

returns:

Response Syntax

{
    'Spaces': [
        {
            'DomainId': 'string',
            'SpaceName': 'string',
            'Status': 'Deleting'|'Failed'|'InService'|'Pending'|'Updating'|'Update_Failed'|'Delete_Failed',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'SpaceSettingsSummary': {
                'AppType': 'JupyterServer'|'KernelGateway'|'DetailedProfiler'|'TensorBoard'|'CodeEditor'|'JupyterLab'|'RStudioServerPro'|'RSessionGateway'|'Canvas',
                'RemoteAccess': 'ENABLED'|'DISABLED',
                'SpaceStorageSettings': {
                    'EbsStorageSettings': {
                        'EbsVolumeSizeInGb': 123
                    }
                }
            },
            'SpaceSharingSettingsSummary': {
                'SharingType': 'Private'|'Shared'
            },
            'OwnershipSettingsSummary': {
                'OwnerUserProfileName': 'string'
            },
            'SpaceDisplayName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Spaces (list) --

      The list of spaces.

      • (dict) --

        The space's details.

        • DomainId (string) --

          The ID of the associated domain.

        • SpaceName (string) --

          The name of the space.

        • Status (string) --

          The status.

        • CreationTime (datetime) --

          The creation time.

        • LastModifiedTime (datetime) --

          The last modified time.

        • SpaceSettingsSummary (dict) --

          Specifies summary information about the space settings.

          • AppType (string) --

            The type of app created within the space.

          • RemoteAccess (string) --

            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.

          • SpaceStorageSettings (dict) --

            The storage settings for a space.

            • EbsStorageSettings (dict) --

              A collection of EBS storage settings for a space.

              • EbsVolumeSizeInGb (integer) --

                The size of an EBS storage volume for a space.

        • SpaceSharingSettingsSummary (dict) --

          Specifies summary information about the space sharing settings.

          • SharingType (string) --

            Specifies the sharing type of the space.

        • OwnershipSettingsSummary (dict) --

          Specifies summary information about the ownership settings.

          • OwnerUserProfileName (string) --

            The user profile who is the owner of the space.

        • SpaceDisplayName (string) --

          The name of the space that appears in the Studio UI.

    • NextToken (string) --

      If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

UpdateSpace (updated) Link ¶
Changes (request)
{'SpaceSettings': {'RemoteAccess': 'ENABLED | DISABLED'}}

Updates the settings of a space.

See also: AWS API Documentation

Request Syntax

client.update_space(
    DomainId='string',
    SpaceName='string',
    SpaceSettings={
        'JupyterServerAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.12xlarge'|'ml.g6.16xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.12xlarge'|'ml.g6e.16xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.p5.48xlarge'|'ml.p5en.48xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.c7i.large'|'ml.c7i.xlarge'|'ml.c7i.2xlarge'|'ml.c7i.4xlarge'|'ml.c7i.8xlarge'|'ml.c7i.12xlarge'|'ml.c7i.16xlarge'|'ml.c7i.24xlarge'|'ml.c7i.48xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.m6id.large'|'ml.m6id.xlarge'|'ml.m6id.2xlarge'|'ml.m6id.4xlarge'|'ml.m6id.8xlarge'|'ml.m6id.12xlarge'|'ml.m6id.16xlarge'|'ml.m6id.24xlarge'|'ml.m6id.32xlarge'|'ml.c6id.large'|'ml.c6id.xlarge'|'ml.c6id.2xlarge'|'ml.c6id.4xlarge'|'ml.c6id.8xlarge'|'ml.c6id.12xlarge'|'ml.c6id.16xlarge'|'ml.c6id.24xlarge'|'ml.c6id.32xlarge'|'ml.r6id.large'|'ml.r6id.xlarge'|'ml.r6id.2xlarge'|'ml.r6id.4xlarge'|'ml.r6id.8xlarge'|'ml.r6id.12xlarge'|'ml.r6id.16xlarge'|'ml.r6id.24xlarge'|'ml.r6id.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.12xlarge'|'ml.g6.16xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.12xlarge'|'ml.g6e.16xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.p5.48xlarge'|'ml.p5en.48xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.c7i.large'|'ml.c7i.xlarge'|'ml.c7i.2xlarge'|'ml.c7i.4xlarge'|'ml.c7i.8xlarge'|'ml.c7i.12xlarge'|'ml.c7i.16xlarge'|'ml.c7i.24xlarge'|'ml.c7i.48xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.m6id.large'|'ml.m6id.xlarge'|'ml.m6id.2xlarge'|'ml.m6id.4xlarge'|'ml.m6id.8xlarge'|'ml.m6id.12xlarge'|'ml.m6id.16xlarge'|'ml.m6id.24xlarge'|'ml.m6id.32xlarge'|'ml.c6id.large'|'ml.c6id.xlarge'|'ml.c6id.2xlarge'|'ml.c6id.4xlarge'|'ml.c6id.8xlarge'|'ml.c6id.12xlarge'|'ml.c6id.16xlarge'|'ml.c6id.24xlarge'|'ml.c6id.32xlarge'|'ml.r6id.large'|'ml.r6id.xlarge'|'ml.r6id.2xlarge'|'ml.r6id.4xlarge'|'ml.r6id.8xlarge'|'ml.r6id.12xlarge'|'ml.r6id.16xlarge'|'ml.r6id.24xlarge'|'ml.r6id.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ]
        },
        'CodeEditorAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.12xlarge'|'ml.g6.16xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.12xlarge'|'ml.g6e.16xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.p5.48xlarge'|'ml.p5en.48xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.c7i.large'|'ml.c7i.xlarge'|'ml.c7i.2xlarge'|'ml.c7i.4xlarge'|'ml.c7i.8xlarge'|'ml.c7i.12xlarge'|'ml.c7i.16xlarge'|'ml.c7i.24xlarge'|'ml.c7i.48xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.m6id.large'|'ml.m6id.xlarge'|'ml.m6id.2xlarge'|'ml.m6id.4xlarge'|'ml.m6id.8xlarge'|'ml.m6id.12xlarge'|'ml.m6id.16xlarge'|'ml.m6id.24xlarge'|'ml.m6id.32xlarge'|'ml.c6id.large'|'ml.c6id.xlarge'|'ml.c6id.2xlarge'|'ml.c6id.4xlarge'|'ml.c6id.8xlarge'|'ml.c6id.12xlarge'|'ml.c6id.16xlarge'|'ml.c6id.24xlarge'|'ml.c6id.32xlarge'|'ml.r6id.large'|'ml.r6id.xlarge'|'ml.r6id.2xlarge'|'ml.r6id.4xlarge'|'ml.r6id.8xlarge'|'ml.r6id.12xlarge'|'ml.r6id.16xlarge'|'ml.r6id.24xlarge'|'ml.r6id.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'AppLifecycleManagement': {
                'IdleSettings': {
                    'IdleTimeoutInMinutes': 123
                }
            }
        },
        'JupyterLabAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'SageMakerImageVersionAlias': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.12xlarge'|'ml.g6.16xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.12xlarge'|'ml.g6e.16xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.p5.48xlarge'|'ml.p5en.48xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.c7i.large'|'ml.c7i.xlarge'|'ml.c7i.2xlarge'|'ml.c7i.4xlarge'|'ml.c7i.8xlarge'|'ml.c7i.12xlarge'|'ml.c7i.16xlarge'|'ml.c7i.24xlarge'|'ml.c7i.48xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge'|'ml.m6id.large'|'ml.m6id.xlarge'|'ml.m6id.2xlarge'|'ml.m6id.4xlarge'|'ml.m6id.8xlarge'|'ml.m6id.12xlarge'|'ml.m6id.16xlarge'|'ml.m6id.24xlarge'|'ml.m6id.32xlarge'|'ml.c6id.large'|'ml.c6id.xlarge'|'ml.c6id.2xlarge'|'ml.c6id.4xlarge'|'ml.c6id.8xlarge'|'ml.c6id.12xlarge'|'ml.c6id.16xlarge'|'ml.c6id.24xlarge'|'ml.c6id.32xlarge'|'ml.r6id.large'|'ml.r6id.xlarge'|'ml.r6id.2xlarge'|'ml.r6id.4xlarge'|'ml.r6id.8xlarge'|'ml.r6id.12xlarge'|'ml.r6id.16xlarge'|'ml.r6id.24xlarge'|'ml.r6id.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ],
            'AppLifecycleManagement': {
                'IdleSettings': {
                    'IdleTimeoutInMinutes': 123
                }
            }
        },
        'AppType': 'JupyterServer'|'KernelGateway'|'DetailedProfiler'|'TensorBoard'|'CodeEditor'|'JupyterLab'|'RStudioServerPro'|'RSessionGateway'|'Canvas',
        'SpaceStorageSettings': {
            'EbsStorageSettings': {
                'EbsVolumeSizeInGb': 123
            }
        },
        'SpaceManagedResources': 'ENABLED'|'DISABLED',
        'CustomFileSystems': [
            {
                'EFSFileSystem': {
                    'FileSystemId': 'string'
                },
                'FSxLustreFileSystem': {
                    'FileSystemId': 'string'
                }
            },
        ],
        'RemoteAccess': 'ENABLED'|'DISABLED'
    },
    SpaceDisplayName='string'
)
type DomainId:

string

param DomainId:

[REQUIRED]

The ID of the associated domain.

type SpaceName:

string

param SpaceName:

[REQUIRED]

The name of the space.

type SpaceSettings:

dict

param SpaceSettings:

A collection of space settings.

  • JupyterServerAppSettings (dict) --

    The JupyterServer app settings.

    • DefaultResourceSpec (dict) --

      The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also required.

      • SageMakerImageArn (string) --

        The ARN of the SageMaker AI image that the image version belongs to.

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance. To clear the value set for SageMakerImageVersionArn, pass None as the value.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

      • InstanceType (string) --

        The instance type that the image version runs on.

      • LifecycleConfigArn (string) --

        The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

    • LifecycleConfigArns (list) --

      The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is also required.

      • (string) --

    • CodeRepositories (list) --

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

      • (dict) --

        A Git repository that SageMaker AI automatically displays to users for cloning in the JupyterServer application.

        • RepositoryUrl (string) -- [REQUIRED]

          The URL of the Git repository.

  • KernelGatewayAppSettings (dict) --

    The KernelGateway app settings.

    • DefaultResourceSpec (dict) --

      The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the KernelGateway app.

      • SageMakerImageArn (string) --

        The ARN of the SageMaker AI image that the image version belongs to.

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance. To clear the value set for SageMakerImageVersionArn, pass None as the value.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

      • InstanceType (string) --

        The instance type that the image version runs on.

      • LifecycleConfigArn (string) --

        The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

    • CustomImages (list) --

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

      The maximum number of custom images are as follows.

      • On a domain level: 200

      • On a space level: 5

      • On a user profile level: 5

      • (dict) --

        A custom SageMaker AI image. For more information, see Bring your own SageMaker AI image.

        • ImageName (string) -- [REQUIRED]

          The name of the CustomImage. Must be unique to your account.

        • ImageVersionNumber (integer) --

          The version number of the CustomImage.

        • AppImageConfigName (string) -- [REQUIRED]

          The name of the AppImageConfig.

    • LifecycleConfigArns (list) --

      The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.

      • (string) --

  • CodeEditorAppSettings (dict) --

    The Code Editor application settings.

    • DefaultResourceSpec (dict) --

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

      • SageMakerImageArn (string) --

        The ARN of the SageMaker AI image that the image version belongs to.

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance. To clear the value set for SageMakerImageVersionArn, pass None as the value.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

      • InstanceType (string) --

        The instance type that the image version runs on.

      • LifecycleConfigArn (string) --

        The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

    • AppLifecycleManagement (dict) --

      Settings that are used to configure and manage the lifecycle of CodeEditor applications in a space.

      • IdleSettings (dict) --

        Settings related to idle shutdown of Studio applications.

        • IdleTimeoutInMinutes (integer) --

          The time that SageMaker waits after the application becomes idle before shutting it down.

  • JupyterLabAppSettings (dict) --

    The settings for the JupyterLab application.

    • DefaultResourceSpec (dict) --

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

      • SageMakerImageArn (string) --

        The ARN of the SageMaker AI image that the image version belongs to.

      • SageMakerImageVersionArn (string) --

        The ARN of the image version created on the instance. To clear the value set for SageMakerImageVersionArn, pass None as the value.

      • SageMakerImageVersionAlias (string) --

        The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.

      • InstanceType (string) --

        The instance type that the image version runs on.

      • LifecycleConfigArn (string) --

        The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

    • CodeRepositories (list) --

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

      • (dict) --

        A Git repository that SageMaker AI automatically displays to users for cloning in the JupyterServer application.

        • RepositoryUrl (string) -- [REQUIRED]

          The URL of the Git repository.

    • AppLifecycleManagement (dict) --

      Settings that are used to configure and manage the lifecycle of JupyterLab applications in a space.

      • IdleSettings (dict) --

        Settings related to idle shutdown of Studio applications.

        • IdleTimeoutInMinutes (integer) --

          The time that SageMaker waits after the application becomes idle before shutting it down.

  • AppType (string) --

    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.

  • SpaceStorageSettings (dict) --

    The storage settings for a space.

    • EbsStorageSettings (dict) --

      A collection of EBS storage settings for a space.

      • EbsVolumeSizeInGb (integer) -- [REQUIRED]

        The size of an EBS storage volume for a space.

  • SpaceManagedResources (string) --

    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.

  • CustomFileSystems (list) --

    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.

    • (dict) --

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

      • EFSFileSystem (dict) --

        A custom file system in Amazon EFS.

        • FileSystemId (string) -- [REQUIRED]

          The ID of your Amazon EFS file system.

      • FSxLustreFileSystem (dict) --

        A custom file system in Amazon FSx for Lustre.

        • FileSystemId (string) -- [REQUIRED]

          Amazon FSx for Lustre file system ID.

  • RemoteAccess (string) --

    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.

type SpaceDisplayName:

string

param SpaceDisplayName:

The name of the space that appears in the Amazon SageMaker Studio UI.

rtype:

dict

returns:

Response Syntax

{
    'SpaceArn': 'string'
}

Response Structure

  • (dict) --

    • SpaceArn (string) --

      The space's Amazon Resource Name (ARN).