:doc:`SageMaker <../../sagemaker>` / Paginator / ListSpaces

**********
ListSpaces
**********



.. py:class:: SageMaker.Paginator.ListSpaces

  ::

    
    paginator = client.get_paginator('list_spaces')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`SageMaker.Client.list_spaces`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListSpaces>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          SortOrder='Ascending'|'Descending',
          SortBy='CreationTime'|'LastModifiedTime',
          DomainIdEquals='string',
          SpaceNameContains='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type SortOrder: string
    :param SortOrder: 

      The sort order for the results. The default is ``Ascending``.

      

    
    :type SortBy: string
    :param SortBy: 

      The parameter by which to sort the results. The default is ``CreationTime``.

      

    
    :type DomainIdEquals: string
    :param DomainIdEquals: 

      A parameter to search for the domain ID.

      

    
    :type SpaceNameContains: string
    :param SpaceNameContains: 

      A parameter by which to filter the results.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: 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'|'CodeEditor'|'JupyterLab'|'RStudioServerPro'|'RSessionGateway'|'Canvas',
                        'RemoteAccess': 'ENABLED'|'DISABLED',
                        '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.

                
              

              - **RemoteAccess** *(string) --* 

                A setting that enables or disables remote access for a SageMaker space. When enabled, this allows you to connect to the remote space from your local IDE.

                
              

              - **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.

              
        
      
    