AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the StartGameSessionPlacement operation. Places a request for a new game session in a queue (see CreateGameSessionQueue). 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:

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.

Game-session-related operations include:

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.GameLift.AmazonGameLiftRequest
      Amazon.GameLift.Model.StartGameSessionPlacementRequest

Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z

Syntax

C#
public class StartGameSessionPlacementRequest : AmazonGameLiftRequest
         IAmazonWebServiceRequest

The StartGameSessionPlacementRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property DesiredPlayerSessions System.Collections.Generic.List<Amazon.GameLift.Model.DesiredPlayerSession>

Gets and sets the property DesiredPlayerSessions.

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

Public Property GameProperties System.Collections.Generic.List<Amazon.GameLift.Model.GameProperty>

Gets and sets the property 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).

Public Property GameSessionData System.String

Gets and sets the property 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).

Public Property GameSessionName System.String

Gets and sets the property GameSessionName.

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

Public Property GameSessionQueueName System.String

Gets and sets the property GameSessionQueueName.

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

Public Property MaximumPlayerSessionCount System.Int32

Gets and sets the property MaximumPlayerSessionCount.

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

Public Property PlacementId System.String

Gets and sets the property PlacementId.

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.

Public Property PlayerLatencies System.Collections.Generic.List<Amazon.GameLift.Model.PlayerLatency>

Gets and sets the property PlayerLatencies.

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.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms