File Coverage

blib/lib/Paws/GameLift/DescribePlayerSessions.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::GameLift::DescribePlayerSessions;
3 1     1   323 use Moose;
  1         2  
  1         6  
4             has GameSessionId => (is => 'ro', isa => 'Str');
5             has Limit => (is => 'ro', isa => 'Int');
6             has NextToken => (is => 'ro', isa => 'Str');
7             has PlayerId => (is => 'ro', isa => 'Str');
8             has PlayerSessionId => (is => 'ro', isa => 'Str');
9             has PlayerSessionStatusFilter => (is => 'ro', isa => 'Str');
10              
11 1     1   5795 use MooseX::ClassAttribute;
  1         2  
  1         7  
12              
13             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribePlayerSessions');
14             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::GameLift::DescribePlayerSessionsOutput');
15             class_has _result_key => (isa => 'Str', is => 'ro');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::GameLift::DescribePlayerSessions - Arguments for method DescribePlayerSessions on Paws::GameLift
23              
24             =head1 DESCRIPTION
25              
26             This class represents the parameters used for calling the method DescribePlayerSessions on the
27             Amazon GameLift service. Use the attributes of this class
28             as arguments to method DescribePlayerSessions.
29              
30             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribePlayerSessions.
31              
32             As an example:
33              
34             $service_obj->DescribePlayerSessions(Att1 => $value1, Att2 => $value2, ...);
35              
36             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.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 GameSessionId => Str
42              
43             Unique identifier for the game session to retrieve player sessions for.
44              
45              
46              
47             =head2 Limit => Int
48              
49             Maximum number of results to return. Use this parameter with
50             C<NextToken> to get results as a set of sequential pages. If a player
51             session ID is specified, this parameter is ignored.
52              
53              
54              
55             =head2 NextToken => Str
56              
57             Token that indicates the start of the next sequential page of results.
58             Use the token that is returned with a previous call to this action. To
59             start at the beginning of the result set, do not specify a value. If a
60             player session ID is specified, this parameter is ignored.
61              
62              
63              
64             =head2 PlayerId => Str
65              
66             Unique identifier for a player to retrieve player sessions for.
67              
68              
69              
70             =head2 PlayerSessionId => Str
71              
72             Unique identifier for a player session to retrieve.
73              
74              
75              
76             =head2 PlayerSessionStatusFilter => Str
77              
78             Player session status to filter results on.
79              
80             Possible player session statuses include the following:
81              
82             =over
83              
84             =item *
85              
86             B<RESERVED> -- The player session request has been received, but the
87             player has not yet connected to the server process and/or been
88             validated.
89              
90             =item *
91              
92             B<ACTIVE> -- The player has been validated by the server process and is
93             currently connected.
94              
95             =item *
96              
97             B<COMPLETED> -- The player connection has been dropped.
98              
99             =item *
100              
101             B<TIMEDOUT> -- A player session request was received, but the player
102             did not connect and/or was not validated within the timeout limit (60
103             seconds).
104              
105             =back
106              
107              
108              
109              
110              
111             =head1 SEE ALSO
112              
113             This class forms part of L<Paws>, documenting arguments for method DescribePlayerSessions in L<Paws::GameLift>
114              
115             =head1 BUGS and CONTRIBUTIONS
116              
117             The source code is located here: https://github.com/pplu/aws-sdk-perl
118              
119             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
120              
121             =cut
122