| 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.ListMetrics
Description
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 the PutMetricData action, allow up to
fifteen minutes for the metric to appear in calls to the ListMetrics
action. Statistics about the metric, however, are available sooner using
GetMetricStatistics.
This operation returns paginated results.
- listMetrics :: ListMetrics
- data ListMetrics
- lmMetricName :: Lens' ListMetrics (Maybe Text)
- lmNamespace :: Lens' ListMetrics (Maybe Text)
- lmNextToken :: Lens' ListMetrics (Maybe Text)
- lmDimensions :: Lens' ListMetrics [DimensionFilter]
- listMetricsResponse :: Int -> ListMetricsResponse
- data ListMetricsResponse
- lmrsMetrics :: Lens' ListMetricsResponse [Metric]
- lmrsNextToken :: Lens' ListMetricsResponse (Maybe Text)
- lmrsResponseStatus :: Lens' ListMetricsResponse Int
Creating a Request
listMetrics :: ListMetrics Source
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:
data ListMetrics Source
See: listMetrics smart constructor.
Instances
Request Lenses
lmMetricName :: Lens' ListMetrics (Maybe Text) Source
The name of the metric to filter against.
lmNamespace :: Lens' ListMetrics (Maybe Text) Source
The namespace to filter against.
lmNextToken :: Lens' ListMetrics (Maybe Text) Source
The token returned by a previous call to indicate that there is more data available.
lmDimensions :: Lens' ListMetrics [DimensionFilter] Source
A list of dimensions to filter against.
Destructuring the Response
Arguments
| :: Int | |
| -> 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:
data ListMetricsResponse Source
The output for the ListMetrics action.
See: listMetricsResponse smart constructor.
Response Lenses
lmrsMetrics :: Lens' ListMetricsResponse [Metric] Source
A list of metrics used to generate statistics for an AWS account.
lmrsNextToken :: Lens' ListMetricsResponse (Maybe Text) Source
A string that marks the start of the next batch of returned results.
lmrsResponseStatus :: Lens' ListMetricsResponse Int Source
The response status code.