Paws::GameLift::GameSession
This class represents one of two things:
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::GameLift::GameSession object:
$service_obj->Method(Att1 => { CreationTime => $value, ..., TerminationTime => $value });
Use accessors for each attribute. If Att1 is expected to be an Paws::GameLift::GameSession object:
$result = $service_obj->Method(...); $result->Att1->CreationTime
Properties describing a game session.
A game session in ACTIVE status can host players. When a game session ends, its status is set to TERMINATED.
TERMINATED
Once the session ends, the game session object is retained for 30 days. This means you can reuse idempotency token values after this time. Game session logs are retained for 14 days.
CreateGameSession
DescribeGameSessions
DescribeGameSessionDetails
SearchGameSessions
UpdateGameSession
GetGameSessionLogUrl
Game session placements
StartGameSessionPlacement
DescribeGameSessionPlacement
StopGameSessionPlacement
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.
Number of players currently in the game session.
Unique identifier for a fleet that the game session is running on.
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 (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). You can search for active game sessions based on this custom data with SearchGameSessions.
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 (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)).
Unique identifier for the game session. A game session ARN has the following format: C<arn:aws:gamelift:E<lt>regionE<gt>::gamesession/E<lt>fleet IDE<gt>/E<lt>custom ID string or idempotency tokenE<gt>>.
IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data (https://docs.aws.amazon.com/gamelift/latest/developerguide/match-server.html#match-server-data). Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill).
Maximum number of players that can be connected simultaneously to the game session.
Descriptive label that is associated with a game session. Session names do not need to be unique.
Indicates whether or not the game session is accepting new players.
Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
Current status of the game session. A game session must have an C<ACTIVE> status to have player sessions.
Provides additional information about game session status. C<INTERRUPTED> indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.
Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
This class forms part of Paws, describing an object used in Paws::GameLift
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
To install Paws::SDK::Config, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws::SDK::Config
CPAN shell
perl -MCPAN -e shell install Paws::SDK::Config
For more information on module installation, please visit the detailed CPAN module installation guide.