Skip to content

/AWS1/CL_GML=>STARTGAMESESSIONPLACEMENT()

About StartGameSessionPlacement

Places a request for a new game session in a 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 player data and a unique player ID for each player that you are joining to the new game session (player data is optional, but if you include it, you must also provide a unique ID for each player)

  • 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 DescribeGameSessionPlacement 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.

Method Signature

IMPORTING

Required arguments:

IV_PLACEMENTID TYPE /AWS1/GMLIDSTRINGMODEL /AWS1/GMLIDSTRINGMODEL

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

IV_GAMESESSIONQUEUENAME TYPE /AWS1/GMLGAMESESSQUEUENAMEOR00 /AWS1/GMLGAMESESSQUEUENAMEOR00

Name of the queue to use to place the new game session. You can use either the queue name or ARN value.

IV_MAXIMUMPLAYERSESSIONCOUNT TYPE /AWS1/GMLWHOLENUMBER /AWS1/GMLWHOLENUMBER

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

Optional arguments:

IT_GAMEPROPERTIES TYPE /AWS1/CL_GMLGAMEPROPERTY=>TT_GAMEPROPERTYLIST TT_GAMEPROPERTYLIST

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

IV_GAMESESSIONNAME TYPE /AWS1/GMLNONZEROANDMAXSTRING /AWS1/GMLNONZEROANDMAXSTRING

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

IT_PLAYERLATENCIES TYPE /AWS1/CL_GMLPLAYERLATENCY=>TT_PLAYERLATENCYLIST TT_PLAYERLATENCYLIST

A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services 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.

IT_DESIREDPLAYERSESSIONS TYPE /AWS1/CL_GMLDESIREDPLAYERSESS=>TT_DESIREDPLAYERSESSIONLIST TT_DESIREDPLAYERSESSIONLIST

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

IV_GAMESESSIONDATA TYPE /AWS1/GMLLARGEGAMESESSIONDATA /AWS1/GMLLARGEGAMESESSIONDATA

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

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_GMLSTRTGAMESESSPLCOUT /AWS1/CL_GMLSTRTGAMESESSPLCOUT