:doc:`CodeCatalyst <../../codecatalyst>` / Client / list_spaces

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



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

  

  Retrieves a list of spaces.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/ListSpaces>`_  


  **Request Syntax**
  ::

    response = client.list_spaces(
        nextToken='string'
    )
    
  :type nextToken: string
  :param nextToken: 

    A token returned from a call to this API to indicate the next batch of results to return, if any.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'nextToken': 'string',
          'items': [
              {
                  'name': 'string',
                  'regionName': 'string',
                  'displayName': 'string',
                  'description': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **nextToken** *(string) --* 

        A token returned from a call to this API to indicate the next batch of results to return, if any.

        
      

      - **items** *(list) --* 

        Information about the spaces.

        
        

        - *(dict) --* 

          Information about an space.

          
          

          - **name** *(string) --* 

            The name of the space.

            
          

          - **regionName** *(string) --* 

            The Amazon Web Services Region where the space exists.

            
          

          - **displayName** *(string) --* 

            The friendly name of the space displayed to users.

            
          

          - **description** *(string) --* 

            The description of the space.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`CodeCatalyst.Client.exceptions.ThrottlingException`

  
  *   :py:class:`CodeCatalyst.Client.exceptions.ConflictException`

  
  *   :py:class:`CodeCatalyst.Client.exceptions.ValidationException`

  
  *   :py:class:`CodeCatalyst.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`CodeCatalyst.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`CodeCatalyst.Client.exceptions.AccessDeniedException`

  