SageMaker / Paginator / ListSpaces


class SageMaker.Paginator.ListSpaces#
paginator = client.get_paginator('list_spaces')

Creates an iterator that will paginate through responses from SageMaker.Client.list_spaces().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • 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.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



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'|'CodeEditor'|'JupyterLab'|'RStudioServerPro'|'RSessionGateway'|'Canvas',
                'SpaceStorageSettings': {
                    'EbsStorageSettings': {
                        'EbsVolumeSizeInGb': 123
            'SpaceSharingSettingsSummary': {
                'SharingType': 'Private'|'Shared'
            'OwnershipSettingsSummary': {
                'OwnerUserProfileName': 'string'
            'SpaceDisplayName': '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 space.

            • EbsStorageSettings (dict) –

              A collection of EBS storage settings for a space.

              • EbsVolumeSizeInGb (integer) –

                The size of an EBS storage volume for a 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 space.

        • SpaceDisplayName (string) –

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