File Coverage

blib/lib/Paws/GameLift/DescribeInstances.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::DescribeInstances;
3 1     1   291 use Moose;
  1         3  
  1         5  
4             has FleetId => (is => 'ro', isa => 'Str', required => 1);
5             has InstanceId => (is => 'ro', isa => 'Str');
6             has Limit => (is => 'ro', isa => 'Int');
7             has NextToken => (is => 'ro', isa => 'Str');
8              
9 1     1   5353 use MooseX::ClassAttribute;
  1         3  
  1         7  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeInstances');
12             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::GameLift::DescribeInstancesOutput');
13             class_has _result_key => (isa => 'Str', is => 'ro');
14             1;
15              
16             ### main pod documentation begin ###
17              
18             =head1 NAME
19              
20             Paws::GameLift::DescribeInstances - Arguments for method DescribeInstances on Paws::GameLift
21              
22             =head1 DESCRIPTION
23              
24             This class represents the parameters used for calling the method DescribeInstances on the
25             Amazon GameLift service. Use the attributes of this class
26             as arguments to method DescribeInstances.
27              
28             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeInstances.
29              
30             As an example:
31              
32             $service_obj->DescribeInstances(Att1 => $value1, Att2 => $value2, ...);
33              
34             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.
35              
36             =head1 ATTRIBUTES
37              
38              
39             =head2 B<REQUIRED> FleetId => Str
40              
41             Unique identifier for a fleet to retrieve instance information for.
42              
43              
44              
45             =head2 InstanceId => Str
46              
47             Unique identifier for an instance to retrieve. Specify an instance ID
48             or leave blank to retrieve all instances in the fleet.
49              
50              
51              
52             =head2 Limit => Int
53              
54             Maximum number of results to return. Use this parameter with
55             C<NextToken> to get results as a set of sequential pages.
56              
57              
58              
59             =head2 NextToken => Str
60              
61             Token that indicates the start of the next sequential page of results.
62             Use the token that is returned with a previous call to this action. To
63             start at the beginning of the result set, do not specify a value.
64              
65              
66              
67              
68             =head1 SEE ALSO
69              
70             This class forms part of L<Paws>, documenting arguments for method DescribeInstances in L<Paws::GameLift>
71              
72             =head1 BUGS and CONTRIBUTIONS
73              
74             The source code is located here: https://github.com/pplu/aws-sdk-perl
75              
76             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
77              
78             =cut
79