/AWS1/CL_GML=>LISTGAMESERVERS()

About ListGameServers

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Retrieves information on all game servers that are currently active in a specified game server group. You can opt to sort the list by game server age. Use the pagination parameters to retrieve results in a set of sequential segments.

Learn more

Amazon GameLift FleetIQ Guide

Method Signature

IMPORTING

Required arguments:

IV_GAMESERVERGROUPNAME TYPE /AWS1/GMLGAMESERVERGRNAMEORARN /AWS1/GMLGAMESERVERGRNAMEORARN

An identifier for the game server group to retrieve a list of game servers from. Use either the name or ARN value.

Optional arguments:

IV_SORTORDER TYPE /AWS1/GMLSORTORDER /AWS1/GMLSORTORDER

Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.

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.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_GMLLISTGAMESERVERSOUT /AWS1/CL_GMLLISTGAMESERVERSOUT