File Coverage

blib/lib/Paws/CloudWatch/MetricDatum.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::CloudWatch::MetricDatum;
2 1     1   421 use Moose;
  1         2  
  1         6  
3             has Dimensions => (is => 'ro', isa => 'ArrayRef[Paws::CloudWatch::Dimension]');
4             has MetricName => (is => 'ro', isa => 'Str', required => 1);
5             has StatisticValues => (is => 'ro', isa => 'Paws::CloudWatch::StatisticSet');
6             has StorageResolution => (is => 'ro', isa => 'Int');
7             has Timestamp => (is => 'ro', isa => 'Str');
8             has Unit => (is => 'ro', isa => 'Str');
9             has Value => (is => 'ro', isa => 'Num');
10             1;
11              
12             ### main pod documentation begin ###
13              
14             =head1 NAME
15              
16             Paws::CloudWatch::MetricDatum
17              
18             =head1 USAGE
19              
20             This class represents one of two things:
21              
22             =head3 Arguments in a call to a service
23              
24             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
25             Each attribute should be used as a named argument in the calls that expect this type of object.
26              
27             As an example, if Att1 is expected to be a Paws::CloudWatch::MetricDatum object:
28              
29             $service_obj->Method(Att1 => { Dimensions => $value, ..., Value => $value });
30              
31             =head3 Results returned from an API call
32              
33             Use accessors for each attribute. If Att1 is expected to be an Paws::CloudWatch::MetricDatum object:
34              
35             $result = $service_obj->Method(...);
36             $result->Att1->Dimensions
37              
38             =head1 DESCRIPTION
39              
40             Encapsulates the information sent to either create a metric or add new
41             values to be aggregated into an existing metric.
42              
43             =head1 ATTRIBUTES
44              
45              
46             =head2 Dimensions => ArrayRef[L<Paws::CloudWatch::Dimension>]
47              
48             The dimensions associated with the metric.
49              
50              
51             =head2 B<REQUIRED> MetricName => Str
52              
53             The name of the metric.
54              
55              
56             =head2 StatisticValues => L<Paws::CloudWatch::StatisticSet>
57              
58             The statistical values for the metric.
59              
60              
61             =head2 StorageResolution => Int
62              
63             Valid values are 1 and 60. Setting this to 1 specifies this metric as a
64             high-resolution metric, so that CloudWatch stores the metric with
65             sub-minute resolution down to one second. Setting this to 60 specifies
66             this metric as a regular-resolution metric, which CloudWatch stores at
67             1-minute resolution. Currently, high resolution is available only for
68             custom metrics. For more information about high-resolution metrics, see
69             High-Resolution Metrics in the I<Amazon CloudWatch User Guide>.
70              
71             This field is optional, if you do not specify it the default of 60 is
72             used.
73              
74              
75             =head2 Timestamp => Str
76              
77             The time the metric data was received, expressed as the number of
78             milliseconds since Jan 1, 1970 00:00:00 UTC.
79              
80              
81             =head2 Unit => Str
82              
83             The unit of the metric.
84              
85              
86             =head2 Value => Num
87              
88             The value for the metric.
89              
90             Although the parameter accepts numbers of type Double, CloudWatch
91             rejects values that are either too small or too large. Values must be
92             in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to
93             2e360 (Base 2). In addition, special values (for example, NaN,
94             +Infinity, -Infinity) are not supported.
95              
96              
97              
98             =head1 SEE ALSO
99              
100             This class forms part of L<Paws>, describing an object used in L<Paws::CloudWatch>
101              
102             =head1 BUGS and CONTRIBUTIONS
103              
104             The source code is located here: https://github.com/pplu/aws-sdk-perl
105              
106             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
107              
108             =cut
109