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 fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using 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.
Type: Array of DimensionFilter objects
Array Members: Maximum number of 10 items.
Required: No
- MetricName
-
The name of the metric to filter against.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No
- Namespace
-
The namespace to filter against.
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
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
Response Elements
The following elements are returned by the service.
- Metrics.member.N
-
The metrics.
Type: Array of Metric objects
- NextToken
-
The token that marks the start of the next batch of returned results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
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:
