| Copyright | (c) 2013-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.CloudWatch.GetMetricStatistics
Description
Gets statistics for the specified metric.
The maximum number of data points that can be queried is 50,850, whereas
the maximum number of data points returned from a single
GetMetricStatistics request is 1,440. If you make a request that
generates more than 1,440 data points, Amazon CloudWatch returns an
error. In such a case, you can alter the request by narrowing the
specified time range or increasing the specified period. Alternatively,
you can make multiple requests across adjacent time ranges.
GetMetricStatistics does not return the data in chronological order.
Amazon CloudWatch aggregates data points based on the length of the
period that you specify. For example, if you request statistics with a
one-minute granularity, Amazon CloudWatch aggregates data points with
time stamps that fall within the same one-minute period. In such a case,
the data points queried can greatly outnumber the data points returned.
The following examples show various statistics allowed by the data point
query maximum of 50,850 when you call GetMetricStatistics on Amazon
EC2 instances with detailed (one-minute) monitoring enabled:
- Statistics for up to 400 instances for a span of one hour
- Statistics for up to 35 instances over a span of 24 hours
- Statistics for up to 2 instances over a span of 2 weeks
For information about the namespace, metric names, and dimensions that other Amazon Web Services products use to send metrics to CloudWatch, go to Amazon CloudWatch Metrics, Namespaces, and Dimensions Reference in the Amazon CloudWatch Developer Guide.
- getMetricStatistics :: Text -> Text -> UTCTime -> UTCTime -> Natural -> NonEmpty Statistic -> GetMetricStatistics
- data GetMetricStatistics
- gmsDimensions :: Lens' GetMetricStatistics [Dimension]
- gmsUnit :: Lens' GetMetricStatistics (Maybe StandardUnit)
- gmsNamespace :: Lens' GetMetricStatistics Text
- gmsMetricName :: Lens' GetMetricStatistics Text
- gmsStartTime :: Lens' GetMetricStatistics UTCTime
- gmsEndTime :: Lens' GetMetricStatistics UTCTime
- gmsPeriod :: Lens' GetMetricStatistics Natural
- gmsStatistics :: Lens' GetMetricStatistics (NonEmpty Statistic)
- getMetricStatisticsResponse :: Int -> GetMetricStatisticsResponse
- data GetMetricStatisticsResponse
- gmsrsDatapoints :: Lens' GetMetricStatisticsResponse [Datapoint]
- gmsrsLabel :: Lens' GetMetricStatisticsResponse (Maybe Text)
- gmsrsResponseStatus :: Lens' GetMetricStatisticsResponse Int
Creating a Request
Creates a value of GetMetricStatistics with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data GetMetricStatistics Source
See: getMetricStatistics smart constructor.
Instances
Request Lenses
gmsDimensions :: Lens' GetMetricStatistics [Dimension] Source
A list of dimensions describing qualities of the metric.
gmsUnit :: Lens' GetMetricStatistics (Maybe StandardUnit) Source
The unit for the metric.
gmsNamespace :: Lens' GetMetricStatistics Text Source
The namespace of the metric, with or without spaces.
gmsMetricName :: Lens' GetMetricStatistics Text Source
The name of the metric, with or without spaces.
gmsStartTime :: Lens' GetMetricStatistics UTCTime Source
The time stamp to use for determining the first datapoint to return. The value specified is inclusive; results include datapoints with the time stamp specified. The time stamp must be in ISO 8601 UTC format (e.g., 2014-09-03T23:00:00Z).
The specified start time is rounded down to the nearest value. Datapoints are returned for start times up to two weeks in the past. Specified start times that are more than two weeks in the past will not return datapoints for metrics that are older than two weeks.
Data that is timestamped 24 hours or more in the past may take in excess
of 48 hours to become available from submission time using
GetMetricStatistics.
gmsEndTime :: Lens' GetMetricStatistics UTCTime Source
The time stamp to use for determining the last datapoint to return. The value specified is exclusive; results will include datapoints up to the time stamp specified. The time stamp must be in ISO 8601 UTC format (e.g., 2014-09-03T23:00:00Z).
gmsPeriod :: Lens' GetMetricStatistics Natural Source
The granularity, in seconds, of the returned datapoints. Period must
be at least 60 seconds and must be a multiple of 60. The default value
is 60.
gmsStatistics :: Lens' GetMetricStatistics (NonEmpty Statistic) Source
The metric statistics to return. For information about specific statistics returned by GetMetricStatistics, see Statistics in the Amazon CloudWatch Developer Guide.
Destructuring the Response
getMetricStatisticsResponse Source
Arguments
| :: Int | |
| -> GetMetricStatisticsResponse |
Creates a value of GetMetricStatisticsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data GetMetricStatisticsResponse Source
The output for the GetMetricStatistics action.
See: getMetricStatisticsResponse smart constructor.
Response Lenses
gmsrsDatapoints :: Lens' GetMetricStatisticsResponse [Datapoint] Source
The datapoints for the specified metric.
gmsrsLabel :: Lens' GetMetricStatisticsResponse (Maybe Text) Source
A label describing the specified metric.
gmsrsResponseStatus :: Lens' GetMetricStatisticsResponse Int Source
The response status code.