# Use `GetMetricStatistics` with an Amazon SDK or CLI
The following code examples show how to use `GetMetricStatistics`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code examples:
+ [Learn the basics](example_cloudwatch_GetStartedMetricsDashboardsAlarms_section.md)
+ [Manage metrics and alarms](example_cloudwatch_Usage_MetricsAlarms_section.md)
------
#### [ .NET ]
**Amazon SDK for .NET (v4)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [Amazon Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/CloudWatch#code-examples).
```
///
/// Get billing statistics using a call to a wrapper class.
///
/// A collection of billing statistics.
private static async Task> SetupBillingStatistics()
{
// Make a request for EstimatedCharges with a period of one day for the past seven days.
var billingStatistics = await _cloudWatchWrapper.GetMetricStatistics(
"AWS/Billing",
"EstimatedCharges",
new List() { "Maximum" },
new List() { new Dimension { Name = "Currency", Value = "USD" } },
7,
86400);
billingStatistics = billingStatistics.OrderBy(n => n.Timestamp).ToList();
return billingStatistics;
}
///
/// Wrapper to get statistics for a specific CloudWatch metric.
///
/// The namespace of the metric.
/// The name of the metric.
/// The list of statistics to include.
/// The list of dimensions to include.
/// The number of days in the past to include.
/// The period for the data.
/// A list of DataPoint objects for the statistics.
public async Task> GetMetricStatistics(string metricNamespace,
string metricName, List statistics, List dimensions, int days, int period)
{
var metricStatistics = await _amazonCloudWatch.GetMetricStatisticsAsync(
new GetMetricStatisticsRequest()
{
Namespace = metricNamespace,
MetricName = metricName,
Dimensions = dimensions,
Statistics = statistics,
StartTimeUtc = DateTime.UtcNow.AddDays(-days),
EndTimeUtc = DateTime.UtcNow,
Period = period
});
return metricStatistics.Datapoints ?? new List();
}
```
+ For API details, see [GetMetricStatistics](https://docs.amazonaws.cn/goto/DotNetSDKV4/monitoring-2010-08-01/GetMetricStatistics) in *Amazon SDK for .NET API Reference*.
------
#### [ CLI ]
**Amazon CLI**
**To get the CPU utilization per EC2 instance**
The following example uses the `get-metric-statistics` command to get the CPU utilization for an EC2 instance with the ID i-abcdef.
```
aws cloudwatch get-metric-statistics --metric-name CPUUtilization --start-time 2014-04-08T23:18:00Z --end-time 2014-04-09T23:18:00Z --period 3600 --namespace AWS/EC2 --statistics Maximum --dimensions Name=InstanceId,Value=i-abcdef
```
Output:
```
{
"Datapoints": [
{
"Timestamp": "2014-04-09T11:18:00Z",
"Maximum": 44.79,
"Unit": "Percent"
},
{
"Timestamp": "2014-04-09T20:18:00Z",
"Maximum": 47.92,
"Unit": "Percent"
},
{
"Timestamp": "2014-04-09T19:18:00Z",
"Maximum": 50.85,
"Unit": "Percent"
},
{
"Timestamp": "2014-04-09T09:18:00Z",
"Maximum": 47.92,
"Unit": "Percent"
},
{
"Timestamp": "2014-04-09T03:18:00Z",
"Maximum": 76.84,
"Unit": "Percent"
},
{
"Timestamp": "2014-04-09T21:18:00Z",
"Maximum": 48.96,
"Unit": "Percent"
},
{
"Timestamp": "2014-04-09T14:18:00Z",
"Maximum": 47.92,
"Unit": "Percent"
},
{
"Timestamp": "2014-04-09T08:18:00Z",
"Maximum": 47.92,
"Unit": "Percent"
},
{
"Timestamp": "2014-04-09T16:18:00Z",
"Maximum": 45.55,
"Unit": "Percent"
},
{
"Timestamp": "2014-04-09T06:18:00Z",
"Maximum": 47.92,
"Unit": "Percent"
},
{
"Timestamp": "2014-04-09T13:18:00Z",
"Maximum": 45.08,
"Unit": "Percent"
},
{
"Timestamp": "2014-04-09T05:18:00Z",
"Maximum": 47.92,
"Unit": "Percent"
},
{
"Timestamp": "2014-04-09T18:18:00Z",
"Maximum": 46.88,
"Unit": "Percent"
},
{
"Timestamp": "2014-04-09T17:18:00Z",
"Maximum": 52.08,
"Unit": "Percent"
},
{
"Timestamp": "2014-04-09T07:18:00Z",
"Maximum": 47.92,
"Unit": "Percent"
},
{
"Timestamp": "2014-04-09T02:18:00Z",
"Maximum": 51.23,
"Unit": "Percent"
},
{
"Timestamp": "2014-04-09T12:18:00Z",
"Maximum": 47.67,
"Unit": "Percent"
},
{
"Timestamp": "2014-04-08T23:18:00Z",
"Maximum": 46.88,
"Unit": "Percent"
},
{
"Timestamp": "2014-04-09T10:18:00Z",
"Maximum": 51.91,
"Unit": "Percent"
},
{
"Timestamp": "2014-04-09T04:18:00Z",
"Maximum": 47.13,
"Unit": "Percent"
},
{
"Timestamp": "2014-04-09T15:18:00Z",
"Maximum": 48.96,
"Unit": "Percent"
},
{
"Timestamp": "2014-04-09T00:18:00Z",
"Maximum": 48.16,
"Unit": "Percent"
},
{
"Timestamp": "2014-04-09T01:18:00Z",
"Maximum": 49.18,
"Unit": "Percent"
}
],
"Label": "CPUUtilization"
}
```
**Specifying multiple dimensions**
The following example illustrates how to specify multiple dimensions. Each dimension is specified as a Name/Value pair, with a comma between the name and the value. Multiple dimensions are separated by a space. If a single metric includes multiple dimensions, you must specify a value for every defined dimension.
For more examples using the `get-metric-statistics` command, see Get Statistics for a Metric in the *Amazon CloudWatch Developer Guide*.
```
aws cloudwatch get-metric-statistics --metric-name Buffers --namespace MyNameSpace --dimensions Name=InstanceID,Value=i-abcdef Name=InstanceType,Value=m1.small --start-time 2016-10-15T04:00:00Z --end-time 2016-10-19T07:00:00Z --statistics Average --period 60
```
+ For API details, see [GetMetricStatistics](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/get-metric-statistics.html) in *Amazon CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [Amazon Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/cloudwatch#code-examples).
```
/**
* Retrieves and displays metric statistics for the specified parameters.
*
* @param nameSpace the namespace for the metric
* @param metVal the name of the metric
* @param metricOption the statistic to retrieve for the metric (e.g., "Maximum", "Average")
* @param date the date for which to retrieve the metric statistics, in the format "yyyy-MM-dd'T'HH:mm:ss'Z'"
* @param myDimension the dimension(s) to filter the metric statistics by
* @return a {@link CompletableFuture} that completes when the metric statistics have been retrieved and displayed
*/
public CompletableFuture getAndDisplayMetricStatisticsAsync(String nameSpace, String metVal,
String metricOption, String date, Dimension myDimension) {
Instant start = Instant.parse(date);
Instant endDate = Instant.now();
// Building the request for metric statistics.
GetMetricStatisticsRequest statisticsRequest = GetMetricStatisticsRequest.builder()
.endTime(endDate)
.startTime(start)
.dimensions(myDimension)
.metricName(metVal)
.namespace(nameSpace)
.period(86400) // 1 day period
.statistics(Statistic.fromValue(metricOption))
.build();
return getAsyncClient().getMetricStatistics(statisticsRequest)
.whenComplete((response, exception) -> {
if (response != null) {
List data = response.datapoints();
if (!data.isEmpty()) {
for (Datapoint datapoint : data) {
logger.info("Timestamp: {} Maximum value: {}", datapoint.timestamp(), datapoint.maximum());
}
} else {
logger.info("The returned data list is empty");
}
} else {
logger.info("Failed to get metric statistics: {} ", exception.getMessage());
}
})
.exceptionally(exception -> {
throw new RuntimeException("Error while getting metric statistics: " + exception.getMessage(), exception);
});
}
```
+ For API details, see [GetMetricStatistics](https://docs.amazonaws.cn/goto/SdkForJavaV2/monitoring-2010-08-01/GetMetricStatistics) in *Amazon SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [Amazon Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/cloudwatch#code-examples).
```
suspend fun getAndDisplayMetricStatistics(
nameSpaceVal: String,
metVal: String,
metricOption: String,
date: String,
myDimension: Dimension,
) {
val start = Instant.parse(date)
val endDate = Instant.now()
val statisticsRequest =
GetMetricStatisticsRequest {
endTime =
aws.smithy.kotlin.runtime.time
.Instant(endDate)
startTime =
aws.smithy.kotlin.runtime.time
.Instant(start)
dimensions = listOf(myDimension)
metricName = metVal
namespace = nameSpaceVal
period = 86400
statistics = listOf(Statistic.fromValue(metricOption))
}
CloudWatchClient { region = "us-east-1" }.use { cwClient ->
val response = cwClient.getMetricStatistics(statisticsRequest)
val data = response.datapoints
if (data != null) {
if (data.isNotEmpty()) {
for (datapoint in data) {
println("Timestamp: ${datapoint.timestamp} Maximum value: ${datapoint.maximum}")
}
} else {
println("The returned data list is empty")
}
}
}
}
```
+ For API details, see [GetMetricStatistics](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *Amazon SDK for Kotlin API reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [Amazon Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/cloudwatch#code-examples).
```
class CloudWatchWrapper:
"""Encapsulates Amazon CloudWatch functions."""
def __init__(self, cloudwatch_resource):
"""
:param cloudwatch_resource: A Boto3 CloudWatch resource.
"""
self.cloudwatch_resource = cloudwatch_resource
def get_metric_statistics(self, namespace, name, start, end, period, stat_types):
"""
Gets statistics for a metric within a specified time span. Metrics are grouped
into the specified period.
:param namespace: The namespace of the metric.
:param name: The name of the metric.
:param start: The UTC start time of the time span to retrieve.
:param end: The UTC end time of the time span to retrieve.
:param period: The period, in seconds, in which to group metrics. The period
must match the granularity of the metric, which depends on
the metric's age. For example, metrics that are older than
three hours have a one-minute granularity, so the period must
be at least 60 and must be a multiple of 60.
:param stat_types: The type of statistics to retrieve, such as average value
or maximum value.
:return: The retrieved statistics for the metric.
"""
try:
metric = self.cloudwatch_resource.Metric(namespace, name)
stats = metric.get_statistics(
StartTime=start, EndTime=end, Period=period, Statistics=stat_types
)
logger.info(
"Got %s statistics for %s.", len(stats["Datapoints"]), stats["Label"]
)
except ClientError:
logger.exception("Couldn't get statistics for %s.%s.", namespace, name)
raise
else:
return stats
```
+ For API details, see [GetMetricStatistics](https://docs.amazonaws.cn/goto/boto3/monitoring-2010-08-01/GetMetricStatistics) in *Amazon SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [Amazon Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cwt#code-examples).
```
TRY.
oo_result = lo_cwt->getmetricstatistics( " oo_result is returned for testing purposes. "
iv_namespace = iv_namespace
iv_metricname = iv_metric_name
iv_starttime = iv_start_time
iv_endtime = iv_end_time
iv_period = iv_period
it_statistics = it_statistics ).
MESSAGE 'Metric statistics retrieved.' TYPE 'I'.
CATCH /aws1/cx_cwtinvparamvalueex.
MESSAGE 'The specified argument was not valid.' TYPE 'E'.
ENDTRY.
```
+ For API details, see [GetMetricStatistics](https://docs.amazonaws.cn/sdk-for-sap-abap/v1/api/latest/index.html) in *Amazon SDK for SAP ABAP API reference*.
------
For a complete list of Amazon SDK developer guides and code examples, see [Using CloudWatch with an Amazon SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.