Request Parameters Response Elements Errors Examples See Also

ListMetrics

List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to get 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 for the metric to appear. To see metric statistics sooner, use GetMetricData or GetMetricStatistics.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view metrics from the linked source accounts. For more information, see CloudWatch cross-account observability.

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

IncludeLinkedAccounts

If you are using this operation in a monitoring account, specify true to include metrics from source accounts in the returned data.

The default is false.

Type: Boolean

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

OwningAccount

When you use this operation in a monitoring account, use this field to return metrics only from one source account. To do so, specify that source account ID in this field, and also specify true for IncludeLinkedAccounts.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

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 50 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

OwningAccounts.member.N

If you are using this operation in a monitoring account, this array contains the account IDs of the source accounts where the metrics in the returned data are from.

This field is a 1:1 mapping between each metric that is returned and the ID of the owning account.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 255.

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

Examples

List metrics in a specified namespace from all source accounts and from the monitoring account

The following example lists metrics in the AWS/EC2 namespace from the monitoring account itself and all source accounts.

Sample Request


{
  "IncludeLinkedAccounts": true,
  "Namespace" : "AWS/EC2"
}

List metrics from a namespace in just one source account

The following example lists metrics in the AWS/EC2 namespace from only the source account with the ID 111111111111.

Sample Request


{
  "IncludeLinkedAccounts": "true",
  "OwningAccount" : "111111111111",
  "Namespace" : "AWS/EC2"
}