Amazon SageMaker Sagemaker Space API
The Sagemaker Space API from Amazon SageMaker — 5 operation(s) for sagemaker space.
The Sagemaker Space API from Amazon SageMaker — 5 operation(s) for sagemaker space.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/amazon-sagemaker:amazon-sagemaker-space-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.1.0
info:
title: Amazon SageMaker Service Space API
version: '2017-07-24'
description: Generated from AWS's published Smithy model for Amazon SageMaker Service. 5 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://api.sagemaker.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
paths:
/#CreateSpace:
post:
operationId: CreateSpace
summary: Create Space
description: Creates a private space or a space used for real time collaboration in a domain.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/CreateSpaceResponse'
'400':
description: ResourceInUse; ResourceLimitExceeded
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ResourceInUse'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- SageMaker.CreateSpace
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/CreateSpaceRequest'
tags:
- Space
/#DeleteSpace:
post:
operationId: DeleteSpace
summary: Delete Space
description: Used to delete a space.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
type: string
'400':
description: ResourceInUse; ResourceNotFound
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ResourceInUse'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- SageMaker.DeleteSpace
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DeleteSpaceRequest'
tags:
- Space
/#DescribeSpace:
post:
operationId: DescribeSpace
summary: Describe Space
description: Describes the space.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DescribeSpaceResponse'
'400':
description: ResourceNotFound
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ResourceNotFound'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- SageMaker.DescribeSpace
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DescribeSpaceRequest'
tags:
- Space
/#ListSpaces:
post:
operationId: ListSpaces
summary: List Spaces
description: Lists spaces.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ListSpacesResponse'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- SageMaker.ListSpaces
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ListSpacesRequest'
tags:
- Space
/#UpdateSpace:
post:
operationId: UpdateSpace
summary: Update Space
description: Updates the settings of a space. You can't edit the app type of a space in the SpaceSettings.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/UpdateSpaceResponse'
'400':
description: ResourceInUse; ResourceLimitExceeded; ResourceNotFound
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ResourceInUse'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- SageMaker.UpdateSpace
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/UpdateSpaceRequest'
tags:
- Space
components:
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: sagemaker
schemas:
CodeRepository:
type: object
properties:
RepositoryUrl:
type: string
description: The URL of the Git repository.
required:
- RepositoryUrl
CreateSpaceRequest:
type: object
properties:
DomainId:
type: string
description: The ID of the associated domain.
SpaceName:
type: string
description: The name of the space.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
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.
SpaceSettings:
$ref: '#/components/schemas/SpaceSettings'
OwnershipSettings:
$ref: '#/components/schemas/OwnershipSettings'
SpaceSharingSettings:
$ref: '#/components/schemas/SpaceSharingSettings'
SpaceDisplayName:
type: string
description: The name of the space that appears in the SageMaker Studio UI.
required:
- DomainId
- SpaceName
CreateSpaceResponse:
type: object
properties:
SpaceArn:
type: string
description: The space's Amazon Resource Name (ARN).
CustomFileSystem:
type: object
properties:
EFSFileSystem:
$ref: '#/components/schemas/EFSFileSystem'
FSxLustreFileSystem:
$ref: '#/components/schemas/FSxLustreFileSystem'
S3FileSystem:
$ref: '#/components/schemas/S3FileSystem'
description: Exactly one member is set.
CustomImage:
type: object
properties:
ImageName:
type: string
description: The name of the CustomImage. Must be unique to your account.
ImageVersionNumber:
type: integer
description: The version number of the CustomImage.
AppImageConfigName:
type: string
description: The name of the AppImageConfig.
required:
- ImageName
- AppImageConfigName
DeleteSpaceRequest:
type: object
properties:
DomainId:
type: string
description: The ID of the associated domain.
SpaceName:
type: string
description: The name of the space.
required:
- DomainId
- SpaceName
DescribeSpaceRequest:
type: object
properties:
DomainId:
type: string
description: The ID of the associated domain.
SpaceName:
type: string
description: The name of the space.
required:
- DomainId
- SpaceName
DescribeSpaceResponse:
type: object
properties:
DomainId:
type: string
description: The ID of the associated domain.
SpaceArn:
type: string
description: The space's Amazon Resource Name (ARN).
SpaceName:
type: string
description: The name of the space.
HomeEfsFileSystemUid:
type: string
description: The ID of the space's profile in the Amazon EFS volume.
Status:
type: string
enum:
- Deleting
- Failed
- InService
- Pending
- Updating
- Update_Failed
- Delete_Failed
description: The status.
LastModifiedTime:
type: string
format: date-time
description: The last modified time.
CreationTime:
type: string
format: date-time
description: The creation time.
FailureReason:
type: string
description: The failure reason.
SpaceSettings:
$ref: '#/components/schemas/SpaceSettings'
OwnershipSettings:
$ref: '#/components/schemas/OwnershipSettings'
SpaceSharingSettings:
$ref: '#/components/schemas/SpaceSharingSettings'
SpaceDisplayName:
type: string
description: The name of the space that appears in the Amazon SageMaker Studio UI.
Url:
type: string
description: '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'
EFSFileSystem:
type: object
properties:
FileSystemId:
type: string
description: The ID of your Amazon EFS file system.
required:
- FileSystemId
EbsStorageSettings:
type: object
properties:
EbsVolumeSizeInGb:
type: integer
description: The size of an EBS storage volume for a space.
required:
- EbsVolumeSizeInGb
FSxLustreFileSystem:
type: object
properties:
FileSystemId:
type: string
description: Amazon FSx for Lustre file system ID.
required:
- FileSystemId
JupyterServerAppSettings:
type: object
properties:
DefaultResourceSpec:
$ref: '#/components/schemas/ResourceSpec'
LifecycleConfigArns:
type: array
items:
type: string
description: The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If
you use this parameter, the DefaultResourceSpec parameter is also required. To remove a Lifecycle Config, you
must set LifecycleConfigArns to an empty list.
CodeRepositories:
type: array
items:
$ref: '#/components/schemas/CodeRepository'
description: A list of Git repositories that SageMaker AI automatically displays to users for cloning in the JupyterServer
application.
KernelGatewayAppSettings:
type: object
properties:
DefaultResourceSpec:
$ref: '#/components/schemas/ResourceSpec'
CustomImages:
type: array
items:
$ref: '#/components/schemas/CustomImage'
description: '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'
LifecycleConfigArns:
type: array
items:
type: string
description: The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or
domain. To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.
ListSpacesRequest:
type: object
properties:
NextToken:
type: string
description: If the previous response was truncated, you will receive this token. Use it in your next request to
receive the next set of results.
MaxResults:
type: integer
description: 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.
SortOrder:
type: string
enum:
- Ascending
- Descending
description: The sort order for the results. The default is Ascending.
SortBy:
type: string
enum:
- CreationTime
- LastModifiedTime
description: The parameter by which to sort the results. The default is CreationTime.
DomainIdEquals:
type: string
description: A parameter to search for the domain ID.
SpaceNameContains:
type: string
description: A parameter by which to filter the results.
ListSpacesResponse:
type: object
properties:
Spaces:
type: array
items:
$ref: '#/components/schemas/SpaceDetails'
description: The list of spaces.
NextToken:
type: string
description: If the previous response was truncated, you will receive this token. Use it in your next request to
receive the next set of results.
OwnershipSettings:
type: object
properties:
OwnerUserProfileName:
type: string
description: The user profile who is the owner of the space.
required:
- OwnerUserProfileName
OwnershipSettingsSummary:
type: object
properties:
OwnerUserProfileName:
type: string
description: The user profile who is the owner of the space.
ResourceInUse:
type: object
properties:
Message:
type: string
ResourceNotFound:
type: object
properties:
Message:
type: string
ResourceSpec:
type: object
properties:
SageMakerImageArn:
type: string
description: The ARN of the SageMaker AI image that the image version belongs to.
SageMakerImageVersionArn:
type: string
description: The ARN of the image version created on the instance. To clear the value set for SageMakerImageVersionArn,
pass None as the value.
SageMakerImageVersionAlias:
type: string
description: The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning
format.
InstanceType:
type: string
enum:
- 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.p6-b200.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
- ml.p5.4xlarge
- ml.g7.2xlarge
- ml.g7.4xlarge
- ml.g7.8xlarge
- ml.g7.12xlarge
- ml.g7.24xlarge
- ml.g7.48xlarge
- ml.g7e.2xlarge
- ml.g7e.4xlarge
- ml.g7e.8xlarge
- ml.g7e.12xlarge
- ml.g7e.24xlarge
- ml.g7e.48xlarge
description: The instance type that the image version runs on. 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:
type: string
description: The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
TrainingPlanArn:
type: string
description: The ARN of the SageMaker AI Training Plan to use for this app. When you specify a training plan, the
app launches on reserved GPU capacity. This field is supported for JupyterLab and CodeEditor app types. For more
information about how to reserve GPU capacity with SageMaker AI Training Plans, see Using training plans in Studio
applications.
S3FileSystem:
type: object
properties:
S3Uri:
type: string
description: 'The Amazon S3 URI that specifies the location in S3 where files are stored, which is mounted within
the Studio environment. For example: s3://<bucket-name>/<prefix>/.'
required:
- S3Uri
SpaceAppLifecycleManagement:
type: object
properties:
IdleSettings:
$ref: '#/components/schemas/SpaceIdleSettings'
SpaceCodeEditorAppSettings:
type: object
properties:
DefaultResourceSpec:
$ref: '#/components/schemas/ResourceSpec'
AppLifecycleManagement:
$ref: '#/components/schemas/SpaceAppLifecycleManagement'
SpaceDetails:
type: object
properties:
DomainId:
type: string
description: The ID of the associated domain.
SpaceName:
type: string
description: The name of the space.
Status:
type: string
enum:
- Deleting
- Failed
- InService
- Pending
- Updating
- Update_Failed
- Delete_Failed
description: The status.
CreationTime:
type: string
format: date-time
description: The creation time.
LastModifiedTime:
type: string
format: date-time
description: The last modified time.
SpaceSettingsSummary:
$ref: '#/components/schemas/SpaceSettingsSummary'
SpaceSharingSettingsSummary:
$ref: '#/components/schemas/SpaceSharingSettingsSummary'
OwnershipSettingsSummary:
$ref: '#/components/schemas/OwnershipSettingsSummary'
SpaceDisplayName:
type: string
description: The name of the space that appears in the Studio UI.
SpaceIdleSettings:
type: object
properties:
IdleTimeoutInMinutes:
type: integer
description: The time that SageMaker waits after the application becomes idle before shutting it down.
SpaceJupyterLabAppSettings:
type: object
properties:
DefaultResourceSpec:
$ref: '#/components/schemas/ResourceSpec'
CodeRepositories:
type: array
items:
$ref: '#/components/schemas/CodeRepository'
description: A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab
application.
AppLifecycleManagement:
$ref: '#/components/schemas/SpaceAppLifecycleManagement'
SpaceSettings:
type: object
properties:
JupyterServerAppSettings:
$ref: '#/components/schemas/JupyterServerAppSettings'
KernelGatewayAppSettings:
$ref: '#/components/schemas/KernelGatewayAppSettings'
CodeEditorAppSettings:
$ref: '#/components/schemas/SpaceCodeEditorAppSettings'
JupyterLabAppSettings:
$ref: '#/components/schemas/SpaceJupyterLabAppSettings'
AppType:
type: string
enum:
- JupyterServer
- KernelGateway
- DetailedProfiler
- TensorBoard
- CodeEditor
- JupyterLab
- RStudioServerPro
- RSessionGateway
- Canvas
description: 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:
$ref: '#/components/schemas/SpaceStorageSettings'
SpaceManagedResources:
type: string
enum:
- ENABLED
- DISABLED
description: '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:
type: array
items:
$ref: '#/components/schemas/CustomFileSystem'
description: 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.
RemoteAccess:
type: string
enum:
- ENABLED
- DISABLED
description: 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.
SpaceSettingsSummary:
type: object
properties:
AppType:
type: string
enum:
- JupyterServer
- KernelGateway
- DetailedProfiler
- TensorBoard
- CodeEditor
- JupyterLab
- RStudioServerPro
- RSessionGateway
- Canvas
description: The type of app created within the space.
RemoteAccess:
type: string
enum:
- ENABLED
- DISABLED
description: 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:
$ref: '#/components/schemas/SpaceStorageSettings'
SpaceSharingSettings:
type: object
properties:
SharingType:
type: string
enum:
- Private
- Shared
description: Specifies the sharing type of the space.
required:
- SharingType
SpaceSharingSettingsSummary:
type: object
properties:
SharingType:
type: string
enum:
- Private
- Shared
description: Specifies the sharing type of the space.
SpaceStorageSettings:
type: object
properties:
EbsStorageSettings:
$ref: '#/components/schemas/EbsStorageSettings'
Tag:
type: object
properties:
Key:
type: string
description: The tag key. Tag keys must be unique per resource.
Value:
type: string
description: The tag value.
required:
- Key
- Value
UpdateSpaceRequest:
type: object
properties:
DomainId:
type: string
description: The ID of the associated domain.
SpaceName:
type: string
description: The name of the space.
SpaceSettings:
$ref: '#/components/schemas/SpaceSettings'
SpaceDisplayName:
type: string
description: The name of the space that appears in the Amazon SageMaker Studio UI.
required:
- DomainId
- SpaceName
UpdateSpaceResponse:
type: object
properties:
SpaceArn:
type: string
description: The space's Amazon Resource Name (ARN).
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/sagemaker/service/2017-07-24/sagemaker-2017-07-24.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)