DescribeGameServer
This operation is used with the Amazon GameLift Servers FleetIQ solution and game server groups.
Retrieves information for a registered game server. Information includes game server status, health check info, and the instance that the game server is running on.
To retrieve game server information, specify the game server ID. If successful, the requested game server object is returned.
Learn more
Amazon GameLift Servers FleetIQ Guide
Request Syntax
{
"GameServerGroupName": "string",
"GameServerId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
Note
In the following list, the required parameters are described first.
- GameServerGroupName
-
A unique identifier for the game server group where the game server is running.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9-\.]+|^arn:.*:gameservergroup\/[a-zA-Z0-9-\.]+Required: Yes
- GameServerId
-
A custom string that uniquely identifies the game server information to be retrieved.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 128.
Pattern:
[a-zA-Z0-9-\.]+Required: Yes
Response Syntax
{
"GameServer": {
"ClaimStatus": "string",
"ConnectionInfo": "string",
"GameServerData": "string",
"GameServerGroupArn": "string",
"GameServerGroupName": "string",
"GameServerId": "string",
"InstanceId": "string",
"LastClaimTime": number,
"LastHealthCheckTime": number,
"RegistrationTime": number,
"UtilizationStatus": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- GameServer
-
Object that describes the requested game server.
Type: GameServer object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceException
-
The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
HTTP Status Code: 500
- InvalidRequestException
-
One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
HTTP Status Code: 400
- NotFoundException
-
The requested resources was not found. The resource was either not created yet or deleted.
HTTP Status Code: 400
- UnauthorizedException
-
The client failed authentication. Clients should not retry such requests.
HTTP Status Code: 400
Examples
Retrieve details for a game server
This example retrieves attributes for a specified game server.
HTTP requests are authenticated using an AWS Signature Version 4 signature in the Authorization header field.
Sample Request
{
"GameServerGroupName": "MegaFrogServers_NA",
"GameServerId": "mega-frog-game-12345678"
}
CLI command:
aws gamelift describe-game-server \
--game-server-group-name MegaFrogServers_NA \
--game-server-id mega-frog-game-12345678 Sample Response
{
"GameServer": {
"ClaimStatus": "",
"ConnectionInfo": "192.0.2.0.80",
"GameServerData": "",
"GameServerGroupArn": "arn:aws:gamelift:us-west-2::GameServerGroup/MegaFrogServers_NA",
"GameServerGroupName": "MegaFrogServers_NA",
"GameServerId": "mega-frog-game-12345678",
"InstanceId": "i-1234567890abcdef0",
"LastClaimTime": 1580218197.293,
"LastHealthCheckTime": 1580218197.293,
"RegistrationTime": 1580218197.293,
"UtilizationStatus": "AVAILABLE"
}
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
