Network.AWS.CloudWatch.GetMetricStatistics

Gets statistics for the specified metric.

Amazon CloudWatch retains metric data as follows:

• Data points with a period of 60 seconds (1 minute) are available for 15 days
• Data points with a period of 300 seconds (5 minute) are available for 63 days
• Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months)

Note that CloudWatch started retaining 5-minute and 1-hour metric data as of 9 July 2016.

The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, Amazon 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. A period can be as short as one minute (60 seconds). Note that data points are not returned 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-hour period, Amazon 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.

For a list of metrics and dimensions supported by AWS services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide .

Creating a Request

getMetricStatistics

Arguments

:: Text

gmsNamespace

-> Text

gmsMetricName

-> UTCTime

gmsStartTime

-> UTCTime

gmsEndTime

-> Natural

gmsPeriod

-> GetMetricStatistics

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:

• gmsExtendedStatistics - The percentile statistics. Specify values between p0.0 and p100.
• gmsStatistics - The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistic .
• gmsDimensions - The dimensions. CloudWatch treats each unique combination of dimensions as a separate metric. You can't retrieve statistics using combinations of dimensions that were not specially published. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide .
• gmsUnit - The unit for a given metric. Metrics may be reported in multiple units. Not supplying a unit results in all units being returned. If the metric only ever reports one unit, specifying a unit has no effect.
• gmsNamespace - The namespace of the metric, with or without spaces.
• gmsMetricName - The name of the metric, with or without spaces.
• gmsStartTime - The time stamp that determines the first data point to return. Note that start times are evaluated relative to the time that CloudWatch receives the request. The value specified is inclusive; results include data points with the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z). 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.
• gmsEndTime - The time stamp that determines the last data point to return. The value specified is exclusive; results will include data points up to the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).
• gmsPeriod - The granularity, in seconds, of the returned data points. A period can be as short as one minute (60 seconds) and must be a multiple of 60. The default value is 60. If the StartTime parameter specifies a time stamp that is greater than 15 days ago, you must specify the period as follows or no data points in that time range is returned: * 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).

data GetMetricStatistics

See: getMetricStatistics smart constructor.

Instances

Eq GetMetricStatistics

Methods

(==) :: GetMetricStatistics -> GetMetricStatistics -> Bool

(/=) :: GetMetricStatistics -> GetMetricStatistics -> Bool

Data GetMetricStatistics

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetMetricStatistics -> c GetMetricStatistics

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetMetricStatistics

toConstr :: GetMetricStatistics -> Constr

dataTypeOf :: GetMetricStatistics -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetMetricStatistics)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetMetricStatistics)

gmapT :: (forall b. Data b => b -> b) -> GetMetricStatistics -> GetMetricStatistics

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetMetricStatistics -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetMetricStatistics -> r

gmapQ :: (forall d. Data d => d -> u) -> GetMetricStatistics -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetMetricStatistics -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetMetricStatistics -> m GetMetricStatistics

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetMetricStatistics -> m GetMetricStatistics

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetMetricStatistics -> m GetMetricStatistics

Read GetMetricStatistics

Methods

readsPrec :: Int -> ReadS GetMetricStatistics

readList :: ReadS [GetMetricStatistics]

readPrec :: ReadPrec GetMetricStatistics

readListPrec :: ReadPrec [GetMetricStatistics]

Show GetMetricStatistics

Methods

showsPrec :: Int -> GetMetricStatistics -> ShowS

show :: GetMetricStatistics -> String

showList :: [GetMetricStatistics] -> ShowS

Generic GetMetricStatistics

Associated Types

type Rep GetMetricStatistics :: * -> *

Methods

from :: GetMetricStatistics -> Rep GetMetricStatistics x

to :: Rep GetMetricStatistics x -> GetMetricStatistics

Hashable GetMetricStatistics

Methods

hashWithSalt :: Int -> GetMetricStatistics -> Int

hash :: GetMetricStatistics -> Int

NFData GetMetricStatistics

Methods

rnf :: GetMetricStatistics -> ()

AWSRequest GetMetricStatistics

Associated Types

type Rs GetMetricStatistics :: *

Methods

request :: GetMetricStatistics -> Request GetMetricStatistics

response :: MonadResource m => Logger -> Service -> Proxy * GetMetricStatistics -> ClientResponse -> m (Response GetMetricStatistics)

ToPath GetMetricStatistics

Methods

toPath :: GetMetricStatistics -> ByteString

ToHeaders GetMetricStatistics

Methods

toHeaders :: GetMetricStatistics -> [Header]

ToQuery GetMetricStatistics

Methods

toQuery :: GetMetricStatistics -> QueryString

type Rep GetMetricStatistics

type Rep GetMetricStatistics = D1 (MetaData "GetMetricStatistics" "Network.AWS.CloudWatch.GetMetricStatistics" "amazonka-cloudwatch-1.4.5-EKf9JeTVY7e7Vri5LpiDhT" False) (C1 (MetaCons "GetMetricStatistics'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_gmsExtendedStatistics") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (List1 Text)))) (S1 (MetaSel (Just Symbol "_gmsStatistics") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (List1 Statistic))))) ((:*:) (S1 (MetaSel (Just Symbol "_gmsDimensions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Dimension]))) (S1 (MetaSel (Just Symbol "_gmsUnit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe StandardUnit))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_gmsNamespace") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_gmsMetricName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_gmsStartTime") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 ISO8601)) ((:*:) (S1 (MetaSel (Just Symbol "_gmsEndTime") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 ISO8601)) (S1 (MetaSel (Just Symbol "_gmsPeriod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat)))))))

type Rs GetMetricStatistics

type Rs GetMetricStatistics = GetMetricStatisticsResponse

Request Lenses

gmsExtendedStatistics :: Lens' GetMetricStatistics (Maybe (NonEmpty Text))

The percentile statistics. Specify values between p0.0 and p100.

gmsStatistics :: Lens' GetMetricStatistics (Maybe (NonEmpty Statistic))

The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistic .

gmsDimensions :: Lens' GetMetricStatistics [Dimension]

The dimensions. CloudWatch treats each unique combination of dimensions as a separate metric. You can't retrieve statistics using combinations of dimensions that were not specially published. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide .

gmsUnit :: Lens' GetMetricStatistics (Maybe StandardUnit)

The unit for a given metric. Metrics may be reported in multiple units. Not supplying a unit results in all units being returned. If the metric only ever reports one unit, specifying a unit has no effect.

gmsNamespace :: Lens' GetMetricStatistics Text

The namespace of the metric, with or without spaces.

gmsMetricName :: Lens' GetMetricStatistics Text

The name of the metric, with or without spaces.

gmsStartTime :: Lens' GetMetricStatistics UTCTime

The time stamp that determines the first data point to return. Note that start times are evaluated relative to the time that CloudWatch receives the request. The value specified is inclusive; results include data points with the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z). 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.

gmsEndTime :: Lens' GetMetricStatistics UTCTime

The time stamp that determines the last data point to return. The value specified is exclusive; results will include data points up to the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).

gmsPeriod :: Lens' GetMetricStatistics Natural

The granularity, in seconds, of the returned data points. A period can be as short as one minute (60 seconds) and must be a multiple of 60. The default value is 60. If the StartTime parameter specifies a time stamp that is greater than 15 days ago, you must specify the period as follows or no data points in that time range is returned: * 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).

Destructuring the Response

getMetricStatisticsResponse

Arguments

:: Int

gmsrsResponseStatus

-> 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:

• gmsrsDatapoints - The data points for the specified metric.
• gmsrsLabel - A label for the specified metric.
• gmsrsResponseStatus - -- | The response status code.

data GetMetricStatisticsResponse

See: getMetricStatisticsResponse smart constructor.

Instances

Eq GetMetricStatisticsResponse

Methods

(==) :: GetMetricStatisticsResponse -> GetMetricStatisticsResponse -> Bool

(/=) :: GetMetricStatisticsResponse -> GetMetricStatisticsResponse -> Bool

Data GetMetricStatisticsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetMetricStatisticsResponse -> c GetMetricStatisticsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetMetricStatisticsResponse

toConstr :: GetMetricStatisticsResponse -> Constr

dataTypeOf :: GetMetricStatisticsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetMetricStatisticsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetMetricStatisticsResponse)

gmapT :: (forall b. Data b => b -> b) -> GetMetricStatisticsResponse -> GetMetricStatisticsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetMetricStatisticsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetMetricStatisticsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> GetMetricStatisticsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetMetricStatisticsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetMetricStatisticsResponse -> m GetMetricStatisticsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetMetricStatisticsResponse -> m GetMetricStatisticsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetMetricStatisticsResponse -> m GetMetricStatisticsResponse

Read GetMetricStatisticsResponse

Methods

readsPrec :: Int -> ReadS GetMetricStatisticsResponse

readList :: ReadS [GetMetricStatisticsResponse]

readPrec :: ReadPrec GetMetricStatisticsResponse

readListPrec :: ReadPrec [GetMetricStatisticsResponse]

Show GetMetricStatisticsResponse

Methods

showsPrec :: Int -> GetMetricStatisticsResponse -> ShowS

show :: GetMetricStatisticsResponse -> String

showList :: [GetMetricStatisticsResponse] -> ShowS

Generic GetMetricStatisticsResponse

Associated Types

type Rep GetMetricStatisticsResponse :: * -> *

Methods

from :: GetMetricStatisticsResponse -> Rep GetMetricStatisticsResponse x

to :: Rep GetMetricStatisticsResponse x -> GetMetricStatisticsResponse

NFData GetMetricStatisticsResponse

Methods

rnf :: GetMetricStatisticsResponse -> ()

type Rep GetMetricStatisticsResponse

type Rep GetMetricStatisticsResponse = D1 (MetaData "GetMetricStatisticsResponse" "Network.AWS.CloudWatch.GetMetricStatistics" "amazonka-cloudwatch-1.4.5-EKf9JeTVY7e7Vri5LpiDhT" False) (C1 (MetaCons "GetMetricStatisticsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gmsrsDatapoints") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Datapoint]))) ((:*:) (S1 (MetaSel (Just Symbol "_gmsrsLabel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gmsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

gmsrsDatapoints :: Lens' GetMetricStatisticsResponse [Datapoint]

The data points for the specified metric.

gmsrsLabel :: Lens' GetMetricStatisticsResponse (Maybe Text)

A label for the specified metric.

gmsrsResponseStatus :: Lens' GetMetricStatisticsResponse Int

• - | The response status code.