Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.CloudWatch.ListMetrics

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

List the specified metrics. You can use the returned metrics with GetMetricStatistics 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 fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using GetMetricStatistics .

This operation returns paginated results.

Synopsis

Creating a Request

listMetrics :: ListMetrics #

Creates a value of ListMetrics with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lmMetricName - The name of the metric to filter against.
lmNamespace - The namespace to filter against.
lmNextToken - The token returned by a previous call to indicate that there is more data available.
lmDimensions - The dimensions to filter against.

data ListMetrics #

See: listMetrics smart constructor.

Instances

Eq ListMetrics #
Instance details Defined in Network.AWS.CloudWatch.ListMetrics Methods (==) :: ListMetrics -> ListMetrics -> Bool # (/=) :: ListMetrics -> ListMetrics -> Bool #
Data ListMetrics #
Instance details Defined in Network.AWS.CloudWatch.ListMetrics Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListMetrics -> c ListMetrics # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListMetrics # toConstr :: ListMetrics -> Constr # dataTypeOf :: ListMetrics -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListMetrics) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListMetrics) # gmapT :: (forall b. Data b => b -> b) -> ListMetrics -> ListMetrics # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListMetrics -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListMetrics -> r # gmapQ :: (forall d. Data d => d -> u) -> ListMetrics -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListMetrics -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListMetrics -> m ListMetrics # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListMetrics -> m ListMetrics # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListMetrics -> m ListMetrics #
Read ListMetrics #
Instance details Defined in Network.AWS.CloudWatch.ListMetrics Methods readsPrec :: Int -> ReadS ListMetrics # readList :: ReadS [ListMetrics] # readPrec :: ReadPrec ListMetrics # readListPrec :: ReadPrec [ListMetrics] #
Show ListMetrics #
Instance details Defined in Network.AWS.CloudWatch.ListMetrics Methods showsPrec :: Int -> ListMetrics -> ShowS # show :: ListMetrics -> String # showList :: [ListMetrics] -> ShowS #
Generic ListMetrics #
Instance details Defined in Network.AWS.CloudWatch.ListMetrics Associated Types type Rep ListMetrics :: * -> * # Methods from :: ListMetrics -> Rep ListMetrics x # to :: Rep ListMetrics x -> ListMetrics #
Hashable ListMetrics #
Instance details Defined in Network.AWS.CloudWatch.ListMetrics Methods hashWithSalt :: Int -> ListMetrics -> Int # hash :: ListMetrics -> Int #
AWSPager ListMetrics #
Instance details Defined in Network.AWS.CloudWatch.ListMetrics Methods page :: ListMetrics -> Rs ListMetrics -> Maybe ListMetrics #
AWSRequest ListMetrics #
Instance details Defined in Network.AWS.CloudWatch.ListMetrics Associated Types type Rs ListMetrics :: * # Methods request :: ListMetrics -> Request ListMetrics # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ListMetrics -> ClientResponse -> m (Response ListMetrics) #
ToHeaders ListMetrics #
Instance details Defined in Network.AWS.CloudWatch.ListMetrics Methods toHeaders :: ListMetrics -> [Header] #
ToPath ListMetrics #
Instance details Defined in Network.AWS.CloudWatch.ListMetrics Methods toPath :: ListMetrics -> ByteString #
ToQuery ListMetrics #
Instance details Defined in Network.AWS.CloudWatch.ListMetrics Methods toQuery :: ListMetrics -> QueryString #
NFData ListMetrics #
Instance details Defined in Network.AWS.CloudWatch.ListMetrics Methods rnf :: ListMetrics -> () #
type Rep ListMetrics #
Instance details Defined in Network.AWS.CloudWatch.ListMetrics type Rep ListMetrics = D1 (MetaData "ListMetrics" "Network.AWS.CloudWatch.ListMetrics" "amazonka-cloudwatch-1.6.0-4goVJMNohH294KWKzR9Wr2" False) (C1 (MetaCons "ListMetrics'" PrefixI True) ((S1 (MetaSel (Just "_lmMetricName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_lmNamespace") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_lmNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lmDimensions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [DimensionFilter])))))
type Rs ListMetrics #
Instance details Defined in Network.AWS.CloudWatch.ListMetrics type Rs ListMetrics = ListMetricsResponse

Request Lenses

lmMetricName :: Lens' ListMetrics (Maybe Text) #

The name of the metric to filter against.

lmNamespace :: Lens' ListMetrics (Maybe Text) #

The namespace to filter against.

lmNextToken :: Lens' ListMetrics (Maybe Text) #

The token returned by a previous call to indicate that there is more data available.

lmDimensions :: Lens' ListMetrics [DimensionFilter] #

The dimensions to filter against.

Destructuring the Response

listMetricsResponse #

Arguments

:: Int	`lmrsResponseStatus`
-> ListMetricsResponse

Creates a value of ListMetricsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lmrsMetrics - The metrics.
lmrsNextToken - The token that marks the start of the next batch of returned results.
lmrsResponseStatus - -- | The response status code.

data ListMetricsResponse #

See: listMetricsResponse smart constructor.

Instances

Eq ListMetricsResponse #
Instance details Defined in Network.AWS.CloudWatch.ListMetrics Methods (==) :: ListMetricsResponse -> ListMetricsResponse -> Bool # (/=) :: ListMetricsResponse -> ListMetricsResponse -> Bool #
Data ListMetricsResponse #
Instance details Defined in Network.AWS.CloudWatch.ListMetrics Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListMetricsResponse -> c ListMetricsResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListMetricsResponse # toConstr :: ListMetricsResponse -> Constr # dataTypeOf :: ListMetricsResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListMetricsResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListMetricsResponse) # gmapT :: (forall b. Data b => b -> b) -> ListMetricsResponse -> ListMetricsResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListMetricsResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListMetricsResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> ListMetricsResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListMetricsResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListMetricsResponse -> m ListMetricsResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListMetricsResponse -> m ListMetricsResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListMetricsResponse -> m ListMetricsResponse #
Read ListMetricsResponse #
Instance details Defined in Network.AWS.CloudWatch.ListMetrics Methods readsPrec :: Int -> ReadS ListMetricsResponse # readList :: ReadS [ListMetricsResponse] # readPrec :: ReadPrec ListMetricsResponse # readListPrec :: ReadPrec [ListMetricsResponse] #
Show ListMetricsResponse #
Instance details Defined in Network.AWS.CloudWatch.ListMetrics Methods showsPrec :: Int -> ListMetricsResponse -> ShowS # show :: ListMetricsResponse -> String # showList :: [ListMetricsResponse] -> ShowS #
Generic ListMetricsResponse #
Instance details Defined in Network.AWS.CloudWatch.ListMetrics Associated Types type Rep ListMetricsResponse :: * -> * # Methods from :: ListMetricsResponse -> Rep ListMetricsResponse x # to :: Rep ListMetricsResponse x -> ListMetricsResponse #
NFData ListMetricsResponse #
Instance details Defined in Network.AWS.CloudWatch.ListMetrics Methods rnf :: ListMetricsResponse -> () #
type Rep ListMetricsResponse #
Instance details Defined in Network.AWS.CloudWatch.ListMetrics type Rep ListMetricsResponse = D1 (MetaData "ListMetricsResponse" "Network.AWS.CloudWatch.ListMetrics" "amazonka-cloudwatch-1.6.0-4goVJMNohH294KWKzR9Wr2" False) (C1 (MetaCons "ListMetricsResponse'" PrefixI True) (S1 (MetaSel (Just "_lmrsMetrics") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Metric])) :: (S1 (MetaSel (Just "_lmrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_lmrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

lmrsMetrics :: Lens' ListMetricsResponse [Metric] #

The metrics.

lmrsNextToken :: Lens' ListMetricsResponse (Maybe Text) #

The token that marks the start of the next batch of returned results.

lmrsResponseStatus :: Lens' ListMetricsResponse Int #

- | The response status code.