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.

A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.

You can assign up to 30 dimensions to a metric.

Inheritance Hierarchy

System.Object
  Amazon.CloudWatch.Model.Dimension

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

Syntax

C#
public class Dimension

The Dimension type exposes the following members

Constructors

NameDescription
Public Method Dimension()

Properties

NameTypeDescription
Public Property Name System.String

Gets and sets the property Name.

The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:). ASCII control characters are not supported as part of dimension names.

Public Property Value System.String

Gets and sets the property Value.

The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.

Examples

This example shows how to get statistics for a metric.

Get metric statistics example

var client = new AmazonCloudWatchClient();

var request = new GetMetricStatisticsRequest
{
  Dimensions = new List<Dimension>() { dimension },
  EndTime = DateTime.Today,
  MetricName = "CPUUtilization",
  Namespace = "AWS/EC2",
  // Get statistics by day.
  Period = (int)TimeSpan.FromDays(1).TotalSeconds,
  // Get statistics for the past month.
  StartTime = DateTime.Today.Subtract(TimeSpan.FromDays(30)),
  Statistics = new List<string>() { "Minimum" },
  Unit = StandardUnit.Percent
};

var response = client.GetMetricStatistics(request);

if (response.Datapoints.Count > 0)
{
  foreach (var point in response.Datapoints)
  {
    Console.WriteLine(point.Timestamp.ToShortDateString() +
      " " + point.Minimum + "%");
  }
}
      

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5