SageMaker / Client / create_space

create_space#

SageMaker.Client.create_space(**kwargs)#

Creates a space used for real time collaboration in a Domain.

Request Syntax

response = 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.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.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.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.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.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            }
        },
        '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.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.trn1.2xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'AppType': 'JupyterServer'|'KernelGateway'|'DetailedProfiler'|'TensorBoard'|'VSCode'|'Savitur'|'CodeEditor'|'JupyterLab'|'RStudioServerPro'|'RSession'|'RSessionGateway'|'Canvas'|'DatasetManager'|'SageMakerLite'|'Local',
        'SpaceStorageSettings': {
            'EbsStorageSettings': {
                'EbsVolumeSizeInGb': 123
            }
        },
        'CustomFileSystems': [
            {
                'EFSFileSystem': {
                    'FileSystemId': 'string'
                }
            },
        ]
    },
    OwnershipSettings={
        'OwnerUserProfileName': 'string'
    },
    SpaceSharingSettings={
        'SharingType': 'Private'|'Shared'
    },
    SpaceDisplayName='string'
)

Parameters:

DomainId (string) –
[REQUIRED]

The ID of the associated Domain.
SpaceName (string) –
[REQUIRED]

The name of the space.
Tags (list) –
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.
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 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 image that the image version belongs to.
    - SageMakerImageVersionArn (string) –
      
      The ARN of the image version created on the instance.
    - 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.
      
      Note
      JupyterServer apps only support the system value.
      
      For KernelGateway apps, the system value is translated to ml.t3.medium. KernelGateway apps also support all other values for available instance types.
    - 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.
    
    Note
    To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.
    - (string) –
  - CodeRepositories (list) –
    
    A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application.
    - (dict) –
      
      A Git repository that SageMaker 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 image used by the KernelGateway app.
    
    Note
    The Amazon SageMaker Studio UI does not use the default instance type value set here. The default instance type set here is used when Apps are created using the Amazon Web Services Command Line Interface or Amazon Web Services CloudFormation and the instance type parameter value is not passed.
    - SageMakerImageArn (string) –
      
      The ARN of the SageMaker image that the image version belongs to.
    - SageMakerImageVersionArn (string) –
      
      The ARN of the image version created on the instance.
    - 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.
      
      Note
      JupyterServer apps only support the system value.
      
      For KernelGateway apps, the system value is translated to ml.t3.medium. KernelGateway apps also support all other values for available instance types.
    - LifecycleConfigArn (string) –
      
      The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
  - CustomImages (list) –
    
    A list of custom SageMaker images that are configured to run as a KernelGateway app.
    - (dict) –
      
      A custom SageMaker image. For more information, see Bring your own SageMaker 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.
    
    Note
    To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.
    - (string) –
- CodeEditorAppSettings (dict) –
  
  The Code Editor application settings.
  - DefaultResourceSpec (dict) –
    
    Specifies the ARN’s of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
    - SageMakerImageArn (string) –
      
      The ARN of the SageMaker image that the image version belongs to.
    - SageMakerImageVersionArn (string) –
      
      The ARN of the image version created on the instance.
    - 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.
      
      Note
      JupyterServer apps only support the system value.
      
      For KernelGateway apps, the system value is translated to ml.t3.medium. KernelGateway apps also support all other values for available instance types.
    - LifecycleConfigArn (string) –
      
      The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- JupyterLabAppSettings (dict) –
  
  The settings for the JupyterLab application.
  - DefaultResourceSpec (dict) –
    
    Specifies the ARN’s of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
    - SageMakerImageArn (string) –
      
      The ARN of the SageMaker image that the image version belongs to.
    - SageMakerImageVersionArn (string) –
      
      The ARN of the image version created on the instance.
    - 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.
      
      Note
      JupyterServer apps only support the system value.
      
      For KernelGateway apps, the system value is translated to ml.t3.medium. KernelGateway apps also support all other values for available instance types.
    - 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 automatically displays to users for cloning in the JupyterServer application.
      - RepositoryUrl (string) – [REQUIRED]
        
        The URL of the Git repository.
- AppType (string) –
  
  The type of app created within the space.
- SpaceStorageSettings (dict) –
  
  The storage settings for a private space.
  - EbsStorageSettings (dict) –
    
    A collection of EBS storage settings for a private space.
    - EbsVolumeSizeInGb (integer) – [REQUIRED]
      
      The size of an EBS storage volume for a private space.
- CustomFileSystems (list) –
  
  A file system, created by you, that you assign to a space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.
  - (dict) –
    
    A file system, created by you, that you assign to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.
    
    Note
    This is a Tagged Union structure. Only one of the following top level keys can be set: EFSFileSystem.
    - EFSFileSystem (dict) –
      
      A custom file system in Amazon EFS.
      - FileSystemId (string) – [REQUIRED]
        
        The ID of your Amazon EFS file system.
OwnershipSettings (dict) –
A collection of ownership settings.
- OwnerUserProfileName (string) – [REQUIRED]
  
  The user profile who is the owner of the private space.
SpaceSharingSettings (dict) –
A collection of space sharing settings.
- SharingType (string) – [REQUIRED]
  
  Specifies the sharing type of the space.
SpaceDisplayName (string) – The name of the space that appears in the SageMaker Studio UI.

Return type:

dict

Returns:

Response Syntax

{
    'SpaceArn': 'string'
}

Response Structure

(dict) –
- SpaceArn (string) –
  
  The space’s Amazon Resource Name (ARN).

Exceptions

SageMaker.Client.exceptions.ResourceLimitExceeded
SageMaker.Client.exceptions.ResourceInUse