Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . gamelift ]

start-game-session-placement

Description

Places a request for a new game session in a queue (see create-game-session-queue ). When processing a placement request, Amazon GameLift searches for available resources on the queue's destinations, scanning each until it finds resources or the placement request times out.

A game session placement request can also request player sessions. When a new game session is successfully created, Amazon GameLift creates a player session for each player included in the request.

When placing a game session, by default Amazon GameLift tries each fleet in the order they are listed in the queue configuration. Ideally, a queue's destinations are listed in preference order.

Alternatively, when requesting a game session with players, you can also provide latency data for each player in relevant regions. Latency data indicates the performance lag a player experiences when connected to a fleet in the region. Amazon GameLift uses latency data to reorder the list of destinations to place the game session in a region with minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each region's average lag for all players and reorders to get the best game play across all players.

To place a new game session request, specify the following:

  • The queue name and a set of game session properties and settings
  • A unique ID (such as a UUID) for the placement. You use this ID to track the status of the placement request
  • (Optional) A set of IDs and player data for each player you want to join to the new game session
  • Latency data for all players (if you want to optimize game play for the players)

If successful, a new game session placement is created.

To track the status of a placement request, call describe-game-session-placement and check the request's status. If the status is FULFILLED , a new game session has been created and a game session ARN and region are referenced. If the placement request times out, you can resubmit the request or retry it with a different queue.

Game-session-related operations include:

  • create-game-session
  • describe-game-sessions
  • describe-game-session-details
  • search-game-sessions
  • update-game-session
  • get-game-session-log-url
  • Game session placements
    • start-game-session-placement
    • describe-game-session-placement
    • stop-game-session-placement

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  start-game-session-placement
--placement-id <value>
--game-session-queue-name <value>
[--game-properties <value>]
--maximum-player-session-count <value>
[--game-session-name <value>]
[--player-latencies <value>]
[--desired-player-sessions <value>]
[--game-session-data <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--placement-id (string)

Unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all regions and cannot be reused unless you are resubmitting a canceled or timed-out placement request.

--game-session-queue-name (string)

Name of the queue to use to place the new game session.

--game-properties (list)

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

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--maximum-player-session-count (integer)

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

--game-session-name (string)

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

--player-latencies (list)

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.

Shorthand Syntax:

PlayerId=string,RegionIdentifier=string,LatencyInMilliseconds=float ...

JSON Syntax:

[
  {
    "PlayerId": "string",
    "RegionIdentifier": "string",
    "LatencyInMilliseconds": float
  }
  ...
]

--desired-player-sessions (list)

Set of information on each player to create a player session for.

Shorthand Syntax:

PlayerId=string,PlayerData=string ...

JSON Syntax:

[
  {
    "PlayerId": "string",
    "PlayerData": "string"
  }
  ...
]

--game-session-data (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

GameSessionPlacement -> (structure)

Object that describes the newly created game session placement. This object includes all the information provided in the request, as well as start/end time stamps and placement status.

PlacementId -> (string)

Unique identifier for a game session placement.

GameSessionQueueName -> (string)

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

Status -> (string)

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 stop-game-session-placement .
  • TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.

GameProperties -> (list)

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

(structure)

Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session, such as to specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session; the server process uses the properties as appropriate. For more information, see the Amazon GameLift Developer Guide .

Key -> (string)

Game property identifier.

Value -> (string)

Game property value.

MaximumPlayerSessionCount -> (integer)

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

GameSessionName -> (string)

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

GameSessionId -> (string)

Unique identifier for the game session. This value is set once the new game session is placed (placement status is FULFILLED ).

GameSessionArn -> (string)

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.

GameSessionRegion -> (string)

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

PlayerLatencies -> (list)

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

(structure)

Regional latency information for a player, used when requesting a new game session with start-game-session-placement . This value indicates the amount of time lag that exists when the player is connected to a fleet in the specified region. The relative difference between a player's latency values for multiple regions are used to determine which fleets are best suited to place a new game session for the player.

PlayerId -> (string)

Unique identifier for a player associated with the latency data.

RegionIdentifier -> (string)

Name of the region that is associated with the latency value.

LatencyInMilliseconds -> (float)

Amount of time that represents the time lag experienced by the player when connected to the specified region.

StartTime -> (timestamp)

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").

EndTime -> (timestamp)

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

IpAddress -> (string)

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

Port -> (integer)

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

PlacedPlayerSessions -> (list)

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 describe-player-sessions with the player session ID.

(structure)

Information about a player session that was created as part of a start-game-session-placement request. This object contains only the player ID and player session ID. To retrieve full details on a player session, call describe-player-sessions with the player session ID.

Player-session-related operations include:

  • create-player-session
  • create-player-sessions
  • describe-player-sessions
  • Game session placements
    • start-game-session-placement
    • describe-game-session-placement
    • stop-game-session-placement

PlayerId -> (string)

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

PlayerSessionId -> (string)

Unique identifier for a player session.

GameSessionData -> (string)

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

MatchmakerData -> (string)

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 .