ListMetrics
List the specified metrics. You can use the returned metrics with GetMetricData or 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 15 minutes before the metric appears. You can see statistics about the metric sooner by using GetMetricData or GetMetricStatistics.
ListMetrics
doesn't return information about metrics if those metrics haven't
reported data in the past two weeks. To retrieve those metrics, use
GetMetricData or
GetMetricStatistics.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- Dimensions.member.N
-
The dimensions to filter against. Only the dimensions that match exactly will be returned.
Type: Array of DimensionFilter objects
Array Members: Maximum number of 10 items.
Required: No
- MetricName
-
The name of the metric to filter against. Only the metrics with names that match exactly will be returned.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No
- Namespace
-
The metric namespace to filter against. Only the namespace that matches exactly will be returned.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[^:].*
Required: No
- NextToken
-
The token returned by a previous call to indicate that there is more data available.
Type: String
Required: No
- RecentlyActive
-
To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of
PT3H
. This is the only valid value for this parameter.The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.
Type: String
Valid Values:
PT3H
Required: No
Response Elements
The following elements are returned by the service.
- Metrics.member.N
-
The metrics that match your request.
Type: Array of Metric objects
- NextToken
-
The token that marks the start of the next batch of returned results.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceError
-
Request processing has failed due to some unknown error, exception, or failure.
HTTP Status Code: 500
- InvalidParameterValue
-
The value of an input parameter is bad or out-of-range.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: