blib/lib/Paws/Lightsail/GetLoadBalancerMetricData.pm untested

filter: Statementstmt 0.0% 0 / 23 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 25 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Lightsail::GetLoadBalancerMetricData;
3 use Moose;
4 has EndTime => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'endTime' , required => 1);
5 has LoadBalancerName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'loadBalancerName' , required => 1);
6 has MetricName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'metricName' , required => 1);
7 has Period => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'period' , required => 1);
8 has StartTime => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'startTime' , required => 1);
9 has Statistics => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'statistics' , required => 1);
10 has Unit => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'unit' , required => 1);
11  
12 use MooseX::ClassAttribute;
13  
14 class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetLoadBalancerMetricData');
15 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Lightsail::GetLoadBalancerMetricDataResult');
16 class_has _result_key => (isa => 'Str', is => 'ro');
17 1;
18  
19 ### main pod documentation begin ###
20  
21 =head1 NAME
22  
23 Paws::Lightsail::GetLoadBalancerMetricData - Arguments for method GetLoadBalancerMetricData on L<Paws::Lightsail>
24  
25 =head1 DESCRIPTION
26  
27 This class represents the parameters used for calling the method GetLoadBalancerMetricData on the
28 L<Amazon Lightsail|Paws::Lightsail> service. Use the attributes of this class
29 as arguments to method GetLoadBalancerMetricData.
30  
31 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetLoadBalancerMetricData.
32  
33 =head1 SYNOPSIS
34  
35 my $lightsail = Paws->service('Lightsail');
36 my $GetLoadBalancerMetricDataResult = $lightsail->GetLoadBalancerMetricData(
37 EndTime => '1970-01-01T01:00:00',
38 LoadBalancerName => 'MyResourceName',
39 MetricName => 'ClientTLSNegotiationErrorCount',
40 Period => 1,
41 StartTime => '1970-01-01T01:00:00',
42 Statistics => [
43 'Minimum', ... # values: Minimum, Maximum, Sum, Average, SampleCount
44 ],
45 Unit => 'Seconds',
46  
47 );
48  
49 # Results:
50 my $MetricData = $GetLoadBalancerMetricDataResult->MetricData;
51 my $MetricName = $GetLoadBalancerMetricDataResult->MetricName;
52  
53 # Returns a L<Paws::Lightsail::GetLoadBalancerMetricDataResult> object.
54  
55 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.
56 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/lightsail/GetLoadBalancerMetricData>
57  
58 =head1 ATTRIBUTES
59  
60  
61 =head2 B<REQUIRED> EndTime => Str
62  
63 The end time of the period.
64  
65  
66  
67 =head2 B<REQUIRED> LoadBalancerName => Str
68  
69 The name of the load balancer.
70  
71  
72  
73 =head2 B<REQUIRED> MetricName => Str
74  
75 The metric for which you want to return information.
76  
77 Valid load balancer metric names are listed below, along with the most
78 useful C<statistics> to include in your request, and the published
79 C<unit> value.
80  
81 =over
82  
83 =item *
84  
85 B<C<ClientTLSNegotiationErrorCount> > - The number of TLS connections
86 initiated by the client that did not establish a session with the load
87 balancer due to a TLS error generated by the load balancer. Possible
88 causes include a mismatch of ciphers or protocols.
89  
90 C<Statistics>: The most useful statistic is C<Sum>.
91  
92 C<Unit>: The published unit is C<Count>.
93  
94 =item *
95  
96 B<C<HealthyHostCount> > - The number of target instances that are
97 considered healthy.
98  
99 C<Statistics>: The most useful statistic are C<Average>, C<Minimum>,
100 and C<Maximum>.
101  
102 C<Unit>: The published unit is C<Count>.
103  
104 =item *
105  
106 B<C<HTTPCode_Instance_2XX_Count> > - The number of HTTP 2XX response
107 codes generated by the target instances. This does not include any
108 response codes generated by the load balancer.
109  
110 C<Statistics>: The most useful statistic is C<Sum>. Note that
111 C<Minimum>, C<Maximum>, and C<Average> all return C<1>.
112  
113 C<Unit>: The published unit is C<Count>.
114  
115 =item *
116  
117 B<C<HTTPCode_Instance_3XX_Count> > - The number of HTTP 3XX response
118 codes generated by the target instances. This does not include any
119 response codes generated by the load balancer.
120  
121 C<Statistics>: The most useful statistic is C<Sum>. Note that
122 C<Minimum>, C<Maximum>, and C<Average> all return C<1>.
123  
124 C<Unit>: The published unit is C<Count>.
125  
126 =item *
127  
128 B<C<HTTPCode_Instance_4XX_Count> > - The number of HTTP 4XX response
129 codes generated by the target instances. This does not include any
130 response codes generated by the load balancer.
131  
132 C<Statistics>: The most useful statistic is C<Sum>. Note that
133 C<Minimum>, C<Maximum>, and C<Average> all return C<1>.
134  
135 C<Unit>: The published unit is C<Count>.
136  
137 =item *
138  
139 B<C<HTTPCode_Instance_5XX_Count> > - The number of HTTP 5XX response
140 codes generated by the target instances. This does not include any
141 response codes generated by the load balancer.
142  
143 C<Statistics>: The most useful statistic is C<Sum>. Note that
144 C<Minimum>, C<Maximum>, and C<Average> all return C<1>.
145  
146 C<Unit>: The published unit is C<Count>.
147  
148 =item *
149  
150 B<C<HTTPCode_LB_4XX_Count> > - The number of HTTP 4XX client error
151 codes that originated from the load balancer. Client errors are
152 generated when requests are malformed or incomplete. These requests
153 were not received by the target instance. This count does not include
154 response codes generated by the target instances.
155  
156 C<Statistics>: The most useful statistic is C<Sum>. Note that
157 C<Minimum>, C<Maximum>, and C<Average> all return C<1>.
158  
159 C<Unit>: The published unit is C<Count>.
160  
161 =item *
162  
163 B<C<HTTPCode_LB_5XX_Count> > - The number of HTTP 5XX server error
164 codes that originated from the load balancer. This does not include any
165 response codes generated by the target instance. This metric is
166 reported if there are no healthy instances attached to the load
167 balancer, or if the request rate exceeds the capacity of the instances
168 (spillover) or the load balancer.
169  
170 C<Statistics>: The most useful statistic is C<Sum>. Note that
171 C<Minimum>, C<Maximum>, and C<Average> all return C<1>.
172  
173 C<Unit>: The published unit is C<Count>.
174  
175 =item *
176  
177 B<C<InstanceResponseTime> > - The time elapsed, in seconds, after the
178 request leaves the load balancer until a response from the target
179 instance is received.
180  
181 C<Statistics>: The most useful statistic is C<Average>.
182  
183 C<Unit>: The published unit is C<Seconds>.
184  
185 =item *
186  
187 B<C<RejectedConnectionCount> > - The number of connections that were
188 rejected because the load balancer had reached its maximum number of
189 connections.
190  
191 C<Statistics>: The most useful statistic is C<Sum>.
192  
193 C<Unit>: The published unit is C<Count>.
194  
195 =item *
196  
197 B<C<RequestCount> > - The number of requests processed over IPv4. This
198 count includes only the requests with a response generated by a target
199 instance of the load balancer.
200  
201 C<Statistics>: The most useful statistic is C<Sum>. Note that
202 C<Minimum>, C<Maximum>, and C<Average> all return C<1>.
203  
204 C<Unit>: The published unit is C<Count>.
205  
206 =item *
207  
208 B<C<UnhealthyHostCount> > - The number of target instances that are
209 considered unhealthy.
210  
211 C<Statistics>: The most useful statistic are C<Average>, C<Minimum>,
212 and C<Maximum>.
213  
214 C<Unit>: The published unit is C<Count>.
215  
216 =back
217  
218  
219 Valid values are: C<"ClientTLSNegotiationErrorCount">, C<"HealthyHostCount">, C<"UnhealthyHostCount">, C<"HTTPCode_LB_4XX_Count">, C<"HTTPCode_LB_5XX_Count">, C<"HTTPCode_Instance_2XX_Count">, C<"HTTPCode_Instance_3XX_Count">, C<"HTTPCode_Instance_4XX_Count">, C<"HTTPCode_Instance_5XX_Count">, C<"InstanceResponseTime">, C<"RejectedConnectionCount">, C<"RequestCount">
220  
221 =head2 B<REQUIRED> Period => Int
222  
223 The granularity, in seconds, of the returned data points.
224  
225  
226  
227 =head2 B<REQUIRED> StartTime => Str
228  
229 The start time of the period.
230  
231  
232  
233 =head2 B<REQUIRED> Statistics => ArrayRef[Str|Undef]
234  
235 The statistic for the metric.
236  
237 The following statistics are available:
238  
239 =over
240  
241 =item *
242  
243 C<Minimum> - The lowest value observed during the specified period. Use
244 this value to determine low volumes of activity for your application.
245  
246 =item *
247  
248 C<Maximum> - The highest value observed during the specified period.
249 Use this value to determine high volumes of activity for your
250 application.
251  
252 =item *
253  
254 C<Sum> - All values submitted for the matching metric added together.
255 You can use this statistic to determine the total volume of a metric.
256  
257 =item *
258  
259 C<Average> - The value of Sum / SampleCount during the specified
260 period. By comparing this statistic with the Minimum and Maximum
261 values, you can determine the full scope of a metric and how close the
262 average use is to the Minimum and Maximum values. This comparison helps
263 you to know when to increase or decrease your resources.
264  
265 =item *
266  
267 C<SampleCount> - The count, or number, of data points used for the
268 statistical calculation.
269  
270 =back
271  
272  
273  
274  
275 =head2 B<REQUIRED> Unit => Str
276  
277 The unit for the metric data request. Valid units depend on the metric
278 data being requested. For the valid units with each available metric,
279 see the C<metricName> parameter.
280  
281 Valid values are: C<"Seconds">, C<"Microseconds">, C<"Milliseconds">, C<"Bytes">, C<"Kilobytes">, C<"Megabytes">, C<"Gigabytes">, C<"Terabytes">, C<"Bits">, C<"Kilobits">, C<"Megabits">, C<"Gigabits">, C<"Terabits">, C<"Percent">, C<"Count">, C<"Bytes/Second">, C<"Kilobytes/Second">, C<"Megabytes/Second">, C<"Gigabytes/Second">, C<"Terabytes/Second">, C<"Bits/Second">, C<"Kilobits/Second">, C<"Megabits/Second">, C<"Gigabits/Second">, C<"Terabits/Second">, C<"Count/Second">, C<"None">
282  
283  
284 =head1 SEE ALSO
285  
286 This class forms part of L<Paws>, documenting arguments for method GetLoadBalancerMetricData in L<Paws::Lightsail>
287  
288 =head1 BUGS and CONTRIBUTIONS
289  
290 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
291  
292 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
293  
294 =cut
295