SageMaker / Client / list_spaces

list_spaces

SageMaker.Client.list_spaces(**kwargs)

Lists spaces.

See also: AWS API Documentation

Request Syntax

response = client.list_spaces(
    NextToken='string',
    MaxResults=123,
    SortOrder='Ascending'|'Descending',
    SortBy='CreationTime'|'LastModifiedTime',
    DomainIdEquals='string',
    SpaceNameContains='string'
)

Parameters:

• NextToken (string) – 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 (integer) – The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

• SortOrder (string) – The sort order for the results. The default is Ascending.

• SortBy (string) – The parameter by which to sort the results. The default is CreationTime.

• DomainIdEquals (string) – A parameter to search for the Domain ID.

• SpaceNameContains (string) – A parameter by which to filter the results.

Return type:

dict

Returns:

Response Syntax

{
    'Spaces': [
        {
            'DomainId': 'string',
            'SpaceName': 'string',
            'Status': 'Deleting'|'Failed'|'InService'|'Pending'|'Updating'|'Update_Failed'|'Delete_Failed',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'SpaceSettingsSummary': {
                'AppType': 'JupyterServer'|'KernelGateway'|'DetailedProfiler'|'TensorBoard'|'VSCode'|'Savitur'|'CodeEditor'|'JupyterLab'|'RStudioServerPro'|'RSession'|'RSessionGateway'|'Canvas'|'DatasetManager'|'SageMakerLite'|'Local',
                'SpaceStorageSettings': {
                    'EbsStorageSettings': {
                        'EbsVolumeSizeInGb': 123
                    }
                }
            },
            'SpaceSharingSettingsSummary': {
                'SharingType': 'Private'|'Shared'
            },
            'OwnershipSettingsSummary': {
                'OwnerUserProfileName': 'string'
            },
            'SpaceDisplayName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • Spaces (list) –

    The list of spaces.

    • (dict) –

      The space’s details.

      • DomainId (string) –

        The ID of the associated Domain.

      • SpaceName (string) –

        The name of the space.

      • Status (string) –

        The status.

      • CreationTime (datetime) –

        The creation time.

      • LastModifiedTime (datetime) –

        The last modified time.

      • SpaceSettingsSummary (dict) –

        Specifies summary information about the space settings.

        • AppType (string) –

          The type of app created within the space.

        • SpaceStorageSettings (dict) –

          The storage settings for a private space.

          • EbsStorageSettings (dict) –

            A collection of EBS storage settings for a private space.

            • EbsVolumeSizeInGb (integer) –

              The size of an EBS storage volume for a private space.

      • SpaceSharingSettingsSummary (dict) –

        Specifies summary information about the space sharing settings.

        • SharingType (string) –

          Specifies the sharing type of the space.

      • OwnershipSettingsSummary (dict) –

        Specifies summary information about the ownership settings.

        • OwnerUserProfileName (string) –

          The user profile who is the owner of the private space.

      • SpaceDisplayName (string) –

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

  • NextToken (string) –

    If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.