Paws::GameLift::DescribePlayerSessions - Arguments for method DescribePlayerSessions on Paws::GameLift
This class represents the parameters used for calling the method DescribePlayerSessions on the Amazon GameLift service. Use the attributes of this class as arguments to method DescribePlayerSessions.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribePlayerSessions.
my $gamelift = Paws->service('GameLift'); my $DescribePlayerSessionsOutput = $gamelift->DescribePlayerSessions( GameSessionId => 'MyArnStringModel', # OPTIONAL Limit => 1, # OPTIONAL NextToken => 'MyNonZeroAndMaxString', # OPTIONAL PlayerId => 'MyNonZeroAndMaxString', # OPTIONAL PlayerSessionId => 'MyPlayerSessionId', # OPTIONAL PlayerSessionStatusFilter => 'MyNonZeroAndMaxString', # OPTIONAL ); # Results: my $NextToken = $DescribePlayerSessionsOutput->NextToken; my $PlayerSessions = $DescribePlayerSessionsOutput->PlayerSessions; # Returns a L<Paws::GameLift::DescribePlayerSessionsOutput> 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/DescribePlayerSessions
A unique identifier for the game session to retrieve player sessions for.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.
NextToken
A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.
A unique identifier for a player to retrieve player sessions for.
A unique identifier for a player session to retrieve.
Player session status to filter results on.
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).
This class forms part of Paws, documenting arguments for method DescribePlayerSessions 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.