PNG
IHDR ; IDATxܻn0K
)(pA7LeG{ §㻢|ذaÆ
6lذaÆ
6lذaÆ
6lom$^yذag5 bÆ
6lذaÆ
6lذa{
6lذaÆ
`}HFkm,mӪôô!x|'ܢ˟;E:9&ᶒ}{v]n&6
h_tڠ͵-ҫZ;Z$.Pkž)!o>}leQfJTu іچ\X=8Rن4`Vwl>nG^is"ms$ui?wbs[m6K4O.4%/bC%tMז -lG6mrz2s%9s@-k9=)kB5\+͂ZsٲRn~GRCwIcIn7jJhۛNCS|j08yiHKֶۛkɈ+;SzL /F*\Ԕ#"5m2[S=gnaPeғL
lذaÆ
6l^ḵaÆ
6lذaÆ
6lذa;
_ذaÆ
6lذaÆ
6lذaÆ
R IENDB`
package Paws::CloudWatch;
use Moose;
sub service { 'monitoring' }
sub signing_name { 'monitoring' }
sub version { '2010-08-01' }
sub flattened_arrays { 0 }
has max_attempts => (is => 'ro', isa => 'Int', default => 5);
has retry => (is => 'ro', isa => 'HashRef', default => sub {
{ base => 'rand', type => 'exponential', growth_factor => 2 }
});
has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
] });
with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::QueryCaller';
sub DeleteAlarms {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::DeleteAlarms', @_);
return $self->caller->do_call($self, $call_object);
}
sub DeleteAnomalyDetector {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::DeleteAnomalyDetector', @_);
return $self->caller->do_call($self, $call_object);
}
sub DeleteDashboards {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::DeleteDashboards', @_);
return $self->caller->do_call($self, $call_object);
}
sub DeleteInsightRules {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::DeleteInsightRules', @_);
return $self->caller->do_call($self, $call_object);
}
sub DeleteMetricStream {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::DeleteMetricStream', @_);
return $self->caller->do_call($self, $call_object);
}
sub DescribeAlarmHistory {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::DescribeAlarmHistory', @_);
return $self->caller->do_call($self, $call_object);
}
sub DescribeAlarms {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::DescribeAlarms', @_);
return $self->caller->do_call($self, $call_object);
}
sub DescribeAlarmsForMetric {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::DescribeAlarmsForMetric', @_);
return $self->caller->do_call($self, $call_object);
}
sub DescribeAnomalyDetectors {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::DescribeAnomalyDetectors', @_);
return $self->caller->do_call($self, $call_object);
}
sub DescribeInsightRules {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::DescribeInsightRules', @_);
return $self->caller->do_call($self, $call_object);
}
sub DisableAlarmActions {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::DisableAlarmActions', @_);
return $self->caller->do_call($self, $call_object);
}
sub DisableInsightRules {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::DisableInsightRules', @_);
return $self->caller->do_call($self, $call_object);
}
sub EnableAlarmActions {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::EnableAlarmActions', @_);
return $self->caller->do_call($self, $call_object);
}
sub EnableInsightRules {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::EnableInsightRules', @_);
return $self->caller->do_call($self, $call_object);
}
sub GetDashboard {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::GetDashboard', @_);
return $self->caller->do_call($self, $call_object);
}
sub GetInsightRuleReport {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::GetInsightRuleReport', @_);
return $self->caller->do_call($self, $call_object);
}
sub GetMetricData {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::GetMetricData', @_);
return $self->caller->do_call($self, $call_object);
}
sub GetMetricStatistics {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::GetMetricStatistics', @_);
return $self->caller->do_call($self, $call_object);
}
sub GetMetricStream {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::GetMetricStream', @_);
return $self->caller->do_call($self, $call_object);
}
sub GetMetricWidgetImage {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::GetMetricWidgetImage', @_);
return $self->caller->do_call($self, $call_object);
}
sub ListDashboards {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::ListDashboards', @_);
return $self->caller->do_call($self, $call_object);
}
sub ListMetrics {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::ListMetrics', @_);
return $self->caller->do_call($self, $call_object);
}
sub ListMetricStreams {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::ListMetricStreams', @_);
return $self->caller->do_call($self, $call_object);
}
sub ListTagsForResource {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::ListTagsForResource', @_);
return $self->caller->do_call($self, $call_object);
}
sub PutAnomalyDetector {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::PutAnomalyDetector', @_);
return $self->caller->do_call($self, $call_object);
}
sub PutCompositeAlarm {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::PutCompositeAlarm', @_);
return $self->caller->do_call($self, $call_object);
}
sub PutDashboard {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::PutDashboard', @_);
return $self->caller->do_call($self, $call_object);
}
sub PutInsightRule {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::PutInsightRule', @_);
return $self->caller->do_call($self, $call_object);
}
sub PutMetricAlarm {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::PutMetricAlarm', @_);
return $self->caller->do_call($self, $call_object);
}
sub PutMetricData {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::PutMetricData', @_);
return $self->caller->do_call($self, $call_object);
}
sub PutMetricStream {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::PutMetricStream', @_);
return $self->caller->do_call($self, $call_object);
}
sub SetAlarmState {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::SetAlarmState', @_);
return $self->caller->do_call($self, $call_object);
}
sub StartMetricStreams {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::StartMetricStreams', @_);
return $self->caller->do_call($self, $call_object);
}
sub StopMetricStreams {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::StopMetricStreams', @_);
return $self->caller->do_call($self, $call_object);
}
sub TagResource {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::TagResource', @_);
return $self->caller->do_call($self, $call_object);
}
sub UntagResource {
my $self = shift;
my $call_object = $self->new_with_coercions('Paws::CloudWatch::UntagResource', @_);
return $self->caller->do_call($self, $call_object);
}
sub DescribeAllAlarmHistory {
my $self = shift;
my $callback = shift @_ if (ref($_[0]) eq 'CODE');
my $result = $self->DescribeAlarmHistory(@_);
my $next_result = $result;
if (not defined $callback) {
while ($next_result->NextToken) {
$next_result = $self->DescribeAlarmHistory(@_, NextToken => $next_result->NextToken);
push @{ $result->AlarmHistoryItems }, @{ $next_result->AlarmHistoryItems };
}
return $result;
} else {
while ($result->NextToken) {
$callback->($_ => 'AlarmHistoryItems') foreach (@{ $result->AlarmHistoryItems });
$result = $self->DescribeAlarmHistory(@_, NextToken => $result->NextToken);
}
$callback->($_ => 'AlarmHistoryItems') foreach (@{ $result->AlarmHistoryItems });
}
return undef
}
sub DescribeAllAlarms {
my $self = shift;
my $callback = shift @_ if (ref($_[0]) eq 'CODE');
my $result = $self->DescribeAlarms(@_);
my $next_result = $result;
if (not defined $callback) {
while ($next_result->NextToken) {
$next_result = $self->DescribeAlarms(@_, NextToken => $next_result->NextToken);
push @{ $result->MetricAlarms }, @{ $next_result->MetricAlarms };
push @{ $result->CompositeAlarms }, @{ $next_result->CompositeAlarms };
}
return $result;
} else {
while ($result->NextToken) {
$callback->($_ => 'MetricAlarms') foreach (@{ $result->MetricAlarms });
$callback->($_ => 'CompositeAlarms') foreach (@{ $result->CompositeAlarms });
$result = $self->DescribeAlarms(@_, NextToken => $result->NextToken);
}
$callback->($_ => 'MetricAlarms') foreach (@{ $result->MetricAlarms });
$callback->($_ => 'CompositeAlarms') foreach (@{ $result->CompositeAlarms });
}
return undef
}
sub GetAllMetricData {
my $self = shift;
my $callback = shift @_ if (ref($_[0]) eq 'CODE');
my $result = $self->GetMetricData(@_);
my $next_result = $result;
if (not defined $callback) {
while ($next_result->NextToken) {
$next_result = $self->GetMetricData(@_, NextToken => $next_result->NextToken);
push @{ $result->MetricDataResults }, @{ $next_result->MetricDataResults };
push @{ $result->Messages }, @{ $next_result->Messages };
}
return $result;
} else {
while ($result->NextToken) {
$callback->($_ => 'MetricDataResults') foreach (@{ $result->MetricDataResults });
$callback->($_ => 'Messages') foreach (@{ $result->Messages });
$result = $self->GetMetricData(@_, NextToken => $result->NextToken);
}
$callback->($_ => 'MetricDataResults') foreach (@{ $result->MetricDataResults });
$callback->($_ => 'Messages') foreach (@{ $result->Messages });
}
return undef
}
sub ListAllDashboards {
my $self = shift;
my $callback = shift @_ if (ref($_[0]) eq 'CODE');
my $result = $self->ListDashboards(@_);
my $next_result = $result;
if (not defined $callback) {
while ($next_result->NextToken) {
$next_result = $self->ListDashboards(@_, NextToken => $next_result->NextToken);
push @{ $result->DashboardEntries }, @{ $next_result->DashboardEntries };
}
return $result;
} else {
while ($result->NextToken) {
$callback->($_ => 'DashboardEntries') foreach (@{ $result->DashboardEntries });
$result = $self->ListDashboards(@_, NextToken => $result->NextToken);
}
$callback->($_ => 'DashboardEntries') foreach (@{ $result->DashboardEntries });
}
return undef
}
sub ListAllMetrics {
my $self = shift;
my $callback = shift @_ if (ref($_[0]) eq 'CODE');
my $result = $self->ListMetrics(@_);
my $next_result = $result;
if (not defined $callback) {
while ($next_result->NextToken) {
$next_result = $self->ListMetrics(@_, NextToken => $next_result->NextToken);
push @{ $result->Metrics }, @{ $next_result->Metrics };
}
return $result;
} else {
while ($result->NextToken) {
$callback->($_ => 'Metrics') foreach (@{ $result->Metrics });
$result = $self->ListMetrics(@_, NextToken => $result->NextToken);
}
$callback->($_ => 'Metrics') foreach (@{ $result->Metrics });
}
return undef
}
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 / }
1;
### main pod documentation begin ###
=head1 NAME
Paws::CloudWatch - Perl Interface to AWS Amazon CloudWatch
=head1 SYNOPSIS
use Paws;
my $obj = Paws->service('CloudWatch');
my $res = $obj->Method(
Arg1 => $val1,
Arg2 => [ 'V1', 'V2' ],
# if Arg3 is an object, the HashRef will be used as arguments to the constructor
# of the arguments type
Arg3 => { Att1 => 'Val1' },
# if Arg4 is an array of objects, the HashRefs will be passed as arguments to
# the constructor of the arguments type
Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
);
=head1 DESCRIPTION
Amazon CloudWatch monitors your Amazon Web Services (AWS) resources and
the applications you run on AWS in real time. You can use CloudWatch to
collect and track metrics, which are the variables you want to measure
for your resources and applications.
CloudWatch alarms send notifications or automatically change the
resources you are monitoring based on rules that you define. For
example, you can monitor the CPU usage and disk reads and writes of
your Amazon EC2 instances. Then, use this data to determine whether you
should launch additional instances to handle increased load. You can
also use this data to stop under-used instances to save money.
In addition to monitoring the built-in metrics that come with AWS, you
can monitor your own custom metrics. With CloudWatch, you gain
system-wide visibility into resource utilization, application
performance, and operational health.
For the AWS API documentation, see L
=head1 METHODS
=head2 DeleteAlarms
=over
=item AlarmNames => ArrayRef[Str|Undef]
=back
Each argument is described in detail in: L
Returns: nothing
Deletes the specified alarms. You can delete up to 100 alarms in one
operation. However, this total can include no more than one composite
alarm. For example, you could delete 99 metric alarms and one composite
alarms with one operation, but you can't delete two composite alarms
with one operation.
In the event of an error, no alarms are deleted.
It is possible to create a loop or cycle of composite alarms, where
composite alarm A depends on composite alarm B, and composite alarm B
also depends on composite alarm A. In this scenario, you can't delete
any composite alarm that is part of the cycle because there is always
still a composite alarm that depends on that alarm that you want to
delete.
To get out of such a situation, you must break the cycle by changing
the rule of one of the composite alarms in the cycle to remove a
dependency that creates the cycle. The simplest change to make to break
a cycle is to change the C of one of the alarms to C.
Additionally, the evaluation of composite alarms stops if CloudWatch
detects a cycle in the evaluation path.
=head2 DeleteAnomalyDetector
=over
=item MetricName => Str
=item Namespace => Str
=item Stat => Str
=item [Dimensions => ArrayRef[L]]
=back
Each argument is described in detail in: L
Returns: a L instance
Deletes the specified anomaly detection model from your account.
=head2 DeleteDashboards
=over
=item DashboardNames => ArrayRef[Str|Undef]
=back
Each argument is described in detail in: L
Returns: a L instance
Deletes all dashboards that you specify. You can specify up to 100
dashboards to delete. If there is an error during this call, no
dashboards are deleted.
=head2 DeleteInsightRules
=over
=item RuleNames => ArrayRef[Str|Undef]
=back
Each argument is described in detail in: L
Returns: a L instance
Permanently deletes the specified Contributor Insights rules.
If you create a rule, delete it, and then re-create it with the same
name, historical data from the first time the rule was created might
not be available.
=head2 DeleteMetricStream
=over
=item Name => Str
=back
Each argument is described in detail in: L
Returns: a L instance
Permanently deletes the metric stream that you specify.
=head2 DescribeAlarmHistory
=over
=item [AlarmName => Str]
=item [AlarmTypes => ArrayRef[Str|Undef]]
=item [EndDate => Str]
=item [HistoryItemType => Str]
=item [MaxRecords => Int]
=item [NextToken => Str]
=item [ScanBy => Str]
=item [StartDate => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
Retrieves the history for the specified alarm. You can filter the
results by date range or item type. If an alarm name is not specified,
the histories for either all metric alarms or all composite alarms are
returned.
CloudWatch retains the history of an alarm even if you delete the
alarm.
=head2 DescribeAlarms
=over
=item [ActionPrefix => Str]
=item [AlarmNamePrefix => Str]
=item [AlarmNames => ArrayRef[Str|Undef]]
=item [AlarmTypes => ArrayRef[Str|Undef]]
=item [ChildrenOfAlarmName => Str]
=item [MaxRecords => Int]
=item [NextToken => Str]
=item [ParentsOfAlarmName => Str]
=item [StateValue => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
Retrieves the specified alarms. You can filter the results by
specifying a prefix for the alarm name, the alarm state, or a prefix
for any action.
=head2 DescribeAlarmsForMetric
=over
=item MetricName => Str
=item Namespace => Str
=item [Dimensions => ArrayRef[L]]
=item [ExtendedStatistic => Str]
=item [Period => Int]
=item [Statistic => Str]
=item [Unit => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
Retrieves the alarms for the specified metric. To filter the results,
specify a statistic, period, or unit.
This operation retrieves only standard alarms that are based on the
specified metric. It does not return alarms based on math expressions
that use the specified metric, or composite alarms that use the
specified metric.
=head2 DescribeAnomalyDetectors
=over
=item [Dimensions => ArrayRef[L]]
=item [MaxResults => Int]
=item [MetricName => Str]
=item [Namespace => Str]
=item [NextToken => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
Lists the anomaly detection models that you have created in your
account. You can list all models in your account or filter the results
to only the models that are related to a certain namespace, metric
name, or metric dimension.
=head2 DescribeInsightRules
=over
=item [MaxResults => Int]
=item [NextToken => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
Returns a list of all the Contributor Insights rules in your account.
For more information about Contributor Insights, see Using Contributor
Insights to Analyze High-Cardinality Data
(https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html).
=head2 DisableAlarmActions
=over
=item AlarmNames => ArrayRef[Str|Undef]
=back
Each argument is described in detail in: L
Returns: nothing
Disables the actions for the specified alarms. When an alarm's actions
are disabled, the alarm actions do not execute when the alarm state
changes.
=head2 DisableInsightRules
=over
=item RuleNames => ArrayRef[Str|Undef]
=back
Each argument is described in detail in: L
Returns: a L instance
Disables the specified Contributor Insights rules. When rules are
disabled, they do not analyze log groups and do not incur costs.
=head2 EnableAlarmActions
=over
=item AlarmNames => ArrayRef[Str|Undef]
=back
Each argument is described in detail in: L
Returns: nothing
Enables the actions for the specified alarms.
=head2 EnableInsightRules
=over
=item RuleNames => ArrayRef[Str|Undef]
=back
Each argument is described in detail in: L
Returns: a L instance
Enables the specified Contributor Insights rules. When rules are
enabled, they immediately begin analyzing log data.
=head2 GetDashboard
=over
=item DashboardName => Str
=back
Each argument is described in detail in: L
Returns: a L instance
Displays the details of the dashboard that you specify.
To copy an existing dashboard, use C, and then use the
data returned within C as the template for the new
dashboard when you call C to create the copy.
=head2 GetInsightRuleReport
=over
=item EndTime => Str
=item Period => Int
=item RuleName => Str
=item StartTime => Str
=item [MaxContributorCount => Int]
=item [Metrics => ArrayRef[Str|Undef]]
=item [OrderBy => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
This operation returns the time series data collected by a Contributor
Insights rule. The data includes the identity and number of
contributors to the log group.
You can also optionally return one or more statistics about each data
point in the time series. These statistics can include the following:
=over
=item *
C -- the number of unique contributors for each
data point.
=item *
C -- the value of the top contributor for each
data point. The identity of the contributor might change for each data
point in the graph.
If this rule aggregates by COUNT, the top contributor for each data
point is the contributor with the most occurrences in that period. If
the rule aggregates by SUM, the top contributor is the contributor with
the highest sum in the log field specified by the rule's C,
during that period.
=item *
C -- the number of data points matched by the rule.
=item *
C -- the sum of the values from all contributors during the time
period represented by that data point.
=item *
C -- the minimum value from a single observation during the
time period represented by that data point.
=item *
C -- the maximum value from a single observation during the
time period represented by that data point.
=item *
C -- the average value from all contributors during the time
period represented by that data point.
=back
=head2 GetMetricData
=over
=item EndTime => Str
=item MetricDataQueries => ArrayRef[L]
=item StartTime => Str
=item [LabelOptions => L]
=item [MaxDatapoints => Int]
=item [NextToken => Str]
=item [ScanBy => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
You can use the C API to retrieve as many as 500
different metrics in a single request, with a total of as many as
100,800 data points. You can also optionally perform math expressions
on the values of the returned statistics, to create new time series
that represent new insights into your data. For example, using Lambda
metrics, you could divide the Errors metric by the Invocations metric
to get an error rate time series. For more information about metric
math expressions, see Metric Math Syntax and Functions
(https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax)
in the I.
Calls to the C API have a different pricing structure
than calls to C. For more information about
pricing, see Amazon CloudWatch Pricing
(https://aws.amazon.com/cloudwatch/pricing/).
Amazon CloudWatch retains metric data as follows:
=over
=item *
Data points with a period of less than 60 seconds are available for 3
hours. These data points are high-resolution metrics and are available
only for custom metrics that have been defined with a
C of 1.
=item *
Data points with a period of 60 seconds (1-minute) are available for 15
days.
=item *
Data points with a period of 300 seconds (5-minute) are available for
63 days.
=item *
Data points with a period of 3600 seconds (1 hour) are available for
455 days (15 months).
=back
Data points that are initially published with a shorter period are
aggregated together for long-term storage. For example, if you collect
data using a period of 1 minute, the data remains available for 15 days
with 1-minute resolution. After 15 days, this data is still available,
but is aggregated and retrievable only with a resolution of 5 minutes.
After 63 days, the data is further aggregated and is available with a
resolution of 1 hour.
If you omit C in your request, all data that was collected with
any unit is returned, along with the corresponding units that were
specified when the data was reported to CloudWatch. If you specify a
unit, the operation returns only data that was collected with that unit
specified. If you specify a unit that does not match the data
collected, the results of the operation are null. CloudWatch does not
perform unit conversions.
=head2 GetMetricStatistics
=over
=item EndTime => Str
=item MetricName => Str
=item Namespace => Str
=item Period => Int
=item StartTime => Str
=item [Dimensions => ArrayRef[L]]
=item [ExtendedStatistics => ArrayRef[Str|Undef]]
=item [Statistics => ArrayRef[Str|Undef]]
=item [Unit => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
Gets statistics for the specified metric.
The maximum number of data points returned from a single call is 1,440.
If you request more than 1,440 data points, CloudWatch returns an
error. To reduce the number of data points, you can narrow the
specified time range and make multiple requests across adjacent time
ranges, or you can increase the specified period. Data points are not
returned in chronological order.
CloudWatch aggregates data points based on the length of the period
that you specify. For example, if you request statistics with a
one-hour period, CloudWatch aggregates all data points with time stamps
that fall within each one-hour period. Therefore, the number of values
aggregated by CloudWatch is larger than the number of data points
returned.
CloudWatch needs raw data points to calculate percentile statistics. If
you publish data using a statistic set instead, you can only retrieve
percentile statistics for this data if one of the following conditions
is true:
=over
=item *
The SampleCount value of the statistic set is 1.
=item *
The Min and the Max values of the statistic set are equal.
=back
Percentile statistics are not available for metrics when any of the
metric values are negative numbers.
Amazon CloudWatch retains metric data as follows:
=over
=item *
Data points with a period of less than 60 seconds are available for 3
hours. These data points are high-resolution metrics and are available
only for custom metrics that have been defined with a
C of 1.
=item *
Data points with a period of 60 seconds (1-minute) are available for 15
days.
=item *
Data points with a period of 300 seconds (5-minute) are available for
63 days.
=item *
Data points with a period of 3600 seconds (1 hour) are available for
455 days (15 months).
=back
Data points that are initially published with a shorter period are
aggregated together for long-term storage. For example, if you collect
data using a period of 1 minute, the data remains available for 15 days
with 1-minute resolution. After 15 days, this data is still available,
but is aggregated and retrievable only with a resolution of 5 minutes.
After 63 days, the data is further aggregated and is available with a
resolution of 1 hour.
CloudWatch started retaining 5-minute and 1-hour metric data as of July
9, 2016.
For information about metrics and dimensions supported by AWS services,
see the Amazon CloudWatch Metrics and Dimensions Reference
(https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CW_Support_For_AWS.html)
in the I.
=head2 GetMetricStream
=over
=item Name => Str
=back
Each argument is described in detail in: L
Returns: a L instance
Returns information about the metric stream that you specify.
=head2 GetMetricWidgetImage
=over
=item MetricWidget => Str
=item [OutputFormat => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
You can use the C API to retrieve a snapshot
graph of one or more Amazon CloudWatch metrics as a bitmap image. You
can then embed this image into your services and products, such as wiki
pages, reports, and documents. You could also retrieve images
regularly, such as every minute, and create your own custom live
dashboard.
The graph you retrieve can include all CloudWatch metric graph
features, including metric math and horizontal and vertical
annotations.
There is a limit of 20 transactions per second for this API. Each
C action has the following limits:
=over
=item *
As many as 100 metrics in the graph.
=item *
Up to 100 KB uncompressed payload.
=back
=head2 ListDashboards
=over
=item [DashboardNamePrefix => Str]
=item [NextToken => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
Returns a list of the dashboards for your account. If you include
C, only those dashboards with names starting with
the prefix are listed. Otherwise, all dashboards in your account are
listed.
C returns up to 1000 results on one page. If there are
more than 1000 dashboards, you can call C again and
include the value you received for C in the first call, to
receive the next 1000 results.
=head2 ListMetrics
=over
=item [Dimensions => ArrayRef[L]]
=item [MetricName => Str]
=item [Namespace => Str]
=item [NextToken => Str]
=item [RecentlyActive => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
List the specified metrics. You can use the returned metrics with
GetMetricData
(https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html)
or GetMetricStatistics
(https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html)
to obtain statistical data.
Up to 500 results are returned for any one call. To retrieve additional
results, use the returned token with subsequent calls.
After you create a metric, allow up to 15 minutes before the metric
appears. You can see statistics about the metric sooner by using
GetMetricData
(https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html)
or GetMetricStatistics
(https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html).
C doesn't return information about metrics if those
metrics haven't reported data in the past two weeks. To retrieve those
metrics, use GetMetricData
(https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html)
or GetMetricStatistics
(https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html).
=head2 ListMetricStreams
=over
=item [MaxResults => Int]
=item [NextToken => Str]
=back
Each argument is described in detail in: L
Returns: a L instance
Returns a list of metric streams in this account.
=head2 ListTagsForResource
=over
=item ResourceARN => Str
=back
Each argument is described in detail in: L
Returns: a L instance
Displays the tags associated with a CloudWatch resource. Currently,
alarms and Contributor Insights rules support tagging.
=head2 PutAnomalyDetector
=over
=item MetricName => Str
=item Namespace => Str
=item Stat => Str
=item [Configuration => L]
=item [Dimensions => ArrayRef[L]]
=back
Each argument is described in detail in: L
Returns: a L instance
Creates an anomaly detection model for a CloudWatch metric. You can use
the model to display a band of expected normal values when the metric
is graphed.
For more information, see CloudWatch Anomaly Detection
(https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Anomaly_Detection.html).
=head2 PutCompositeAlarm
=over
=item AlarmName => Str
=item AlarmRule => Str
=item [ActionsEnabled => Bool]
=item [AlarmActions => ArrayRef[Str|Undef]]
=item [AlarmDescription => Str]
=item [InsufficientDataActions => ArrayRef[Str|Undef]]
=item [OKActions => ArrayRef[Str|Undef]]
=item [Tags => ArrayRef[L]]
=back
Each argument is described in detail in: L
Returns: nothing
Creates or updates a I. When you create a composite
alarm, you specify a rule expression for the alarm that takes into
account the alarm states of other alarms that you have created. The
composite alarm goes into ALARM state only if all conditions of the
rule are met.
The alarms specified in a composite alarm's rule expression can include
metric alarms and other composite alarms.
Using composite alarms can reduce alarm noise. You can create multiple
metric alarms, and also create a composite alarm and set up alerts only
for the composite alarm. For example, you could create a composite
alarm that goes into ALARM state only when more than one of the
underlying metric alarms are in ALARM state.
Currently, the only alarm actions that can be taken by composite alarms
are notifying SNS topics.
It is possible to create a loop or cycle of composite alarms, where
composite alarm A depends on composite alarm B, and composite alarm B
also depends on composite alarm A. In this scenario, you can't delete
any composite alarm that is part of the cycle because there is always
still a composite alarm that depends on that alarm that you want to
delete.
To get out of such a situation, you must break the cycle by changing
the rule of one of the composite alarms in the cycle to remove a
dependency that creates the cycle. The simplest change to make to break
a cycle is to change the C of one of the alarms to C.
Additionally, the evaluation of composite alarms stops if CloudWatch
detects a cycle in the evaluation path.
When this operation creates an alarm, the alarm state is immediately
set to C. The alarm is then evaluated and its state
is set appropriately. Any actions associated with the new state are
then executed. For a composite alarm, this initial time after creation
is the only time that the alarm can be in C state.
When you update an existing alarm, its state is left unchanged, but the
update completely overwrites the previous configuration of the alarm.
If you are an IAM user, you must have C to
create a composite alarm that has Systems Manager OpsItem actions.
=head2 PutDashboard
=over
=item DashboardBody => Str
=item DashboardName => Str
=back
Each argument is described in detail in: L
Returns: a L instance
Creates a dashboard if it does not already exist, or updates an
existing dashboard. If you update a dashboard, the entire contents are
replaced with what you specify here.
All dashboards in your account are global, not region-specific.
A simple way to create a dashboard using C is to copy an
existing dashboard. To copy an existing dashboard using the console,
you can load the dashboard and then use the View/edit source command in
the Actions menu to display the JSON block for that dashboard. Another
way to copy a dashboard is to use C, and then use the
data returned within C as the template for the new
dashboard when you call C.
When you create a dashboard with C, a good practice is to
add a text widget at the top of the dashboard with a message that the
dashboard was created by script and should not be changed in the
console. This message could also point console users to the location of
the C script or the CloudFormation template used to
create the dashboard.
=head2 PutInsightRule
=over
=item RuleDefinition => Str
=item RuleName => Str
=item [RuleState => Str]
=item [Tags => ArrayRef[L]]
=back
Each argument is described in detail in: L
Returns: a L instance
Creates a Contributor Insights rule. Rules evaluate log events in a
CloudWatch Logs log group, enabling you to find contributor data for
the log events in that log group. For more information, see Using
Contributor Insights to Analyze High-Cardinality Data
(https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html).
If you create a rule, delete it, and then re-create it with the same
name, historical data from the first time the rule was created might
not be available.
=head2 PutMetricAlarm
=over
=item AlarmName => Str
=item ComparisonOperator => Str
=item EvaluationPeriods => Int
=item [ActionsEnabled => Bool]
=item [AlarmActions => ArrayRef[Str|Undef]]
=item [AlarmDescription => Str]
=item [DatapointsToAlarm => Int]
=item [Dimensions => ArrayRef[L]]
=item [EvaluateLowSampleCountPercentile => Str]
=item [ExtendedStatistic => Str]
=item [InsufficientDataActions => ArrayRef[Str|Undef]]
=item [MetricName => Str]
=item [Metrics => ArrayRef[L]]
=item [Namespace => Str]
=item [OKActions => ArrayRef[Str|Undef]]
=item [Period => Int]
=item [Statistic => Str]
=item [Tags => ArrayRef[L]]
=item [Threshold => Num]
=item [ThresholdMetricId => Str]
=item [TreatMissingData => Str]
=item [Unit => Str]
=back
Each argument is described in detail in: L
Returns: nothing
Creates or updates an alarm and associates it with the specified
metric, metric math expression, or anomaly detection model.
Alarms based on anomaly detection models cannot have Auto Scaling
actions.
When this operation creates an alarm, the alarm state is immediately
set to C. The alarm is then evaluated and its state
is set appropriately. Any actions associated with the new state are
then executed.
When you update an existing alarm, its state is left unchanged, but the
update completely overwrites the previous configuration of the alarm.
If you are an IAM user, you must have Amazon EC2 permissions for some
alarm operations:
=over
=item *
The C for all alarms with EC2 actions
=item *
The C to create an alarm with Systems
Manager OpsItem actions.
=back
The first time you create an alarm in the AWS Management Console, the
CLI, or by using the PutMetricAlarm API, CloudWatch creates the
necessary service-linked role for you. The service-linked roles are
called C and
C. For more information,
see AWS service-linked role
(https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role).
=head2 PutMetricData
=over
=item MetricData => ArrayRef[L]
=item Namespace => Str
=back
Each argument is described in detail in: L
Returns: nothing
Publishes metric data points to Amazon CloudWatch. CloudWatch
associates the data points with the specified metric. If the specified
metric does not exist, CloudWatch creates the metric. When CloudWatch
creates a metric, it can take up to fifteen minutes for the metric to
appear in calls to ListMetrics
(https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html).
You can publish either individual data points in the C field, or
arrays of values and the number of times each value occurred during the
period by using the C and C fields in the
C structure. Using the C and C method
enables you to publish up to 150 values per metric with one
C request, and supports retrieving percentile statistics
on this data.
Each C request is limited to 40 KB in size for HTTP POST
requests. You can send a payload compressed by gzip. Each request is
also limited to no more than 20 different metrics.
Although the C parameter accepts numbers of type C,
CloudWatch rejects values that are either too small or too large.
Values must be in the range of -2^360 to 2^360. In addition, special
values (for example, NaN, +Infinity, -Infinity) are not supported.
You can use up to 10 dimensions per metric to further clarify what data
the metric collects. Each dimension consists of a Name and Value pair.
For more information about specifying dimensions, see Publishing
Metrics
(https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html)
in the I.
You specify the time stamp to be associated with each data point. You
can specify time stamps that are as much as two weeks before the
current date, and as much as 2 hours after the current day and time.
Data points with time stamps from 24 hours ago or longer can take at
least 48 hours to become available for GetMetricData
(https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html)
or GetMetricStatistics
(https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html)
from the time they are submitted. Data points with time stamps between
3 and 24 hours ago can take as much as 2 hours to become available for
for GetMetricData
(https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html)
or GetMetricStatistics
(https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html).
CloudWatch needs raw data points to calculate percentile statistics. If
you publish data using a statistic set instead, you can only retrieve
percentile statistics for this data if one of the following conditions
is true:
=over
=item *
The C value of the statistic set is 1 and C, C,
and C are all equal.
=item *
The C and C are equal, and C is equal to C
multiplied by C.
=back
=head2 PutMetricStream
=over
=item FirehoseArn => Str
=item Name => Str
=item OutputFormat => Str
=item RoleArn => Str
=item [ExcludeFilters => ArrayRef[L]]
=item [IncludeFilters => ArrayRef[L]]
=item [Tags => ArrayRef[L]]
=back
Each argument is described in detail in: L
Returns: a L instance
Creates or updates a metric stream. Metric streams can automatically
stream CloudWatch metrics to AWS destinations including Amazon S3 and
to many third-party solutions.
For more information, see Using Metric Streams
(https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Metric-Streams.html).
To create a metric stream, you must be logged on to an account that has
the C permission and either the C
policy or the C permission.
When you create or update a metric stream, you choose one of the
following:
=over
=item *
Stream metrics from all metric namespaces in the account.
=item *
Stream metrics from all metric namespaces in the account, except for
the namespaces that you list in C.
=item *
Stream metrics from only the metric namespaces that you list in
C.
=back
When you use C to create a new metric stream, the
stream is created in the C state. If you use it to update an
existing stream, the state of the stream is not changed.
=head2 SetAlarmState
=over
=item AlarmName => Str
=item StateReason => Str
=item StateValue => Str
=item [StateReasonData => Str]
=back
Each argument is described in detail in: L
Returns: nothing
Temporarily sets the state of an alarm for testing purposes. When the
updated state differs from the previous value, the action configured
for the appropriate state is invoked. For example, if your alarm is
configured to send an Amazon SNS message when an alarm is triggered,
temporarily changing the alarm state to C sends an SNS message.
Metric alarms returns to their actual state quickly, often within
seconds. Because the metric alarm state change happens quickly, it is
typically only visible in the alarm's B tab in the Amazon
CloudWatch console or through DescribeAlarmHistory
(https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarmHistory.html).
If you use C on a composite alarm, the composite alarm
is not guaranteed to return to its actual state. It returns to its
actual state only once any of its children alarms change state. It is
also reevaluated if you update its configuration.
If an alarm triggers EC2 Auto Scaling policies or application Auto
Scaling policies, you must include information in the
C parameter to enable the policy to take the correct
action.
=head2 StartMetricStreams
=over
=item Names => ArrayRef[Str|Undef]
=back
Each argument is described in detail in: L
Returns: a L instance
Starts the streaming of metrics for one or more of your metric streams.
=head2 StopMetricStreams
=over
=item Names => ArrayRef[Str|Undef]
=back
Each argument is described in detail in: L
Returns: a L instance
Stops the streaming of metrics for one or more of your metric streams.
=head2 TagResource
=over
=item ResourceARN => Str
=item Tags => ArrayRef[L]
=back
Each argument is described in detail in: L
Returns: a L instance
Assigns one or more tags (key-value pairs) to the specified CloudWatch
resource. Currently, the only CloudWatch resources that can be tagged
are alarms and Contributor Insights rules.
Tags can help you organize and categorize your resources. You can also
use them to scope user permissions by granting a user permission to
access or change only resources with certain tag values.
Tags don't have any semantic meaning to AWS and are interpreted
strictly as strings of characters.
You can use the C action with an alarm that already has
tags. If you specify a new tag key for the alarm, this tag is appended
to the list of tags associated with the alarm. If you specify a tag key
that is already associated with the alarm, the new tag value that you
specify replaces the previous value for that tag.
You can associate as many as 50 tags with a CloudWatch resource.
=head2 UntagResource
=over
=item ResourceARN => Str
=item TagKeys => ArrayRef[Str|Undef]
=back
Each argument is described in detail in: L
Returns: a L instance
Removes one or more tags from the specified resource.
=head1 PAGINATORS
Paginator methods are helpers that repetively call methods that return partial results
=head2 DescribeAllAlarmHistory(sub { },[AlarmName => Str, AlarmTypes => ArrayRef[Str|Undef], EndDate => Str, HistoryItemType => Str, MaxRecords => Int, NextToken => Str, ScanBy => Str, StartDate => Str])
=head2 DescribeAllAlarmHistory([AlarmName => Str, AlarmTypes => ArrayRef[Str|Undef], EndDate => Str, HistoryItemType => Str, MaxRecords => Int, NextToken => Str, ScanBy => Str, StartDate => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- AlarmHistoryItems, passing the object as the first parameter, and the string 'AlarmHistoryItems' as the second parameter
If not, it will return a a L instance with all the Cs; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
=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])
=head2 DescribeAllAlarms([ActionPrefix => Str, AlarmNamePrefix => Str, AlarmNames => ArrayRef[Str|Undef], AlarmTypes => ArrayRef[Str|Undef], ChildrenOfAlarmName => Str, MaxRecords => Int, NextToken => Str, ParentsOfAlarmName => Str, StateValue => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- MetricAlarms, passing the object as the first parameter, and the string 'MetricAlarms' as the second parameter
- CompositeAlarms, passing the object as the first parameter, and the string 'CompositeAlarms' as the second parameter
If not, it will return a a L instance with all the Cs; andCs; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
=head2 GetAllMetricData(sub { },EndTime => Str, MetricDataQueries => ArrayRef[L], StartTime => Str, [LabelOptions => L, MaxDatapoints => Int, NextToken => Str, ScanBy => Str])
=head2 GetAllMetricData(EndTime => Str, MetricDataQueries => ArrayRef[L], StartTime => Str, [LabelOptions => L, MaxDatapoints => Int, NextToken => Str, ScanBy => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- MetricDataResults, passing the object as the first parameter, and the string 'MetricDataResults' as the second parameter
- Messages, passing the object as the first parameter, and the string 'Messages' as the second parameter
If not, it will return a a L instance with all the Cs; andCs; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
=head2 ListAllDashboards(sub { },[DashboardNamePrefix => Str, NextToken => Str])
=head2 ListAllDashboards([DashboardNamePrefix => Str, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- DashboardEntries, passing the object as the first parameter, and the string 'DashboardEntries' as the second parameter
If not, it will return a a L instance with all the Cs; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
=head2 ListAllMetrics(sub { },[Dimensions => ArrayRef[L], MetricName => Str, Namespace => Str, NextToken => Str, RecentlyActive => Str])
=head2 ListAllMetrics([Dimensions => ArrayRef[L], MetricName => Str, Namespace => Str, NextToken => Str, RecentlyActive => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- Metrics, passing the object as the first parameter, and the string 'Metrics' as the second parameter
If not, it will return a a L instance with all the Cs; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
=head1 SEE ALSO
This service class forms part of L
=head1 BUGS and CONTRIBUTIONS
The source code is located here: L
Please report bugs to: L
=cut