AmazonCloudWatchClient.ListMetrics Method (ListMetricsRequest)

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to ListMetricsAsync.

Namespace: Amazon.CloudWatch
Assembly: AWSSDK.CloudWatch.dll
Version: 3.x.y.z

Syntax

public virtual ListMetricsResponse ListMetrics(
         ListMetricsRequest request
)

Parameters

request: Type: Amazon.CloudWatch.Model.ListMetricsRequest

Container for the necessary parameters to execute the ListMetrics service method.

Return Value

Type: ListMetricsResponse

The response from the ListMetrics service method, as returned by CloudWatch.

Exceptions

Exception	Condition
InternalServiceException	Request processing has failed due to some unknown error, exception, or failure.
InvalidParameterValueException	The value of an input parameter is bad or out-of-range.

Examples

This example shows how to list a set of metrics.

List metrics example

var client = new AmazonCloudWatchClient();

var filter = new DimensionFilter
{
  Name = "InstanceType",
  Value = "t1.micro"
};

var request = new ListMetricsRequest
{
  Dimensions = new List<DimensionFilter>() { filter },
  MetricName = "CPUUtilization",
  Namespace = "AWS/EC2"
};

var response = new ListMetricsResponse();

do
{
  response = client.ListMetrics(request);

  if (response.Metrics.Count > 0)
  {
    foreach (var metric in response.Metrics)
    {
      Console.WriteLine(metric.MetricName +
        " (" + metric.Namespace + ")");

      foreach (var dimension in metric.Dimensions)
      {
        Console.WriteLine("  " + dimension.Name + ": "
          + dimension.Value);
      }
    }
  }
  else
  {
    Console.WriteLine("No metrics found.");
  }

  request.NextToken = response.NextToken;

} while (!string.IsNullOrEmpty(response.NextToken));

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

AmazonCloudWatchClient.ListMetrics (ListMetricsRequest)

Method