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

****************************
ListSourceRepositoryBranches
****************************



.. py:class:: CodeCatalyst.Paginator.ListSourceRepositoryBranches

  ::

    
    paginator = client.get_paginator('list_source_repository_branches')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          spaceName='string',
          projectName='string',
          sourceRepositoryName='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type spaceName: string
    :param spaceName: **[REQUIRED]** 

      The name of the space.

      

    
    :type projectName: string
    :param projectName: **[REQUIRED]** 

      The name of the project in the space.

      

    
    :type sourceRepositoryName: string
    :param sourceRepositoryName: **[REQUIRED]** 

      The name of the source repository.

      

    
    :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': [
                {
                    'ref': 'string',
                    'name': 'string',
                    'lastUpdatedTime': datetime(2015, 1, 1),
                    'headCommitId': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

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

          Information about the source branches.

          
          

          - *(dict) --* 

            Information about a branch of a source repository returned in a list of branches.

            
            

            - **ref** *(string) --* 

              The Git reference name of the branch.

              
            

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

              The name of the branch.

              
            

            - **lastUpdatedTime** *(datetime) --* 

              The time the branch was last updated, in coordinated universal time (UTC) timestamp format as specified in `RFC 3339 <https://www.rfc-editor.org/rfc/rfc3339#section-5.6>`__.

              
            

            - **headCommitId** *(string) --* 

              The commit ID of the tip of the branch at the time of the request, also known as the head commit.

              
        
      
        

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

          A token to resume pagination.

          
    