NAME
Paws::CloudWatch::GetMetricData - Arguments for method GetMetricData on Paws::CloudWatch
DESCRIPTION
This class represents the parameters used for calling the method GetMetricData on the Amazon CloudWatch service. Use the attributes of this class as arguments to method GetMetricData.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetMetricData.
SYNOPSIS
my $monitoring = Paws->service('CloudWatch');
my $GetMetricDataOutput = $monitoring->GetMetricData(
EndTime => '1970-01-01T01:00:00',
MetricDataQueries => [
{
Id => 'MyMetricId', # min: 1, max: 255
Expression => 'MyMetricExpression', # min: 1, max: 1024; OPTIONAL
Label => 'MyMetricLabel', # OPTIONAL
MetricStat => {
Metric => {
Dimensions => [
{
Name => 'MyDimensionName', # min: 1, max: 255
Value => 'MyDimensionValue', # min: 1, max: 255
},
...
], # max: 10; OPTIONAL
MetricName => 'MyMetricName', # min: 1, max: 255; OPTIONAL
Namespace => 'MyNamespace', # min: 1, max: 255; OPTIONAL
},
Period => 1, # min: 1
Stat => 'MyStat',
Unit => 'Seconds'
, # values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None; OPTIONAL
}, # OPTIONAL
Period => 1, # min: 1
ReturnData => 1, # OPTIONAL
},
...
],
StartTime => '1970-01-01T01:00:00',
LabelOptions => {
Timezone => 'MyGetMetricDataLabelTimezone', # OPTIONAL
}, # OPTIONAL
MaxDatapoints => 1, # OPTIONAL
NextToken => 'MyNextToken', # OPTIONAL
ScanBy => 'TimestampDescending', # OPTIONAL
);
# Results:
my $Messages = $GetMetricDataOutput->Messages;
my $MetricDataResults = $GetMetricDataOutput->MetricDataResults;
my $NextToken = $GetMetricDataOutput->NextToken;
# Returns a L<Paws::CloudWatch::GetMetricDataOutput> object.Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/monitoring/GetMetricData
ATTRIBUTES
REQUIRED EndTime => Str
The time stamp indicating the latest data to be returned.
The value specified is exclusive; results include data points up to the specified time stamp.
For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as EndTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the EndTime.
LabelOptions => Paws::CloudWatch::LabelOptions
This structure includes the Timezone parameter, which you can use to specify your time zone so that the labels of returned data display the correct time for your time zone.
MaxDatapoints => Int
The maximum number of data points the request should return before paginating. If you omit this, the default of 100,800 is used.
REQUIRED MetricDataQueries => ArrayRef[Paws::CloudWatch::MetricDataQuery]
The metric queries to be returned. A single GetMetricData call can include as many as 500 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.
NextToken => Str
Include this value, if it was returned by the previous GetMetricData operation, to get the next set of data points.
ScanBy => Str
The order in which data points should be returned. TimestampDescending returns the newest data first and paginates when the MaxDatapoints limit is reached. TimestampAscending returns the oldest data first and paginates when the MaxDatapoints limit is reached.
Valid values are: "TimestampDescending", "TimestampAscending"
REQUIRED StartTime => Str
The time stamp indicating the earliest data to be returned.
The value specified is inclusive; results include data points with the specified time stamp.
CloudWatch rounds the specified time stamp as follows:
Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.
Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.
Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.
If you set Period to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.
For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the StartTime.
SEE ALSO
This class forms part of Paws, documenting arguments for method GetMetricData 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