Creates a private space or a space used for real time collaboration in a domain.
Request Syntax
{
"DomainId": "string",
"OwnershipSettings": {
"OwnerUserProfileName": "string"
},
"SpaceDisplayName": "string",
"SpaceName": "string",
"SpaceSettings": {
"AppType": "string",
"CodeEditorAppSettings": {
"AppLifecycleManagement": {
"IdleSettings": {
"IdleTimeoutInMinutes": number
}
},
"DefaultResourceSpec": {
"InstanceType": "string",
"LifecycleConfigArn": "string",
"SageMakerImageArn": "string",
"SageMakerImageVersionAlias": "string",
"SageMakerImageVersionArn": "string"
}
},
"CustomFileSystems": [
{ ... }
],
"JupyterLabAppSettings": {
"AppLifecycleManagement": {
"IdleSettings": {
"IdleTimeoutInMinutes": number
}
},
"CodeRepositories": [
{
"RepositoryUrl": "string"
}
],
"DefaultResourceSpec": {
"InstanceType": "string",
"LifecycleConfigArn": "string",
"SageMakerImageArn": "string",
"SageMakerImageVersionAlias": "string",
"SageMakerImageVersionArn": "string"
}
},
"JupyterServerAppSettings": {
"CodeRepositories": [
{
"RepositoryUrl": "string"
}
],
"DefaultResourceSpec": {
"InstanceType": "string",
"LifecycleConfigArn": "string",
"SageMakerImageArn": "string",
"SageMakerImageVersionAlias": "string",
"SageMakerImageVersionArn": "string"
},
"LifecycleConfigArns": [ "string" ]
},
"KernelGatewayAppSettings": {
"CustomImages": [
{
"AppImageConfigName": "string",
"ImageName": "string",
"ImageVersionNumber": number
}
],
"DefaultResourceSpec": {
"InstanceType": "string",
"LifecycleConfigArn": "string",
"SageMakerImageArn": "string",
"SageMakerImageVersionAlias": "string",
"SageMakerImageVersionArn": "string"
},
"LifecycleConfigArns": [ "string" ]
},
"SpaceStorageSettings": {
"EbsStorageSettings": {
"EbsVolumeSizeInGb": number
}
}
},
"SpaceSharingSettings": {
"SharingType": "string"
},
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- DomainId
-
The ID of the associated domain.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
^d-(-*[a-z0-9]){1,61}Required: Yes
- OwnershipSettings
-
A collection of ownership settings.
Type: OwnershipSettings object
Required: No
- SpaceDisplayName
-
The name of the space that appears in the SageMaker Studio UI.
Type: String
Length Constraints: Maximum length of 64.
Pattern:
^(?!\s*$).+Required: No
- SpaceName
-
The name of the space.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}Required: Yes
- SpaceSettings
-
A collection of space settings.
Type: SpaceSettings object
Required: No
- SpaceSharingSettings
-
A collection of space sharing settings.
Type: SpaceSharingSettings object
Required: No
- 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
SearchAPI.Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
Response Syntax
{
"SpaceArn": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- SpaceArn
-
The space's Amazon Resource Name (ARN).
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:space/.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceInUse
-
Resource being accessed is in use.
HTTP Status Code: 400
- ResourceLimitExceeded
-
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
