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.

Amazon GameLift retains a game session resource for 30 days after the game session ends. You can reuse idempotency token values after this time. Game session logs are retained for 14 days.

All APIs by task

Note

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

CreationTime

A 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

A 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

DnsName

The DNS identifier assigned to the instance that is running the game session. Values have the following format:

TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.
Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

Type: String

Required: No

FleetArn

The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on.

Type: String

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

Pattern: ^arn:.*:[a-z]*fleet\/[a-z]*fleet-[a-zA-Z0-9\-]+$

Required: No

FleetId

A unique identifier for the fleet that the game session is running on.

Type: String

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

Pattern: ^[a-z]*fleet-[a-zA-Z0-9\-]+

Required: No

GameProperties

A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}.

Type: Array of GameProperty objects

Array Members: Maximum number of 16 items.

Required: No

GameSessionData

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session. For more information, see Start a game session.

Type: String

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

Required: No

GameSessionId

A 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

The 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

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

Pattern: ^[0-9A-Fa-f\:\.]+

Required: No

Location

The fleet location where the game session is running. This value might specify the fleet's home Region or a remote location. Location is expressed as an AWS Region code such as us-west-2.

Type: String

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

Pattern: ^[A-Za-z0-9\-]+

Required: No

MatchmakerData

Information about the matchmaking process that resulted in the game session, if matchmaking was used. Data is in JSON syntax, formatted as a string. Information includes the matchmaker ID as well as player attributes and team assignments. For more details on matchmaker data, see Match Data. Matchmaker data 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

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

Type: Integer

Valid Range: Minimum value of 0.

Required: No

Name

A 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

The 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

A 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

GameSession

Contents

Note

See Also