NAME
Paws::CloudWatch::MetricStat
USAGE
This class represents one of two things:
Arguments in a call to a service
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::CloudWatch::MetricStat object:
$service_obj->Method(Att1 => { Metric => $value, ..., Unit => $value });
Results returned from an API call
Use accessors for each attribute. If Att1 is expected to be an Paws::CloudWatch::MetricStat object:
$result = $service_obj->Method(...);
$result->Att1->Metric
DESCRIPTION
This structure defines the metric to be returned, along with the statistics, period, and units.
ATTRIBUTES
REQUIRED Metric => Paws::CloudWatch::Metric
The metric to return, including the metric name, namespace, and dimensions.
REQUIRED Period => Int
The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData
call that includes a StorageResolution
of 1 second.
If the StartTime
parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
REQUIRED Stat => Str
The statistic to return. It can include any CloudWatch statistic or extended statistic.
Unit => Str
When you are using a Put
operation, this defines what unit you want to use when storing the metric.
In a Get
operation, if you omit Unit
then 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.
SEE ALSO
This class forms part of Paws, describing an object used in Paws::CloudWatch
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues