File Coverage

blib/lib/Paws/GameLift/DescribeScalingPolicies.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::DescribeScalingPolicies;
3 1     1   328 use Moose;
  1         2  
  1         6  
4             has FleetId => (is => 'ro', isa => 'Str', required => 1);
5             has Limit => (is => 'ro', isa => 'Int');
6             has NextToken => (is => 'ro', isa => 'Str');
7             has StatusFilter => (is => 'ro', isa => 'Str');
8              
9 1     1   5486 use MooseX::ClassAttribute;
  1         2  
  1         7  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeScalingPolicies');
12             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::GameLift::DescribeScalingPoliciesOutput');
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::DescribeScalingPolicies - Arguments for method DescribeScalingPolicies on Paws::GameLift
21              
22             =head1 DESCRIPTION
23              
24             This class represents the parameters used for calling the method DescribeScalingPolicies on the
25             Amazon GameLift service. Use the attributes of this class
26             as arguments to method DescribeScalingPolicies.
27              
28             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeScalingPolicies.
29              
30             As an example:
31              
32             $service_obj->DescribeScalingPolicies(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 scaling policies for.
42              
43              
44              
45             =head2 Limit => Int
46              
47             Maximum number of results to return. Use this parameter with
48             C<NextToken> to get results as a set of sequential pages.
49              
50              
51              
52             =head2 NextToken => Str
53              
54             Token that indicates the start of the next sequential page of results.
55             Use the token that is returned with a previous call to this action. To
56             start at the beginning of the result set, do not specify a value.
57              
58              
59              
60             =head2 StatusFilter => Str
61              
62             Scaling policy status to filter results on. A scaling policy is only in
63             force when in an C<ACTIVE> status.
64              
65             =over
66              
67             =item *
68              
69             B<ACTIVE> -- The scaling policy is currently in force.
70              
71             =item *
72              
73             B<UPDATEREQUESTED> -- A request to update the scaling policy has been
74             received.
75              
76             =item *
77              
78             B<UPDATING> -- A change is being made to the scaling policy.
79              
80             =item *
81              
82             B<DELETEREQUESTED> -- A request to delete the scaling policy has been
83             received.
84              
85             =item *
86              
87             B<DELETING> -- The scaling policy is being deleted.
88              
89             =item *
90              
91             B<DELETED> -- The scaling policy has been deleted.
92              
93             =item *
94              
95             B<ERROR> -- An error occurred in creating the policy. It should be
96             removed and recreated.
97              
98             =back
99              
100              
101             Valid values are: C<"ACTIVE">, C<"UPDATE_REQUESTED">, C<"UPDATING">, C<"DELETE_REQUESTED">, C<"DELETING">, C<"DELETED">, C<"ERROR">
102              
103              
104             =head1 SEE ALSO
105              
106             This class forms part of L<Paws>, documenting arguments for method DescribeScalingPolicies in L<Paws::GameLift>
107              
108             =head1 BUGS and CONTRIBUTIONS
109              
110             The source code is located here: https://github.com/pplu/aws-sdk-perl
111              
112             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
113              
114             =cut
115