class Aws::GameLift::Types::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:

@!attribute [rw] placement_id

A unique identifier for a game session placement.
@return [String]

@!attribute [rw] game_session_queue_name

A descriptive label that is associated with game session queue.
Queue names must be unique within each Region.
@return [String]

@!attribute [rw] 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.

* **FAILED** -- GameLift is not able to complete the process of
  placing the game session. Common reasons are the game session
  terminated before the placement process was completed, or an
  unexpected internal error.
@return [String]

@!attribute [rw] game_properties

A 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][1]).

[1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
@return [Array<Types::GameProperty>]

@!attribute [rw] maximum_player_session_count

The maximum number of players that can be connected simultaneously
to the game session.
@return [Integer]

@!attribute [rw] game_session_name

A descriptive label that is associated with a game session. Session
names do not need to be unique.
@return [String]

@!attribute [rw] game_session_id

A unique identifier for the game session. This value is set once the
new game session is placed (placement status is `FULFILLED`).
@return [String]

@!attribute [rw] game_session_arn

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.
@return [String]

@!attribute [rw] game_session_region

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`).
@return [String]

@!attribute [rw] player_latencies

A set of values, expressed in milliseconds, that indicates the
amount of latency that a player experiences when connected to AWS
Regions.
@return [Array<Types::PlayerLatency>]

@!attribute [rw] start_time

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"`).
@return [Time]

@!attribute [rw] end_time

Time stamp indicating when this request was completed, canceled, or
timed out.
@return [Time]

@!attribute [rw] ip_address

The IP address of the game session. To connect to a 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`).
@return [String]

@!attribute [rw] dns_name

The DNS identifier assigned to the instance that is running the game
session. Values have the following format:

* TLS-enabled fleets: `<unique identifier>.<region
  identifier>.amazongamelift.com`.

* Non-TLS-enabled fleets: `ec2-<unique
  identifier>.compute.amazonaws.com`. (See [Amazon EC2 Instance IP
  Addressing][1].)

When connecting to a game session that is running on a TLS-enabled
fleet, you must use the DNS name, not the IP address.

[1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses
@return [String]

@!attribute [rw] port

The port number for the game session. To connect to a 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`).
@return [Integer]

@!attribute [rw] placed_player_sessions

A 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.
@return [Array<Types::PlacedPlayerSession>]

@!attribute [rw] game_session_data

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][1]).

[1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
@return [String]

@!attribute [rw] matchmaker_data

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][1].

[1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GameSessionPlacement AWS API Documentation

Constants

SENSITIVE