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

PlayerSession

Properties describing a player session. Player session objects are created either by creating a player session for a specific game session, or as part of a game session placement. A player session represents either a player reservation for a game session (status RESERVED) or actual player activity in a game session (status ACTIVE). A player session object (including player data) is automatically passed to a game session when the player connects to the game session and is validated.

When a player disconnects, the player session status changes to COMPLETED. Once the session ends, the player session object is retained for 30 days and then removed.

Player-session-related operations include:

Contents

Note

In the following list, the required parameters are described first.

CreationTime

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Type: Timestamp

Required: No

FleetId

Unique identifier for a fleet that the player's game session is running on.

Type: String

Pattern: ^fleet-\S+

Required: No

GameSessionId

Unique identifier for the game session that the player session is connected to.

Type: String

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

Required: No

IpAddress

IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

Type: String

Required: No

PlayerData

Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

Type: String

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

Required: No

PlayerId

Unique identifier for a player that is associated with this player session.

Type: String

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

Required: No

PlayerSessionId

Unique identifier for a player session.

Type: String

Pattern: ^psess-\S+

Required: No

Port

Port number for the game session. To connect to a Amazon GameLift server process, an app needs both the IP address and port number.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 60000.

Required: No

Status

Current status of the player session.

Possible player session statuses include the following:

  • RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.

  • ACTIVE -- The player has been validated by the server process and is currently connected.

  • COMPLETED -- The player connection has been dropped.

  • TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

Type: String

Valid Values: RESERVED | ACTIVE | COMPLETED | TIMEDOUT

Required: No

TerminationTime

Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Type: Timestamp

Required: No

See Also

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

On this page: