:doc:`GameLift <../../gamelift>` / Paginator / ListFleets

**********
ListFleets
**********



.. py:class:: GameLift.Paginator.ListFleets

  ::

    
    paginator = client.get_paginator('list_fleets')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`GameLift.Client.list_fleets`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListFleets>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          BuildId='string',
          ScriptId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type BuildId: string
    :param BuildId: 

      A unique identifier for the build to request fleets for. Use this parameter to return only fleets using a specified build. Use either the build ID or ARN value.

      

    
    :type ScriptId: string
    :param ScriptId: 

      A unique identifier for the Realtime script to request fleets for. Use this parameter to return only fleets using a specified script. Use either the script ID or ARN value.

      

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

      
      ::

        {
            'FleetIds': [
                'string',
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **FleetIds** *(list) --* 

          A set of fleet IDs that match the list request.

          
          

          - *(string) --* 
      
    