Skip to content

DescribeSpaceResponse

Source code in docs_src/capo_sagemaker/types/describe_space_response.py
class DescribeSpaceResponse(TypedDict, closed=True):
    domain_id: NotRequired["capo_sagemaker.types.domain_id.DomainId"]
    """<p>The ID of the associated domain.</p>"""
    space_arn: NotRequired["capo_sagemaker.types.space_arn.SpaceArn"]
    """<p>The space's Amazon Resource Name (ARN).</p>"""
    space_name: NotRequired["capo_sagemaker.types.space_name.SpaceName"]
    """<p>The name of the space.</p>"""
    home_efs_file_system_uid: NotRequired["capo_sagemaker.types.efs_uid.EfsUid"]
    """<p>The ID of the space's profile in the Amazon EFS volume.</p>"""
    status: NotRequired["capo_sagemaker.types.space_status.SpaceStatus"]
    """<p>The status.</p>"""
    last_modified_time: NotRequired[
        "capo_sagemaker.types.last_modified_time.LastModifiedTime"
    ]
    """<p>The last modified time.</p>"""
    creation_time: NotRequired["capo_sagemaker.types.creation_time.CreationTime"]
    """<p>The creation time.</p>"""
    failure_reason: NotRequired["capo_sagemaker.types.failure_reason.FailureReason"]
    """<p>The failure reason.</p>"""
    space_settings: NotRequired["capo_sagemaker.types.space_settings.SpaceSettings"]
    """<p>A collection of space settings.</p>"""
    ownership_settings: NotRequired[
        "capo_sagemaker.types.ownership_settings.OwnershipSettings"
    ]
    """<p>The collection of ownership settings for a space.</p>"""
    space_sharing_settings: NotRequired[
        "capo_sagemaker.types.space_sharing_settings.SpaceSharingSettings"
    ]
    """<p>The collection of space sharing settings for a space.</p>"""
    space_display_name: NotRequired[
        "capo_sagemaker.types.non_empty_string64.NonEmptyString64"
    ]
    """<p>The name of the space that appears in the Amazon SageMaker Studio UI.</p>"""
    url: NotRequired["capo_sagemaker.types.string1024.String1024"]
    """<p>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.</p> <p>The following application types are supported:</p> <ul> <li> <p>Studio Classic: <code>&amp;redirect=JupyterServer</code> </p> </li> <li> <p>JupyterLab: <code>&amp;redirect=JupyterLab</code> </p> </li> <li> <p>Code Editor, based on Code-OSS, Visual Studio Code - Open Source: <code>&amp;redirect=CodeEditor</code> </p> </li> </ul>"""

creation_time instance-attribute

creation_time: NotRequired[CreationTime]

The creation time.

domain_id instance-attribute

domain_id: NotRequired[DomainId]

The ID of the associated domain.

failure_reason instance-attribute

failure_reason: NotRequired[FailureReason]

The failure reason.

home_efs_file_system_uid instance-attribute

home_efs_file_system_uid: NotRequired[EfsUid]

The ID of the space's profile in the Amazon EFS volume.

last_modified_time instance-attribute

last_modified_time: NotRequired[LastModifiedTime]

The last modified time.

ownership_settings instance-attribute

ownership_settings: NotRequired[OwnershipSettings]

The collection of ownership settings for a space.

space_arn instance-attribute

space_arn: NotRequired[SpaceArn]

The space's Amazon Resource Name (ARN).

space_display_name instance-attribute

space_display_name: NotRequired[NonEmptyString64]

The name of the space that appears in the Amazon SageMaker Studio UI.

space_name instance-attribute

space_name: NotRequired[SpaceName]

The name of the space.

space_settings instance-attribute

space_settings: NotRequired[SpaceSettings]

A collection of space settings.

space_sharing_settings instance-attribute

space_sharing_settings: NotRequired[SpaceSharingSettings]

The collection of space sharing settings for a space.

status instance-attribute

status: NotRequired[SpaceStatus]

The status.

url instance-attribute

url: NotRequired[String1024]

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