GameSessionPlacement

Represents a potential game session placement, including the full details of the original placement request and the current status.

Note

If the game session placement status is PENDING, the properties for game session ID/ARN, region, IP address/DNS, and port aren't final. A game session is not active and ready to accept players until placement status reaches FULFILLED. When the placement is in PENDING status, Amazon GameLift may attempt to place a game session multiple times before succeeding. With each attempt it creates a GameSession object and updates this placement object with the new game session properties..

Note

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

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

EndTime

Time stamp indicating when this request was completed, canceled, or timed out.

Type: Timestamp

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

GameSessionArn

Identifier for the game session created by this placement request. This identifier is unique across all Regions. This value isn't final until placement status is FULFILLED.

Type: String

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

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 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 262144.

Required: No

GameSessionId

A unique identifier for the game session. This value isn't final until placement status is FULFILLED.

Type: String

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

Required: No

GameSessionName

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

GameSessionQueueName

A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

Type: String

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

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

Required: No

GameSessionRegion

Name of the Region where the game session created by this placement request is running. This value isn't final until placement status is FULFILLED.

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. This value isn't final until placement status is FULFILLED.

Type: String

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

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

Required: No

MatchmakerData

Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data.

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

PlacedPlayerSessions

A collection of information on player sessions created in response to the game session placement request. These player sessions are created only after a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID, provided in the placement request, and a corresponding player session ID.

Type: Array of PlacedPlayerSession objects

Required: No

PlacementId

A unique identifier for a game session placement.

Type: String

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

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

Required: No

PlayerLatencies

A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to AWS Regions.

Type: Array of PlayerLatency objects

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. This value isn't final until placement status is FULFILLED.

Type: Integer

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

Required: No

StartTime

Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Type: Timestamp

Required: No

Status

Current status of the game session placement request.

PENDING -- The placement request is in the queue waiting to be processed. Game session properties are not yet final.
FULFILLED -- A new game session has been successfully placed. Game session properties are now final.
CANCELLED -- The placement request was canceled.
TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.
FAILED -- Amazon GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.

Type: String

Valid Values: PENDING | FULFILLED | CANCELLED | TIMED_OUT | FAILED

Required: No

GameSessionPlacement

Note

Contents

Note

See Also