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

*******************************
list_source_repository_branches
*******************************



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

  

  Retrieves a list of branches in a specified source repository.

  

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


  **Request Syntax**
  ::

    response = client.list_source_repository_branches(
        spaceName='string',
        projectName='string',
        sourceRepositoryName='string',
        nextToken='string',
        maxResults=123
    )
    
  :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 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.

    

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

    
    ::

      {
          'nextToken': 'string',
          'items': [
              {
                  'ref': 'string',
                  'name': 'string',
                  'lastUpdatedTime': datetime(2015, 1, 1),
                  'headCommitId': '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 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.

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

  