spaces

Creates, updates, deletes, gets or lists a spaces resource.

Overview

Name	spaces
Type	Resource
Id	aws.sagemaker.spaces

Fields

The following fields are returned by SELECT queries:

describe_space

Name	Datatype	Description
creation_time	string (date-time)	The creation time.
domain_id	string	The ID of the associated domain. (pattern: <code>d-(-*[a-z0-9]){1,61}</code>)
failure_reason	string	The failure reason.
home_efs_file_system_uid	string	The ID of the space's profile in the Amazon EFS volume. (pattern: <code>\d+</code>)
last_modified_time	string (date-time)	The last modified time.
ownership_settings	object	The collection of ownership settings for a space.
space_arn	string	The space's Amazon Resource Name (ARN). (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:space/.*</code>)
space_display_name	string	The name of the space that appears in the Amazon SageMaker Studio UI. (pattern: <code>(?!\s*$).+</code>)
space_name	string	The name of the space. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
space_settings	object	A collection of space settings.
space_sharing_settings	object	The collection of space sharing settings for a space.
status	string	The status. (Deleting, Failed, InService, Pending, Updating, Update_Failed, Delete_Failed)
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

list_spaces

Name	Datatype	Description
creation_time	string (date-time)	The creation time.
domain_id	string	The ID of the associated domain. (pattern: <code>d-(-*[a-z0-9]){1,61}</code>)
last_modified_time	string (date-time)	The last modified time.
ownership_settings_summary	object	Specifies summary information about the ownership settings.
space_display_name	string	The name of the space that appears in the Studio UI. (pattern: <code>(?!\s*$).+</code>)
space_name	string	The name of the space. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
space_settings_summary	object	Specifies summary information about the space settings.
space_sharing_settings_summary	object	Specifies summary information about the space sharing settings.
status	string	The status. (Deleting, Failed, InService, Pending, Updating, Update_Failed, Delete_Failed)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_space	select	region		Describes the space.
list_spaces	select	region		Lists spaces.
create_space	insert	region, DomainId, SpaceName		Creates a private space or a space used for real time collaboration in a domain.
update_space	update	region, DomainId, SpaceName		Updates the settings of a space. You can't edit the app type of a space in the SpaceSettings.
delete_space	delete	region		Used to delete a space.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_space

Describes the space.

SELECT
creation_time,
domain_id,
failure_reason,
home_efs_file_system_uid,
last_modified_time,
ownership_settings,
space_arn,
space_display_name,
space_name,
space_settings,
space_sharing_settings,
status,
url
FROM aws.sagemaker.spaces
WHERE region = '{{ region }}' -- required
;

list_spaces

Lists spaces.

SELECT
creation_time,
domain_id,
last_modified_time,
ownership_settings_summary,
space_display_name,
space_name,
space_settings_summary,
space_sharing_settings_summary,
status
FROM aws.sagemaker.spaces
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_space

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

INSERT INTO aws.sagemaker.spaces (
DomainId,
SpaceName,
Tags,
SpaceSettings,
OwnershipSettings,
SpaceSharingSettings,
SpaceDisplayName,
region
)
SELECT 
'{{ DomainId }}' /* required */,
'{{ SpaceName }}' /* required */,
'{{ Tags }}',
'{{ SpaceSettings }}',
'{{ OwnershipSettings }}',
'{{ SpaceSharingSettings }}',
'{{ SpaceDisplayName }}',
'{{ region }}'
RETURNING
space_arn
;

Manifest

# Description fields are for documentation purposes
- name: spaces
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the spaces resource.
  - name: DomainId
    value: "{{ DomainId }}"
    description: |
      The ID of the associated domain.
  - name: SpaceName
    value: "{{ SpaceName }}"
    description: |
      The name of the space.
  - name: Tags
    description: |
      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.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: SpaceSettings
    description: |
      A collection of space settings.
    value:
      JupyterServerAppSettings:
        DefaultResourceSpec:
          SageMakerImageArn: "{{ SageMakerImageArn }}"
          SageMakerImageVersionArn: "{{ SageMakerImageVersionArn }}"
          SageMakerImageVersionAlias: "{{ SageMakerImageVersionAlias }}"
          InstanceType: "{{ InstanceType }}"
          LifecycleConfigArn: "{{ LifecycleConfigArn }}"
          TrainingPlanArn: "{{ TrainingPlanArn }}"
        LifecycleConfigArns:
          - "{{ LifecycleConfigArns }}"
        CodeRepositories:
          - RepositoryUrl: "{{ RepositoryUrl }}"
      KernelGatewayAppSettings:
        DefaultResourceSpec:
          SageMakerImageArn: "{{ SageMakerImageArn }}"
          SageMakerImageVersionArn: "{{ SageMakerImageVersionArn }}"
          SageMakerImageVersionAlias: "{{ SageMakerImageVersionAlias }}"
          InstanceType: "{{ InstanceType }}"
          LifecycleConfigArn: "{{ LifecycleConfigArn }}"
          TrainingPlanArn: "{{ TrainingPlanArn }}"
        CustomImages:
          - ImageName: "{{ ImageName }}"
            ImageVersionNumber: {{ ImageVersionNumber }}
            AppImageConfigName: "{{ AppImageConfigName }}"
        LifecycleConfigArns:
          - "{{ LifecycleConfigArns }}"
      CodeEditorAppSettings:
        DefaultResourceSpec:
          SageMakerImageArn: "{{ SageMakerImageArn }}"
          SageMakerImageVersionArn: "{{ SageMakerImageVersionArn }}"
          SageMakerImageVersionAlias: "{{ SageMakerImageVersionAlias }}"
          InstanceType: "{{ InstanceType }}"
          LifecycleConfigArn: "{{ LifecycleConfigArn }}"
          TrainingPlanArn: "{{ TrainingPlanArn }}"
        AppLifecycleManagement:
          IdleSettings:
            IdleTimeoutInMinutes: {{ IdleTimeoutInMinutes }}
      JupyterLabAppSettings:
        DefaultResourceSpec:
          SageMakerImageArn: "{{ SageMakerImageArn }}"
          SageMakerImageVersionArn: "{{ SageMakerImageVersionArn }}"
          SageMakerImageVersionAlias: "{{ SageMakerImageVersionAlias }}"
          InstanceType: "{{ InstanceType }}"
          LifecycleConfigArn: "{{ LifecycleConfigArn }}"
          TrainingPlanArn: "{{ TrainingPlanArn }}"
        CodeRepositories:
          - RepositoryUrl: "{{ RepositoryUrl }}"
        AppLifecycleManagement:
          IdleSettings:
            IdleTimeoutInMinutes: {{ IdleTimeoutInMinutes }}
      AppType: "{{ AppType }}"
      SpaceStorageSettings:
        EbsStorageSettings:
          EbsVolumeSizeInGb: {{ EbsVolumeSizeInGb }}
      SpaceManagedResources: "{{ SpaceManagedResources }}"
      CustomFileSystems:
        - EFSFileSystem:
            FileSystemId: "{{ FileSystemId }}"
          FSxLustreFileSystem:
            FileSystemId: "{{ FileSystemId }}"
          S3FileSystem:
            S3Uri: "{{ S3Uri }}"
      RemoteAccess: "{{ RemoteAccess }}"
  - name: OwnershipSettings
    description: |
      A collection of ownership settings.
    value:
      OwnerUserProfileName: "{{ OwnerUserProfileName }}"
  - name: SpaceSharingSettings
    description: |
      A collection of space sharing settings.
    value:
      SharingType: "{{ SharingType }}"
  - name: SpaceDisplayName
    value: "{{ SpaceDisplayName }}"
    description: |
      The name of the space that appears in the SageMaker Studio UI.

UPDATE examples

update_space

Updates the settings of a space. You can't edit the app type of a space in the SpaceSettings.

UPDATE aws.sagemaker.spaces
SET 
DomainId = '{{ DomainId }}',
SpaceName = '{{ SpaceName }}',
SpaceSettings = '{{ SpaceSettings }}',
SpaceDisplayName = '{{ SpaceDisplayName }}'
WHERE 
region = '{{ region }}' --required
AND DomainId = '{{ DomainId }}' --required
AND SpaceName = '{{ SpaceName }}' --required
RETURNING
space_arn;

DELETE examples

delete_space

Used to delete a space.

DELETE FROM aws.sagemaker.spaces
WHERE region = '{{ region }}' --required
;