:doc:`SageMaker <../../sagemaker>` / Client / list_spaces

***********
list_spaces
***********



.. py:method:: SageMaker.Client.list_spaces(**kwargs)

  

  Lists spaces.

  

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


  **Request Syntax**
  ::

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

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

    

  
  :type MaxResults: integer
  :param MaxResults: 

    This parameter defines the maximum number of results that can be return in a single response. The ``MaxResults`` parameter is an upper bound, not a target. If there are more results available than the value specified, a ``NextToken`` is provided in the response. The ``NextToken`` indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for ``MaxResults`` is 10.

    

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

    

  
  
  :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'
              },
          ],
          '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.

              
            

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

            
      
    
      

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

        
  