:doc:`Proton <../../proton>` / Paginator / ListRepositories

****************
ListRepositories
****************



.. py:class:: Proton.Paginator.ListRepositories

  ::

    
    paginator = client.get_paginator('list_repositories')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Proton.Client.list_repositories`.

    .. danger::

            This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.


    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListRepositories>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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**

      
      ::

        {
            'repositories': [
                {
                    'arn': 'string',
                    'connectionArn': 'string',
                    'name': 'string',
                    'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **repositories** *(list) --* 

          An array of repository links.

          
          

          - *(dict) --* 

            Summary data of a linked repository—a repository that has been registered with Proton.

            
            

            - **arn** *(string) --* 

              The Amazon Resource Name (ARN) of the linked repository.

              
            

            - **connectionArn** *(string) --* 

              The Amazon Resource Name (ARN) of the of your connection that connects Proton to your repository.

              
            

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

              The repository name.

              
            

            - **provider** *(string) --* 

              The repository provider.

              
        
      
        

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

          A token to resume pagination.

          
    