File Coverage

blib/lib/Paws/GameLift/DescribeGameSessions.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::DescribeGameSessions;
3 1     1   519 use Moose;
  1         2  
  1         6  
4             has AliasId => (is => 'ro', isa => 'Str');
5             has FleetId => (is => 'ro', isa => 'Str');
6             has GameSessionId => (is => 'ro', isa => 'Str');
7             has Limit => (is => 'ro', isa => 'Int');
8             has NextToken => (is => 'ro', isa => 'Str');
9             has StatusFilter => (is => 'ro', isa => 'Str');
10              
11 1     1   6213 use MooseX::ClassAttribute;
  1         2  
  1         9  
12              
13             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeGameSessions');
14             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::GameLift::DescribeGameSessionsOutput');
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::DescribeGameSessions - Arguments for method DescribeGameSessions on Paws::GameLift
23              
24             =head1 DESCRIPTION
25              
26             This class represents the parameters used for calling the method DescribeGameSessions on the
27             Amazon GameLift service. Use the attributes of this class
28             as arguments to method DescribeGameSessions.
29              
30             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeGameSessions.
31              
32             As an example:
33              
34             $service_obj->DescribeGameSessions(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 AliasId => Str
42              
43             Unique identifier for an alias associated with the fleet to retrieve
44             all game sessions for.
45              
46              
47              
48             =head2 FleetId => Str
49              
50             Unique identifier for a fleet to retrieve all game sessions for.
51              
52              
53              
54             =head2 GameSessionId => Str
55              
56             Unique identifier for the game session to retrieve. You can use either
57             a C<GameSessionId> or C<GameSessionArn> value.
58              
59              
60              
61             =head2 Limit => Int
62              
63             Maximum number of results to return. Use this parameter with
64             C<NextToken> to get results as a set of sequential pages.
65              
66              
67              
68             =head2 NextToken => Str
69              
70             Token that indicates the start of the next sequential page of results.
71             Use the token that is returned with a previous call to this action. To
72             specify the start of the result set, do not specify a value.
73              
74              
75              
76             =head2 StatusFilter => Str
77              
78             Game session status to filter results on. Possible game session
79             statuses include C<ACTIVE>, C<TERMINATED>, C<ACTIVATING>, and
80             C<TERMINATING> (the last two are transitory).
81              
82              
83              
84              
85             =head1 SEE ALSO
86              
87             This class forms part of L<Paws>, documenting arguments for method DescribeGameSessions in L<Paws::GameLift>
88              
89             =head1 BUGS and CONTRIBUTIONS
90              
91             The source code is located here: https://github.com/pplu/aws-sdk-perl
92              
93             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
94              
95             =cut
96