Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14104474602.4 KB

Retrieves information about a fleet's instances, including instance IDs, connection data, and status.

This operation can be used in the following ways:

  • To get information on all instances that are deployed to a fleet's home Region, provide the fleet ID.

  • To get information on all instances that are deployed to a fleet's remote location, provide the fleet ID and location name.

  • To get information on a specific instance in a fleet, provide the fleet ID and instance ID.

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

If successful, an Instance object is returned for each requested instance. Instances are not returned in any particular order.

Learn more

Remotely Access Fleet Instances

Debug Fleet Issues

Related actions

All APIs by task

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

Query parameters

Limitstring

Pagination limit

NextTokenstring

Pagination token

Headers

X-Amz-Target'GameLift.DescribeInstances' required

Request body

FleetIdstring required

A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN value.

InstanceIdstring

A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

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.

Locationstring

The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as <code>us-west-2</code>.

Response

Success

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.