:doc:`CodeBuild <../../codebuild>` / Client / list_build_batches_for_project

******************************
list_build_batches_for_project
******************************



.. py:method:: CodeBuild.Client.list_build_batches_for_project(**kwargs)

  

  Retrieves the identifiers of the build batches for a specific project.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/ListBuildBatchesForProject>`_  


  **Request Syntax**
  ::

    response = client.list_build_batches_for_project(
        projectName='string',
        filter={
            'status': 'SUCCEEDED'|'FAILED'|'FAULT'|'TIMED_OUT'|'IN_PROGRESS'|'STOPPED'
        },
        maxResults=123,
        sortOrder='ASCENDING'|'DESCENDING',
        nextToken='string'
    )
    
  :type projectName: string
  :param projectName: 

    The name of the project.

    

  
  :type filter: dict
  :param filter: 

    A ``BuildBatchFilter`` object that specifies the filters for the search.

    

  
    - **status** *(string) --* 

      The status of the batch builds to retrieve. Only batch builds that have this status will be retrieved.

      

    
  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return.

    

  
  :type sortOrder: string
  :param sortOrder: 

    Specifies the sort order of the returned items. Valid values include:

     

    
    * ``ASCENDING``: List the batch build identifiers in ascending order by identifier.
     
    * ``DESCENDING``: List the batch build identifiers in descending order by identifier.
    

    

  
  :type nextToken: string
  :param nextToken: 

    The ``nextToken`` value returned from a previous call to ``ListBuildBatchesForProject``. This specifies the next item to return. To return the beginning of the list, exclude this parameter.

    

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

    
    ::

      {
          'ids': [
              'string',
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ids** *(list) --* 

        An array of strings that contains the batch build identifiers.

        
        

        - *(string) --* 
    
      

      - **nextToken** *(string) --* 

        If there are more items to return, this contains a token that is passed to a subsequent call to ``ListBuildBatchesForProject`` to retrieve the next set of items.

        
  
  **Exceptions**
  
  *   :py:class:`CodeBuild.Client.exceptions.InvalidInputException`

  
  *   :py:class:`CodeBuild.Client.exceptions.ResourceNotFoundException`

  