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

GameSession

Properties describing a game session.

A game session in ACTIVE status can host players. When a game session ends, its status is set to TERMINATED.

Once the session ends, the game session object is retained for 30 days. This means you can reuse idempotency token values after this time. Game session logs are retained for 14 days.

Game-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

CreatorId

Unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.

Type: String

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

Required: No

CurrentPlayerSessionCount

Number of players currently in the game session.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

FleetId

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

Type: String

Pattern: ^fleet-\S+

Required: No

GameProperties

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). You can search for active game sessions based on this custom data with SearchGameSessions.

Type: Array of GameProperty objects

Array Members: Maximum number of 16 items.

Required: No

GameSessionData

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Type: String

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

Required: No

GameSessionId

Unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.

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

MatchmakerData

Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formated as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data. Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill).

Type: String

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

Required: No

MaximumPlayerSessionCount

Maximum number of players that can be connected simultaneously to the game session.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

Name

Descriptive label that is associated with a game session. Session names do not need to be unique.

Type: String

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

Required: No

PlayerSessionCreationPolicy

Indicates whether or not the game session is accepting new players.

Type: String

Valid Values: ACCEPT_ALL | DENY_ALL

Required: No

Port

Port number for the game session. To connect to a Amazon GameLift game server, 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 game session. A game session must have an ACTIVE status to have player sessions.

Type: String

Valid Values: ACTIVE | ACTIVATING | TERMINATED | TERMINATING | ERROR

Required: No

StatusReason

Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.

Type: String

Valid Values: INTERRUPTED

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: