Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetPlayerConnectionStatus

Gets the status of a player's connection to the game runtime.

It's possible for a single player to have multiple connections to the game runtime. If a player is not connected, this operation returns an empty list.

Request Syntax


GET /runtime/game/GameName/stage/StageName/player/PlayerId/connection HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

GameName

The name of the game.

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

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

PlayerId

The unique identifier representing a player.

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

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

StageName

The name of the stage.

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

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Connections": [ 
      { 
         "Created": number,
         "Id": "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.

Connections

The list of connection ids, one for each connection in use by the player.

Type: Array of Connection objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The service encountered an internal error.

HTTP Status Code: 500

ResourceNotFoundException

The resource specified in the request does not exist.

HTTP Status Code: 404

ThrottlingException

The request throughput limit was exceeded.

HTTP Status Code: 429

ValidationException

One of the parameters in the request is invalid.

HTTP Status Code: 400