DescribeSpace
Describes the space.
Request Syntax
{
"DomainId": "string
",
"SpaceName": "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.
Response Syntax
{
"CreationTime": number,
"DomainId": "string",
"FailureReason": "string",
"HomeEfsFileSystemUid": "string",
"LastModifiedTime": number,
"OwnershipSettings": {
"OwnerUserProfileName": "string"
},
"SpaceArn": "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"
},
"Status": "string",
"Url": "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.
- CreationTime
-
The creation time.
Type: Timestamp
- DomainId
-
The ID of the associated domain.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
^d-(-*[a-z0-9]){1,61}
- FailureReason
-
The failure reason.
Type: String
Length Constraints: Maximum length of 1024.
- HomeEfsFileSystemUid
-
The ID of the space's profile in the Amazon EFS volume.
Type: String
Length Constraints: Maximum length of 10.
Pattern:
\d+
- LastModifiedTime
-
The last modified time.
Type: Timestamp
- OwnershipSettings
-
The collection of ownership settings for a space.
Type: OwnershipSettings object
- 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/.*
- SpaceDisplayName
-
The name of the space that appears in the Amazon SageMaker Studio UI.
Type: String
Length Constraints: Maximum length of 64.
Pattern:
^(?!\s*$).+
- 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}
- SpaceSettings
-
A collection of space settings.
Type: SpaceSettings object
- SpaceSharingSettings
-
The collection of space sharing settings for a space.
Type: SpaceSharingSettings object
- Status
-
The status.
Type: String
Valid Values:
Deleting | Failed | InService | Pending | Updating | Update_Failed | Delete_Failed
- Url
-
Returns the URL of the space. If the space is created with Amazon IAM Identity Center (Successor to Amazon 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 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
Type: String
Length Constraints: Maximum length of 1024.
-
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFound
-
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: