AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

List the specified metrics. You can use the returned metrics with 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 GetMetricStatistics.

Note:

For PCL 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

C#
public abstract ListMetricsResponse ListMetrics(
         ListMetricsRequest request
)
Parameters
request
Type: Amazon.CloudWatch.Model.ListMetricsRequest

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

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

Exceptions

ExceptionCondition
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() { 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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also