Menu
Amazon GameLift Service
API Reference (API Version 2015-10-01)

DescribeGameSessionDetails

Retrieves properties, including the protection policy in force, for one or more game sessions. This action can be used in several ways: (1) provide a GameSessionId or GameSessionArn to request details for a specific game session; (2) provide either a FleetId or an AliasId to request properties for all game sessions running on a fleet.

To get game session record(s), specify just one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionDetail object is returned for each session matching the request.

Game-session-related operations include:

Request Syntax

{
   "AliasId": "string",
   "FleetId": "string",
   "GameSessionId": "string",
   "Limit": number,
   "NextToken": "string",
   "StatusFilter": "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.

AliasId

Unique identifier for an alias associated with the fleet to retrieve all game sessions for.

Type: String

Pattern: ^alias-\S+

Required: No

FleetId

Unique identifier for a fleet to retrieve all game sessions active on the fleet.

Type: String

Pattern: ^fleet-\S+

Required: No

GameSessionId

Unique identifier for the game session to retrieve.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9:/-]+

Required: No

Limit

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

NextToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

StatusFilter

Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

Response Syntax

{
   "GameSessionDetails": [ 
      { 
         "GameSession": { 
            "CreationTime": number,
            "CreatorId": "string",
            "CurrentPlayerSessionCount": number,
            "FleetId": "string",
            "GameProperties": [ 
               { 
                  "Key": "string",
                  "Value": "string"
               }
            ],
            "GameSessionData": "string",
            "GameSessionId": "string",
            "IpAddress": "string",
            "MaximumPlayerSessionCount": number,
            "Name": "string",
            "PlayerSessionCreationPolicy": "string",
            "Port": number,
            "Status": "string",
            "TerminationTime": number
         },
         "ProtectionPolicy": "string"
      }
   ],
   "NextToken": "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.

GameSessionDetails

Collection of objects containing game session properties and the protection policy currently in force for each session matching the request.

Type: Array of GameSessionDetail objects

NextToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

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

A service resource associated with the request could not be found. Clients should not retry such requests.

HTTP Status Code: 400

TerminalRoutingStrategyException

The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.

HTTP Status Code: 400

UnauthorizedException

The client failed authentication. Clients should not retry such requests.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: