SageMaker / Client / update_space

update_space#

SageMaker.Client.update_space(**kwargs)#

Updates the settings of a space.

Request Syntax

response = client.update_space(
    DomainId='string',
    SpaceName='string',
    SpaceSettings={
        'JupyterServerAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': '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',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': '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',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ]
        }
    }
)

Parameters:

DomainId (string) –
[REQUIRED]

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

The name of the space.
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.
    - 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.
    - 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) –

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
SageMaker.Client.exceptions.ResourceNotFound