:doc:`CodeCatalyst <../../codecatalyst>` / Paginator / ListProjects

************
ListProjects
************



.. py:class:: CodeCatalyst.Paginator.ListProjects

  ::

    
    paginator = client.get_paginator('list_projects')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`CodeCatalyst.Client.list_projects`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          spaceName='string',
          filters=[
              {
                  'key': 'hasAccessTo'|'name',
                  'values': [
                      'string',
                  ],
                  'comparisonOperator': 'EQ'|'GT'|'GE'|'LT'|'LE'|'BEGINS_WITH'
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type spaceName: string
    :param spaceName: **[REQUIRED]** 

      The name of the space.

      

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

          

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

      
      ::

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

      

      - *(dict) --* 
        

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

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    