DescribeGameSessionPlacement - GameLift Service

DescribeGameSessionPlacement

Retrieves information, including current status, about a game session placement request.

To get game session placement details, specify the placement ID.

This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with DescribeGameSessionPlacement should only be used for games in development with low game session usage.

If successful, a GameSessionPlacement object is returned.

Related actions

CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task

Request Syntax

{ "PlacementId": "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.

PlacementId

A unique identifier for a game session placement to retrieve.

Type: String

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

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

Required: Yes

Response Syntax

{ "GameSessionPlacement": { "DnsName": "string", "EndTime": number, "GameProperties": [ { "Key": "string", "Value": "string" } ], "GameSessionArn": "string", "GameSessionData": "string", "GameSessionId": "string", "GameSessionName": "string", "GameSessionQueueName": "string", "GameSessionRegion": "string", "IpAddress": "string", "MatchmakerData": "string", "MaximumPlayerSessionCount": number, "PlacedPlayerSessions": [ { "PlayerId": "string", "PlayerSessionId": "string" } ], "PlacementId": "string", "PlayerLatencies": [ { "LatencyInMilliseconds": number, "PlayerId": "string", "RegionIdentifier": "string" } ], "Port": number, "StartTime": number, "Status": "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.

GameSessionPlacement

Object that describes the requested game session placement.

Type: GameSessionPlacement 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

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

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: