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.

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:

Inheritance Hierarchy

System.Object
  Amazon.GameLift.Model.GameSessionPlacement

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

Syntax

C#
public class GameSessionPlacement

The GameSessionPlacement type exposes the following members

Constructors

NameDescription
Public Method GameSessionPlacement()

Properties

NameTypeDescription
Public Property EndTime System.DateTime

Gets and sets the property EndTime.

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

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 GameSessionArn System.String

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

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 GameSessionId System.String

Gets and sets the property GameSessionId.

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

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.

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

Public Property GameSessionRegion System.String

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

Public Property IpAddress System.String

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

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 PlacedPlayerSessions System.Collections.Generic.List<Amazon.GameLift.Model.PlacedPlayerSession>

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

Public Property PlacementId System.String

Gets and sets the property PlacementId.

Unique identifier for a game session placement.

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.

Public Property Port System.Int32

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

Public Property StartTime System.DateTime

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

Public Property Status Amazon.GameLift.GameSessionPlacementState

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

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