blib/lib/Paws/CloudWatch.pm

filter: Statementstmt 10.1% 23 / 227 Branchbran 0.0% 0 / 40 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 16.3% 8 / 49 Podpod 89.1% 41 / 46 totaltotal 19.8% 72 / 362 CC 35 SCAR 35.5
CC
35
Cov
9%
DescribeAllAlarms
90.0
GetAllMetricData
90.0
DescribeAllAlarmHistory
56.0
CRAP 34.7
« blib/lib/Paws/IoT.pm ↑ Summary blib/lib/Paws/CloudWatchLogs.pm »
1 package Paws::CloudWatch;
2 2 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
3 15 ▶ sub service { 'monitoring' }
Subroutine service: called CC=1 SCAR=0.0
Pod undocumented
4 0 ▶ sub signing_name { 'monitoring' }
Subroutine signing_name: not called CC=1 SCAR=6.9
Pod undocumented
5 0 ▶ sub version { '2010-08-01' }
Subroutine version: not called CC=1 SCAR=6.9
Pod undocumented
6 0 ▶ sub flattened_arrays { 0 }
Subroutine flattened_arrays: not called CC=1 SCAR=6.9
Pod undocumented
7 2 has max_attempts => (is => 'ro', isa => 'Int', default => 5);
8 15 ▶ has retry => (is => 'ro', isa => 'HashRef', default => sub {
Subroutine __ANON__: called CC=1 SCAR=0.0
9 15 { base => 'rand', type => 'exponential', growth_factor => 2 }
10 2 });
11 15 ▶ has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
Subroutine __ANON__: called CC=1 SCAR=0.0
12 15 ] });
13  
14 2 with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::QueryCaller';
15  
16
17 0 ▶ sub DeleteAlarms {
Subroutine DeleteAlarms: not called CC=1 SCAR=6.9
Pod documented
18 0 my $self = shift;
19 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::DeleteAlarms', @_);
20 0 return $self->caller->do_call($self, $call_object);
21 }
22 0 ▶ sub DeleteAnomalyDetector {
Subroutine DeleteAnomalyDetector: not called CC=1 SCAR=6.9
Pod documented
23 0 my $self = shift;
24 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::DeleteAnomalyDetector', @_);
25 0 return $self->caller->do_call($self, $call_object);
26 }
27 0 ▶ sub DeleteDashboards {
Subroutine DeleteDashboards: not called CC=1 SCAR=6.9
Pod documented
28 0 my $self = shift;
29 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::DeleteDashboards', @_);
30 0 return $self->caller->do_call($self, $call_object);
31 }
32 0 ▶ sub DeleteInsightRules {
Subroutine DeleteInsightRules: not called CC=1 SCAR=6.9
Pod documented
33 0 my $self = shift;
34 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::DeleteInsightRules', @_);
35 0 return $self->caller->do_call($self, $call_object);
36 }
37 0 ▶ sub DeleteMetricStream {
Subroutine DeleteMetricStream: not called CC=1 SCAR=6.9
Pod documented
38 0 my $self = shift;
39 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::DeleteMetricStream', @_);
40 0 return $self->caller->do_call($self, $call_object);
41 }
42 1 ▶ sub DescribeAlarmHistory {
Subroutine DescribeAlarmHistory: called CC=1 SCAR=0.0
Pod documented
43 1 my $self = shift;
44 1 my $call_object = $self->new_with_coercions('Paws::CloudWatch::DescribeAlarmHistory', @_);
45 1 return $self->caller->do_call($self, $call_object);
46 }
47 1 ▶ sub DescribeAlarms {
Subroutine DescribeAlarms: called CC=1 SCAR=0.0
Pod documented
48 1 my $self = shift;
49 1 my $call_object = $self->new_with_coercions('Paws::CloudWatch::DescribeAlarms', @_);
50 1 return $self->caller->do_call($self, $call_object);
51 }
52 0 ▶ sub DescribeAlarmsForMetric {
Subroutine DescribeAlarmsForMetric: not called CC=1 SCAR=6.9
Pod documented
53 0 my $self = shift;
54 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::DescribeAlarmsForMetric', @_);
55 0 return $self->caller->do_call($self, $call_object);
56 }
57 0 ▶ sub DescribeAnomalyDetectors {
Subroutine DescribeAnomalyDetectors: not called CC=1 SCAR=6.9
Pod documented
58 0 my $self = shift;
59 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::DescribeAnomalyDetectors', @_);
60 0 return $self->caller->do_call($self, $call_object);
61 }
62 0 ▶ sub DescribeInsightRules {
Subroutine DescribeInsightRules: not called CC=1 SCAR=6.9
Pod documented
63 0 my $self = shift;
64 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::DescribeInsightRules', @_);
65 0 return $self->caller->do_call($self, $call_object);
66 }
67 0 ▶ sub DisableAlarmActions {
Subroutine DisableAlarmActions: not called CC=1 SCAR=6.9
Pod documented
68 0 my $self = shift;
69 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::DisableAlarmActions', @_);
70 0 return $self->caller->do_call($self, $call_object);
71 }
72 0 ▶ sub DisableInsightRules {
Subroutine DisableInsightRules: not called CC=1 SCAR=6.9
Pod documented
73 0 my $self = shift;
74 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::DisableInsightRules', @_);
75 0 return $self->caller->do_call($self, $call_object);
76 }
77 0 ▶ sub EnableAlarmActions {
Subroutine EnableAlarmActions: not called CC=1 SCAR=6.9
Pod documented
78 0 my $self = shift;
79 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::EnableAlarmActions', @_);
80 0 return $self->caller->do_call($self, $call_object);
81 }
82 0 ▶ sub EnableInsightRules {
Subroutine EnableInsightRules: not called CC=1 SCAR=6.9
Pod documented
83 0 my $self = shift;
84 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::EnableInsightRules', @_);
85 0 return $self->caller->do_call($self, $call_object);
86 }
87 0 ▶ sub GetDashboard {
Subroutine GetDashboard: not called CC=1 SCAR=6.9
Pod documented
88 0 my $self = shift;
89 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::GetDashboard', @_);
90 0 return $self->caller->do_call($self, $call_object);
91 }
92 0 ▶ sub GetInsightRuleReport {
Subroutine GetInsightRuleReport: not called CC=1 SCAR=6.9
Pod documented
93 0 my $self = shift;
94 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::GetInsightRuleReport', @_);
95 0 return $self->caller->do_call($self, $call_object);
96 }
97 0 ▶ sub GetMetricData {
Subroutine GetMetricData: not called CC=1 SCAR=6.9
Pod documented
98 0 my $self = shift;
99 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::GetMetricData', @_);
100 0 return $self->caller->do_call($self, $call_object);
101 }
102 1 ▶ sub GetMetricStatistics {
Subroutine GetMetricStatistics: called CC=1 SCAR=0.0
Pod documented
103 1 my $self = shift;
104 1 my $call_object = $self->new_with_coercions('Paws::CloudWatch::GetMetricStatistics', @_);
105 1 return $self->caller->do_call($self, $call_object);
106 }
107 0 ▶ sub GetMetricStream {
Subroutine GetMetricStream: not called CC=1 SCAR=6.9
Pod documented
108 0 my $self = shift;
109 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::GetMetricStream', @_);
110 0 return $self->caller->do_call($self, $call_object);
111 }
112 0 ▶ sub GetMetricWidgetImage {
Subroutine GetMetricWidgetImage: not called CC=1 SCAR=6.9
Pod documented
113 0 my $self = shift;
114 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::GetMetricWidgetImage', @_);
115 0 return $self->caller->do_call($self, $call_object);
116 }
117 0 ▶ sub ListDashboards {
Subroutine ListDashboards: not called CC=1 SCAR=6.9
Pod documented
118 0 my $self = shift;
119 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::ListDashboards', @_);
120 0 return $self->caller->do_call($self, $call_object);
121 }
122 2 ▶ sub ListMetrics {
Subroutine ListMetrics: called CC=1 SCAR=0.0
Pod documented
123 2 my $self = shift;
124 2 my $call_object = $self->new_with_coercions('Paws::CloudWatch::ListMetrics', @_);
125 2 return $self->caller->do_call($self, $call_object);
126 }
127 0 ▶ sub ListMetricStreams {
Subroutine ListMetricStreams: not called CC=1 SCAR=6.9
Pod documented
128 0 my $self = shift;
129 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::ListMetricStreams', @_);
130 0 return $self->caller->do_call($self, $call_object);
131 }
132 0 ▶ sub ListTagsForResource {
Subroutine ListTagsForResource: not called CC=1 SCAR=6.9
Pod documented
133 0 my $self = shift;
134 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::ListTagsForResource', @_);
135 0 return $self->caller->do_call($self, $call_object);
136 }
137 0 ▶ sub PutAnomalyDetector {
Subroutine PutAnomalyDetector: not called CC=1 SCAR=6.9
Pod documented
138 0 my $self = shift;
139 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::PutAnomalyDetector', @_);
140 0 return $self->caller->do_call($self, $call_object);
141 }
142 0 ▶ sub PutCompositeAlarm {
Subroutine PutCompositeAlarm: not called CC=1 SCAR=6.9
Pod documented
143 0 my $self = shift;
144 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::PutCompositeAlarm', @_);
145 0 return $self->caller->do_call($self, $call_object);
146 }
147 0 ▶ sub PutDashboard {
Subroutine PutDashboard: not called CC=1 SCAR=6.9
Pod documented
148 0 my $self = shift;
149 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::PutDashboard', @_);
150 0 return $self->caller->do_call($self, $call_object);
151 }
152 0 ▶ sub PutInsightRule {
Subroutine PutInsightRule: not called CC=1 SCAR=6.9
Pod documented
153 0 my $self = shift;
154 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::PutInsightRule', @_);
155 0 return $self->caller->do_call($self, $call_object);
156 }
157 0 ▶ sub PutMetricAlarm {
Subroutine PutMetricAlarm: not called CC=1 SCAR=6.9
Pod documented
158 0 my $self = shift;
159 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::PutMetricAlarm', @_);
160 0 return $self->caller->do_call($self, $call_object);
161 }
162 0 ▶ sub PutMetricData {
Subroutine PutMetricData: not called CC=1 SCAR=6.9
Pod documented
163 0 my $self = shift;
164 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::PutMetricData', @_);
165 0 return $self->caller->do_call($self, $call_object);
166 }
167 0 ▶ sub PutMetricStream {
Subroutine PutMetricStream: not called CC=1 SCAR=6.9
Pod documented
168 0 my $self = shift;
169 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::PutMetricStream', @_);
170 0 return $self->caller->do_call($self, $call_object);
171 }
172 0 ▶ sub SetAlarmState {
Subroutine SetAlarmState: not called CC=1 SCAR=6.9
Pod documented
173 0 my $self = shift;
174 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::SetAlarmState', @_);
175 0 return $self->caller->do_call($self, $call_object);
176 }
177 0 ▶ sub StartMetricStreams {
Subroutine StartMetricStreams: not called CC=1 SCAR=6.9
Pod documented
178 0 my $self = shift;
179 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::StartMetricStreams', @_);
180 0 return $self->caller->do_call($self, $call_object);
181 }
182 0 ▶ sub StopMetricStreams {
Subroutine StopMetricStreams: not called CC=1 SCAR=6.9
Pod documented
183 0 my $self = shift;
184 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::StopMetricStreams', @_);
185 0 return $self->caller->do_call($self, $call_object);
186 }
187 0 ▶ sub TagResource {
Subroutine TagResource: not called CC=1 SCAR=6.9
Pod documented
188 0 my $self = shift;
189 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::TagResource', @_);
190 0 return $self->caller->do_call($self, $call_object);
191 }
192 0 ▶ sub UntagResource {
Subroutine UntagResource: not called CC=1 SCAR=6.9
Pod documented
193 0 my $self = shift;
194 0 my $call_object = $self->new_with_coercions('Paws::CloudWatch::UntagResource', @_);
195 0 return $self->caller->do_call($self, $call_object);
196 }
197
198 0 ▶ sub DescribeAllAlarmHistory {
Subroutine DescribeAllAlarmHistory: not called CC=7 SCAR=40.3
Pod documented
199 0 my $self = shift;
200  
201 0 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 0 0 0
202 0 my $result = $self->DescribeAlarmHistory(@_);
203 0 my $next_result = $result;
204  
205 0 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 0 0 0
206 0 ▶ while ($next_result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->NextToken) 0 0 0
207 0 $next_result = $self->DescribeAlarmHistory(@_, NextToken => $next_result->NextToken);
208 0 push @{ $result->AlarmHistoryItems }, @{ $next_result->AlarmHistoryItems };
209 }
210 0 return $result;
211 } else {
212 0 ▶ while ($result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->NextToken) 0 0 0
213 0 $callback->($_ => 'AlarmHistoryItems') foreach (@{ $result->AlarmHistoryItems });
214 0 $result = $self->DescribeAlarmHistory(@_, NextToken => $result->NextToken);
215 }
216 0 $callback->($_ => 'AlarmHistoryItems') foreach (@{ $result->AlarmHistoryItems });
217 }
218  
219 return undef
220 0 }
221 0 ▶ sub DescribeAllAlarms {
Subroutine DescribeAllAlarms: not called CC=9 SCAR=45.0
Pod documented
222 0 my $self = shift;
223  
224 0 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 0 0 0
225 0 my $result = $self->DescribeAlarms(@_);
226 0 my $next_result = $result;
227  
228 0 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 0 0 0
229 0 ▶ while ($next_result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->NextToken) 0 0 0
230 0 $next_result = $self->DescribeAlarms(@_, NextToken => $next_result->NextToken);
231 0 push @{ $result->MetricAlarms }, @{ $next_result->MetricAlarms };
232 0 push @{ $result->CompositeAlarms }, @{ $next_result->CompositeAlarms };
233 }
234 0 return $result;
235 } else {
236 0 ▶ while ($result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->NextToken) 0 0 0
237 0 $callback->($_ => 'MetricAlarms') foreach (@{ $result->MetricAlarms });
238 0 $callback->($_ => 'CompositeAlarms') foreach (@{ $result->CompositeAlarms });
239 0 $result = $self->DescribeAlarms(@_, NextToken => $result->NextToken);
240 }
241 0 $callback->($_ => 'MetricAlarms') foreach (@{ $result->MetricAlarms });
242 0 $callback->($_ => 'CompositeAlarms') foreach (@{ $result->CompositeAlarms });
243 }
244  
245 return undef
246 0 }
247 0 ▶ sub GetAllMetricData {
Subroutine GetAllMetricData: not called CC=9 SCAR=45.0
Pod documented
248 0 my $self = shift;
249  
250 0 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 0 0 0
251 0 my $result = $self->GetMetricData(@_);
252 0 my $next_result = $result;
253  
254 0 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 0 0 0
255 0 ▶ while ($next_result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->NextToken) 0 0 0
256 0 $next_result = $self->GetMetricData(@_, NextToken => $next_result->NextToken);
257 0 push @{ $result->MetricDataResults }, @{ $next_result->MetricDataResults };
258 0 push @{ $result->Messages }, @{ $next_result->Messages };
259 }
260 0 return $result;
261 } else {
262 0 ▶ while ($result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->NextToken) 0 0 0
263 0 $callback->($_ => 'MetricDataResults') foreach (@{ $result->MetricDataResults });
264 0 $callback->($_ => 'Messages') foreach (@{ $result->Messages });
265 0 $result = $self->GetMetricData(@_, NextToken => $result->NextToken);
266 }
267 0 $callback->($_ => 'MetricDataResults') foreach (@{ $result->MetricDataResults });
268 0 $callback->($_ => 'Messages') foreach (@{ $result->Messages });
269 }
270  
271 return undef
272 0 }
273 0 ▶ sub ListAllDashboards {
Subroutine ListAllDashboards: not called CC=7 SCAR=40.3
Pod documented
274 0 my $self = shift;
275  
276 0 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 0 0 0
277 0 my $result = $self->ListDashboards(@_);
278 0 my $next_result = $result;
279  
280 0 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 0 0 0
281 0 ▶ while ($next_result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->NextToken) 0 0 0
282 0 $next_result = $self->ListDashboards(@_, NextToken => $next_result->NextToken);
283 0 push @{ $result->DashboardEntries }, @{ $next_result->DashboardEntries };
284 }
285 0 return $result;
286 } else {
287 0 ▶ while ($result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->NextToken) 0 0 0
288 0 $callback->($_ => 'DashboardEntries') foreach (@{ $result->DashboardEntries });
289 0 $result = $self->ListDashboards(@_, NextToken => $result->NextToken);
290 }
291 0 $callback->($_ => 'DashboardEntries') foreach (@{ $result->DashboardEntries });
292 }
293  
294 return undef
295 0 }
296 0 ▶ sub ListAllMetrics {
Subroutine ListAllMetrics: not called CC=7 SCAR=40.3
Pod documented
297 0 my $self = shift;
298  
299 0 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 0 0 0
300 0 my $result = $self->ListMetrics(@_);
301 0 my $next_result = $result;
302  
303 0 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 0 0 0
304 0 ▶ while ($next_result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->NextToken) 0 0 0
305 0 $next_result = $self->ListMetrics(@_, NextToken => $next_result->NextToken);
306 0 push @{ $result->Metrics }, @{ $next_result->Metrics };
307 }
308 0 return $result;
309 } else {
310 0 ▶ while ($result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->NextToken) 0 0 0
311 0 $callback->($_ => 'Metrics') foreach (@{ $result->Metrics });
312 0 $result = $self->ListMetrics(@_, NextToken => $result->NextToken);
313 }
314 0 $callback->($_ => 'Metrics') foreach (@{ $result->Metrics });
315 }
316  
317 return undef
318 0 }
319  
320  
321 0 ▶ sub operations { qw/DeleteAlarms DeleteAnomalyDetector DeleteDashboards DeleteInsightRules DeleteMetricStream DescribeAlarmHistory DescribeAlarms DescribeAlarmsForMetric DescribeAnomalyDetectors DescribeInsightRules DisableAlarmActions DisableInsightRules EnableAlarmActions EnableInsightRules GetDashboard GetInsightRuleReport GetMetricData GetMetricStatistics GetMetricStream GetMetricWidgetImage ListDashboards ListMetrics ListMetricStreams ListTagsForResource PutAnomalyDetector PutCompositeAlarm PutDashboard PutInsightRule PutMetricAlarm PutMetricData PutMetricStream SetAlarmState StartMetricStreams StopMetricStreams TagResource UntagResource / }
Subroutine operations: not called CC=1 SCAR=6.9
Pod undocumented
322  
323 2 1;
324  
325 ### main pod documentation begin ###
326  
327 =head1 NAME
328  
329 Paws::CloudWatch - Perl Interface to AWS Amazon CloudWatch
330  
331 =head1 SYNOPSIS
332  
333 use Paws;
334  
335 my $obj = Paws->service('CloudWatch');
336 my $res = $obj->Method(
337 Arg1 => $val1,
338 Arg2 => [ 'V1', 'V2' ],
339 # if Arg3 is an object, the HashRef will be used as arguments to the constructor
340 # of the arguments type
341 Arg3 => { Att1 => 'Val1' },
342 # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
343 # the constructor of the arguments type
344 Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
345 );
346  
347 =head1 DESCRIPTION
348  
349 Amazon CloudWatch monitors your Amazon Web Services (AWS) resources and
350 the applications you run on AWS in real time. You can use CloudWatch to
351 collect and track metrics, which are the variables you want to measure
352 for your resources and applications.
353  
354 CloudWatch alarms send notifications or automatically change the
355 resources you are monitoring based on rules that you define. For
356 example, you can monitor the CPU usage and disk reads and writes of
357 your Amazon EC2 instances. Then, use this data to determine whether you
358 should launch additional instances to handle increased load. You can
359 also use this data to stop under-used instances to save money.
360  
361 In addition to monitoring the built-in metrics that come with AWS, you
362 can monitor your own custom metrics. With CloudWatch, you gain
363 system-wide visibility into resource utilization, application
364 performance, and operational health.
365  
366 For the AWS API documentation, see L<https://docs.aws.amazon.com/cloudwatch/>
367  
368  
369 =head1 METHODS
370  
371 =head2 DeleteAlarms
372  
373 =over
374  
375 =item AlarmNames => ArrayRef[Str|Undef]
376  
377  
378 =back
379  
380 Each argument is described in detail in: L<Paws::CloudWatch::DeleteAlarms>
381  
382 Returns: nothing
383  
384 Deletes the specified alarms. You can delete up to 100 alarms in one
385 operation. However, this total can include no more than one composite
386 alarm. For example, you could delete 99 metric alarms and one composite
387 alarms with one operation, but you can't delete two composite alarms
388 with one operation.
389  
390 In the event of an error, no alarms are deleted.
391  
392 It is possible to create a loop or cycle of composite alarms, where
393 composite alarm A depends on composite alarm B, and composite alarm B
394 also depends on composite alarm A. In this scenario, you can't delete
395 any composite alarm that is part of the cycle because there is always
396 still a composite alarm that depends on that alarm that you want to
397 delete.
398  
399 To get out of such a situation, you must break the cycle by changing
400 the rule of one of the composite alarms in the cycle to remove a
401 dependency that creates the cycle. The simplest change to make to break
402 a cycle is to change the C<AlarmRule> of one of the alarms to C<False>.
403  
404 Additionally, the evaluation of composite alarms stops if CloudWatch
405 detects a cycle in the evaluation path.
406  
407  
408 =head2 DeleteAnomalyDetector
409  
410 =over
411  
412 =item MetricName => Str
413  
414 =item Namespace => Str
415  
416 =item Stat => Str
417  
418 =item [Dimensions => ArrayRef[L<Paws::CloudWatch::Dimension>]]
419  
420  
421 =back
422  
423 Each argument is described in detail in: L<Paws::CloudWatch::DeleteAnomalyDetector>
424  
425 Returns: a L<Paws::CloudWatch::DeleteAnomalyDetectorOutput> instance
426  
427 Deletes the specified anomaly detection model from your account.
428  
429  
430 =head2 DeleteDashboards
431  
432 =over
433  
434 =item DashboardNames => ArrayRef[Str|Undef]
435  
436  
437 =back
438  
439 Each argument is described in detail in: L<Paws::CloudWatch::DeleteDashboards>
440  
441 Returns: a L<Paws::CloudWatch::DeleteDashboardsOutput> instance
442  
443 Deletes all dashboards that you specify. You can specify up to 100
444 dashboards to delete. If there is an error during this call, no
445 dashboards are deleted.
446  
447  
448 =head2 DeleteInsightRules
449  
450 =over
451  
452 =item RuleNames => ArrayRef[Str|Undef]
453  
454  
455 =back
456  
457 Each argument is described in detail in: L<Paws::CloudWatch::DeleteInsightRules>
458  
459 Returns: a L<Paws::CloudWatch::DeleteInsightRulesOutput> instance
460  
461 Permanently deletes the specified Contributor Insights rules.
462  
463 If you create a rule, delete it, and then re-create it with the same
464 name, historical data from the first time the rule was created might
465 not be available.
466  
467  
468 =head2 DeleteMetricStream
469  
470 =over
471  
472 =item Name => Str
473  
474  
475 =back
476  
477 Each argument is described in detail in: L<Paws::CloudWatch::DeleteMetricStream>
478  
479 Returns: a L<Paws::CloudWatch::DeleteMetricStreamOutput> instance
480  
481 Permanently deletes the metric stream that you specify.
482  
483  
484 =head2 DescribeAlarmHistory
485  
486 =over
487  
488 =item [AlarmName => Str]
489  
490 =item [AlarmTypes => ArrayRef[Str|Undef]]
491  
492 =item [EndDate => Str]
493  
494 =item [HistoryItemType => Str]
495  
496 =item [MaxRecords => Int]
497  
498 =item [NextToken => Str]
499  
500 =item [ScanBy => Str]
501  
502 =item [StartDate => Str]
503  
504  
505 =back
506  
507 Each argument is described in detail in: L<Paws::CloudWatch::DescribeAlarmHistory>
508  
509 Returns: a L<Paws::CloudWatch::DescribeAlarmHistoryOutput> instance
510  
511 Retrieves the history for the specified alarm. You can filter the
512 results by date range or item type. If an alarm name is not specified,
513 the histories for either all metric alarms or all composite alarms are
514 returned.
515  
516 CloudWatch retains the history of an alarm even if you delete the
517 alarm.
518  
519  
520 =head2 DescribeAlarms
521  
522 =over
523  
524 =item [ActionPrefix => Str]
525  
526 =item [AlarmNamePrefix => Str]
527  
528 =item [AlarmNames => ArrayRef[Str|Undef]]
529  
530 =item [AlarmTypes => ArrayRef[Str|Undef]]
531  
532 =item [ChildrenOfAlarmName => Str]
533  
534 =item [MaxRecords => Int]
535  
536 =item [NextToken => Str]
537  
538 =item [ParentsOfAlarmName => Str]
539  
540 =item [StateValue => Str]
541  
542  
543 =back
544  
545 Each argument is described in detail in: L<Paws::CloudWatch::DescribeAlarms>
546  
547 Returns: a L<Paws::CloudWatch::DescribeAlarmsOutput> instance
548  
549 Retrieves the specified alarms. You can filter the results by
550 specifying a prefix for the alarm name, the alarm state, or a prefix
551 for any action.
552  
553  
554 =head2 DescribeAlarmsForMetric
555  
556 =over
557  
558 =item MetricName => Str
559  
560 =item Namespace => Str
561  
562 =item [Dimensions => ArrayRef[L<Paws::CloudWatch::Dimension>]]
563  
564 =item [ExtendedStatistic => Str]
565  
566 =item [Period => Int]
567  
568 =item [Statistic => Str]
569  
570 =item [Unit => Str]
571  
572  
573 =back
574  
575 Each argument is described in detail in: L<Paws::CloudWatch::DescribeAlarmsForMetric>
576  
577 Returns: a L<Paws::CloudWatch::DescribeAlarmsForMetricOutput> instance
578  
579 Retrieves the alarms for the specified metric. To filter the results,
580 specify a statistic, period, or unit.
581  
582 This operation retrieves only standard alarms that are based on the
583 specified metric. It does not return alarms based on math expressions
584 that use the specified metric, or composite alarms that use the
585 specified metric.
586  
587  
588 =head2 DescribeAnomalyDetectors
589  
590 =over
591  
592 =item [Dimensions => ArrayRef[L<Paws::CloudWatch::Dimension>]]
593  
594 =item [MaxResults => Int]
595  
596 =item [MetricName => Str]
597  
598 =item [Namespace => Str]
599  
600 =item [NextToken => Str]
601  
602  
603 =back
604  
605 Each argument is described in detail in: L<Paws::CloudWatch::DescribeAnomalyDetectors>
606  
607 Returns: a L<Paws::CloudWatch::DescribeAnomalyDetectorsOutput> instance
608  
609 Lists the anomaly detection models that you have created in your
610 account. You can list all models in your account or filter the results
611 to only the models that are related to a certain namespace, metric
612 name, or metric dimension.
613  
614  
615 =head2 DescribeInsightRules
616  
617 =over
618  
619 =item [MaxResults => Int]
620  
621 =item [NextToken => Str]
622  
623  
624 =back
625  
626 Each argument is described in detail in: L<Paws::CloudWatch::DescribeInsightRules>
627  
628 Returns: a L<Paws::CloudWatch::DescribeInsightRulesOutput> instance
629  
630 Returns a list of all the Contributor Insights rules in your account.
631  
632 For more information about Contributor Insights, see Using Contributor
633 Insights to Analyze High-Cardinality Data
634 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html).
635  
636  
637 =head2 DisableAlarmActions
638  
639 =over
640  
641 =item AlarmNames => ArrayRef[Str|Undef]
642  
643  
644 =back
645  
646 Each argument is described in detail in: L<Paws::CloudWatch::DisableAlarmActions>
647  
648 Returns: nothing
649  
650 Disables the actions for the specified alarms. When an alarm's actions
651 are disabled, the alarm actions do not execute when the alarm state
652 changes.
653  
654  
655 =head2 DisableInsightRules
656  
657 =over
658  
659 =item RuleNames => ArrayRef[Str|Undef]
660  
661  
662 =back
663  
664 Each argument is described in detail in: L<Paws::CloudWatch::DisableInsightRules>
665  
666 Returns: a L<Paws::CloudWatch::DisableInsightRulesOutput> instance
667  
668 Disables the specified Contributor Insights rules. When rules are
669 disabled, they do not analyze log groups and do not incur costs.
670  
671  
672 =head2 EnableAlarmActions
673  
674 =over
675  
676 =item AlarmNames => ArrayRef[Str|Undef]
677  
678  
679 =back
680  
681 Each argument is described in detail in: L<Paws::CloudWatch::EnableAlarmActions>
682  
683 Returns: nothing
684  
685 Enables the actions for the specified alarms.
686  
687  
688 =head2 EnableInsightRules
689  
690 =over
691  
692 =item RuleNames => ArrayRef[Str|Undef]
693  
694  
695 =back
696  
697 Each argument is described in detail in: L<Paws::CloudWatch::EnableInsightRules>
698  
699 Returns: a L<Paws::CloudWatch::EnableInsightRulesOutput> instance
700  
701 Enables the specified Contributor Insights rules. When rules are
702 enabled, they immediately begin analyzing log data.
703  
704  
705 =head2 GetDashboard
706  
707 =over
708  
709 =item DashboardName => Str
710  
711  
712 =back
713  
714 Each argument is described in detail in: L<Paws::CloudWatch::GetDashboard>
715  
716 Returns: a L<Paws::CloudWatch::GetDashboardOutput> instance
717  
718 Displays the details of the dashboard that you specify.
719  
720 To copy an existing dashboard, use C<GetDashboard>, and then use the
721 data returned within C<DashboardBody> as the template for the new
722 dashboard when you call C<PutDashboard> to create the copy.
723  
724  
725 =head2 GetInsightRuleReport
726  
727 =over
728  
729 =item EndTime => Str
730  
731 =item Period => Int
732  
733 =item RuleName => Str
734  
735 =item StartTime => Str
736  
737 =item [MaxContributorCount => Int]
738  
739 =item [Metrics => ArrayRef[Str|Undef]]
740  
741 =item [OrderBy => Str]
742  
743  
744 =back
745  
746 Each argument is described in detail in: L<Paws::CloudWatch::GetInsightRuleReport>
747  
748 Returns: a L<Paws::CloudWatch::GetInsightRuleReportOutput> instance
749  
750 This operation returns the time series data collected by a Contributor
751 Insights rule. The data includes the identity and number of
752 contributors to the log group.
753  
754 You can also optionally return one or more statistics about each data
755 point in the time series. These statistics can include the following:
756  
757 =over
758  
759 =item *
760  
761 C<UniqueContributors> -- the number of unique contributors for each
762 data point.
763  
764 =item *
765  
766 C<MaxContributorValue> -- the value of the top contributor for each
767 data point. The identity of the contributor might change for each data
768 point in the graph.
769  
770 If this rule aggregates by COUNT, the top contributor for each data
771 point is the contributor with the most occurrences in that period. If
772 the rule aggregates by SUM, the top contributor is the contributor with
773 the highest sum in the log field specified by the rule's C<Value>,
774 during that period.
775  
776 =item *
777  
778 C<SampleCount> -- the number of data points matched by the rule.
779  
780 =item *
781  
782 C<Sum> -- the sum of the values from all contributors during the time
783 period represented by that data point.
784  
785 =item *
786  
787 C<Minimum> -- the minimum value from a single observation during the
788 time period represented by that data point.
789  
790 =item *
791  
792 C<Maximum> -- the maximum value from a single observation during the
793 time period represented by that data point.
794  
795 =item *
796  
797 C<Average> -- the average value from all contributors during the time
798 period represented by that data point.
799  
800 =back
801  
802  
803  
804 =head2 GetMetricData
805  
806 =over
807  
808 =item EndTime => Str
809  
810 =item MetricDataQueries => ArrayRef[L<Paws::CloudWatch::MetricDataQuery>]
811  
812 =item StartTime => Str
813  
814 =item [LabelOptions => L<Paws::CloudWatch::LabelOptions>]
815  
816 =item [MaxDatapoints => Int]
817  
818 =item [NextToken => Str]
819  
820 =item [ScanBy => Str]
821  
822  
823 =back
824  
825 Each argument is described in detail in: L<Paws::CloudWatch::GetMetricData>
826  
827 Returns: a L<Paws::CloudWatch::GetMetricDataOutput> instance
828  
829 You can use the C<GetMetricData> API to retrieve as many as 500
830 different metrics in a single request, with a total of as many as
831 100,800 data points. You can also optionally perform math expressions
832 on the values of the returned statistics, to create new time series
833 that represent new insights into your data. For example, using Lambda
834 metrics, you could divide the Errors metric by the Invocations metric
835 to get an error rate time series. For more information about metric
836 math expressions, see Metric Math Syntax and Functions
837 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax)
838 in the I<Amazon CloudWatch User Guide>.
839  
840 Calls to the C<GetMetricData> API have a different pricing structure
841 than calls to C<GetMetricStatistics>. For more information about
842 pricing, see Amazon CloudWatch Pricing
843 (https://aws.amazon.com/cloudwatch/pricing/).
844  
845 Amazon CloudWatch retains metric data as follows:
846  
847 =over
848  
849 =item *
850  
851 Data points with a period of less than 60 seconds are available for 3
852 hours. These data points are high-resolution metrics and are available
853 only for custom metrics that have been defined with a
854 C<StorageResolution> of 1.
855  
856 =item *
857  
858 Data points with a period of 60 seconds (1-minute) are available for 15
859 days.
860  
861 =item *
862  
863 Data points with a period of 300 seconds (5-minute) are available for
864 63 days.
865  
866 =item *
867  
868 Data points with a period of 3600 seconds (1 hour) are available for
869 455 days (15 months).
870  
871 =back
872  
873 Data points that are initially published with a shorter period are
874 aggregated together for long-term storage. For example, if you collect
875 data using a period of 1 minute, the data remains available for 15 days
876 with 1-minute resolution. After 15 days, this data is still available,
877 but is aggregated and retrievable only with a resolution of 5 minutes.
878 After 63 days, the data is further aggregated and is available with a
879 resolution of 1 hour.
880  
881 If you omit C<Unit> in your request, all data that was collected with
882 any unit is returned, along with the corresponding units that were
883 specified when the data was reported to CloudWatch. If you specify a
884 unit, the operation returns only data that was collected with that unit
885 specified. If you specify a unit that does not match the data
886 collected, the results of the operation are null. CloudWatch does not
887 perform unit conversions.
888  
889  
890 =head2 GetMetricStatistics
891  
892 =over
893  
894 =item EndTime => Str
895  
896 =item MetricName => Str
897  
898 =item Namespace => Str
899  
900 =item Period => Int
901  
902 =item StartTime => Str
903  
904 =item [Dimensions => ArrayRef[L<Paws::CloudWatch::Dimension>]]
905  
906 =item [ExtendedStatistics => ArrayRef[Str|Undef]]
907  
908 =item [Statistics => ArrayRef[Str|Undef]]
909  
910 =item [Unit => Str]
911  
912  
913 =back
914  
915 Each argument is described in detail in: L<Paws::CloudWatch::GetMetricStatistics>
916  
917 Returns: a L<Paws::CloudWatch::GetMetricStatisticsOutput> instance
918  
919 Gets statistics for the specified metric.
920  
921 The maximum number of data points returned from a single call is 1,440.
922 If you request more than 1,440 data points, CloudWatch returns an
923 error. To reduce the number of data points, you can narrow the
924 specified time range and make multiple requests across adjacent time
925 ranges, or you can increase the specified period. Data points are not
926 returned in chronological order.
927  
928 CloudWatch aggregates data points based on the length of the period
929 that you specify. For example, if you request statistics with a
930 one-hour period, CloudWatch aggregates all data points with time stamps
931 that fall within each one-hour period. Therefore, the number of values
932 aggregated by CloudWatch is larger than the number of data points
933 returned.
934  
935 CloudWatch needs raw data points to calculate percentile statistics. If
936 you publish data using a statistic set instead, you can only retrieve
937 percentile statistics for this data if one of the following conditions
938 is true:
939  
940 =over
941  
942 =item *
943  
944 The SampleCount value of the statistic set is 1.
945  
946 =item *
947  
948 The Min and the Max values of the statistic set are equal.
949  
950 =back
951  
952 Percentile statistics are not available for metrics when any of the
953 metric values are negative numbers.
954  
955 Amazon CloudWatch retains metric data as follows:
956  
957 =over
958  
959 =item *
960  
961 Data points with a period of less than 60 seconds are available for 3
962 hours. These data points are high-resolution metrics and are available
963 only for custom metrics that have been defined with a
964 C<StorageResolution> of 1.
965  
966 =item *
967  
968 Data points with a period of 60 seconds (1-minute) are available for 15
969 days.
970  
971 =item *
972  
973 Data points with a period of 300 seconds (5-minute) are available for
974 63 days.
975  
976 =item *
977  
978 Data points with a period of 3600 seconds (1 hour) are available for
979 455 days (15 months).
980  
981 =back
982  
983 Data points that are initially published with a shorter period are
984 aggregated together for long-term storage. For example, if you collect
985 data using a period of 1 minute, the data remains available for 15 days
986 with 1-minute resolution. After 15 days, this data is still available,
987 but is aggregated and retrievable only with a resolution of 5 minutes.
988 After 63 days, the data is further aggregated and is available with a
989 resolution of 1 hour.
990  
991 CloudWatch started retaining 5-minute and 1-hour metric data as of July
992 9, 2016.
993  
994 For information about metrics and dimensions supported by AWS services,
995 see the Amazon CloudWatch Metrics and Dimensions Reference
996 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CW_Support_For_AWS.html)
997 in the I<Amazon CloudWatch User Guide>.
998  
999  
1000 =head2 GetMetricStream
1001  
1002 =over
1003  
1004 =item Name => Str
1005  
1006  
1007 =back
1008  
1009 Each argument is described in detail in: L<Paws::CloudWatch::GetMetricStream>
1010  
1011 Returns: a L<Paws::CloudWatch::GetMetricStreamOutput> instance
1012  
1013 Returns information about the metric stream that you specify.
1014  
1015  
1016 =head2 GetMetricWidgetImage
1017  
1018 =over
1019  
1020 =item MetricWidget => Str
1021  
1022 =item [OutputFormat => Str]
1023  
1024  
1025 =back
1026  
1027 Each argument is described in detail in: L<Paws::CloudWatch::GetMetricWidgetImage>
1028  
1029 Returns: a L<Paws::CloudWatch::GetMetricWidgetImageOutput> instance
1030  
1031 You can use the C<GetMetricWidgetImage> API to retrieve a snapshot
1032 graph of one or more Amazon CloudWatch metrics as a bitmap image. You
1033 can then embed this image into your services and products, such as wiki
1034 pages, reports, and documents. You could also retrieve images
1035 regularly, such as every minute, and create your own custom live
1036 dashboard.
1037  
1038 The graph you retrieve can include all CloudWatch metric graph
1039 features, including metric math and horizontal and vertical
1040 annotations.
1041  
1042 There is a limit of 20 transactions per second for this API. Each
1043 C<GetMetricWidgetImage> action has the following limits:
1044  
1045 =over
1046  
1047 =item *
1048  
1049 As many as 100 metrics in the graph.
1050  
1051 =item *
1052  
1053 Up to 100 KB uncompressed payload.
1054  
1055 =back
1056  
1057  
1058  
1059 =head2 ListDashboards
1060  
1061 =over
1062  
1063 =item [DashboardNamePrefix => Str]
1064  
1065 =item [NextToken => Str]
1066  
1067  
1068 =back
1069  
1070 Each argument is described in detail in: L<Paws::CloudWatch::ListDashboards>
1071  
1072 Returns: a L<Paws::CloudWatch::ListDashboardsOutput> instance
1073  
1074 Returns a list of the dashboards for your account. If you include
1075 C<DashboardNamePrefix>, only those dashboards with names starting with
1076 the prefix are listed. Otherwise, all dashboards in your account are
1077 listed.
1078  
1079 C<ListDashboards> returns up to 1000 results on one page. If there are
1080 more than 1000 dashboards, you can call C<ListDashboards> again and
1081 include the value you received for C<NextToken> in the first call, to
1082 receive the next 1000 results.
1083  
1084  
1085 =head2 ListMetrics
1086  
1087 =over
1088  
1089 =item [Dimensions => ArrayRef[L<Paws::CloudWatch::DimensionFilter>]]
1090  
1091 =item [MetricName => Str]
1092  
1093 =item [Namespace => Str]
1094  
1095 =item [NextToken => Str]
1096  
1097 =item [RecentlyActive => Str]
1098  
1099  
1100 =back
1101  
1102 Each argument is described in detail in: L<Paws::CloudWatch::ListMetrics>
1103  
1104 Returns: a L<Paws::CloudWatch::ListMetricsOutput> instance
1105  
1106 List the specified metrics. You can use the returned metrics with
1107 GetMetricData
1108 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html)
1109 or GetMetricStatistics
1110 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html)
1111 to obtain statistical data.
1112  
1113 Up to 500 results are returned for any one call. To retrieve additional
1114 results, use the returned token with subsequent calls.
1115  
1116 After you create a metric, allow up to 15 minutes before the metric
1117 appears. You can see statistics about the metric sooner by using
1118 GetMetricData
1119 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html)
1120 or GetMetricStatistics
1121 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html).
1122  
1123 C<ListMetrics> doesn't return information about metrics if those
1124 metrics haven't reported data in the past two weeks. To retrieve those
1125 metrics, use GetMetricData
1126 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html)
1127 or GetMetricStatistics
1128 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html).
1129  
1130  
1131 =head2 ListMetricStreams
1132  
1133 =over
1134  
1135 =item [MaxResults => Int]
1136  
1137 =item [NextToken => Str]
1138  
1139  
1140 =back
1141  
1142 Each argument is described in detail in: L<Paws::CloudWatch::ListMetricStreams>
1143  
1144 Returns: a L<Paws::CloudWatch::ListMetricStreamsOutput> instance
1145  
1146 Returns a list of metric streams in this account.
1147  
1148  
1149 =head2 ListTagsForResource
1150  
1151 =over
1152  
1153 =item ResourceARN => Str
1154  
1155  
1156 =back
1157  
1158 Each argument is described in detail in: L<Paws::CloudWatch::ListTagsForResource>
1159  
1160 Returns: a L<Paws::CloudWatch::ListTagsForResourceOutput> instance
1161  
1162 Displays the tags associated with a CloudWatch resource. Currently,
1163 alarms and Contributor Insights rules support tagging.
1164  
1165  
1166 =head2 PutAnomalyDetector
1167  
1168 =over
1169  
1170 =item MetricName => Str
1171  
1172 =item Namespace => Str
1173  
1174 =item Stat => Str
1175  
1176 =item [Configuration => L<Paws::CloudWatch::AnomalyDetectorConfiguration>]
1177  
1178 =item [Dimensions => ArrayRef[L<Paws::CloudWatch::Dimension>]]
1179  
1180  
1181 =back
1182  
1183 Each argument is described in detail in: L<Paws::CloudWatch::PutAnomalyDetector>
1184  
1185 Returns: a L<Paws::CloudWatch::PutAnomalyDetectorOutput> instance
1186  
1187 Creates an anomaly detection model for a CloudWatch metric. You can use
1188 the model to display a band of expected normal values when the metric
1189 is graphed.
1190  
1191 For more information, see CloudWatch Anomaly Detection
1192 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Anomaly_Detection.html).
1193  
1194  
1195 =head2 PutCompositeAlarm
1196  
1197 =over
1198  
1199 =item AlarmName => Str
1200  
1201 =item AlarmRule => Str
1202  
1203 =item [ActionsEnabled => Bool]
1204  
1205 =item [AlarmActions => ArrayRef[Str|Undef]]
1206  
1207 =item [AlarmDescription => Str]
1208  
1209 =item [InsufficientDataActions => ArrayRef[Str|Undef]]
1210  
1211 =item [OKActions => ArrayRef[Str|Undef]]
1212  
1213 =item [Tags => ArrayRef[L<Paws::CloudWatch::Tag>]]
1214  
1215  
1216 =back
1217  
1218 Each argument is described in detail in: L<Paws::CloudWatch::PutCompositeAlarm>
1219  
1220 Returns: nothing
1221  
1222 Creates or updates a I<composite alarm>. When you create a composite
1223 alarm, you specify a rule expression for the alarm that takes into
1224 account the alarm states of other alarms that you have created. The
1225 composite alarm goes into ALARM state only if all conditions of the
1226 rule are met.
1227  
1228 The alarms specified in a composite alarm's rule expression can include
1229 metric alarms and other composite alarms.
1230  
1231 Using composite alarms can reduce alarm noise. You can create multiple
1232 metric alarms, and also create a composite alarm and set up alerts only
1233 for the composite alarm. For example, you could create a composite
1234 alarm that goes into ALARM state only when more than one of the
1235 underlying metric alarms are in ALARM state.
1236  
1237 Currently, the only alarm actions that can be taken by composite alarms
1238 are notifying SNS topics.
1239  
1240 It is possible to create a loop or cycle of composite alarms, where
1241 composite alarm A depends on composite alarm B, and composite alarm B
1242 also depends on composite alarm A. In this scenario, you can't delete
1243 any composite alarm that is part of the cycle because there is always
1244 still a composite alarm that depends on that alarm that you want to
1245 delete.
1246  
1247 To get out of such a situation, you must break the cycle by changing
1248 the rule of one of the composite alarms in the cycle to remove a
1249 dependency that creates the cycle. The simplest change to make to break
1250 a cycle is to change the C<AlarmRule> of one of the alarms to C<False>.
1251  
1252 Additionally, the evaluation of composite alarms stops if CloudWatch
1253 detects a cycle in the evaluation path.
1254  
1255 When this operation creates an alarm, the alarm state is immediately
1256 set to C<INSUFFICIENT_DATA>. The alarm is then evaluated and its state
1257 is set appropriately. Any actions associated with the new state are
1258 then executed. For a composite alarm, this initial time after creation
1259 is the only time that the alarm can be in C<INSUFFICIENT_DATA> state.
1260  
1261 When you update an existing alarm, its state is left unchanged, but the
1262 update completely overwrites the previous configuration of the alarm.
1263  
1264 If you are an IAM user, you must have C<iam:CreateServiceLinkedRole> to
1265 create a composite alarm that has Systems Manager OpsItem actions.
1266  
1267  
1268 =head2 PutDashboard
1269  
1270 =over
1271  
1272 =item DashboardBody => Str
1273  
1274 =item DashboardName => Str
1275  
1276  
1277 =back
1278  
1279 Each argument is described in detail in: L<Paws::CloudWatch::PutDashboard>
1280  
1281 Returns: a L<Paws::CloudWatch::PutDashboardOutput> instance
1282  
1283 Creates a dashboard if it does not already exist, or updates an
1284 existing dashboard. If you update a dashboard, the entire contents are
1285 replaced with what you specify here.
1286  
1287 All dashboards in your account are global, not region-specific.
1288  
1289 A simple way to create a dashboard using C<PutDashboard> is to copy an
1290 existing dashboard. To copy an existing dashboard using the console,
1291 you can load the dashboard and then use the View/edit source command in
1292 the Actions menu to display the JSON block for that dashboard. Another
1293 way to copy a dashboard is to use C<GetDashboard>, and then use the
1294 data returned within C<DashboardBody> as the template for the new
1295 dashboard when you call C<PutDashboard>.
1296  
1297 When you create a dashboard with C<PutDashboard>, a good practice is to
1298 add a text widget at the top of the dashboard with a message that the
1299 dashboard was created by script and should not be changed in the
1300 console. This message could also point console users to the location of
1301 the C<DashboardBody> script or the CloudFormation template used to
1302 create the dashboard.
1303  
1304  
1305 =head2 PutInsightRule
1306  
1307 =over
1308  
1309 =item RuleDefinition => Str
1310  
1311 =item RuleName => Str
1312  
1313 =item [RuleState => Str]
1314  
1315 =item [Tags => ArrayRef[L<Paws::CloudWatch::Tag>]]
1316  
1317  
1318 =back
1319  
1320 Each argument is described in detail in: L<Paws::CloudWatch::PutInsightRule>
1321  
1322 Returns: a L<Paws::CloudWatch::PutInsightRuleOutput> instance
1323  
1324 Creates a Contributor Insights rule. Rules evaluate log events in a
1325 CloudWatch Logs log group, enabling you to find contributor data for
1326 the log events in that log group. For more information, see Using
1327 Contributor Insights to Analyze High-Cardinality Data
1328 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html).
1329  
1330 If you create a rule, delete it, and then re-create it with the same
1331 name, historical data from the first time the rule was created might
1332 not be available.
1333  
1334  
1335 =head2 PutMetricAlarm
1336  
1337 =over
1338  
1339 =item AlarmName => Str
1340  
1341 =item ComparisonOperator => Str
1342  
1343 =item EvaluationPeriods => Int
1344  
1345 =item [ActionsEnabled => Bool]
1346  
1347 =item [AlarmActions => ArrayRef[Str|Undef]]
1348  
1349 =item [AlarmDescription => Str]
1350  
1351 =item [DatapointsToAlarm => Int]
1352  
1353 =item [Dimensions => ArrayRef[L<Paws::CloudWatch::Dimension>]]
1354  
1355 =item [EvaluateLowSampleCountPercentile => Str]
1356  
1357 =item [ExtendedStatistic => Str]
1358  
1359 =item [InsufficientDataActions => ArrayRef[Str|Undef]]
1360  
1361 =item [MetricName => Str]
1362  
1363 =item [Metrics => ArrayRef[L<Paws::CloudWatch::MetricDataQuery>]]
1364  
1365 =item [Namespace => Str]
1366  
1367 =item [OKActions => ArrayRef[Str|Undef]]
1368  
1369 =item [Period => Int]
1370  
1371 =item [Statistic => Str]
1372  
1373 =item [Tags => ArrayRef[L<Paws::CloudWatch::Tag>]]
1374  
1375 =item [Threshold => Num]
1376  
1377 =item [ThresholdMetricId => Str]
1378  
1379 =item [TreatMissingData => Str]
1380  
1381 =item [Unit => Str]
1382  
1383  
1384 =back
1385  
1386 Each argument is described in detail in: L<Paws::CloudWatch::PutMetricAlarm>
1387  
1388 Returns: nothing
1389  
1390 Creates or updates an alarm and associates it with the specified
1391 metric, metric math expression, or anomaly detection model.
1392  
1393 Alarms based on anomaly detection models cannot have Auto Scaling
1394 actions.
1395  
1396 When this operation creates an alarm, the alarm state is immediately
1397 set to C<INSUFFICIENT_DATA>. The alarm is then evaluated and its state
1398 is set appropriately. Any actions associated with the new state are
1399 then executed.
1400  
1401 When you update an existing alarm, its state is left unchanged, but the
1402 update completely overwrites the previous configuration of the alarm.
1403  
1404 If you are an IAM user, you must have Amazon EC2 permissions for some
1405 alarm operations:
1406  
1407 =over
1408  
1409 =item *
1410  
1411 The C<iam:CreateServiceLinkedRole> for all alarms with EC2 actions
1412  
1413 =item *
1414  
1415 The C<iam:CreateServiceLinkedRole> to create an alarm with Systems
1416 Manager OpsItem actions.
1417  
1418 =back
1419  
1420 The first time you create an alarm in the AWS Management Console, the
1421 CLI, or by using the PutMetricAlarm API, CloudWatch creates the
1422 necessary service-linked role for you. The service-linked roles are
1423 called C<AWSServiceRoleForCloudWatchEvents> and
1424 C<AWSServiceRoleForCloudWatchAlarms_ActionSSM>. For more information,
1425 see AWS service-linked role
1426 (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role).
1427  
1428  
1429 =head2 PutMetricData
1430  
1431 =over
1432  
1433 =item MetricData => ArrayRef[L<Paws::CloudWatch::MetricDatum>]
1434  
1435 =item Namespace => Str
1436  
1437  
1438 =back
1439  
1440 Each argument is described in detail in: L<Paws::CloudWatch::PutMetricData>
1441  
1442 Returns: nothing
1443  
1444 Publishes metric data points to Amazon CloudWatch. CloudWatch
1445 associates the data points with the specified metric. If the specified
1446 metric does not exist, CloudWatch creates the metric. When CloudWatch
1447 creates a metric, it can take up to fifteen minutes for the metric to
1448 appear in calls to ListMetrics
1449 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html).
1450  
1451 You can publish either individual data points in the C<Value> field, or
1452 arrays of values and the number of times each value occurred during the
1453 period by using the C<Values> and C<Counts> fields in the
1454 C<MetricDatum> structure. Using the C<Values> and C<Counts> method
1455 enables you to publish up to 150 values per metric with one
1456 C<PutMetricData> request, and supports retrieving percentile statistics
1457 on this data.
1458  
1459 Each C<PutMetricData> request is limited to 40 KB in size for HTTP POST
1460 requests. You can send a payload compressed by gzip. Each request is
1461 also limited to no more than 20 different metrics.
1462  
1463 Although the C<Value> parameter accepts numbers of type C<Double>,
1464 CloudWatch rejects values that are either too small or too large.
1465 Values must be in the range of -2^360 to 2^360. In addition, special
1466 values (for example, NaN, +Infinity, -Infinity) are not supported.
1467  
1468 You can use up to 10 dimensions per metric to further clarify what data
1469 the metric collects. Each dimension consists of a Name and Value pair.
1470 For more information about specifying dimensions, see Publishing
1471 Metrics
1472 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html)
1473 in the I<Amazon CloudWatch User Guide>.
1474  
1475 You specify the time stamp to be associated with each data point. You
1476 can specify time stamps that are as much as two weeks before the
1477 current date, and as much as 2 hours after the current day and time.
1478  
1479 Data points with time stamps from 24 hours ago or longer can take at
1480 least 48 hours to become available for GetMetricData
1481 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html)
1482 or GetMetricStatistics
1483 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html)
1484 from the time they are submitted. Data points with time stamps between
1485 3 and 24 hours ago can take as much as 2 hours to become available for
1486 for GetMetricData
1487 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html)
1488 or GetMetricStatistics
1489 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html).
1490  
1491 CloudWatch needs raw data points to calculate percentile statistics. If
1492 you publish data using a statistic set instead, you can only retrieve
1493 percentile statistics for this data if one of the following conditions
1494 is true:
1495  
1496 =over
1497  
1498 =item *
1499  
1500 The C<SampleCount> value of the statistic set is 1 and C<Min>, C<Max>,
1501 and C<Sum> are all equal.
1502  
1503 =item *
1504  
1505 The C<Min> and C<Max> are equal, and C<Sum> is equal to C<Min>
1506 multiplied by C<SampleCount>.
1507  
1508 =back
1509  
1510  
1511  
1512 =head2 PutMetricStream
1513  
1514 =over
1515  
1516 =item FirehoseArn => Str
1517  
1518 =item Name => Str
1519  
1520 =item OutputFormat => Str
1521  
1522 =item RoleArn => Str
1523  
1524 =item [ExcludeFilters => ArrayRef[L<Paws::CloudWatch::MetricStreamFilter>]]
1525  
1526 =item [IncludeFilters => ArrayRef[L<Paws::CloudWatch::MetricStreamFilter>]]
1527  
1528 =item [Tags => ArrayRef[L<Paws::CloudWatch::Tag>]]
1529  
1530  
1531 =back
1532  
1533 Each argument is described in detail in: L<Paws::CloudWatch::PutMetricStream>
1534  
1535 Returns: a L<Paws::CloudWatch::PutMetricStreamOutput> instance
1536  
1537 Creates or updates a metric stream. Metric streams can automatically
1538 stream CloudWatch metrics to AWS destinations including Amazon S3 and
1539 to many third-party solutions.
1540  
1541 For more information, see Using Metric Streams
1542 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Metric-Streams.html).
1543  
1544 To create a metric stream, you must be logged on to an account that has
1545 the C<iam:PassRole> permission and either the C<CloudWatchFullAccess>
1546 policy or the C<cloudwatch:PutMetricStream> permission.
1547  
1548 When you create or update a metric stream, you choose one of the
1549 following:
1550  
1551 =over
1552  
1553 =item *
1554  
1555 Stream metrics from all metric namespaces in the account.
1556  
1557 =item *
1558  
1559 Stream metrics from all metric namespaces in the account, except for
1560 the namespaces that you list in C<ExcludeFilters>.
1561  
1562 =item *
1563  
1564 Stream metrics from only the metric namespaces that you list in
1565 C<IncludeFilters>.
1566  
1567 =back
1568  
1569 When you use C<PutMetricStream> to create a new metric stream, the
1570 stream is created in the C<running> state. If you use it to update an
1571 existing stream, the state of the stream is not changed.
1572  
1573  
1574 =head2 SetAlarmState
1575  
1576 =over
1577  
1578 =item AlarmName => Str
1579  
1580 =item StateReason => Str
1581  
1582 =item StateValue => Str
1583  
1584 =item [StateReasonData => Str]
1585  
1586  
1587 =back
1588  
1589 Each argument is described in detail in: L<Paws::CloudWatch::SetAlarmState>
1590  
1591 Returns: nothing
1592  
1593 Temporarily sets the state of an alarm for testing purposes. When the
1594 updated state differs from the previous value, the action configured
1595 for the appropriate state is invoked. For example, if your alarm is
1596 configured to send an Amazon SNS message when an alarm is triggered,
1597 temporarily changing the alarm state to C<ALARM> sends an SNS message.
1598  
1599 Metric alarms returns to their actual state quickly, often within
1600 seconds. Because the metric alarm state change happens quickly, it is
1601 typically only visible in the alarm's B<History> tab in the Amazon
1602 CloudWatch console or through DescribeAlarmHistory
1603 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarmHistory.html).
1604  
1605 If you use C<SetAlarmState> on a composite alarm, the composite alarm
1606 is not guaranteed to return to its actual state. It returns to its
1607 actual state only once any of its children alarms change state. It is
1608 also reevaluated if you update its configuration.
1609  
1610 If an alarm triggers EC2 Auto Scaling policies or application Auto
1611 Scaling policies, you must include information in the
1612 C<StateReasonData> parameter to enable the policy to take the correct
1613 action.
1614  
1615  
1616 =head2 StartMetricStreams
1617  
1618 =over
1619  
1620 =item Names => ArrayRef[Str|Undef]
1621  
1622  
1623 =back
1624  
1625 Each argument is described in detail in: L<Paws::CloudWatch::StartMetricStreams>
1626  
1627 Returns: a L<Paws::CloudWatch::StartMetricStreamsOutput> instance
1628  
1629 Starts the streaming of metrics for one or more of your metric streams.
1630  
1631  
1632 =head2 StopMetricStreams
1633  
1634 =over
1635  
1636 =item Names => ArrayRef[Str|Undef]
1637  
1638  
1639 =back
1640  
1641 Each argument is described in detail in: L<Paws::CloudWatch::StopMetricStreams>
1642  
1643 Returns: a L<Paws::CloudWatch::StopMetricStreamsOutput> instance
1644  
1645 Stops the streaming of metrics for one or more of your metric streams.
1646  
1647  
1648 =head2 TagResource
1649  
1650 =over
1651  
1652 =item ResourceARN => Str
1653  
1654 =item Tags => ArrayRef[L<Paws::CloudWatch::Tag>]
1655  
1656  
1657 =back
1658  
1659 Each argument is described in detail in: L<Paws::CloudWatch::TagResource>
1660  
1661 Returns: a L<Paws::CloudWatch::TagResourceOutput> instance
1662  
1663 Assigns one or more tags (key-value pairs) to the specified CloudWatch
1664 resource. Currently, the only CloudWatch resources that can be tagged
1665 are alarms and Contributor Insights rules.
1666  
1667 Tags can help you organize and categorize your resources. You can also
1668 use them to scope user permissions by granting a user permission to
1669 access or change only resources with certain tag values.
1670  
1671 Tags don't have any semantic meaning to AWS and are interpreted
1672 strictly as strings of characters.
1673  
1674 You can use the C<TagResource> action with an alarm that already has
1675 tags. If you specify a new tag key for the alarm, this tag is appended
1676 to the list of tags associated with the alarm. If you specify a tag key
1677 that is already associated with the alarm, the new tag value that you
1678 specify replaces the previous value for that tag.
1679  
1680 You can associate as many as 50 tags with a CloudWatch resource.
1681  
1682  
1683 =head2 UntagResource
1684  
1685 =over
1686  
1687 =item ResourceARN => Str
1688  
1689 =item TagKeys => ArrayRef[Str|Undef]
1690  
1691  
1692 =back
1693  
1694 Each argument is described in detail in: L<Paws::CloudWatch::UntagResource>
1695  
1696 Returns: a L<Paws::CloudWatch::UntagResourceOutput> instance
1697  
1698 Removes one or more tags from the specified resource.
1699  
1700  
1701  
1702  
1703 =head1 PAGINATORS
1704  
1705 Paginator methods are helpers that repetively call methods that return partial results
1706  
1707 =head2 DescribeAllAlarmHistory(sub { },[AlarmName => Str, AlarmTypes => ArrayRef[Str|Undef], EndDate => Str, HistoryItemType => Str, MaxRecords => Int, NextToken => Str, ScanBy => Str, StartDate => Str])
1708  
1709 =head2 DescribeAllAlarmHistory([AlarmName => Str, AlarmTypes => ArrayRef[Str|Undef], EndDate => Str, HistoryItemType => Str, MaxRecords => Int, NextToken => Str, ScanBy => Str, StartDate => Str])
1710  
1711  
1712 If passed a sub as first parameter, it will call the sub for each element found in :
1713  
1714 - AlarmHistoryItems, passing the object as the first parameter, and the string 'AlarmHistoryItems' as the second parameter
1715  
1716 If not, it will return a a L<Paws::CloudWatch::DescribeAlarmHistoryOutput> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1717  
1718  
1719 =head2 DescribeAllAlarms(sub { },[ActionPrefix => Str, AlarmNamePrefix => Str, AlarmNames => ArrayRef[Str|Undef], AlarmTypes => ArrayRef[Str|Undef], ChildrenOfAlarmName => Str, MaxRecords => Int, NextToken => Str, ParentsOfAlarmName => Str, StateValue => Str])
1720  
1721 =head2 DescribeAllAlarms([ActionPrefix => Str, AlarmNamePrefix => Str, AlarmNames => ArrayRef[Str|Undef], AlarmTypes => ArrayRef[Str|Undef], ChildrenOfAlarmName => Str, MaxRecords => Int, NextToken => Str, ParentsOfAlarmName => Str, StateValue => Str])
1722  
1723  
1724 If passed a sub as first parameter, it will call the sub for each element found in :
1725  
1726 - MetricAlarms, passing the object as the first parameter, and the string 'MetricAlarms' as the second parameter
1727  
1728 - CompositeAlarms, passing the object as the first parameter, and the string 'CompositeAlarms' as the second parameter
1729  
1730 If not, it will return a a L<Paws::CloudWatch::DescribeAlarmsOutput> instance with all the C<param>s; andC<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1731  
1732  
1733 =head2 GetAllMetricData(sub { },EndTime => Str, MetricDataQueries => ArrayRef[L<Paws::CloudWatch::MetricDataQuery>], StartTime => Str, [LabelOptions => L<Paws::CloudWatch::LabelOptions>, MaxDatapoints => Int, NextToken => Str, ScanBy => Str])
1734  
1735 =head2 GetAllMetricData(EndTime => Str, MetricDataQueries => ArrayRef[L<Paws::CloudWatch::MetricDataQuery>], StartTime => Str, [LabelOptions => L<Paws::CloudWatch::LabelOptions>, MaxDatapoints => Int, NextToken => Str, ScanBy => Str])
1736  
1737  
1738 If passed a sub as first parameter, it will call the sub for each element found in :
1739  
1740 - MetricDataResults, passing the object as the first parameter, and the string 'MetricDataResults' as the second parameter
1741  
1742 - Messages, passing the object as the first parameter, and the string 'Messages' as the second parameter
1743  
1744 If not, it will return a a L<Paws::CloudWatch::GetMetricDataOutput> instance with all the C<param>s; andC<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1745  
1746  
1747 =head2 ListAllDashboards(sub { },[DashboardNamePrefix => Str, NextToken => Str])
1748  
1749 =head2 ListAllDashboards([DashboardNamePrefix => Str, NextToken => Str])
1750  
1751  
1752 If passed a sub as first parameter, it will call the sub for each element found in :
1753  
1754 - DashboardEntries, passing the object as the first parameter, and the string 'DashboardEntries' as the second parameter
1755  
1756 If not, it will return a a L<Paws::CloudWatch::ListDashboardsOutput> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1757  
1758  
1759 =head2 ListAllMetrics(sub { },[Dimensions => ArrayRef[L<Paws::CloudWatch::DimensionFilter>], MetricName => Str, Namespace => Str, NextToken => Str, RecentlyActive => Str])
1760  
1761 =head2 ListAllMetrics([Dimensions => ArrayRef[L<Paws::CloudWatch::DimensionFilter>], MetricName => Str, Namespace => Str, NextToken => Str, RecentlyActive => Str])
1762  
1763  
1764 If passed a sub as first parameter, it will call the sub for each element found in :
1765  
1766 - Metrics, passing the object as the first parameter, and the string 'Metrics' as the second parameter
1767  
1768 If not, it will return a a L<Paws::CloudWatch::ListMetricsOutput> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1769  
1770  
1771  
1772  
1773  
1774 =head1 SEE ALSO
1775  
1776 This service class forms part of L<Paws>
1777  
1778 =head1 BUGS and CONTRIBUTIONS
1779  
1780 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
1781  
1782 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
1783  
1784 =cut
1785  
« blib/lib/Paws/IoT.pm ↑ Summary blib/lib/Paws/CloudWatchLogs.pm »