/AWS1/CL_GML=>LISTCOMPUTE()
¶
About ListCompute¶
This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Retrieves information on the compute resources in an Amazon GameLift fleet.
To request a list of computes, specify the fleet ID. Use the pagination parameters to retrieve results in a set of sequential pages.
You can filter the result set by location.
If successful, this operation returns information on all computes in the requested fleet. Depending on the fleet's compute type, the result includes the following information:
-
For
EC2
fleets, this operation returns information about the EC2 instance. Compute names are instance IDs. -
For
ANYWHERE
fleets, this operation returns the compute names and details provided when the compute was registered withRegisterCompute
. TheGameLiftServiceSdkEndpoint
orGameLiftAgentEndpoint
is included. -
For
CONTAINER
fleets, this operation returns information about containers that are registered as computes, and the instances they're running on. Compute names are container names.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_FLEETID
TYPE /AWS1/GMLFLEETIDORARN
/AWS1/GMLFLEETIDORARN
¶
A unique identifier for the fleet to retrieve compute resources for.
Optional arguments:¶
IV_LOCATION
TYPE /AWS1/GMLLOCATIONSTRINGMODEL
/AWS1/GMLLOCATIONSTRINGMODEL
¶
The name of a location to retrieve compute resources for. For an Amazon GameLift Anywhere fleet, use a custom location. For a multi-location EC2 or container fleet, provide a Amazon Web Services Region or Local Zone code (for example:
us-west-2
orus-west-2-lax-1
).
IV_LIMIT
TYPE /AWS1/GMLPOSITIVEINTEGER
/AWS1/GMLPOSITIVEINTEGER
¶
The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.
IV_NEXTTOKEN
TYPE /AWS1/GMLNONZEROANDMAXSTRING
/AWS1/GMLNONZEROANDMAXSTRING
¶
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.