Paws::GameLift::StartGameSessionPlacement - Arguments for method StartGameSessionPlacement on Paws::GameLift
This class represents the parameters used for calling the method StartGameSessionPlacement on the Amazon GameLift service. Use the attributes of this class as arguments to method StartGameSessionPlacement.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartGameSessionPlacement.
my $gamelift = Paws->service('GameLift'); my $StartGameSessionPlacementOutput = $gamelift->StartGameSessionPlacement( GameSessionQueueName => 'MyGameSessionQueueNameOrArn', MaximumPlayerSessionCount => 1, PlacementId => 'MyIdStringModel', DesiredPlayerSessions => [ { PlayerData => 'MyPlayerData', # min: 1, max: 2048; OPTIONAL PlayerId => 'MyNonZeroAndMaxString', # min: 1, max: 1024; OPTIONAL }, ... ], # OPTIONAL GameProperties => [ { Key => 'MyGamePropertyKey', # max: 32 Value => 'MyGamePropertyValue', # max: 96 }, ... ], # OPTIONAL GameSessionData => 'MyLargeGameSessionData', # OPTIONAL GameSessionName => 'MyNonZeroAndMaxString', # OPTIONAL PlayerLatencies => [ { LatencyInMilliseconds => 1.0, # OPTIONAL PlayerId => 'MyNonZeroAndMaxString', # min: 1, max: 1024; OPTIONAL RegionIdentifier => 'MyNonZeroAndMaxString', # min: 1, max: 1024; OPTIONAL }, ... ], # OPTIONAL ); # Results: my $GameSessionPlacement = $StartGameSessionPlacementOutput->GameSessionPlacement; # Returns a L<Paws::GameLift::StartGameSessionPlacementOutput> object.
Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/gamelift/StartGameSessionPlacement
Set of information on each player to create a player session for.
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 (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)).
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 (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)).
A descriptive label that is associated with a game session. Session names do not need to be unique.
Name of the queue to use to place the new game session. You can use either the queue name or ARN value.
The maximum number of players that can be connected simultaneously to the game session.
A 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.
A set of values, expressed in milliseconds, that indicates 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.
This class forms part of Paws, documenting arguments for method StartGameSessionPlacement 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, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws
CPAN shell
perl -MCPAN -e shell install Paws
For more information on module installation, please visit the detailed CPAN module installation guide.