File Coverage

blib/lib/Paws/CloudWatch/GetMetricStatistics.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::CloudWatch::GetMetricStatistics;
3 1     1   316 use Moose;
  1     1   2  
  1         5  
  1         398  
  1         3  
  1         7  
4             has Dimensions => (is => 'ro', isa => 'ArrayRef[Paws::CloudWatch::Dimension]');
5             has EndTime => (is => 'ro', isa => 'Str', required => 1);
6             has ExtendedStatistics => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
7             has MetricName => (is => 'ro', isa => 'Str', required => 1);
8             has Namespace => (is => 'ro', isa => 'Str', required => 1);
9             has Period => (is => 'ro', isa => 'Int', required => 1);
10             has StartTime => (is => 'ro', isa => 'Str', required => 1);
11             has Statistics => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
12             has Unit => (is => 'ro', isa => 'Str');
13              
14 1     1   5388 use MooseX::ClassAttribute;
  1     1   2  
  1         8  
  1         5736  
  1         5  
  1         7  
15              
16             class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetMetricStatistics');
17             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudWatch::GetMetricStatisticsOutput');
18             class_has _result_key => (isa => 'Str', is => 'ro', default => 'GetMetricStatisticsResult');
19             1;
20              
21             ### main pod documentation begin ###
22              
23             =head1 NAME
24              
25             Paws::CloudWatch::GetMetricStatistics - Arguments for method GetMetricStatistics on Paws::CloudWatch
26              
27             =head1 DESCRIPTION
28              
29             This class represents the parameters used for calling the method GetMetricStatistics on the
30             Amazon CloudWatch service. Use the attributes of this class
31             as arguments to method GetMetricStatistics.
32              
33             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetMetricStatistics.
34              
35             As an example:
36              
37             $service_obj->GetMetricStatistics(Att1 => $value1, Att2 => $value2, ...);
38              
39             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.
40              
41             =head1 ATTRIBUTES
42              
43              
44             =head2 Dimensions => ArrayRef[L<Paws::CloudWatch::Dimension>]
45              
46             The dimensions. If the metric contains multiple dimensions, you must
47             include a value for each dimension. CloudWatch treats each unique
48             combination of dimensions as a separate metric. If a specific
49             combination of dimensions was not published, you can't retrieve
50             statistics for it. You must specify the same dimensions that were used
51             when the metrics were created. For an example, see Dimension
52             Combinations in the I<Amazon CloudWatch User Guide>. For more
53             information about specifying dimensions, see Publishing Metrics in the
54             I<Amazon CloudWatch User Guide>.
55              
56              
57              
58             =head2 B<REQUIRED> EndTime => Str
59              
60             The time stamp that determines the last data point to return.
61              
62             The value specified is exclusive; results include data points up to the
63             specified time stamp. The time stamp must be in ISO 8601 UTC format
64             (for example, 2016-10-10T23:00:00Z).
65              
66              
67              
68             =head2 ExtendedStatistics => ArrayRef[Str|Undef]
69              
70             The percentile statistics. Specify values between p0.0 and p100. When
71             calling C<GetMetricStatistics>, you must specify either C<Statistics>
72             or C<ExtendedStatistics>, but not both.
73              
74              
75              
76             =head2 B<REQUIRED> MetricName => Str
77              
78             The name of the metric, with or without spaces.
79              
80              
81              
82             =head2 B<REQUIRED> Namespace => Str
83              
84             The namespace of the metric, with or without spaces.
85              
86              
87              
88             =head2 B<REQUIRED> Period => Int
89              
90             The granularity, in seconds, of the returned data points. For metrics
91             with regular resolution, a period can be as short as one minute (60
92             seconds) and must be a multiple of 60. For high-resolution metrics that
93             are collected at intervals of less than one minute, the period can be
94             1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are
95             those metrics stored by a C<PutMetricData> call that includes a
96             C<StorageResolution> of 1 second.
97              
98             If the C<StartTime> parameter specifies a time stamp that is greater
99             than 3 hours ago, you must specify the period as follows or no data
100             points in that time range is returned:
101              
102             =over
103              
104             =item *
105              
106             Start time between 3 hours and 15 days ago - Use a multiple of 60
107             seconds (1 minute).
108              
109             =item *
110              
111             Start time between 15 and 63 days ago - Use a multiple of 300 seconds
112             (5 minutes).
113              
114             =item *
115              
116             Start time greater than 63 days ago - Use a multiple of 3600 seconds (1
117             hour).
118              
119             =back
120              
121              
122              
123              
124             =head2 B<REQUIRED> StartTime => Str
125              
126             The time stamp that determines the first data point to return. Start
127             times are evaluated relative to the time that CloudWatch receives the
128             request.
129              
130             The value specified is inclusive; results include data points with the
131             specified time stamp. The time stamp must be in ISO 8601 UTC format
132             (for example, 2016-10-03T23:00:00Z).
133              
134             CloudWatch rounds the specified time stamp as follows:
135              
136             =over
137              
138             =item *
139              
140             Start time less than 15 days ago - Round down to the nearest whole
141             minute. For example, 12:32:34 is rounded down to 12:32:00.
142              
143             =item *
144              
145             Start time between 15 and 63 days ago - Round down to the nearest
146             5-minute clock interval. For example, 12:32:34 is rounded down to
147             12:30:00.
148              
149             =item *
150              
151             Start time greater than 63 days ago - Round down to the nearest 1-hour
152             clock interval. For example, 12:32:34 is rounded down to 12:00:00.
153              
154             =back
155              
156             If you set C<Period> to 5, 10, or 30, the start time of your request is
157             rounded down to the nearest time that corresponds to even 5-, 10-, or
158             30-second divisions of a minute. For example, if you make a query at
159             (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time
160             of your request is rounded down and you receive data from 01:05:10 to
161             01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of
162             data, using a period of 5 seconds, you receive data timestamped between
163             15:02:15 and 15:07:15.
164              
165              
166              
167             =head2 Statistics => ArrayRef[Str|Undef]
168              
169             The metric statistics, other than percentile. For percentile
170             statistics, use C<ExtendedStatistics>. When calling
171             C<GetMetricStatistics>, you must specify either C<Statistics> or
172             C<ExtendedStatistics>, but not both.
173              
174              
175              
176             =head2 Unit => Str
177              
178             The unit for a given metric. Metrics may be reported in multiple units.
179             Not supplying a unit results in all units being returned. If the metric
180             only ever reports one unit, specifying a unit has no effect.
181              
182             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">
183              
184              
185             =head1 SEE ALSO
186              
187             This class forms part of L<Paws>, documenting arguments for method GetMetricStatistics in L<Paws::CloudWatch>
188              
189             =head1 BUGS and CONTRIBUTIONS
190              
191             The source code is located here: https://github.com/pplu/aws-sdk-perl
192              
193             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
194              
195             =cut
196