blib/lib/Paws/CloudWatch/MetricStat.pm untested

filter: Statementstmt 0.0% 0 / 7 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 8 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::CloudWatch::MetricStat;
3 use Moose;
4 has Metric => (is => 'ro', isa => 'Paws::CloudWatch::Metric', required => 1);
5 has Period => (is => 'ro', isa => 'Int', required => 1);
6 has Stat => (is => 'ro', isa => 'Str', required => 1);
7 has Unit => (is => 'ro', isa => 'Str');
8  
9 1;
10  
11 ### main pod documentation begin ###
12  
13 =head1 NAME
14  
15 Paws::CloudWatch::MetricStat
16  
17 =head1 USAGE
18  
19 This class represents one of two things:
20  
21 =head3 Arguments in a call to a service
22  
23 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
24 Each attribute should be used as a named argument in the calls that expect this type of object.
25  
26 As an example, if Att1 is expected to be a Paws::CloudWatch::MetricStat object:
27  
28 $service_obj->Method(Att1 => { Metric => $value, ..., Unit => $value });
29  
30 =head3 Results returned from an API call
31  
32 Use accessors for each attribute. If Att1 is expected to be an Paws::CloudWatch::MetricStat object:
33  
34 $result = $service_obj->Method(...);
35 $result->Att1->Metric
36  
37 =head1 DESCRIPTION
38  
39 This structure defines the metric to be returned, along with the
40 statistics, period, and units.
41  
42 =head1 ATTRIBUTES
43  
44  
45 =head2 B<REQUIRED> Metric => L<Paws::CloudWatch::Metric>
46  
47 The metric to return, including the metric name, namespace, and
48 dimensions.
49  
50  
51 =head2 B<REQUIRED> Period => Int
52  
53 The granularity, in seconds, of the returned data points. For metrics
54 with regular resolution, a period can be as short as one minute (60
55 seconds) and must be a multiple of 60. For high-resolution metrics that
56 are collected at intervals of less than one minute, the period can be
57 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are
58 those metrics stored by a C<PutMetricData> call that includes a
59 C<StorageResolution> of 1 second.
60  
61 If the C<StartTime> parameter specifies a time stamp that is greater
62 than 3 hours ago, you must specify the period as follows or no data
63 points in that time range is returned:
64  
65 =over
66  
67 =item *
68  
69 Start time between 3 hours and 15 days ago - Use a multiple of 60
70 seconds (1 minute).
71  
72 =item *
73  
74 Start time between 15 and 63 days ago - Use a multiple of 300 seconds
75 (5 minutes).
76  
77 =item *
78  
79 Start time greater than 63 days ago - Use a multiple of 3600 seconds (1
80 hour).
81  
82 =back
83  
84  
85  
86 =head2 B<REQUIRED> Stat => Str
87  
88 The statistic to return. It can include any CloudWatch statistic or
89 extended statistic.
90  
91  
92 =head2 Unit => Str
93  
94 When you are using a C<Put> operation, this defines what unit you want
95 to use when storing the metric.
96  
97 In a C<Get> operation, if you omit C<Unit> then all data that was
98 collected with any unit is returned, along with the corresponding units
99 that were specified when the data was reported to CloudWatch. If you
100 specify a unit, the operation returns only data that was collected with
101 that unit specified. If you specify a unit that does not match the data
102 collected, the results of the operation are null. CloudWatch does not
103 perform unit conversions.
104  
105  
106  
107 =head1 SEE ALSO
108  
109 This class forms part of L<Paws>, describing an object used in L<Paws::CloudWatch>
110  
111 =head1 BUGS and CONTRIBUTIONS
112  
113 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
114  
115 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
116  
117 =cut
118