AWS SDK Version 4 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.

Represents a specific metric.

Inheritance Hierarchy

System.Object
  Amazon.CloudWatch.Model.Metric

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

Syntax

C#
public class Metric

The Metric type exposes the following members

Constructors

NameDescription
Public Method Metric()

Properties

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

Gets and sets the property Dimensions.

The dimensions for the metric.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property MetricName System.String

Gets and sets the property MetricName.

The name of the metric. This is a required field.

Public Property Namespace System.String

Gets and sets the property Namespace.

The namespace of the metric.

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 = await client.ListMetricsAsync(request);

    if (response.Metrics != null)
    {
        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:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer