Network.AWS.CloudWatch.ListMetrics

Returns a list of valid metrics stored for the AWS account owner. Returned metrics can be used with GetMetricStatistics to obtain statistical data for a given metric.

Up to 500 results are returned for any one call. To retrieve further results, use returned NextToken values with subsequent ListMetrics operations.

If you create a metric with PutMetricData, allow up to fifteen minutes for the metric to appear in calls to ListMetrics. Statistics about the metric, however, are available sooner using GetMetricStatistics.

This operation returns paginated results.

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
• lmNamespace
• lmNextToken
• lmDimensions

data ListMetrics

Describes the inputs for ListMetrics.

See: listMetrics smart constructor.

Instances

Eq ListMetrics

Methods

(==) :: ListMetrics -> ListMetrics -> Bool

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

Data 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

Methods

readsPrec :: Int -> ReadS ListMetrics

readList :: ReadS [ListMetrics]

readPrec :: ReadPrec ListMetrics

readListPrec :: ReadPrec [ListMetrics]

Show ListMetrics

Methods

showsPrec :: Int -> ListMetrics -> ShowS

show :: ListMetrics -> String

showList :: [ListMetrics] -> ShowS

Generic ListMetrics

Associated Types

type Rep ListMetrics :: * -> *

Methods

from :: ListMetrics -> Rep ListMetrics x

to :: Rep ListMetrics x -> ListMetrics

Hashable ListMetrics

Methods

hashWithSalt :: Int -> ListMetrics -> Int

hash :: ListMetrics -> Int

NFData ListMetrics

Methods

rnf :: ListMetrics -> ()

AWSPager ListMetrics

Methods

page :: ListMetrics -> Rs ListMetrics -> Maybe ListMetrics

AWSRequest ListMetrics

Associated Types

type Rs ListMetrics :: *

Methods

request :: ListMetrics -> Request ListMetrics

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

ToPath ListMetrics

Methods

toPath :: ListMetrics -> ByteString

ToHeaders ListMetrics

Methods

toHeaders :: ListMetrics -> [Header]

ToQuery ListMetrics

Methods

toQuery :: ListMetrics -> QueryString

type Rep ListMetrics

type Rep ListMetrics = D1 (MetaData "ListMetrics" "Network.AWS.CloudWatch.ListMetrics" "amazonka-cloudwatch-1.4.4-5PvRRv2XeI7H4fkMIKBqZw" False) (C1 (MetaCons "ListMetrics'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lmMetricName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lmNamespace") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_lmNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lmDimensions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [DimensionFilter]))))))

type Rs 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]

A list of 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
• lmrsNextToken
• lmrsResponseStatus

data ListMetricsResponse

The output for ListMetrics.

See: listMetricsResponse smart constructor.

Instances

Eq ListMetricsResponse

Methods

(==) :: ListMetricsResponse -> ListMetricsResponse -> Bool

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

Data ListMetricsResponse

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

Methods

readsPrec :: Int -> ReadS ListMetricsResponse

readList :: ReadS [ListMetricsResponse]

readPrec :: ReadPrec ListMetricsResponse

readListPrec :: ReadPrec [ListMetricsResponse]

Show ListMetricsResponse

Methods

showsPrec :: Int -> ListMetricsResponse -> ShowS

show :: ListMetricsResponse -> String

showList :: [ListMetricsResponse] -> ShowS

Generic ListMetricsResponse

Associated Types

type Rep ListMetricsResponse :: * -> *

Methods

from :: ListMetricsResponse -> Rep ListMetricsResponse x

to :: Rep ListMetricsResponse x -> ListMetricsResponse

NFData ListMetricsResponse

Methods

rnf :: ListMetricsResponse -> ()

type Rep ListMetricsResponse

type Rep ListMetricsResponse = D1 (MetaData "ListMetricsResponse" "Network.AWS.CloudWatch.ListMetrics" "amazonka-cloudwatch-1.4.4-5PvRRv2XeI7H4fkMIKBqZw" False) (C1 (MetaCons "ListMetricsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lmrsMetrics") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Metric]))) ((:*:) (S1 (MetaSel (Just Symbol "_lmrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lmrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

lmrsMetrics :: Lens' ListMetricsResponse [Metric]

A list of metrics used to generate statistics for an AWS account.

lmrsNextToken :: Lens' ListMetricsResponse (Maybe Text)

A string that marks the start of the next batch of returned results.

lmrsResponseStatus :: Lens' ListMetricsResponse Int

The response status code.