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

*************
list_projects
*************



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

  

  Retrieves a list of projects.

  

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


  **Request Syntax**
  ::

    response = client.list_projects(
        spaceName='string',
        nextToken='string',
        maxResults=123,
        filters=[
            {
                'key': 'hasAccessTo'|'name',
                'values': [
                    'string',
                ],
                'comparisonOperator': 'EQ'|'GT'|'GE'|'LT'|'LE'|'BEGINS_WITH'
            },
        ]
    )
    
  :type spaceName: string
  :param spaceName: **[REQUIRED]** 

    The name of the space.

    

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

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a ``NextToken`` element, which you can use to obtain additional results.

    

  
  :type filters: list
  :param filters: 

    Information about filters to apply to narrow the results returned in the list.

    

  
    - *(dict) --* 

      nformation about the filter used to narrow the results returned in a list of projects.

      

    
      - **key** *(string) --* **[REQUIRED]** 

        A key that can be used to sort results.

        

      
      - **values** *(list) --* **[REQUIRED]** 

        The values of the key.

        

      
        - *(string) --* 

        
    
      - **comparisonOperator** *(string) --* 

        The operator used to compare the fields.

        

      
    

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

    
    ::

      {
          'nextToken': 'string',
          'items': [
              {
                  'name': '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 projects.

        
        

        - *(dict) --* 

          Information about a project.

          
          

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

            The name of the project in the space.

            
          

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

            The friendly name displayed to users of the project in Amazon CodeCatalyst.

            
          

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

            The description of the project.

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

  