class Aws::GameLift::Types::PlayerSession

Represents a player session. Player sessions are created either for a specific game session, or as part of a game session placement or matchmaking request. A player session can represents a reserved player slot in a game session (when status is `RESERVED`) or actual player activity in a game session (when status is `ACTIVE`). A player session object, including player data, is automatically passed to a game session when the player connects to the game session and is validated. After the game session ends, player sessions information is retained for 30 days and then removed.

**Related actions**

CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions | StartGameSessionPlacement | DescribeGameSessionPlacement | [All APIs by task]

[1]: docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets

@!attribute [rw] player_session_id

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

@!attribute [rw] player_id

A unique identifier for a player that is associated with this player
session.
@return [String]

@!attribute [rw] game_session_id

A unique identifier for the game session that the player session is
connected to.
@return [String]

@!attribute [rw] fleet_id

A unique identifier for the fleet that the player's game session is
running on.
@return [String]

@!attribute [rw] fleet_arn

The Amazon Resource Name ([ARN][1]) associated with the GameLift
fleet that the player's game session is running on.

[1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
@return [String]

@!attribute [rw] creation_time

A time stamp indicating when this data object was created. Format is
a number expressed in Unix time as milliseconds (for example
`"1469498468.057"`).
@return [Time]

@!attribute [rw] termination_time

A time stamp indicating when this data object was terminated. Format
is a number expressed in Unix time as milliseconds (for example
`"1469498468.057"`).
@return [Time]

@!attribute [rw] status

Current status of the player session.

Possible player session statuses include the following:

* **RESERVED** -- The player session request has been received, but
  the player has not yet connected to the server process and/or been
  validated.

* **ACTIVE** -- The player has been validated by the server process
  and is currently connected.

* **COMPLETED** -- The player connection has been dropped.

* **TIMEDOUT** -- A player session request was received, but the
  player did not connect and/or was not validated within the timeout
  limit (60 seconds).
@return [String]

@!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.
@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

Port number for the game session. To connect to a Amazon GameLift
server process, an app needs both the IP address and port number.
@return [Integer]

@!attribute [rw] player_data

Developer-defined information related to a player. GameLift does not
use this data, so it can be formatted as needed for use in the game.
@return [String]

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

Constants

SENSITIVE