GameLift / Paginator / ListFleets

ListFleets

class GameLift.Paginator.ListFleets

paginator = client.get_paginator('list_fleets')

paginate(**kwargs)

Creates an iterator that will paginate through responses from GameLift.Client.list_fleets().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• BuildId (string) – 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.

• ScriptId (string) – 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.

• ContainerGroupDefinitionName (string) – The container group definition name to request fleets for. Use this parameter to return only fleets that are deployed with the specified container group definition.

• PaginationConfig (dict) –

  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.

Return type:

dict

Returns:

Response Syntax

{
    'FleetIds': [
        'string',
    ],

}

Response Structure

• (dict) –

  • FleetIds (list) –

    A set of fleet IDs that match the list request.

    • (string) –