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

GameSessionPlacement

Object that describes a StartGameSessionPlacement request. This object includes the full details of the original request plus the current status and start/end time stamps.

Game session placement-related operations include:

Contents

Note

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

EndTime

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

Type: Timestamp

Required: No

GameProperties

Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).

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 value is set once the new game session is placed (placement status is FULFILLED). This identifier is unique across all regions. You can use this value as a GameSessionId value as needed.

Type: String

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

Required: No

GameSessionData

Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server 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. This value is set once the new game session is placed (placement status is FULFILLED).

Type: String

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

Required: No

GameSessionName

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

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 is set once the new game session is placed (placement status is FULFILLED).

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. This value is set once the new game session is placed (placement status is FULFILLED).

Type: String

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

PlacedPlayerSessions

Collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.

Type: Array of PlacedPlayerSession objects

Required: No

PlacementId

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

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions.

Type: Array of PlayerLatency objects

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. This value is set once the new game session is placed (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 currently in the queue waiting to be processed.

  • FULFILLED -- A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.

  • CANCELLED -- The placement request was canceled with a call to StopGameSessionPlacement.

  • TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.

Type: String

Valid Values: PENDING | FULFILLED | CANCELLED | TIMED_OUT

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: