There are more AWS SDK examples available in the [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub repo.
# Use `GetMetricWidgetImage` with an AWS SDK or CLI
The following code examples show how to use `GetMetricWidgetImage`.
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 example:
+ [Learn the basics](cloudwatch_example_cloudwatch_GetStartedMetricsDashboardsAlarms_section.md)
------
#### [ .NET ]
**SDK for .NET (v4)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/CloudWatch#code-examples).
```
///
/// Get an image for a metric graphed over time.
///
/// The namespace of the metric.
/// The name of the metric.
/// The name of the stat to chart.
/// The period to use for the chart.
/// A memory stream for the chart image.
public async Task GetTimeSeriesMetricImage(string metricNamespace, string metric, string stat, int period)
{
var metricImageWidget = new
{
title = "Example Metric Graph",
view = "timeSeries",
stacked = false,
period = period,
width = 1400,
height = 600,
metrics = new List>
{ new() { metricNamespace, metric, new { stat } } }
};
var metricImageWidgetString = JsonSerializer.Serialize(metricImageWidget);
var imageResponse = await _amazonCloudWatch.GetMetricWidgetImageAsync(
new GetMetricWidgetImageRequest()
{
MetricWidget = metricImageWidgetString
});
return imageResponse.MetricWidgetImage;
}
///
/// Save a metric image to a file.
///
/// The MemoryStream for the metric image.
/// The name of the metric.
/// The path to the file.
public string SaveMetricImage(MemoryStream memoryStream, string metricName)
{
var metricFileName = $"{metricName}_{DateTime.Now.Ticks}.png";
using var sr = new StreamReader(memoryStream);
// Writes the memory stream to a file.
File.WriteAllBytes(metricFileName, memoryStream.ToArray());
var filePath = Path.Join(AppDomain.CurrentDomain.BaseDirectory,
metricFileName);
return filePath;
}
```
+ For API details, see [GetMetricWidgetImage](https://docs.aws.amazon.com/goto/DotNetSDKV4/monitoring-2010-08-01/GetMetricWidgetImage) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To retrieve a snapshot graph of CPUUtilization**
The following `get-metric-widget-image` example retrieves snapshot graph for the metric `CPUUtilization` of the EC2 instance with the ID `i-abcde` and saves the retrieved image as a file named "image.png" on your local machine.
```
aws cloudwatch get-metric-widget-image \
--metric-widget '{"metrics":[["AWS/EC2","CPUUtilization","InstanceId","i-abcde"]]}' \
--output-format png \
--output text | base64 --decode > image.png
```
This command produces no output.
+ For API details, see [GetMetricWidgetImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/get-metric-widget-image.html) in *AWS 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 [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/cloudwatch#code-examples).
```
/**
* Retrieves and saves a custom metric image to a file.
*
* @param fileName the name of the file to save the metric image to
* @return a {@link CompletableFuture} that completes when the image has been saved to the file
*/
public CompletableFuture downloadAndSaveMetricImageAsync(String fileName) {
logger.info("Getting Image data for custom metric.");
String myJSON = """
{
"title": "Example Metric Graph",
"view": "timeSeries",
"stacked ": false,
"period": 10,
"width": 1400,
"height": 600,
"metrics": [
[
"AWS/Billing",
"EstimatedCharges",
"Currency",
"USD"
]
]
}
""";
GetMetricWidgetImageRequest imageRequest = GetMetricWidgetImageRequest.builder()
.metricWidget(myJSON)
.build();
return getAsyncClient().getMetricWidgetImage(imageRequest)
.thenCompose(response -> {
SdkBytes sdkBytes = response.metricWidgetImage();
byte[] bytes = sdkBytes.asByteArray();
return CompletableFuture.runAsync(() -> {
try {
File outputFile = new File(fileName);
try (FileOutputStream outputStream = new FileOutputStream(outputFile)) {
outputStream.write(bytes);
}
} catch (IOException e) {
throw new RuntimeException("Failed to write image to file", e);
}
});
})
.whenComplete((result, exception) -> {
if (exception != null) {
throw new RuntimeException("Error getting and saving metric image", exception);
} else {
logger.info("Image data saved successfully to {}", fileName);
}
});
}
```
+ For API details, see [GetMetricWidgetImage](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/GetMetricWidgetImage) in *AWS 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 [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/cloudwatch#code-examples).
```
suspend fun getAndOpenMetricImage(fileName: String) {
println("Getting Image data for custom metric.")
val myJSON = """{
"title": "Example Metric Graph",
"view": "timeSeries",
"stacked ": false,
"period": 10,
"width": 1400,
"height": 600,
"metrics": [
[
"AWS/Billing",
"EstimatedCharges",
"Currency",
"USD"
]
]
}"""
val imageRequest =
GetMetricWidgetImageRequest {
metricWidget = myJSON
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
val response = cwClient.getMetricWidgetImage(imageRequest)
val bytes = response.metricWidgetImage
if (bytes != null) {
File(fileName).writeBytes(bytes)
}
}
println("You have successfully written data to $fileName")
}
```
+ For API details, see [GetMetricWidgetImage](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------