ListMetricsRequest Class | AWS SDK for .NET V2

Container for the parameters to the ListMetrics operation. Returns a list of valid metrics stored for the AWS account owner. Returned metrics can be used with GetMetricStatistics to obtain statistical data for a given metric. Up to 500 results are returned for any one call. To retrieve further results, use returned NextToken values with subsequent ListMetrics operations. If you create a metric with the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action. 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.dll
Version: (assembly version)

Syntax

public class ListMetricsRequest : AmazonCloudWatchRequest
         IRequestEvents

The ListMetricsRequest type exposes the following members

Constructors

	Name	Description
	ListMetricsRequest()

Properties

Name	Type	Description
Dimensions	System.Collections.Generic.List<Amazon.CloudWatch.Model.DimensionFilter>	Gets and sets the property Dimensions. A list of dimensions to filter against.
MetricName	System.String	Gets and sets the property MetricName. The name of the metric to filter against.
Namespace	System.String	Gets and sets the property Namespace. The namespace to filter against.
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<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

.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8

.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8