Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14104474602.4 KB

Retrieves a collection of fleet resources in an Amazon Web Services Region. You can call this operation to get fleets in a previously selected default Region (see https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.htmlor specify a Region in your request. You can filter the result set to find only those fleets that are deployed with a specific build or script. For fleets that have multiple locations, this operation retrieves fleets based on their home Region only.

This operation can be used in the following ways:

  • To get a list of all fleets in a Region, don't provide a build or script identifier.

  • To get a list of all fleets where a specific custom game build is deployed, provide the build ID.

  • To get a list of all Realtime Servers fleets with a specific configuration script, provide the script ID.

Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a list of fleet IDs that match the request parameters is returned. A NextToken value is also returned if there are more result pages to retrieve.

Fleet resources are not listed in a particular order.

Learn more

Setting up Amazon GameLift fleets

post/#X-Amz-Target=GameLift.ListFleets

Query parameters

Limitstring

Pagination limit

NextTokenstring

Pagination token

Headers

X-Amz-Target'GameLift.ListFleets' required

Request body

BuildIdstring

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.

ScriptIdstring

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.

Limitinteger

The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.

NextTokenstring

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

Response

Success

FleetIdsFleetId[]

A set of fleet IDs that match the list request.

NextTokenstring

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.