list-game-servers¶
Description¶
This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.
Retrieves information on all game servers that are currently running in a specified game server group. If there are custom key sort values for your game servers, you can opt to have the returned list sorted based on these values. Use the pagination parameters to retrieve results in a set of sequential pages.
RegisterGameServer
ListGameServers
ClaimGameServer
DescribeGameServer
UpdateGameServer
DeregisterGameServer
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
list-game-servers
--game-server-group-name <value>
[--sort-order <value>]
[--limit <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--game-server-group-name (string)
An identifier for the game server group for the game server you want to list. Use either the GameServerGroup name or ARN value.
--sort-order (string)
Indicates how to sort the returned data based on the game servers’ custom key sort value. If this parameter is left empty, the list of game servers is returned in no particular order.
Possible values:
ASCENDING
DESCENDING
--limit (integer)
The maximum number of results to return. Use this parameter with
NextTokento get results as a set of sequential pages.
--next-token (string)
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 action. To start at the beginning of the result set, do not specify a value.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Output¶
GameServers -> (list)
A collection of game server objects that match the request.
(structure)
This data type is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.
Properties describing a game server resource.
A game server resource is created by a successful call to RegisterGameServer and deleted by calling DeregisterGameServer .
GameServerGroupName -> (string)
The name identifier for the game server group where the game server is located.
GameServerGroupArn -> (string)
The ARN identifier for the game server group where the game server is located.
GameServerId -> (string)
A custom string that uniquely identifies the game server. Game server IDs are developer-defined and are unique across all game server groups in an AWS account.
InstanceId -> (string)
The unique identifier for the instance where the game server is located.
ConnectionInfo -> (string)
The port and IP address that must be used to establish a client connection to the game server.
GameServerData -> (string)
A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service in response to requests ListGameServers or ClaimGameServer . This property can be updated using UpdateGameServer .
CustomSortKey -> (string)
A game server tag that can be used to request sorted lists of game servers when calling ListGameServers . Custom sort keys are developer-defined. This property can be updated using UpdateGameServer .
ClaimStatus -> (string)
Indicates when an available game server has been reserved but has not yet started hosting a game. Once it is claimed, game server remains in CLAIMED status for a maximum of one minute. During this time, game clients must connect to the game server and start the game, which triggers the game server to update its utilization status. After one minute, the game server claim status reverts to null.
UtilizationStatus -> (string)
Indicates whether the game server is currently available for new games or is busy. Possible statuses include:
AVAILABLE - The game server is available to be claimed. A game server that has been claimed remains in this status until it reports game hosting activity.
IN_USE - The game server is currently hosting a game session with players.
RegistrationTime -> (timestamp)
Time stamp indicating when the game server resource was created with a RegisterGameServer request. Format is a number expressed in Unix time as milliseconds (for example “1469498468.057”).
LastClaimTime -> (timestamp)
Time stamp indicating the last time the game server was claimed with a ClaimGameServer request. Format is a number expressed in Unix time as milliseconds (for example “1469498468.057”). This value is used to calculate when the game server’s claim status.
LastHealthCheckTime -> (timestamp)
Time stamp indicating the last time the game server was updated with health status using an UpdateGameServer request. Format is a number expressed in Unix time as milliseconds (for example “1469498468.057”). After game server registration, this property is only changed when a game server update specifies a health check value.
NextToken -> (string)
A token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.