/AWS1/CL_GML=>DESCRIBEGAMESERVERINSTANCES()
¶
About DescribeGameServerInstances¶
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Retrieves status information about the Amazon EC2 instances associated with a Amazon GameLift FleetIQ game server group. Use this operation to detect when instances are active or not available to host new game servers.
To request status for all instances in the game server group, provide a game server
group ID only. To request status for specific instances, provide the game server group
ID and one or more instance IDs. Use the pagination parameters to retrieve results in
sequential segments. If successful, a collection of GameServerInstance
objects is returned.
This operation is not designed to be called with every game server claim request; this practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, cache the results and refresh your cache no more than once every 10 seconds.
Learn more
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_GAMESERVERGROUPNAME
TYPE /AWS1/GMLGAMESERVERGRNAMEORARN
/AWS1/GMLGAMESERVERGRNAMEORARN
¶
A unique identifier for the game server group. Use either the name or ARN value.
Optional arguments:¶
IT_INSTANCEIDS
TYPE /AWS1/CL_GMLGAMESERVERINSTID00=>TT_GAMESERVERINSTANCEIDS
TT_GAMESERVERINSTANCEIDS
¶
The Amazon EC2 instance IDs that you want to retrieve status on. Amazon EC2 instance IDs use a 17-character format, for example:
i-1234567890abcdef0
. To retrieve all instances in the game server group, leave this parameter empty.
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.