ListMetricsRequest Class | AWS SDK for .NET V3

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

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

public class ListMetricsRequest : AmazonCloudWatchRequest
         IAmazonWebServiceRequest

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. The dimensions to filter against. Only the dimensions that match exactly will be returned.
IncludeLinkedAccounts	System.Boolean	Gets and sets the property 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`.
MetricName	System.String	Gets and sets the property MetricName. The name of the metric to filter against. Only the metrics with names that match exactly will be returned.
Namespace	System.String	Gets and sets the property Namespace. The metric namespace to filter against. Only the namespace that matches exactly will be returned.
NextToken	System.String	Gets and sets the property NextToken. The token returned by a previous call to indicate that there is more data available.
OwningAccount	System.String	Gets and sets the property 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`.
RecentlyActive	Amazon.CloudWatch.RecentlyActive	Gets and sets the property 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 40 minutes more than the specified time interval.

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 Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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