blib/lib/Paws/Lightsail/GetRelationalDatabaseMetricData.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::GetRelationalDatabaseMetricData;
3 use Moose;
4 has EndTime => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'endTime' , required => 1);
5 has MetricName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'metricName' , required => 1);
6 has Period => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'period' , required => 1);
7 has RelationalDatabaseName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'relationalDatabaseName' , 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 => 'GetRelationalDatabaseMetricData');
15 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Lightsail::GetRelationalDatabaseMetricDataResult');
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::GetRelationalDatabaseMetricData - Arguments for method GetRelationalDatabaseMetricData on L<Paws::Lightsail>
24  
25 =head1 DESCRIPTION
26  
27 This class represents the parameters used for calling the method GetRelationalDatabaseMetricData on the
28 L<Amazon Lightsail|Paws::Lightsail> service. Use the attributes of this class
29 as arguments to method GetRelationalDatabaseMetricData.
30  
31 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetRelationalDatabaseMetricData.
32  
33 =head1 SYNOPSIS
34  
35 my $lightsail = Paws->service('Lightsail');
36 my $GetRelationalDatabaseMetricDataResult =
37 $lightsail->GetRelationalDatabaseMetricData(
38 EndTime => '1970-01-01T01:00:00',
39 MetricName => 'CPUUtilization',
40 Period => 1,
41 RelationalDatabaseName => 'MyResourceName',
42 StartTime => '1970-01-01T01:00:00',
43 Statistics => [
44 'Minimum', ... # values: Minimum, Maximum, Sum, Average, SampleCount
45 ],
46 Unit => 'Seconds',
47  
48 );
49  
50 # Results:
51 my $MetricData = $GetRelationalDatabaseMetricDataResult->MetricData;
52 my $MetricName = $GetRelationalDatabaseMetricDataResult->MetricName;
53  
54 # Returns a L<Paws::Lightsail::GetRelationalDatabaseMetricDataResult> object.
55  
56 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.
57 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/lightsail/GetRelationalDatabaseMetricData>
58  
59 =head1 ATTRIBUTES
60  
61  
62 =head2 B<REQUIRED> EndTime => Str
63  
64 The end of the time interval from which to get metric data.
65  
66 Constraints:
67  
68 =over
69  
70 =item *
71  
72 Specified in Coordinated Universal Time (UTC).
73  
74 =item *
75  
76 Specified in the Unix time format.
77  
78 For example, if you wish to use an end time of October 1, 2018, at 8 PM
79 UTC, then you input C<1538424000> as the end time.
80  
81 =back
82  
83  
84  
85  
86 =head2 B<REQUIRED> MetricName => Str
87  
88 The metric for which you want to return information.
89  
90 Valid relational database metric names are listed below, along with the
91 most useful C<statistics> to include in your request, and the published
92 C<unit> value. All relational database metric data is available in
93 1-minute (60 seconds) granularity.
94  
95 =over
96  
97 =item *
98  
99 B<C<CPUUtilization> > - The percentage of CPU utilization currently in
100 use on the database.
101  
102 C<Statistics>: The most useful statistics are C<Maximum> and
103 C<Average>.
104  
105 C<Unit>: The published unit is C<Percent>.
106  
107 =item *
108  
109 B<C<DatabaseConnections> > - The number of database connections in use.
110  
111 C<Statistics>: The most useful statistics are C<Maximum> and C<Sum>.
112  
113 C<Unit>: The published unit is C<Count>.
114  
115 =item *
116  
117 B<C<DiskQueueDepth> > - The number of outstanding IOs (read/write
118 requests) that are waiting to access the disk.
119  
120 C<Statistics>: The most useful statistic is C<Sum>.
121  
122 C<Unit>: The published unit is C<Count>.
123  
124 =item *
125  
126 B<C<FreeStorageSpace> > - The amount of available storage space.
127  
128 C<Statistics>: The most useful statistic is C<Sum>.
129  
130 C<Unit>: The published unit is C<Bytes>.
131  
132 =item *
133  
134 B<C<NetworkReceiveThroughput> > - The incoming (Receive) network
135 traffic on the database, including both customer database traffic and
136 AWS traffic used for monitoring and replication.
137  
138 C<Statistics>: The most useful statistic is C<Average>.
139  
140 C<Unit>: The published unit is C<Bytes/Second>.
141  
142 =item *
143  
144 B<C<NetworkTransmitThroughput> > - The outgoing (Transmit) network
145 traffic on the database, including both customer database traffic and
146 AWS traffic used for monitoring and replication.
147  
148 C<Statistics>: The most useful statistic is C<Average>.
149  
150 C<Unit>: The published unit is C<Bytes/Second>.
151  
152 =back
153  
154  
155 Valid values are: C<"CPUUtilization">, C<"DatabaseConnections">, C<"DiskQueueDepth">, C<"FreeStorageSpace">, C<"NetworkReceiveThroughput">, C<"NetworkTransmitThroughput">
156  
157 =head2 B<REQUIRED> Period => Int
158  
159 The granularity, in seconds, of the returned data points.
160  
161 All relational database metric data is available in 1-minute (60
162 seconds) granularity.
163  
164  
165  
166 =head2 B<REQUIRED> RelationalDatabaseName => Str
167  
168 The name of your database from which to get metric data.
169  
170  
171  
172 =head2 B<REQUIRED> StartTime => Str
173  
174 The start of the time interval from which to get metric data.
175  
176 Constraints:
177  
178 =over
179  
180 =item *
181  
182 Specified in Coordinated Universal Time (UTC).
183  
184 =item *
185  
186 Specified in the Unix time format.
187  
188 For example, if you wish to use a start time of October 1, 2018, at 8
189 PM UTC, then you input C<1538424000> as the start time.
190  
191 =back
192  
193  
194  
195  
196 =head2 B<REQUIRED> Statistics => ArrayRef[Str|Undef]
197  
198 The statistic for the metric.
199  
200 The following statistics are available:
201  
202 =over
203  
204 =item *
205  
206 C<Minimum> - The lowest value observed during the specified period. Use
207 this value to determine low volumes of activity for your application.
208  
209 =item *
210  
211 C<Maximum> - The highest value observed during the specified period.
212 Use this value to determine high volumes of activity for your
213 application.
214  
215 =item *
216  
217 C<Sum> - All values submitted for the matching metric added together.
218 You can use this statistic to determine the total volume of a metric.
219  
220 =item *
221  
222 C<Average> - The value of Sum / SampleCount during the specified
223 period. By comparing this statistic with the Minimum and Maximum
224 values, you can determine the full scope of a metric and how close the
225 average use is to the Minimum and Maximum values. This comparison helps
226 you to know when to increase or decrease your resources.
227  
228 =item *
229  
230 C<SampleCount> - The count, or number, of data points used for the
231 statistical calculation.
232  
233 =back
234  
235  
236  
237  
238 =head2 B<REQUIRED> Unit => Str
239  
240 The unit for the metric data request. Valid units depend on the metric
241 data being requested. For the valid units with each available metric,
242 see the C<metricName> parameter.
243  
244 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">
245  
246  
247 =head1 SEE ALSO
248  
249 This class forms part of L<Paws>, documenting arguments for method GetRelationalDatabaseMetricData in L<Paws::Lightsail>
250  
251 =head1 BUGS and CONTRIBUTIONS
252  
253 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
254  
255 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
256  
257 =cut
258