:doc:`CodeBuild <../../codebuild>` / Paginator / ListBuildBatches

****************
ListBuildBatches
****************



.. py:class:: CodeBuild.Paginator.ListBuildBatches

  ::

    
    paginator = client.get_paginator('list_build_batches')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`CodeBuild.Client.list_build_batches`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          filter={
              'status': 'SUCCEEDED'|'FAILED'|'FAULT'|'TIMED_OUT'|'IN_PROGRESS'|'STOPPED'
          },
          sortOrder='ASCENDING'|'DESCENDING',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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 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 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**

      
      ::

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

      

      - *(dict) --* 
        

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

          An array of strings that contains the batch build identifiers.

          
          

          - *(string) --* 
      
        

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

          A token to resume pagination.

          
    