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.

Container for the parameters to the ListMetrics operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CloudWatch.AmazonCloudWatchRequest
      Amazon.CloudWatch.Model.ListMetricsRequest

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

Syntax

C#
public class ListMetricsRequest : AmazonCloudWatchRequest
         IAmazonWebServiceRequest

The ListMetricsRequest type exposes the following members

Constructors

NameDescription
Public Method ListMetricsRequest()

Properties

NameTypeDescription
Public Property Dimensions System.Collections.Generic.List<Amazon.CloudWatch.Model.DimensionFilter>

Gets and sets the property Dimensions.

The dimensions to filter against.

Public Property MetricName System.String

Gets and sets the property MetricName.

The name of the metric to filter against.

Public Property Namespace System.String

Gets and sets the property Namespace.

The namespace to filter against.

Public Property NextToken System.String

Gets and sets the property NextToken.

The token returned by a previous call to indicate that there is more data available.

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 Standard:
Supported in: 1.3

.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