to continue:");
String input = scanner.nextLine();
if (input.trim().equalsIgnoreCase("c")) {
logger.info("Continuing with the program...");
logger.info("");
break;
} else {
// Handle invalid input.
logger.info("Invalid input. Please try again.");
}
}
}
}
```
A wrapper class for CloudWatch SDK methods.
```
public class CloudWatchActions {
private static CloudWatchAsyncClient cloudWatchAsyncClient;
private static final Logger logger = LoggerFactory.getLogger(CloudWatchActions.class);
/**
* Retrieves an asynchronous CloudWatch client instance.
*
*
* This method ensures that the CloudWatch client is initialized with the following configurations:
*
* - Maximum concurrency: 100
* - Connection timeout: 60 seconds
* - Read timeout: 60 seconds
* - Write timeout: 60 seconds
* - API call timeout: 2 minutes
* - API call attempt timeout: 90 seconds
* - Retry strategy: STANDARD
*
*
*
* @return the asynchronous CloudWatch client instance
*/
private static CloudWatchAsyncClient getAsyncClient() {
if (cloudWatchAsyncClient == null) {
SdkAsyncHttpClient httpClient = NettyNioAsyncHttpClient.builder()
.maxConcurrency(100)
.connectionTimeout(Duration.ofSeconds(60))
.readTimeout(Duration.ofSeconds(60))
.writeTimeout(Duration.ofSeconds(60))
.build();
ClientOverrideConfiguration overrideConfig = ClientOverrideConfiguration.builder()
.apiCallTimeout(Duration.ofMinutes(2))
.apiCallAttemptTimeout(Duration.ofSeconds(90))
.retryStrategy(RetryMode.STANDARD)
.build();
cloudWatchAsyncClient = CloudWatchAsyncClient.builder()
.httpClient(httpClient)
.overrideConfiguration(overrideConfig)
.build();
}
return cloudWatchAsyncClient;
}
/**
* Deletes an Anomaly Detector.
*
* @param fileName the name of the file containing the Anomaly Detector configuration
* @return a CompletableFuture that represents the asynchronous deletion of the Anomaly Detector
*/
public CompletableFuture deleteAnomalyDetectorAsync(String fileName) {
CompletableFuture readFileFuture = CompletableFuture.supplyAsync(() -> {
try {
JsonParser parser = new JsonFactory().createParser(new File(fileName));
return new ObjectMapper().readTree(parser); // Return the root node
} catch (IOException e) {
throw new RuntimeException("Failed to read or parse the file", e);
}
});
return readFileFuture.thenCompose(rootNode -> {
String customMetricNamespace = rootNode.findValue("customMetricNamespace").asText();
String customMetricName = rootNode.findValue("customMetricName").asText();
SingleMetricAnomalyDetector singleMetricAnomalyDetector = SingleMetricAnomalyDetector.builder()
.metricName(customMetricName)
.namespace(customMetricNamespace)
.stat("Maximum")
.build();
DeleteAnomalyDetectorRequest request = DeleteAnomalyDetectorRequest.builder()
.singleMetricAnomalyDetector(singleMetricAnomalyDetector)
.build();
return getAsyncClient().deleteAnomalyDetector(request);
}).whenComplete((result, exception) -> {
if (exception != null) {
throw new RuntimeException("Failed to delete the Anomaly Detector", exception);
} else {
logger.info("Successfully deleted the Anomaly Detector.");
}
});
}
/**
* Deletes a CloudWatch alarm.
*
* @param alarmName the name of the alarm to be deleted
* @return a {@link CompletableFuture} representing the asynchronous operation to delete the alarm
* the {@link DeleteAlarmsResponse} is returned when the operation completes successfully,
* or a {@link RuntimeException} is thrown if the operation fails
*/
public CompletableFuture deleteCWAlarmAsync(String alarmName) {
DeleteAlarmsRequest request = DeleteAlarmsRequest.builder()
.alarmNames(alarmName)
.build();
return getAsyncClient().deleteAlarms(request)
.whenComplete((response, exception) -> {
if (exception != null) {
throw new RuntimeException("Failed to delete the alarm:{} " + alarmName, exception);
} else {
logger.info("Successfully deleted alarm {} ", alarmName);
}
});
}
/**
* Deletes the specified dashboard.
*
* @param dashboardName the name of the dashboard to be deleted
* @return a {@link CompletableFuture} representing the asynchronous operation of deleting the dashboard
* @throws RuntimeException if the dashboard deletion fails
*/
public CompletableFuture deleteDashboardAsync(String dashboardName) {
DeleteDashboardsRequest dashboardsRequest = DeleteDashboardsRequest.builder()
.dashboardNames(dashboardName)
.build();
return getAsyncClient().deleteDashboards(dashboardsRequest)
.whenComplete((response, exception) -> {
if (exception != null) {
throw new RuntimeException("Failed to delete the dashboard: " + dashboardName, exception);
} else {
logger.info("{} was successfully deleted.", dashboardName);
}
});
}
/**
* 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);
}
});
}
/**
* Describes the anomaly detectors based on the specified JSON file.
*
* @param fileName the name of the JSON file containing the custom metric namespace and name
* @return a {@link CompletableFuture} that completes when the anomaly detectors have been described
* @throws RuntimeException if there is a failure during the operation, such as when reading or parsing the JSON file,
* or when describing the anomaly detectors
*/
public CompletableFuture describeAnomalyDetectorsAsync(String fileName) {
CompletableFuture readFileFuture = CompletableFuture.supplyAsync(() -> {
try {
JsonParser parser = new JsonFactory().createParser(new File(fileName));
return new ObjectMapper().readTree(parser);
} catch (IOException e) {
throw new RuntimeException("Failed to read or parse the file", e);
}
});
return readFileFuture.thenCompose(rootNode -> {
try {
String customMetricNamespace = rootNode.findValue("customMetricNamespace").asText();
String customMetricName = rootNode.findValue("customMetricName").asText();
DescribeAnomalyDetectorsRequest detectorsRequest = DescribeAnomalyDetectorsRequest.builder()
.maxResults(10)
.metricName(customMetricName)
.namespace(customMetricNamespace)
.build();
return getAsyncClient().describeAnomalyDetectors(detectorsRequest).thenAccept(response -> {
List anomalyDetectorList = response.anomalyDetectors();
for (AnomalyDetector detector : anomalyDetectorList) {
logger.info("Metric name: {} ", detector.singleMetricAnomalyDetector().metricName());
logger.info("State: {} ", detector.stateValue());
}
});
} catch (RuntimeException e) {
throw new RuntimeException("Failed to describe anomaly detectors", e);
}
}).whenComplete((result, exception) -> {
if (exception != null) {
throw new RuntimeException("Error describing anomaly detectors", exception);
}
});
}
/**
* Adds an anomaly detector for the given file.
*
* @param fileName the name of the file containing the anomaly detector configuration
* @return a {@link CompletableFuture} that completes when the anomaly detector has been added
*/
public CompletableFuture addAnomalyDetectorAsync(String fileName) {
CompletableFuture readFileFuture = CompletableFuture.supplyAsync(() -> {
try {
JsonParser parser = new JsonFactory().createParser(new File(fileName));
return new ObjectMapper().readTree(parser); // Return the root node
} catch (IOException e) {
throw new RuntimeException("Failed to read or parse the file", e);
}
});
return readFileFuture.thenCompose(rootNode -> {
try {
String customMetricNamespace = rootNode.findValue("customMetricNamespace").asText();
String customMetricName = rootNode.findValue("customMetricName").asText();
SingleMetricAnomalyDetector singleMetricAnomalyDetector = SingleMetricAnomalyDetector.builder()
.metricName(customMetricName)
.namespace(customMetricNamespace)
.stat("Maximum")
.build();
PutAnomalyDetectorRequest anomalyDetectorRequest = PutAnomalyDetectorRequest.builder()
.singleMetricAnomalyDetector(singleMetricAnomalyDetector)
.build();
return getAsyncClient().putAnomalyDetector(anomalyDetectorRequest).thenAccept(response -> {
logger.info("Added anomaly detector for metric {}", customMetricName);
});
} catch (Exception e) {
throw new RuntimeException("Failed to create anomaly detector", e);
}
}).whenComplete((result, exception) -> {
if (exception != null) {
throw new RuntimeException("Error adding anomaly detector", exception);
}
});
}
/**
* Retrieves the alarm history for a given alarm name and date range.
*
* @param fileName the path to the JSON file containing the alarm name
* @param date the date to start the alarm history search (in the format "yyyy-MM-dd'T'HH:mm:ss'Z'")
* @return a {@code CompletableFuture} that completes when the alarm history has been retrieved and processed
*/
public CompletableFuture getAlarmHistoryAsync(String fileName, String date) {
CompletableFuture readFileFuture = CompletableFuture.supplyAsync(() -> {
try {
JsonParser parser = new JsonFactory().createParser(new File(fileName));
com.fasterxml.jackson.databind.JsonNode rootNode = new ObjectMapper().readTree(parser);
return rootNode.findValue("exampleAlarmName").asText(); // Return alarmName from the JSON file
} catch (IOException e) {
throw new RuntimeException("Failed to read or parse the file", e);
}
});
// Use the alarm name to describe alarm history with a paginator.
return readFileFuture.thenCompose(alarmName -> {
try {
Instant start = Instant.parse(date);
Instant endDate = Instant.now();
DescribeAlarmHistoryRequest historyRequest = DescribeAlarmHistoryRequest.builder()
.startDate(start)
.endDate(endDate)
.alarmName(alarmName)
.historyItemType(HistoryItemType.ACTION)
.build();
// Use the paginator to paginate through alarm history pages.
DescribeAlarmHistoryPublisher historyPublisher = getAsyncClient().describeAlarmHistoryPaginator(historyRequest);
CompletableFuture future = historyPublisher
.subscribe(response -> response.alarmHistoryItems().forEach(item -> {
logger.info("History summary: {}", item.historySummary());
logger.info("Timestamp: {}", item.timestamp());
}))
.whenComplete((result, exception) -> {
if (exception != null) {
logger.error("Error occurred while getting alarm history: " + exception.getMessage(), exception);
} else {
logger.info("Successfully retrieved all alarm history.");
}
});
// Return the future to the calling code for further handling
return future;
} catch (Exception e) {
throw new RuntimeException("Failed to process alarm history", e);
}
}).whenComplete((result, exception) -> {
if (exception != null) {
throw new RuntimeException("Error completing alarm history processing", exception);
}
});
}
/**
* Checks for a metric alarm in AWS CloudWatch.
*
* @param fileName the name of the file containing the JSON configuration for the custom metric
* @return a {@link CompletableFuture} that completes when the check for the metric alarm is complete
*/
public CompletableFuture checkForMetricAlarmAsync(String fileName) {
CompletableFuture readFileFuture = CompletableFuture.supplyAsync(() -> {
try {
JsonParser parser = new JsonFactory().createParser(new File(fileName));
com.fasterxml.jackson.databind.JsonNode rootNode = new ObjectMapper().readTree(parser);
return rootNode.toString(); // Return JSON as a string for further processing
} catch (IOException e) {
throw new RuntimeException("Failed to read file", e);
}
});
return readFileFuture.thenCompose(jsonContent -> {
try {
com.fasterxml.jackson.databind.JsonNode rootNode = new ObjectMapper().readTree(jsonContent);
String customMetricNamespace = rootNode.findValue("customMetricNamespace").asText();
String customMetricName = rootNode.findValue("customMetricName").asText();
DescribeAlarmsForMetricRequest metricRequest = DescribeAlarmsForMetricRequest.builder()
.metricName(customMetricName)
.namespace(customMetricNamespace)
.build();
return checkForAlarmAsync(metricRequest, customMetricName, 10);
} catch (IOException e) {
throw new RuntimeException("Failed to parse JSON content", e);
}
}).whenComplete((result, exception) -> {
if (exception != null) {
throw new RuntimeException("Error checking metric alarm", exception);
}
});
}
// Recursive method to check for the alarm.
/**
* Checks for the existence of an alarm asynchronously for the specified metric.
*
* @param metricRequest the request to describe the alarms for the specified metric
* @param customMetricName the name of the custom metric to check for an alarm
* @param retries the number of retries to perform if no alarm is found
* @return a {@link CompletableFuture} that completes when an alarm is found or the maximum number of retries has been reached
*/
private static CompletableFuture checkForAlarmAsync(DescribeAlarmsForMetricRequest metricRequest, String customMetricName, int retries) {
if (retries == 0) {
return CompletableFuture.completedFuture(null).thenRun(() ->
logger.info("No Alarm state found for {} after 10 retries.", customMetricName)
);
}
return (getAsyncClient().describeAlarmsForMetric(metricRequest).thenCompose(response -> {
if (response.hasMetricAlarms()) {
logger.info("Alarm state found for {}", customMetricName);
return CompletableFuture.completedFuture(null); // Alarm found, complete the future
} else {
return CompletableFuture.runAsync(() -> {
try {
Thread.sleep(20000);
logger.info(".");
} catch (InterruptedException e) {
throw new RuntimeException("Interrupted while waiting to retry", e);
}
}).thenCompose(v -> checkForAlarmAsync(metricRequest, customMetricName, retries - 1)); // Recursive call
}
}));
}
/**
* Adds metric data for an alarm asynchronously.
*
* @param fileName the name of the JSON file containing the metric data
* @return a CompletableFuture that asynchronously returns the PutMetricDataResponse
*/
public CompletableFuture addMetricDataForAlarmAsync(String fileName) {
CompletableFuture readFileFuture = CompletableFuture.supplyAsync(() -> {
try {
JsonParser parser = new JsonFactory().createParser(new File(fileName));
com.fasterxml.jackson.databind.JsonNode rootNode = new ObjectMapper().readTree(parser);
return rootNode.toString(); // Return JSON as a string for further processing
} catch (IOException e) {
throw new RuntimeException("Failed to read file", e);
}
});
return readFileFuture.thenCompose(jsonContent -> {
try {
com.fasterxml.jackson.databind.JsonNode rootNode = new ObjectMapper().readTree(jsonContent);
String customMetricNamespace = rootNode.findValue("customMetricNamespace").asText();
String customMetricName = rootNode.findValue("customMetricName").asText();
Instant instant = Instant.now();
// Create MetricDatum objects.
MetricDatum datum1 = MetricDatum.builder()
.metricName(customMetricName)
.unit(StandardUnit.NONE)
.value(1001.00)
.timestamp(instant)
.build();
MetricDatum datum2 = MetricDatum.builder()
.metricName(customMetricName)
.unit(StandardUnit.NONE)
.value(1002.00)
.timestamp(instant)
.build();
List metricDataList = new ArrayList<>();
metricDataList.add(datum1);
metricDataList.add(datum2);
// Build the PutMetricData request.
PutMetricDataRequest request = PutMetricDataRequest.builder()
.namespace(customMetricNamespace)
.metricData(metricDataList)
.build();
// Send the request asynchronously.
return getAsyncClient().putMetricData(request);
} catch (IOException e) {
CompletableFuture failedFuture = new CompletableFuture<>();
failedFuture.completeExceptionally(new RuntimeException("Failed to parse JSON content", e));
return failedFuture;
}
}).whenComplete((response, exception) -> {
if (exception != null) {
logger.error("Failed to put metric data: " + exception.getMessage(), exception);
} else {
logger.info("Added metric values for metric.");
}
});
}
/**
* Retrieves custom metric data from the AWS CloudWatch service.
*
* @param fileName the name of the file containing the custom metric information
* @return a {@link CompletableFuture} that completes when the metric data has been retrieved
*/
public CompletableFuture getCustomMetricDataAsync(String fileName) {
CompletableFuture readFileFuture = CompletableFuture.supplyAsync(() -> {
try {
// Read values from the JSON file.
JsonParser parser = new JsonFactory().createParser(new File(fileName));
com.fasterxml.jackson.databind.JsonNode rootNode = new ObjectMapper().readTree(parser);
return rootNode.toString(); // Return JSON as a string for further processing
} catch (IOException e) {
throw new RuntimeException("Failed to read file", e);
}
});
return readFileFuture.thenCompose(jsonContent -> {
try {
// Parse the JSON string to extract relevant values.
com.fasterxml.jackson.databind.JsonNode rootNode = new ObjectMapper().readTree(jsonContent);
String customMetricNamespace = rootNode.findValue("customMetricNamespace").asText();
String customMetricName = rootNode.findValue("customMetricName").asText();
// Set the current time and date range for metric query.
Instant nowDate = Instant.now();
long hours = 1;
long minutes = 30;
Instant endTime = nowDate.plus(hours, ChronoUnit.HOURS).plus(minutes, ChronoUnit.MINUTES);
Metric met = Metric.builder()
.metricName(customMetricName)
.namespace(customMetricNamespace)
.build();
MetricStat metStat = MetricStat.builder()
.stat("Maximum")
.period(60) // Assuming period in seconds
.metric(met)
.build();
MetricDataQuery dataQuery = MetricDataQuery.builder()
.metricStat(metStat)
.id("foo2")
.returnData(true)
.build();
List dq = new ArrayList<>();
dq.add(dataQuery);
GetMetricDataRequest getMetricDataRequest = GetMetricDataRequest.builder()
.maxDatapoints(10)
.scanBy(ScanBy.TIMESTAMP_DESCENDING)
.startTime(nowDate)
.endTime(endTime)
.metricDataQueries(dq)
.build();
// Call the async method for CloudWatch data retrieval.
return getAsyncClient().getMetricData(getMetricDataRequest);
} catch (IOException e) {
throw new RuntimeException("Failed to parse JSON content", e);
}
}).thenAccept(response -> {
List data = response.metricDataResults();
for (MetricDataResult item : data) {
logger.info("The label is: {}", item.label());
logger.info("The status code is: {}", item.statusCode().toString());
}
}).exceptionally(exception -> {
throw new RuntimeException("Failed to get metric data", exception);
});
}
/**
* Describes the CloudWatch alarms of the 'METRIC_ALARM' type.
*
* @return a {@link CompletableFuture} that represents the asynchronous operation
* of describing the CloudWatch alarms. The future completes when the
* operation is finished, either successfully or with an error.
*/
public CompletableFuture describeAlarmsAsync() {
List typeList = new ArrayList<>();
typeList.add(AlarmType.METRIC_ALARM);
DescribeAlarmsRequest alarmsRequest = DescribeAlarmsRequest.builder()
.alarmTypes(typeList)
.maxRecords(10)
.build();
return getAsyncClient().describeAlarms(alarmsRequest)
.thenAccept(response -> {
List alarmList = response.metricAlarms();
for (MetricAlarm alarm : alarmList) {
logger.info("Alarm name: {}", alarm.alarmName());
logger.info("Alarm description: {} ", alarm.alarmDescription());
}
})
.whenComplete((response, ex) -> {
if (ex != null) {
logger.info("Failed to describe alarms: {}", ex.getMessage());
} else {
logger.info("Successfully described alarms.");
}
});
}
/**
* Creates an alarm based on the configuration provided in a JSON file.
*
* @param fileName the name of the JSON file containing the alarm configuration
* @return a CompletableFuture that represents the asynchronous operation of creating the alarm
* @throws RuntimeException if an exception occurs while reading the JSON file or creating the alarm
*/
public CompletableFuture createAlarmAsync(String fileName) {
com.fasterxml.jackson.databind.JsonNode rootNode;
try {
JsonParser parser = new JsonFactory().createParser(new File(fileName));
rootNode = new ObjectMapper().readTree(parser);
} catch (IOException e) {
throw new RuntimeException("Failed to read the alarm configuration file", e);
}
// Extract values from the JSON node.
String customMetricNamespace = rootNode.findValue("customMetricNamespace").asText();
String customMetricName = rootNode.findValue("customMetricName").asText();
String alarmName = rootNode.findValue("exampleAlarmName").asText();
String emailTopic = rootNode.findValue("emailTopic").asText();
String accountId = rootNode.findValue("accountId").asText();
String region = rootNode.findValue("region").asText();
// Create a List for alarm actions.
List alarmActions = new ArrayList<>();
alarmActions.add("arn:aws:sns:" + region + ":" + accountId + ":" + emailTopic);
PutMetricAlarmRequest alarmRequest = PutMetricAlarmRequest.builder()
.alarmActions(alarmActions)
.alarmDescription("Example metric alarm")
.alarmName(alarmName)
.comparisonOperator(ComparisonOperator.GREATER_THAN_OR_EQUAL_TO_THRESHOLD)
.threshold(100.00)
.metricName(customMetricName)
.namespace(customMetricNamespace)
.evaluationPeriods(1)
.period(10)
.statistic("Maximum")
.datapointsToAlarm(1)
.treatMissingData("ignore")
.build();
// Call the putMetricAlarm asynchronously and handle the result.
return getAsyncClient().putMetricAlarm(alarmRequest)
.handle((response, ex) -> {
if (ex != null) {
logger.info("Failed to create alarm: {}", ex.getMessage());
throw new RuntimeException("Failed to create alarm", ex);
} else {
logger.info("{} was successfully created!", alarmName);
return alarmName;
}
});
}
/**
* Adds a metric to a dashboard asynchronously.
*
* @param fileName the name of the file containing the dashboard content
* @param dashboardName the name of the dashboard to be updated
* @return a {@link CompletableFuture} representing the asynchronous operation, which will complete with a
* {@link PutDashboardResponse} when the dashboard is successfully updated
*/
public CompletableFuture addMetricToDashboardAsync(String fileName, String dashboardName) {
String dashboardBody;
try {
dashboardBody = readFileAsString(fileName);
} catch (IOException e) {
throw new RuntimeException("Failed to read the dashboard file", e);
}
PutDashboardRequest dashboardRequest = PutDashboardRequest.builder()
.dashboardName(dashboardName)
.dashboardBody(dashboardBody)
.build();
return getAsyncClient().putDashboard(dashboardRequest)
.handle((response, ex) -> {
if (ex != null) {
logger.info("Failed to update dashboard: {}", ex.getMessage());
throw new RuntimeException("Error updating dashboard", ex);
} else {
logger.info("{} was successfully updated.", dashboardName);
return response;
}
});
}
/**
* Creates a new custom metric.
*
* @param dataPoint the data point to be added to the custom metric
* @return a {@link CompletableFuture} representing the asynchronous operation of adding the custom metric
*/
public CompletableFuture createNewCustomMetricAsync(Double dataPoint) {
Dimension dimension = Dimension.builder()
.name("UNIQUE_PAGES")
.value("URLS")
.build();
// Set an Instant object for the current time in UTC.
String time = ZonedDateTime.now(ZoneOffset.UTC).format(DateTimeFormatter.ISO_INSTANT);
Instant instant = Instant.parse(time);
// Create the MetricDatum.
MetricDatum datum = MetricDatum.builder()
.metricName("PAGES_VISITED")
.unit(StandardUnit.NONE)
.value(dataPoint)
.timestamp(instant)
.dimensions(dimension)
.build();
PutMetricDataRequest request = PutMetricDataRequest.builder()
.namespace("SITE/TRAFFIC")
.metricData(datum)
.build();
return getAsyncClient().putMetricData(request)
.whenComplete((response, ex) -> {
if (ex != null) {
throw new RuntimeException("Error adding custom metric", ex);
} else {
logger.info("Successfully added metric values for PAGES_VISITED.");
}
});
}
/**
* Lists the available dashboards.
*
* @return a {@link CompletableFuture} that completes when the operation is finished.
* The future will complete exceptionally if an error occurs while listing the dashboards.
*/
public CompletableFuture listDashboardsAsync() {
ListDashboardsRequest listDashboardsRequest = ListDashboardsRequest.builder().build();
ListDashboardsPublisher paginator = getAsyncClient().listDashboardsPaginator(listDashboardsRequest);
return paginator.subscribe(response -> {
response.dashboardEntries().forEach(entry -> {
logger.info("Dashboard name is: {} ", entry.dashboardName());
logger.info("Dashboard ARN is: {} ", entry.dashboardArn());
});
}).exceptionally(ex -> {
logger.info("Failed to list dashboards: {} ", ex.getMessage());
throw new RuntimeException("Error occurred while listing dashboards", ex);
});
}
/**
* Creates a new dashboard with the specified name and metrics from the given file.
*
* @param dashboardName the name of the dashboard to be created
* @param fileName the name of the file containing the dashboard body
* @return a {@link CompletableFuture} representing the asynchronous operation of creating the dashboard
* @throws IOException if there is an error reading the dashboard body from the file
*/
public CompletableFuture createDashboardWithMetricsAsync(String dashboardName, String fileName) throws IOException {
String dashboardBody = readFileAsString(fileName);
PutDashboardRequest dashboardRequest = PutDashboardRequest.builder()
.dashboardName(dashboardName)
.dashboardBody(dashboardBody)
.build();
return getAsyncClient().putDashboard(dashboardRequest)
.handle((response, ex) -> {
if (ex != null) {
logger.info("Failed to create dashboard: {}", ex.getMessage());
throw new RuntimeException("Dashboard creation failed", ex);
} else {
// Handle the normal response case
logger.info("{} was successfully created.", dashboardName);
List messages = response.dashboardValidationMessages();
if (messages.isEmpty()) {
logger.info("There are no messages in the new Dashboard.");
} else {
for (DashboardValidationMessage message : messages) {
logger.info("Message: {}", message.message());
}
}
return response; // Return the response for further use
}
});
}
/**
* Retrieves the metric statistics for the "EstimatedCharges" metric in the "AWS/Billing" namespace.
*
* @param costDateWeek the start date for the metric statistics, in the format of an ISO-8601 date string (e.g., "2023-04-05")
* @return a {@link CompletableFuture} that, when completed, contains the {@link GetMetricStatisticsResponse} with the retrieved metric statistics
* @throws RuntimeException if the metric statistics cannot be retrieved successfully
*/
public CompletableFuture getMetricStatisticsAsync(String costDateWeek) {
Instant start = Instant.parse(costDateWeek);
Instant endDate = Instant.now();
// Define dimension
Dimension dimension = Dimension.builder()
.name("Currency")
.value("USD")
.build();
List dimensionList = new ArrayList<>();
dimensionList.add(dimension);
GetMetricStatisticsRequest statisticsRequest = GetMetricStatisticsRequest.builder()
.metricName("EstimatedCharges")
.namespace("AWS/Billing")
.dimensions(dimensionList)
.statistics(Statistic.MAXIMUM)
.startTime(start)
.endTime(endDate)
.period(86400) // One day period
.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 {
throw new RuntimeException("Failed to get metric statistics: " + exception.getMessage(), exception);
}
});
}
/**
* 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);
});
}
/**
* Retrieves a list of metric names for the specified namespace.
*
* @param namespace the namespace for which to retrieve the metric names
* @return a {@link CompletableFuture} that, when completed, contains an {@link ArrayList} of
* the metric names in the specified namespace
* @throws RuntimeException if an error occurs while listing the metrics
*/
public CompletableFuture> listMetsAsync(String namespace) {
ListMetricsRequest request = ListMetricsRequest.builder()
.namespace(namespace)
.build();
ListMetricsPublisher metricsPaginator = getAsyncClient().listMetricsPaginator(request);
Set metSet = new HashSet<>();
CompletableFuture future = metricsPaginator.subscribe(response -> {
response.metrics().forEach(metric -> {
String metricName = metric.metricName();
metSet.add(metricName);
});
});
return future
.thenApply(ignored -> new ArrayList<>(metSet))
.exceptionally(exception -> {
throw new RuntimeException("Failed to list metrics: " + exception.getMessage(), exception);
});
}
/**
* Lists the available namespaces for the current AWS account.
*
* @return a {@link CompletableFuture} that, when completed, contains an {@link ArrayList} of the available namespace names.
* @throws RuntimeException if an error occurs while listing the namespaces.
*/
public CompletableFuture> listNameSpacesAsync() {
ArrayList nameSpaceList = new ArrayList<>();
ListMetricsRequest request = ListMetricsRequest.builder().build();
ListMetricsPublisher metricsPaginator = getAsyncClient().listMetricsPaginator(request);
CompletableFuture future = metricsPaginator.subscribe(response -> {
response.metrics().forEach(metric -> {
String namespace = metric.namespace();
if (!nameSpaceList.contains(namespace)) {
nameSpaceList.add(namespace);
}
});
});
return future
.thenApply(ignored -> nameSpaceList)
.exceptionally(exception -> {
throw new RuntimeException("Failed to list namespaces: " + exception.getMessage(), exception);
});
}
/**
* Retrieves the specific metric asynchronously.
*
* @param namespace the namespace of the metric to retrieve
* @return a CompletableFuture that completes with the first dimension of the first metric found in the specified namespace,
* or throws a RuntimeException if an error occurs or no metrics or dimensions are found
*/
public CompletableFuture getSpecificMetAsync(String namespace) {
ListMetricsRequest request = ListMetricsRequest.builder()
.namespace(namespace)
.build();
return getAsyncClient().listMetrics(request).handle((response, exception) -> {
if (exception != null) {
logger.info("Error occurred while listing metrics: {} ", exception.getMessage());
throw new RuntimeException("Failed to retrieve specific metric dimension", exception);
} else {
List myList = response.metrics();
if (!myList.isEmpty()) {
Metric metric = myList.get(0);
if (!metric.dimensions().isEmpty()) {
return metric.dimensions().get(0); // Return the first dimension
}
}
throw new RuntimeException("No metrics or dimensions found");
}
});
}
public static String readFileAsString(String file) throws IOException {
return new String(Files.readAllBytes(Paths.get(file)));
}
}
```
+ For API details, see the following topics in *AWS SDK for Java 2.x API Reference*.
+ [DeleteAlarms](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/DeleteAlarms)
+ [DeleteAnomalyDetector](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/DeleteAnomalyDetector)
+ [DeleteDashboards](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/DeleteDashboards)
+ [DescribeAlarmHistory](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/DescribeAlarmHistory)
+ [DescribeAlarms](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/DescribeAlarms)
+ [DescribeAlarmsForMetric](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/DescribeAlarmsForMetric)
+ [DescribeAnomalyDetectors](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/DescribeAnomalyDetectors)
+ [GetMetricData](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/GetMetricData)
+ [GetMetricStatistics](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/GetMetricStatistics)
+ [GetMetricWidgetImage](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/GetMetricWidgetImage)
+ [ListMetrics](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/ListMetrics)
+ [PutAnomalyDetector](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/PutAnomalyDetector)
+ [PutDashboard](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/PutDashboard)
+ [PutMetricAlarm](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/PutMetricAlarm)
+ [PutMetricData](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/PutMetricData)
------
#### [ 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).
Run an interactive scenario demonstrating CloudWatch features.
```
/**
Before running this Kotlin code example, set up your development environment,
including your credentials.
For more information, see the following documentation topic:
https://docs.aws.amazon.com/sdk-for-kotlin/latest/developer-guide/setup.html
To enable billing metrics and statistics for this example, make sure billing alerts are enabled for your account:
https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html#turning_on_billing_metrics
This Kotlin code example performs the following tasks:
1. List available namespaces from Amazon CloudWatch. Select a namespace from the list.
2. List available metrics within the selected namespace.
3. Get statistics for the selected metric over the last day.
4. Get CloudWatch estimated billing for the last week.
5. Create a new CloudWatch dashboard with metrics.
6. List dashboards using a paginator.
7. Create a new custom metric by adding data for it.
8. Add the custom metric to the dashboard.
9. Create an alarm for the custom metric.
10. Describe current alarms.
11. Get current data for the new custom metric.
12. Push data into the custom metric to trigger the alarm.
13. Check the alarm state using the action DescribeAlarmsForMetric.
14. Get alarm history for the new alarm.
15. Add an anomaly detector for the custom metric.
16. Describe current anomaly detectors.
17. Get a metric image for the custom metric.
18. Clean up the Amazon CloudWatch resources.
*/
val DASHES: String? = String(CharArray(80)).replace("\u0000", "-")
suspend fun main(args: Array) {
val usage = """
Usage:
Where:
myDate - The start date to use to get metric statistics. (For example, 2023-01-11T18:35:24.00Z.)
costDateWeek - The start date to use to get AWS Billing and Cost Management statistics. (For example, 2023-01-11T18:35:24.00Z.)
dashboardName - The name of the dashboard to create.
dashboardJson - The location of a JSON file to use to create a dashboard. (See Readme file.)
dashboardAdd - The location of a JSON file to use to update a dashboard. (See Readme file.)
settings - The location of a JSON file from which various values are read. (See Readme file.)
metricImage - The location of a BMP file that is used to create a graph.
"""
if (args.size != 7) {
println(usage)
System.exit(1)
}
val myDate = args[0]
val costDateWeek = args[1]
val dashboardName = args[2]
val dashboardJson = args[3]
val dashboardAdd = args[4]
val settings = args[5]
var metricImage = args[6]
val dataPoint = "10.0".toDouble()
val inOb = Scanner(System.`in`)
println(DASHES)
println("Welcome to the Amazon CloudWatch example scenario.")
println(DASHES)
println(DASHES)
println("1. List at least five available unique namespaces from Amazon CloudWatch. Select a CloudWatch namespace from the list.")
val list: ArrayList = listNameSpaces()
for (z in 0..4) {
println(" ${z + 1}. ${list[z]}")
}
var selectedNamespace: String
var selectedMetrics = ""
var num = inOb.nextLine().toInt()
println("You selected $num")
if (1 <= num && num <= 5) {
selectedNamespace = list[num - 1]
} else {
println("You did not select a valid option.")
exitProcess(1)
}
println("You selected $selectedNamespace")
println(DASHES)
println(DASHES)
println("2. List available metrics within the selected namespace and select one from the list.")
val metList = listMets(selectedNamespace)
for (z in 0..4) {
println(" ${ z + 1}. ${metList?.get(z)}")
}
num = inOb.nextLine().toInt()
if (1 <= num && num <= 5) {
selectedMetrics = metList!![num - 1]
} else {
println("You did not select a valid option.")
System.exit(1)
}
println("You selected $selectedMetrics")
val myDimension = getSpecificMet(selectedNamespace)
if (myDimension == null) {
println("Error - Dimension is null")
exitProcess(1)
}
println(DASHES)
println(DASHES)
println("3. Get statistics for the selected metric over the last day.")
val metricOption: String
val statTypes = ArrayList()
statTypes.add("SampleCount")
statTypes.add("Average")
statTypes.add("Sum")
statTypes.add("Minimum")
statTypes.add("Maximum")
for (t in 0..4) {
println(" ${t + 1}. ${statTypes[t]}")
}
println("Select a metric statistic by entering a number from the preceding list:")
num = inOb.nextLine().toInt()
if (1 <= num && num <= 5) {
metricOption = statTypes[num - 1]
} else {
println("You did not select a valid option.")
exitProcess(1)
}
println("You selected $metricOption")
getAndDisplayMetricStatistics(selectedNamespace, selectedMetrics, metricOption, myDate, myDimension)
println(DASHES)
println(DASHES)
println("4. Get CloudWatch estimated billing for the last week.")
getMetricStatistics(costDateWeek)
println(DASHES)
println(DASHES)
println("5. Create a new CloudWatch dashboard with metrics.")
createDashboardWithMetrics(dashboardName, dashboardJson)
println(DASHES)
println(DASHES)
println("6. List dashboards using a paginator.")
listDashboards()
println(DASHES)
println(DASHES)
println("7. Create a new custom metric by adding data to it.")
createNewCustomMetric(dataPoint)
println(DASHES)
println(DASHES)
println("8. Add an additional metric to the dashboard.")
addMetricToDashboard(dashboardAdd, dashboardName)
println(DASHES)
println(DASHES)
println("9. Create an alarm for the custom metric.")
val alarmName: String = createAlarm(settings)
println(DASHES)
println(DASHES)
println("10. Describe 10 current alarms.")
describeAlarms()
println(DASHES)
println(DASHES)
println("11. Get current data for the new custom metric.")
getCustomMetricData(settings)
println(DASHES)
println(DASHES)
println("12. Push data into the custom metric to trigger the alarm.")
addMetricDataForAlarm(settings)
println(DASHES)
println(DASHES)
println("13. Check the alarm state using the action DescribeAlarmsForMetric.")
checkForMetricAlarm(settings)
println(DASHES)
println(DASHES)
println("14. Get alarm history for the new alarm.")
getAlarmHistory(settings, myDate)
println(DASHES)
println(DASHES)
println("15. Add an anomaly detector for the custom metric.")
addAnomalyDetector(settings)
println(DASHES)
println(DASHES)
println("16. Describe current anomaly detectors.")
describeAnomalyDetectors(settings)
println(DASHES)
println(DASHES)
println("17. Get a metric image for the custom metric.")
getAndOpenMetricImage(metricImage)
println(DASHES)
println(DASHES)
println("18. Clean up the Amazon CloudWatch resources.")
deleteDashboard(dashboardName)
deleteAlarm(alarmName)
deleteAnomalyDetector(settings)
println(DASHES)
println(DASHES)
println("The Amazon CloudWatch example scenario is complete.")
println(DASHES)
}
suspend fun deleteAnomalyDetector(fileName: String) {
// Read values from the JSON file.
val parser = JsonFactory().createParser(File(fileName))
val rootNode = ObjectMapper().readTree(parser)
val customMetricNamespace = rootNode.findValue("customMetricNamespace").asText()
val customMetricName = rootNode.findValue("customMetricName").asText()
val singleMetricAnomalyDetectorVal =
SingleMetricAnomalyDetector {
metricName = customMetricName
namespace = customMetricNamespace
stat = "Maximum"
}
val request =
DeleteAnomalyDetectorRequest {
singleMetricAnomalyDetector = singleMetricAnomalyDetectorVal
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
cwClient.deleteAnomalyDetector(request)
println("Successfully deleted the Anomaly Detector.")
}
}
suspend fun deleteAlarm(alarmNameVal: String) {
val request =
DeleteAlarmsRequest {
alarmNames = listOf(alarmNameVal)
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
cwClient.deleteAlarms(request)
println("Successfully deleted alarm $alarmNameVal")
}
}
suspend fun deleteDashboard(dashboardName: String) {
val dashboardsRequest =
DeleteDashboardsRequest {
dashboardNames = listOf(dashboardName)
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
cwClient.deleteDashboards(dashboardsRequest)
println("$dashboardName was successfully deleted.")
}
}
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")
}
suspend fun describeAnomalyDetectors(fileName: String) {
// Read values from the JSON file.
val parser = JsonFactory().createParser(File(fileName))
val rootNode = ObjectMapper().readTree(parser)
val customMetricNamespace = rootNode.findValue("customMetricNamespace").asText()
val customMetricName = rootNode.findValue("customMetricName").asText()
val detectorsRequest =
DescribeAnomalyDetectorsRequest {
maxResults = 10
metricName = customMetricName
namespace = customMetricNamespace
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
val response = cwClient.describeAnomalyDetectors(detectorsRequest)
response.anomalyDetectors?.forEach { detector ->
println("Metric name: ${detector.singleMetricAnomalyDetector?.metricName}")
println("State: ${detector.stateValue}")
}
}
}
suspend fun addAnomalyDetector(fileName: String?) {
// Read values from the JSON file.
val parser = JsonFactory().createParser(File(fileName))
val rootNode = ObjectMapper().readTree(parser)
val customMetricNamespace = rootNode.findValue("customMetricNamespace").asText()
val customMetricName = rootNode.findValue("customMetricName").asText()
val singleMetricAnomalyDetectorVal =
SingleMetricAnomalyDetector {
metricName = customMetricName
namespace = customMetricNamespace
stat = "Maximum"
}
val anomalyDetectorRequest =
PutAnomalyDetectorRequest {
singleMetricAnomalyDetector = singleMetricAnomalyDetectorVal
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
cwClient.putAnomalyDetector(anomalyDetectorRequest)
println("Added anomaly detector for metric $customMetricName.")
}
}
suspend fun getAlarmHistory(
fileName: String,
date: String,
) {
// Read values from the JSON file.
val parser = JsonFactory().createParser(File(fileName))
val rootNode = ObjectMapper().readTree(parser)
val alarmNameVal = rootNode.findValue("exampleAlarmName").asText()
val start = Instant.parse(date)
val endDateVal = Instant.now()
val historyRequest =
DescribeAlarmHistoryRequest {
startDate =
aws.smithy.kotlin.runtime.time
.Instant(start)
endDate =
aws.smithy.kotlin.runtime.time
.Instant(endDateVal)
alarmName = alarmNameVal
historyItemType = HistoryItemType.Action
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
val response = cwClient.describeAlarmHistory(historyRequest)
val historyItems = response.alarmHistoryItems
if (historyItems != null) {
if (historyItems.isEmpty()) {
println("No alarm history data found for $alarmNameVal.")
} else {
for (item in historyItems) {
println("History summary ${item.historySummary}")
println("Time stamp: ${item.timestamp}")
}
}
}
}
}
suspend fun checkForMetricAlarm(fileName: String?) {
// Read values from the JSON file.
val parser = JsonFactory().createParser(File(fileName))
val rootNode = ObjectMapper().readTree(parser)
val customMetricNamespace = rootNode.findValue("customMetricNamespace").asText()
val customMetricName = rootNode.findValue("customMetricName").asText()
var hasAlarm = false
var retries = 10
val metricRequest =
DescribeAlarmsForMetricRequest {
metricName = customMetricName
namespace = customMetricNamespace
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
while (!hasAlarm && retries > 0) {
val response = cwClient.describeAlarmsForMetric(metricRequest)
if (response.metricAlarms?.count()!! > 0) {
hasAlarm = true
}
retries--
delay(20000)
println(".")
}
if (!hasAlarm) {
println("No Alarm state found for $customMetricName after 10 retries.")
} else {
println("Alarm state found for $customMetricName.")
}
}
}
suspend fun addMetricDataForAlarm(fileName: String?) {
// Read values from the JSON file.
val parser = JsonFactory().createParser(File(fileName))
val rootNode = ObjectMapper().readTree(parser)
val customMetricNamespace = rootNode.findValue("customMetricNamespace").asText()
val customMetricName = rootNode.findValue("customMetricName").asText()
// Set an Instant object.
val time = ZonedDateTime.now(ZoneOffset.UTC).format(DateTimeFormatter.ISO_INSTANT)
val instant = Instant.parse(time)
val datum =
MetricDatum {
metricName = customMetricName
unit = StandardUnit.None
value = 1001.00
timestamp =
aws.smithy.kotlin.runtime.time
.Instant(instant)
}
val datum2 =
MetricDatum {
metricName = customMetricName
unit = StandardUnit.None
value = 1002.00
timestamp =
aws.smithy.kotlin.runtime.time
.Instant(instant)
}
val metricDataList = ArrayList()
metricDataList.add(datum)
metricDataList.add(datum2)
val request =
PutMetricDataRequest {
namespace = customMetricNamespace
metricData = metricDataList
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
cwClient.putMetricData(request)
println("Added metric values for for metric $customMetricName")
}
}
suspend fun getCustomMetricData(fileName: String) {
// Read values from the JSON file.
val parser = JsonFactory().createParser(File(fileName))
val rootNode = ObjectMapper().readTree(parser)
val customMetricNamespace = rootNode.findValue("customMetricNamespace").asText()
val customMetricName = rootNode.findValue("customMetricName").asText()
// Set the date.
val nowDate = Instant.now()
val hours: Long = 1
val minutes: Long = 30
val date2 =
nowDate.plus(hours, ChronoUnit.HOURS).plus(
minutes,
ChronoUnit.MINUTES,
)
val met =
Metric {
metricName = customMetricName
namespace = customMetricNamespace
}
val metStat =
MetricStat {
stat = "Maximum"
period = 1
metric = met
}
val dataQUery =
MetricDataQuery {
metricStat = metStat
id = "foo2"
returnData = true
}
val dq = ArrayList()
dq.add(dataQUery)
val getMetReq =
GetMetricDataRequest {
maxDatapoints = 10
scanBy = ScanBy.TimestampDescending
startTime =
aws.smithy.kotlin.runtime.time
.Instant(nowDate)
endTime =
aws.smithy.kotlin.runtime.time
.Instant(date2)
metricDataQueries = dq
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
val response = cwClient.getMetricData(getMetReq)
response.metricDataResults?.forEach { item ->
println("The label is ${item.label}")
println("The status code is ${item.statusCode}")
}
}
}
suspend fun describeAlarms() {
val typeList = ArrayList()
typeList.add(AlarmType.MetricAlarm)
val alarmsRequest =
DescribeAlarmsRequest {
alarmTypes = typeList
maxRecords = 10
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
val response = cwClient.describeAlarms(alarmsRequest)
response.metricAlarms?.forEach { alarm ->
println("Alarm name: ${alarm.alarmName}")
println("Alarm description: ${alarm.alarmDescription}")
}
}
}
suspend fun createAlarm(fileName: String): String {
// Read values from the JSON file.
val parser = JsonFactory().createParser(File(fileName))
val rootNode: JsonNode = ObjectMapper().readTree(parser)
val customMetricNamespace = rootNode.findValue("customMetricNamespace").asText()
val customMetricName = rootNode.findValue("customMetricName").asText()
val alarmNameVal = rootNode.findValue("exampleAlarmName").asText()
val emailTopic = rootNode.findValue("emailTopic").asText()
val accountId = rootNode.findValue("accountId").asText()
val region2 = rootNode.findValue("region").asText()
// Create a List for alarm actions.
val alarmActionObs: MutableList = ArrayList()
alarmActionObs.add("arn:aws:sns:$region2:$accountId:$emailTopic")
val alarmRequest =
PutMetricAlarmRequest {
alarmActions = alarmActionObs
alarmDescription = "Example metric alarm"
alarmName = alarmNameVal
comparisonOperator = ComparisonOperator.GreaterThanOrEqualToThreshold
threshold = 100.00
metricName = customMetricName
namespace = customMetricNamespace
evaluationPeriods = 1
period = 10
statistic = Statistic.Maximum
datapointsToAlarm = 1
treatMissingData = "ignore"
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
cwClient.putMetricAlarm(alarmRequest)
println("$alarmNameVal was successfully created!")
return alarmNameVal
}
}
suspend fun addMetricToDashboard(
fileNameVal: String,
dashboardNameVal: String,
) {
val dashboardRequest =
PutDashboardRequest {
dashboardName = dashboardNameVal
dashboardBody = readFileAsString(fileNameVal)
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
cwClient.putDashboard(dashboardRequest)
println("$dashboardNameVal was successfully updated.")
}
}
suspend fun createNewCustomMetric(dataPoint: Double) {
val dimension =
Dimension {
name = "UNIQUE_PAGES"
value = "URLS"
}
// Set an Instant object.
val time = ZonedDateTime.now(ZoneOffset.UTC).format(DateTimeFormatter.ISO_INSTANT)
val instant = Instant.parse(time)
val datum =
MetricDatum {
metricName = "PAGES_VISITED"
unit = StandardUnit.None
value = dataPoint
timestamp =
aws.smithy.kotlin.runtime.time
.Instant(instant)
dimensions = listOf(dimension)
}
val request =
PutMetricDataRequest {
namespace = "SITE/TRAFFIC"
metricData = listOf(datum)
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
cwClient.putMetricData(request)
println("Added metric values for for metric PAGES_VISITED")
}
}
suspend fun listDashboards() {
CloudWatchClient { region = "us-east-1" }.use { cwClient ->
cwClient
.listDashboardsPaginated({})
.transform { it.dashboardEntries?.forEach { obj -> emit(obj) } }
.collect { obj ->
println("Name is ${obj.dashboardName}")
println("Dashboard ARN is ${obj.dashboardArn}")
}
}
}
suspend fun createDashboardWithMetrics(
dashboardNameVal: String,
fileNameVal: String,
) {
val dashboardRequest =
PutDashboardRequest {
dashboardName = dashboardNameVal
dashboardBody = readFileAsString(fileNameVal)
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
val response = cwClient.putDashboard(dashboardRequest)
println("$dashboardNameVal was successfully created.")
val messages = response.dashboardValidationMessages
if (messages != null) {
if (messages.isEmpty()) {
println("There are no messages in the new Dashboard")
} else {
for (message in messages) {
println("Message is: ${message.message}")
}
}
}
}
}
fun readFileAsString(file: String): String = String(Files.readAllBytes(Paths.get(file)))
suspend fun getMetricStatistics(costDateWeek: String?) {
val start = Instant.parse(costDateWeek)
val endDate = Instant.now()
val dimension =
Dimension {
name = "Currency"
value = "USD"
}
val dimensionList: MutableList = ArrayList()
dimensionList.add(dimension)
val statisticsRequest =
GetMetricStatisticsRequest {
metricName = "EstimatedCharges"
namespace = "AWS/Billing"
dimensions = dimensionList
statistics = listOf(Statistic.Maximum)
startTime =
aws.smithy.kotlin.runtime.time
.Instant(start)
endTime =
aws.smithy.kotlin.runtime.time
.Instant(endDate)
period = 86400
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
val response = cwClient.getMetricStatistics(statisticsRequest)
val data: List? = response.datapoints
if (data != null) {
if (!data.isEmpty()) {
for (datapoint in data) {
println("Timestamp: ${datapoint.timestamp} Maximum value: ${datapoint.maximum}")
}
} else {
println("The returned data list is empty")
}
}
}
}
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")
}
}
}
}
suspend fun listMets(namespaceVal: String?): ArrayList? {
val metList = ArrayList()
val request =
ListMetricsRequest {
namespace = namespaceVal
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
val reponse = cwClient.listMetrics(request)
reponse.metrics?.forEach { metrics ->
val data = metrics.metricName
if (!metList.contains(data)) {
metList.add(data!!)
}
}
}
return metList
}
suspend fun getSpecificMet(namespaceVal: String?): Dimension? {
val request =
ListMetricsRequest {
namespace = namespaceVal
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
val response = cwClient.listMetrics(request)
val myList = response.metrics
if (myList != null) {
return myList[0].dimensions?.get(0)
}
}
return null
}
suspend fun listNameSpaces(): ArrayList {
val nameSpaceList = ArrayList()
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
val response = cwClient.listMetrics(ListMetricsRequest {})
response.metrics?.forEach { metrics ->
val data = metrics.namespace
if (!nameSpaceList.contains(data)) {
nameSpaceList.add(data!!)
}
}
}
return nameSpaceList
}
```
+ For API details, see the following topics in *AWS SDK for Kotlin API reference*.
+ [DeleteAlarms](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DeleteAnomalyDetector](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DeleteDashboards](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DescribeAlarmHistory](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DescribeAlarms](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DescribeAlarmsForMetric](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DescribeAnomalyDetectors](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [GetMetricData](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [GetMetricStatistics](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [GetMetricWidgetImage](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [ListMetrics](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [PutAnomalyDetector](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [PutDashboard](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [PutMetricAlarm](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [PutMetricData](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
------
# Actions for CloudWatch using AWS SDKs
The following code examples demonstrate how to perform individual CloudWatch actions with AWS SDKs. Each example includes a link to GitHub, where you can find instructions for setting up and running the code.
These excerpts call the CloudWatch API and are code excerpts from larger programs that must be run in context. You can see actions in context in [Scenarios for CloudWatch using AWS SDKs](cloudwatch_code_examples_scenarios.md).
The following examples include only the most commonly used actions. For a complete list, see the [Amazon CloudWatch API Reference](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/Welcome.html).
**Topics**
+ [`DeleteAlarms`](cloudwatch_example_cloudwatch_DeleteAlarms_section.md)
+ [`DeleteAnomalyDetector`](cloudwatch_example_cloudwatch_DeleteAnomalyDetector_section.md)
+ [`DeleteDashboards`](cloudwatch_example_cloudwatch_DeleteDashboards_section.md)
+ [`DescribeAlarmHistory`](cloudwatch_example_cloudwatch_DescribeAlarmHistory_section.md)
+ [`DescribeAlarms`](cloudwatch_example_cloudwatch_DescribeAlarms_section.md)
+ [`DescribeAlarmsForMetric`](cloudwatch_example_cloudwatch_DescribeAlarmsForMetric_section.md)
+ [`DescribeAnomalyDetectors`](cloudwatch_example_cloudwatch_DescribeAnomalyDetectors_section.md)
+ [`DisableAlarmActions`](cloudwatch_example_cloudwatch_DisableAlarmActions_section.md)
+ [`EnableAlarmActions`](cloudwatch_example_cloudwatch_EnableAlarmActions_section.md)
+ [`GetDashboard`](cloudwatch_example_cloudwatch_GetDashboard_section.md)
+ [`GetMetricData`](cloudwatch_example_cloudwatch_GetMetricData_section.md)
+ [`GetMetricStatistics`](cloudwatch_example_cloudwatch_GetMetricStatistics_section.md)
+ [`GetMetricWidgetImage`](cloudwatch_example_cloudwatch_GetMetricWidgetImage_section.md)
+ [`ListDashboards`](cloudwatch_example_cloudwatch_ListDashboards_section.md)
+ [`ListMetrics`](cloudwatch_example_cloudwatch_ListMetrics_section.md)
+ [`PutAnomalyDetector`](cloudwatch_example_cloudwatch_PutAnomalyDetector_section.md)
+ [`PutDashboard`](cloudwatch_example_cloudwatch_PutDashboard_section.md)
+ [`PutMetricAlarm`](cloudwatch_example_cloudwatch_PutMetricAlarm_section.md)
+ [`PutMetricData`](cloudwatch_example_cloudwatch_PutMetricData_section.md)
# Use `DeleteAlarms` with an AWS SDK or CLI
The following code examples show how to use `DeleteAlarms`.
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](cloudwatch_example_cloudwatch_GetStartedMetricsDashboardsAlarms_section.md)
+ [Get started with alarms](cloudwatch_example_cloudwatch_Scenario_GettingStarted_section.md)
+ [Manage metrics and alarms](cloudwatch_example_cloudwatch_Usage_MetricsAlarms_section.md)
+ [Run CPU stress tests on EC2 instances using FIS](cloudwatch_example_iam_GettingStarted_069_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).
```
///
/// Delete a list of alarms from CloudWatch.
///
/// A list of names of alarms to delete.
/// True if successful.
public async Task DeleteAlarms(List alarmNames)
{
var deleteAlarmsResult = await _amazonCloudWatch.DeleteAlarmsAsync(
new DeleteAlarmsRequest()
{
AlarmNames = alarmNames
});
return deleteAlarmsResult.HttpStatusCode == HttpStatusCode.OK;
}
```
+ For API details, see [DeleteAlarms](https://docs.aws.amazon.com/goto/DotNetSDKV4/monitoring-2010-08-01/DeleteAlarms) in *AWS SDK for .NET API Reference*.
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
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/cpp/example_code/cloudwatch#code-examples).
Include the required files.
```
#include
#include
#include
#include
```
Delete the alarm.
```
Aws::CloudWatch::CloudWatchClient cw;
Aws::CloudWatch::Model::DeleteAlarmsRequest request;
request.AddAlarmNames(alarm_name);
auto outcome = cw.DeleteAlarms(request);
if (!outcome.IsSuccess())
{
std::cout << "Failed to delete CloudWatch alarm:" <<
outcome.GetError().GetMessage() << std::endl;
}
else
{
std::cout << "Successfully deleted CloudWatch alarm " << alarm_name
<< std::endl;
}
```
+ For API details, see [DeleteAlarms](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/DeleteAlarms) in *AWS SDK for C\$1\$1 API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To delete an alarm**
The following example uses the `delete-alarms` command to delete the Amazon CloudWatch alarm named "myalarm":
```
aws cloudwatch delete-alarms --alarm-names myalarm
```
Output:
```
This command returns to the prompt if successful.
```
+ For API details, see [DeleteAlarms](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/delete-alarms.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).
```
/**
* Deletes a CloudWatch alarm.
*
* @param alarmName the name of the alarm to be deleted
* @return a {@link CompletableFuture} representing the asynchronous operation to delete the alarm
* the {@link DeleteAlarmsResponse} is returned when the operation completes successfully,
* or a {@link RuntimeException} is thrown if the operation fails
*/
public CompletableFuture deleteCWAlarmAsync(String alarmName) {
DeleteAlarmsRequest request = DeleteAlarmsRequest.builder()
.alarmNames(alarmName)
.build();
return getAsyncClient().deleteAlarms(request)
.whenComplete((response, exception) -> {
if (exception != null) {
throw new RuntimeException("Failed to delete the alarm:{} " + alarmName, exception);
} else {
logger.info("Successfully deleted alarm {} ", alarmName);
}
});
}
```
+ For API details, see [DeleteAlarms](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/DeleteAlarms) in *AWS SDK for Java 2.x API Reference*.
------
#### [ JavaScript ]
**SDK for JavaScript (v3)**
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/javascriptv3/example_code/cloudwatch#code-examples).
Import the SDK and client modules and call the API.
```
import { DeleteAlarmsCommand } from "@aws-sdk/client-cloudwatch";
import { client } from "../libs/client.js";
const run = async () => {
const command = new DeleteAlarmsCommand({
AlarmNames: [process.env.CLOUDWATCH_ALARM_NAME], // Set the value of CLOUDWATCH_ALARM_NAME to the name of an existing alarm.
});
try {
return await client.send(command);
} catch (err) {
console.error(err);
}
};
export default run();
```
Create the client in a separate module and export it.
```
import { CloudWatchClient } from "@aws-sdk/client-cloudwatch";
export const client = new CloudWatchClient({});
```
+ For more information, see [AWS SDK for JavaScript Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/cloudwatch-examples-creating-alarms.html#cloudwatch-examples-creating-alarms-deleting).
+ For API details, see [DeleteAlarms](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudwatch/command/DeleteAlarmsCommand) in *AWS SDK for JavaScript API Reference*.
**SDK for JavaScript (v2)**
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/javascript/example_code/cloudwatch#code-examples).
Import the SDK and client modules and call the API.
```
// Load the AWS SDK for Node.js
var AWS = require("aws-sdk");
// Set the region
AWS.config.update({ region: "REGION" });
// Create CloudWatch service object
var cw = new AWS.CloudWatch({ apiVersion: "2010-08-01" });
var params = {
AlarmNames: ["Web_Server_CPU_Utilization"],
};
cw.deleteAlarms(params, function (err, data) {
if (err) {
console.log("Error", err);
} else {
console.log("Success", data);
}
});
```
+ For more information, see [AWS SDK for JavaScript Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/cloudwatch-examples-creating-alarms.html#cloudwatch-examples-creating-alarms-deleting).
+ For API details, see [DeleteAlarms](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/monitoring-2010-08-01/DeleteAlarms) in *AWS SDK for JavaScript 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 deleteAlarm(alarmNameVal: String) {
val request =
DeleteAlarmsRequest {
alarmNames = listOf(alarmNameVal)
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
cwClient.deleteAlarms(request)
println("Successfully deleted alarm $alarmNameVal")
}
}
```
+ For API details, see [DeleteAlarms](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS 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 [AWS 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 delete_metric_alarms(self, metric_namespace, metric_name):
"""
Deletes all of the alarms that are currently watching the specified metric.
:param metric_namespace: The namespace of the metric.
:param metric_name: The name of the metric.
"""
try:
metric = self.cloudwatch_resource.Metric(metric_namespace, metric_name)
metric.alarms.delete()
logger.info(
"Deleted alarms for metric %s.%s.", metric_namespace, metric_name
)
except ClientError:
logger.exception(
"Couldn't delete alarms for metric %s.%s.",
metric_namespace,
metric_name,
)
raise
```
+ For API details, see [DeleteAlarms](https://docs.aws.amazon.com/goto/boto3/monitoring-2010-08-01/DeleteAlarms) in *AWS 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 [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cwt#code-examples).
```
TRY.
lo_cwt->deletealarms(
it_alarmnames = it_alarm_names ).
MESSAGE 'Alarms deleted.' TYPE 'I'.
CATCH /aws1/cx_cwtresourcenotfound.
MESSAGE 'Resource being accessed is not found.' TYPE 'E'.
ENDTRY.
```
+ For API details, see [DeleteAlarms](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `DeleteAnomalyDetector` with an AWS SDK or CLI
The following code examples show how to use `DeleteAnomalyDetector`.
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).
```
///
/// Delete a single metric anomaly detector.
///
/// The anomaly detector to delete.
/// True if successful.
public async Task DeleteAnomalyDetector(SingleMetricAnomalyDetector anomalyDetector)
{
var deleteAnomalyDetectorResponse = await _amazonCloudWatch.DeleteAnomalyDetectorAsync(
new DeleteAnomalyDetectorRequest()
{
SingleMetricAnomalyDetector = anomalyDetector
});
return deleteAnomalyDetectorResponse.HttpStatusCode == HttpStatusCode.OK;
}
```
+ For API details, see [DeleteAnomalyDetector](https://docs.aws.amazon.com/goto/DotNetSDKV4/monitoring-2010-08-01/DeleteAnomalyDetector) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To delete a specified anomaly detection model**
The following `delete-anomaly-detector` example deletes an anomaly detector model in the specified account.
```
aws cloudwatch delete-anomaly-detector \
--namespace AWS/Logs \
--metric-name IncomingBytes \
--stat SampleCount
```
This command produces no output.
For more information, see [Deleting an anomaly detection model](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Anomaly_Detection_Alarm.html#Delete_Anomaly_Detection_Model) in the *Amazon CloudWatch User Guide*.
+ For API details, see [DeleteAnomalyDetector](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/delete-anomaly-detector.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).
```
/**
* Deletes an Anomaly Detector.
*
* @param fileName the name of the file containing the Anomaly Detector configuration
* @return a CompletableFuture that represents the asynchronous deletion of the Anomaly Detector
*/
public CompletableFuture deleteAnomalyDetectorAsync(String fileName) {
CompletableFuture readFileFuture = CompletableFuture.supplyAsync(() -> {
try {
JsonParser parser = new JsonFactory().createParser(new File(fileName));
return new ObjectMapper().readTree(parser); // Return the root node
} catch (IOException e) {
throw new RuntimeException("Failed to read or parse the file", e);
}
});
return readFileFuture.thenCompose(rootNode -> {
String customMetricNamespace = rootNode.findValue("customMetricNamespace").asText();
String customMetricName = rootNode.findValue("customMetricName").asText();
SingleMetricAnomalyDetector singleMetricAnomalyDetector = SingleMetricAnomalyDetector.builder()
.metricName(customMetricName)
.namespace(customMetricNamespace)
.stat("Maximum")
.build();
DeleteAnomalyDetectorRequest request = DeleteAnomalyDetectorRequest.builder()
.singleMetricAnomalyDetector(singleMetricAnomalyDetector)
.build();
return getAsyncClient().deleteAnomalyDetector(request);
}).whenComplete((result, exception) -> {
if (exception != null) {
throw new RuntimeException("Failed to delete the Anomaly Detector", exception);
} else {
logger.info("Successfully deleted the Anomaly Detector.");
}
});
}
```
+ For API details, see [DeleteAnomalyDetector](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/DeleteAnomalyDetector) 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 deleteAnomalyDetector(fileName: String) {
// Read values from the JSON file.
val parser = JsonFactory().createParser(File(fileName))
val rootNode = ObjectMapper().readTree(parser)
val customMetricNamespace = rootNode.findValue("customMetricNamespace").asText()
val customMetricName = rootNode.findValue("customMetricName").asText()
val singleMetricAnomalyDetectorVal =
SingleMetricAnomalyDetector {
metricName = customMetricName
namespace = customMetricNamespace
stat = "Maximum"
}
val request =
DeleteAnomalyDetectorRequest {
singleMetricAnomalyDetector = singleMetricAnomalyDetectorVal
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
cwClient.deleteAnomalyDetector(request)
println("Successfully deleted the Anomaly Detector.")
}
}
```
+ For API details, see [DeleteAnomalyDetector](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
# Use `DeleteDashboards` with an AWS SDK or CLI
The following code examples show how to use `DeleteDashboards`.
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](cloudwatch_example_cloudwatch_GetStartedMetricsDashboardsAlarms_section.md)
+ [Creating a CloudWatch dashboard with function name as a variable](cloudwatch_example_cloudwatch_GettingStarted_031_section.md)
+ [Using property variables in CloudWatch dashboards to monitor multiple Lambda functions](cloudwatch_example_iam_GettingStarted_032_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).
```
///
/// Delete a list of CloudWatch dashboards.
///
/// List of dashboard names to delete.
/// True if successful.
public async Task DeleteDashboards(List dashboardNames)
{
var deleteDashboardsResponse = await _amazonCloudWatch.DeleteDashboardsAsync(
new DeleteDashboardsRequest()
{
DashboardNames = dashboardNames
});
return deleteDashboardsResponse.HttpStatusCode == HttpStatusCode.OK;
}
```
+ For API details, see [DeleteDashboards](https://docs.aws.amazon.com/goto/DotNetSDKV4/monitoring-2010-08-01/DeleteDashboards) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To delete specified dashboards**
The following `delete-dashboards` example deletes two dashboards named `Dashboard-A` and `Dashboard-B` in the specified account.
```
aws cloudwatch delete-dashboards \
--dashboard-names Dashboard-A Dashboard-B
```
This command produces no output.
For more information, see [Amazon CloudWatch dashboards](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Dashboards.html) in the *Amazon CloudWatch User Guide*.
+ For API details, see [DeleteDashboards](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/delete-dashboards.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).
```
/**
* Deletes the specified dashboard.
*
* @param dashboardName the name of the dashboard to be deleted
* @return a {@link CompletableFuture} representing the asynchronous operation of deleting the dashboard
* @throws RuntimeException if the dashboard deletion fails
*/
public CompletableFuture deleteDashboardAsync(String dashboardName) {
DeleteDashboardsRequest dashboardsRequest = DeleteDashboardsRequest.builder()
.dashboardNames(dashboardName)
.build();
return getAsyncClient().deleteDashboards(dashboardsRequest)
.whenComplete((response, exception) -> {
if (exception != null) {
throw new RuntimeException("Failed to delete the dashboard: " + dashboardName, exception);
} else {
logger.info("{} was successfully deleted.", dashboardName);
}
});
}
```
+ For API details, see [DeleteDashboards](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/DeleteDashboards) 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 deleteDashboard(dashboardName: String) {
val dashboardsRequest =
DeleteDashboardsRequest {
dashboardNames = listOf(dashboardName)
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
cwClient.deleteDashboards(dashboardsRequest)
println("$dashboardName was successfully deleted.")
}
}
```
+ For API details, see [DeleteDashboards](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: Deletes the specified dashboard, promoting for confirmation before proceeding. To bypass confirmation add the -Force switch to the command.**
```
Remove-CWDashboard -DashboardName Dashboard1
```
+ For API details, see [DeleteDashboards](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: Deletes the specified dashboard, promoting for confirmation before proceeding. To bypass confirmation add the -Force switch to the command.**
```
Remove-CWDashboard -DashboardName Dashboard1
```
+ For API details, see [DeleteDashboards](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DescribeAlarmHistory` with an AWS SDK or CLI
The following code examples show how to use `DescribeAlarmHistory`.
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).
```
///
/// Describe the history of an alarm for a number of days in the past.
///
/// The name of the alarm.
/// The number of days in the past.
/// The list of alarm history data.
public async Task> DescribeAlarmHistory(string alarmName, int historyDays)
{
List alarmHistory = new List();
var paginatedAlarmHistory = _amazonCloudWatch.Paginators.DescribeAlarmHistory(
new DescribeAlarmHistoryRequest()
{
AlarmName = alarmName,
EndDateUtc = DateTime.UtcNow,
HistoryItemType = HistoryItemType.StateUpdate,
StartDateUtc = DateTime.UtcNow.AddDays(-historyDays)
});
await foreach (var data in paginatedAlarmHistory.AlarmHistoryItems)
{
alarmHistory.Add(data);
}
return alarmHistory;
}
```
+ For API details, see [DescribeAlarmHistory](https://docs.aws.amazon.com/goto/DotNetSDKV4/monitoring-2010-08-01/DescribeAlarmHistory) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To retrieve history for an alarm**
The following example uses the `describe-alarm-history` command to retrieve history for the Amazon CloudWatch alarm named "myalarm":
```
aws cloudwatch describe-alarm-history --alarm-name "myalarm" --history-item-type StateUpdate
```
Output:
```
{
"AlarmHistoryItems": [
{
"Timestamp": "2014-04-09T18:59:06.442Z",
"HistoryItemType": "StateUpdate",
"AlarmName": "myalarm",
"HistoryData": "{\"version\":\"1.0\",\"oldState\":{\"stateValue\":\"ALARM\",\"stateReason\":\"testing purposes\"},\"newState\":{\"stateValue\":\"OK\",\"stateReason\":\"Threshold Crossed: 2 datapoints were not greater than the threshold (70.0). The most recent datapoints: [38.958, 40.292].\",\"stateReasonData\":{\"version\":\"1.0\",\"queryDate\":\"2014-04-09T18:59:06.419+0000\",\"startDate\":\"2014-04-09T18:44:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[38.958,40.292],\"threshold\":70.0}}}",
"HistorySummary": "Alarm updated from ALARM to OK"
},
{
"Timestamp": "2014-04-09T18:59:05.805Z",
"HistoryItemType": "StateUpdate",
"AlarmName": "myalarm",
"HistoryData": "{\"version\":\"1.0\",\"oldState\":{\"stateValue\":\"OK\",\"stateReason\":\"Threshold Crossed: 2 datapoints were not greater than the threshold (70.0). The most recent datapoints: [38.839999999999996, 39.714].\",\"stateReasonData\":{\"version\":\"1.0\",\"queryDate\":\"2014-03-11T22:45:41.569+0000\",\"startDate\":\"2014-03-11T22:30:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[38.839999999999996,39.714],\"threshold\":70.0}},\"newState\":{\"stateValue\":\"ALARM\",\"stateReason\":\"testing purposes\"}}",
"HistorySummary": "Alarm updated from OK to ALARM"
}
]
}
```
+ For API details, see [DescribeAlarmHistory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/describe-alarm-history.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 the alarm history for a given alarm name and date range.
*
* @param fileName the path to the JSON file containing the alarm name
* @param date the date to start the alarm history search (in the format "yyyy-MM-dd'T'HH:mm:ss'Z'")
* @return a {@code CompletableFuture} that completes when the alarm history has been retrieved and processed
*/
public CompletableFuture getAlarmHistoryAsync(String fileName, String date) {
CompletableFuture readFileFuture = CompletableFuture.supplyAsync(() -> {
try {
JsonParser parser = new JsonFactory().createParser(new File(fileName));
com.fasterxml.jackson.databind.JsonNode rootNode = new ObjectMapper().readTree(parser);
return rootNode.findValue("exampleAlarmName").asText(); // Return alarmName from the JSON file
} catch (IOException e) {
throw new RuntimeException("Failed to read or parse the file", e);
}
});
// Use the alarm name to describe alarm history with a paginator.
return readFileFuture.thenCompose(alarmName -> {
try {
Instant start = Instant.parse(date);
Instant endDate = Instant.now();
DescribeAlarmHistoryRequest historyRequest = DescribeAlarmHistoryRequest.builder()
.startDate(start)
.endDate(endDate)
.alarmName(alarmName)
.historyItemType(HistoryItemType.ACTION)
.build();
// Use the paginator to paginate through alarm history pages.
DescribeAlarmHistoryPublisher historyPublisher = getAsyncClient().describeAlarmHistoryPaginator(historyRequest);
CompletableFuture future = historyPublisher
.subscribe(response -> response.alarmHistoryItems().forEach(item -> {
logger.info("History summary: {}", item.historySummary());
logger.info("Timestamp: {}", item.timestamp());
}))
.whenComplete((result, exception) -> {
if (exception != null) {
logger.error("Error occurred while getting alarm history: " + exception.getMessage(), exception);
} else {
logger.info("Successfully retrieved all alarm history.");
}
});
// Return the future to the calling code for further handling
return future;
} catch (Exception e) {
throw new RuntimeException("Failed to process alarm history", e);
}
}).whenComplete((result, exception) -> {
if (exception != null) {
throw new RuntimeException("Error completing alarm history processing", exception);
}
});
}
```
+ For API details, see [DescribeAlarmHistory](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/DescribeAlarmHistory) 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 getAlarmHistory(
fileName: String,
date: String,
) {
// Read values from the JSON file.
val parser = JsonFactory().createParser(File(fileName))
val rootNode = ObjectMapper().readTree(parser)
val alarmNameVal = rootNode.findValue("exampleAlarmName").asText()
val start = Instant.parse(date)
val endDateVal = Instant.now()
val historyRequest =
DescribeAlarmHistoryRequest {
startDate =
aws.smithy.kotlin.runtime.time
.Instant(start)
endDate =
aws.smithy.kotlin.runtime.time
.Instant(endDateVal)
alarmName = alarmNameVal
historyItemType = HistoryItemType.Action
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
val response = cwClient.describeAlarmHistory(historyRequest)
val historyItems = response.alarmHistoryItems
if (historyItems != null) {
if (historyItems.isEmpty()) {
println("No alarm history data found for $alarmNameVal.")
} else {
for (item in historyItems) {
println("History summary ${item.historySummary}")
println("Time stamp: ${item.timestamp}")
}
}
}
}
}
```
+ For API details, see [DescribeAlarmHistory](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
# Use `DescribeAlarms` with an AWS SDK or CLI
The following code examples show how to use `DescribeAlarms`.
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](cloudwatch_example_cloudwatch_GetStartedMetricsDashboardsAlarms_section.md)
+ [Get started with alarms](cloudwatch_example_cloudwatch_Scenario_GettingStarted_section.md)
+ [Run CPU stress tests on EC2 instances using FIS](cloudwatch_example_iam_GettingStarted_069_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).
```
///
/// Describe the current alarms, optionally filtered by state.
///
/// Optional filter for alarm state.
/// The list of alarm data.
public async Task> DescribeAlarms(StateValue? stateValue = null)
{
List alarms = new List();
var paginatedDescribeAlarms = _amazonCloudWatch.Paginators.DescribeAlarms(
new DescribeAlarmsRequest()
{
StateValue = stateValue
});
await foreach (var data in paginatedDescribeAlarms.MetricAlarms)
{
alarms.Add(data);
}
return alarms;
}
```
+ For API details, see [DescribeAlarms](https://docs.aws.amazon.com/goto/DotNetSDKV4/monitoring-2010-08-01/DescribeAlarms) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To list information about an alarm**
The following example uses the `describe-alarms` command to provide information about the alarm named "myalarm":
```
aws cloudwatch describe-alarms --alarm-names "myalarm"
```
Output:
```
{
"MetricAlarms": [
{
"EvaluationPeriods": 2,
"AlarmArn": "arn:aws:cloudwatch:us-east-1:123456789012:alarm:myalarm",
"StateUpdatedTimestamp": "2014-04-09T18:59:06.442Z",
"AlarmConfigurationUpdatedTimestamp": "2012-12-27T00:49:54.032Z",
"ComparisonOperator": "GreaterThanThreshold",
"AlarmActions": [
"arn:aws:sns:us-east-1:123456789012:myHighCpuAlarm"
],
"Namespace": "AWS/EC2",
"AlarmDescription": "CPU usage exceeds 70 percent",
"StateReasonData": "{\"version\":\"1.0\",\"queryDate\":\"2014-04-09T18:59:06.419+0000\",\"startDate\":\"2014-04-09T18:44:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[38.958,40.292],\"threshold\":70.0}",
"Period": 300,
"StateValue": "OK",
"Threshold": 70.0,
"AlarmName": "myalarm",
"Dimensions": [
{
"Name": "InstanceId",
"Value": "i-0c986c72"
}
],
"Statistic": "Average",
"StateReason": "Threshold Crossed: 2 datapoints were not greater than the threshold (70.0). The most recent datapoints: [38.958, 40.292].",
"InsufficientDataActions": [],
"OKActions": [],
"ActionsEnabled": true,
"MetricName": "CPUUtilization"
}
]
}
```
+ For API details, see [DescribeAlarms](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/describe-alarms.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).
```
/**
* Describes the CloudWatch alarms of the 'METRIC_ALARM' type.
*
* @return a {@link CompletableFuture} that represents the asynchronous operation
* of describing the CloudWatch alarms. The future completes when the
* operation is finished, either successfully or with an error.
*/
public CompletableFuture describeAlarmsAsync() {
List typeList = new ArrayList<>();
typeList.add(AlarmType.METRIC_ALARM);
DescribeAlarmsRequest alarmsRequest = DescribeAlarmsRequest.builder()
.alarmTypes(typeList)
.maxRecords(10)
.build();
return getAsyncClient().describeAlarms(alarmsRequest)
.thenAccept(response -> {
List alarmList = response.metricAlarms();
for (MetricAlarm alarm : alarmList) {
logger.info("Alarm name: {}", alarm.alarmName());
logger.info("Alarm description: {} ", alarm.alarmDescription());
}
})
.whenComplete((response, ex) -> {
if (ex != null) {
logger.info("Failed to describe alarms: {}", ex.getMessage());
} else {
logger.info("Successfully described alarms.");
}
});
}
```
+ For API details, see [DescribeAlarms](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/DescribeAlarms) 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 describeAlarms() {
val typeList = ArrayList()
typeList.add(AlarmType.MetricAlarm)
val alarmsRequest =
DescribeAlarmsRequest {
alarmTypes = typeList
maxRecords = 10
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
val response = cwClient.describeAlarms(alarmsRequest)
response.metricAlarms?.forEach { alarm ->
println("Alarm name: ${alarm.alarmName}")
println("Alarm description: ${alarm.alarmDescription}")
}
}
}
```
+ For API details, see [DescribeAlarms](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: Returns all the alarms including Composite and Metric Alarms from CloudWatch.**
```
Get-CWAlarm -MaxRecords 1
```
**Output:**
```
CompositeAlarms MetricAlarms NextToken
--------------- ------------ ---------
{MetricAlarms-01} NextToken-01
{MetricAlarms-02} NextToken-02
{MetricAlarms-03} NextToken-03
```
**Example 2: Returns only the composite alarms data from CloudWatch after setting -AlarmType parameter to CompositeAlarms.**
```
Get-CWAlarm -AlarmType 'CompositeAlarms'
```
**Output:**
```
CompositeAlarms MetricAlarms NextToken
--------------- ------------ ---------
{CompositeAlarms-01}
{CompositeAlarms-02}
{CompositeAlarms-03}
```
+ For API details, see [DescribeAlarms](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
------
#### [ Ruby ]
**SDK for Ruby**
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/ruby/example_code/cloudwatch#code-examples).
```
require 'aws-sdk-cloudwatch'
# Lists the names of available Amazon CloudWatch alarms.
#
# @param cloudwatch_client [Aws::CloudWatch::Client]
# An initialized CloudWatch client.
# @example
# list_alarms(Aws::CloudWatch::Client.new(region: 'us-east-1'))
def list_alarms(cloudwatch_client)
response = cloudwatch_client.describe_alarms
if response.metric_alarms.count.positive?
response.metric_alarms.each do |alarm|
puts alarm.alarm_name
end
else
puts 'No alarms found.'
end
rescue StandardError => e
puts "Error getting information about alarms: #{e.message}"
end
```
+ For API details, see [DescribeAlarms](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/DescribeAlarms) in *AWS SDK for Ruby 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 [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cwt#code-examples).
```
TRY.
oo_result = lo_cwt->describealarms( " oo_result is returned for testing purposes. "
it_alarmnames = it_alarm_names ).
MESSAGE 'Alarms retrieved.' TYPE 'I'.
CATCH /aws1/cx_rt_service_generic INTO DATA(lo_exception).
DATA(lv_error) = |"{ lo_exception->av_err_code }" - { lo_exception->av_err_msg }|.
MESSAGE lv_error TYPE 'E'.
ENDTRY.
```
+ For API details, see [DescribeAlarms](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `DescribeAlarmsForMetric` with an AWS SDK or CLI
The following code examples show how to use `DescribeAlarmsForMetric`.
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](cloudwatch_example_cloudwatch_GetStartedMetricsDashboardsAlarms_section.md)
+ [Manage metrics and alarms](cloudwatch_example_cloudwatch_Usage_MetricsAlarms_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).
```
///
/// Describe the current alarms for a specific metric.
///
/// The namespace of the metric.
/// The name of the metric.
/// The list of alarm data.
public async Task> DescribeAlarmsForMetric(string metricNamespace, string metricName)
{
var alarmsResult = await _amazonCloudWatch.DescribeAlarmsForMetricAsync(
new DescribeAlarmsForMetricRequest()
{
Namespace = metricNamespace,
MetricName = metricName
});
return alarmsResult.MetricAlarms ?? new List();
}
```
+ For API details, see [DescribeAlarmsForMetric](https://docs.aws.amazon.com/goto/DotNetSDKV4/monitoring-2010-08-01/DescribeAlarmsForMetric) in *AWS SDK for .NET API Reference*.
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
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/cpp/example_code/cloudwatch#code-examples).
Include the required files.
```
#include
#include
#include
#include
#include
#include
```
Describe the alarms.
```
Aws::CloudWatch::CloudWatchClient cw;
Aws::CloudWatch::Model::DescribeAlarmsRequest request;
request.SetMaxRecords(1);
bool done = false;
bool header = false;
while (!done)
{
auto outcome = cw.DescribeAlarms(request);
if (!outcome.IsSuccess())
{
std::cout << "Failed to describe CloudWatch alarms:" <<
outcome.GetError().GetMessage() << std::endl;
break;
}
if (!header)
{
std::cout << std::left <<
std::setw(32) << "Name" <<
std::setw(64) << "Arn" <<
std::setw(64) << "Description" <<
std::setw(20) << "LastUpdated" <<
std::endl;
header = true;
}
const auto &alarms = outcome.GetResult().GetMetricAlarms();
for (const auto &alarm : alarms)
{
std::cout << std::left <<
std::setw(32) << alarm.GetAlarmName() <<
std::setw(64) << alarm.GetAlarmArn() <<
std::setw(64) << alarm.GetAlarmDescription() <<
std::setw(20) <<
alarm.GetAlarmConfigurationUpdatedTimestamp().ToGmtString(
SIMPLE_DATE_FORMAT_STR) <<
std::endl;
}
const auto &next_token = outcome.GetResult().GetNextToken();
request.SetNextToken(next_token);
done = next_token.empty();
}
```
+ For API details, see [DescribeAlarmsForMetric](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/DescribeAlarmsForMetric) in *AWS SDK for C\$1\$1 API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To display information about alarms associated with a metric**
The following example uses the `describe-alarms-for-metric` command to display information about any alarms associated with the Amazon EC2 CPUUtilization metric and the instance with the ID i-0c986c72.:
```
aws cloudwatch describe-alarms-for-metric --metric-name CPUUtilization --namespace AWS/EC2 --dimensions Name=InstanceId,Value=i-0c986c72
```
Output:
```
{
"MetricAlarms": [
{
"EvaluationPeriods": 10,
"AlarmArn": "arn:aws:cloudwatch:us-east-1:111122223333:alarm:myHighCpuAlarm2",
"StateUpdatedTimestamp": "2013-10-30T03:03:51.479Z",
"AlarmConfigurationUpdatedTimestamp": "2013-10-30T03:03:50.865Z",
"ComparisonOperator": "GreaterThanOrEqualToThreshold",
"AlarmActions": [
"arn:aws:sns:us-east-1:111122223333:NotifyMe"
],
"Namespace": "AWS/EC2",
"AlarmDescription": "CPU usage exceeds 70 percent",
"StateReasonData": "{\"version\":\"1.0\",\"queryDate\":\"2013-10-30T03:03:51.479+0000\",\"startDate\":\"2013-10-30T02:08:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[40.698,39.612,42.432,39.796,38.816,42.28,42.854,40.088,40.760000000000005,41.316],\"threshold\":70.0}",
"Period": 300,
"StateValue": "OK",
"Threshold": 70.0,
"AlarmName": "myHighCpuAlarm2",
"Dimensions": [
{
"Name": "InstanceId",
"Value": "i-0c986c72"
}
],
"Statistic": "Average",
"StateReason": "Threshold Crossed: 10 datapoints were not greater than or equal to the threshold (70.0). The most recent datapoints: [40.760000000000005, 41.316].",
"InsufficientDataActions": [],
"OKActions": [],
"ActionsEnabled": true,
"MetricName": "CPUUtilization"
},
{
"EvaluationPeriods": 2,
"AlarmArn": "arn:aws:cloudwatch:us-east-1:111122223333:alarm:myHighCpuAlarm",
"StateUpdatedTimestamp": "2014-04-09T18:59:06.442Z",
"AlarmConfigurationUpdatedTimestamp": "2014-04-09T22:26:05.958Z",
"ComparisonOperator": "GreaterThanThreshold",
"AlarmActions": [
"arn:aws:sns:us-east-1:111122223333:HighCPUAlarm"
],
"Namespace": "AWS/EC2",
"AlarmDescription": "CPU usage exceeds 70 percent",
"StateReasonData": "{\"version\":\"1.0\",\"queryDate\":\"2014-04-09T18:59:06.419+0000\",\"startDate\":\"2014-04-09T18:44:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[38.958,40.292],\"threshold\":70.0}",
"Period": 300,
"StateValue": "OK",
"Threshold": 70.0,
"AlarmName": "myHighCpuAlarm",
"Dimensions": [
{
"Name": "InstanceId",
"Value": "i-0c986c72"
}
],
"Statistic": "Average",
"StateReason": "Threshold Crossed: 2 datapoints were not greater than the threshold (70.0). The most recent datapoints: [38.958, 40.292].",
"InsufficientDataActions": [],
"OKActions": [],
"ActionsEnabled": false,
"MetricName": "CPUUtilization"
}
]
}
```
+ For API details, see [DescribeAlarmsForMetric](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/describe-alarms-for-metric.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).
```
/**
* Checks for a metric alarm in AWS CloudWatch.
*
* @param fileName the name of the file containing the JSON configuration for the custom metric
* @return a {@link CompletableFuture} that completes when the check for the metric alarm is complete
*/
public CompletableFuture checkForMetricAlarmAsync(String fileName) {
CompletableFuture readFileFuture = CompletableFuture.supplyAsync(() -> {
try {
JsonParser parser = new JsonFactory().createParser(new File(fileName));
com.fasterxml.jackson.databind.JsonNode rootNode = new ObjectMapper().readTree(parser);
return rootNode.toString(); // Return JSON as a string for further processing
} catch (IOException e) {
throw new RuntimeException("Failed to read file", e);
}
});
return readFileFuture.thenCompose(jsonContent -> {
try {
com.fasterxml.jackson.databind.JsonNode rootNode = new ObjectMapper().readTree(jsonContent);
String customMetricNamespace = rootNode.findValue("customMetricNamespace").asText();
String customMetricName = rootNode.findValue("customMetricName").asText();
DescribeAlarmsForMetricRequest metricRequest = DescribeAlarmsForMetricRequest.builder()
.metricName(customMetricName)
.namespace(customMetricNamespace)
.build();
return checkForAlarmAsync(metricRequest, customMetricName, 10);
} catch (IOException e) {
throw new RuntimeException("Failed to parse JSON content", e);
}
}).whenComplete((result, exception) -> {
if (exception != null) {
throw new RuntimeException("Error checking metric alarm", exception);
}
});
}
// Recursive method to check for the alarm.
/**
* Checks for the existence of an alarm asynchronously for the specified metric.
*
* @param metricRequest the request to describe the alarms for the specified metric
* @param customMetricName the name of the custom metric to check for an alarm
* @param retries the number of retries to perform if no alarm is found
* @return a {@link CompletableFuture} that completes when an alarm is found or the maximum number of retries has been reached
*/
private static CompletableFuture checkForAlarmAsync(DescribeAlarmsForMetricRequest metricRequest, String customMetricName, int retries) {
if (retries == 0) {
return CompletableFuture.completedFuture(null).thenRun(() ->
logger.info("No Alarm state found for {} after 10 retries.", customMetricName)
);
}
return (getAsyncClient().describeAlarmsForMetric(metricRequest).thenCompose(response -> {
if (response.hasMetricAlarms()) {
logger.info("Alarm state found for {}", customMetricName);
return CompletableFuture.completedFuture(null); // Alarm found, complete the future
} else {
return CompletableFuture.runAsync(() -> {
try {
Thread.sleep(20000);
logger.info(".");
} catch (InterruptedException e) {
throw new RuntimeException("Interrupted while waiting to retry", e);
}
}).thenCompose(v -> checkForAlarmAsync(metricRequest, customMetricName, retries - 1)); // Recursive call
}
}));
}
```
+ For API details, see [DescribeAlarmsForMetric](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/DescribeAlarmsForMetric) in *AWS SDK for Java 2.x API Reference*.
------
#### [ JavaScript ]
**SDK for JavaScript (v3)**
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/javascriptv3/example_code/cloudwatch#code-examples).
Import the SDK and client modules and call the API.
```
import { DescribeAlarmsCommand } from "@aws-sdk/client-cloudwatch";
import { client } from "../libs/client.js";
const run = async () => {
const command = new DescribeAlarmsCommand({
AlarmNames: [process.env.CLOUDWATCH_ALARM_NAME], // Set the value of CLOUDWATCH_ALARM_NAME to the name of an existing alarm.
});
try {
return await client.send(command);
} catch (err) {
console.error(err);
}
};
export default run();
```
Create the client in a separate module and export it.
```
import { CloudWatchClient } from "@aws-sdk/client-cloudwatch";
export const client = new CloudWatchClient({});
```
+ For more information, see [AWS SDK for JavaScript Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/cloudwatch-examples-creating-alarms.html#cloudwatch-examples-creating-alarms-describing).
+ For API details, see [DescribeAlarmsForMetric](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudwatch/command/DescribeAlarmsForMetricCommand) in *AWS SDK for JavaScript API Reference*.
**SDK for JavaScript (v2)**
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/javascript/example_code/cloudwatch#code-examples).
```
// Load the AWS SDK for Node.js
var AWS = require("aws-sdk");
// Set the region
AWS.config.update({ region: "REGION" });
// Create CloudWatch service object
var cw = new AWS.CloudWatch({ apiVersion: "2010-08-01" });
cw.describeAlarms({ StateValue: "INSUFFICIENT_DATA" }, function (err, data) {
if (err) {
console.log("Error", err);
} else {
// List the names of all current alarms in the console
data.MetricAlarms.forEach(function (item, index, array) {
console.log(item.AlarmName);
});
}
});
```
+ For more information, see [AWS SDK for JavaScript Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/cloudwatch-examples-creating-alarms.html#cloudwatch-examples-creating-alarms-describing).
+ For API details, see [DescribeAlarmsForMetric](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/monitoring-2010-08-01/DescribeAlarmsForMetric) in *AWS SDK for JavaScript 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 checkForMetricAlarm(fileName: String?) {
// Read values from the JSON file.
val parser = JsonFactory().createParser(File(fileName))
val rootNode = ObjectMapper().readTree(parser)
val customMetricNamespace = rootNode.findValue("customMetricNamespace").asText()
val customMetricName = rootNode.findValue("customMetricName").asText()
var hasAlarm = false
var retries = 10
val metricRequest =
DescribeAlarmsForMetricRequest {
metricName = customMetricName
namespace = customMetricNamespace
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
while (!hasAlarm && retries > 0) {
val response = cwClient.describeAlarmsForMetric(metricRequest)
if (response.metricAlarms?.count()!! > 0) {
hasAlarm = true
}
retries--
delay(20000)
println(".")
}
if (!hasAlarm) {
println("No Alarm state found for $customMetricName after 10 retries.")
} else {
println("Alarm state found for $customMetricName.")
}
}
}
```
+ For API details, see [DescribeAlarmsForMetric](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS 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 [AWS 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_alarms(self, metric_namespace, metric_name):
"""
Gets the alarms that are currently watching the specified metric.
:param metric_namespace: The namespace of the metric.
:param metric_name: The name of the metric.
:returns: An iterator that yields the alarms.
"""
metric = self.cloudwatch_resource.Metric(metric_namespace, metric_name)
alarm_iter = metric.alarms.all()
logger.info("Got alarms for metric %s.%s.", metric_namespace, metric_name)
return alarm_iter
```
+ For API details, see [DescribeAlarmsForMetric](https://docs.aws.amazon.com/goto/boto3/monitoring-2010-08-01/DescribeAlarmsForMetric) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ Ruby ]
**SDK for Ruby**
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/ruby/example_code/cloudwatch#code-examples).
```
#
# @param cloudwatch_client [Aws::CloudWatch::Client]
# An initialized CloudWatch client.
# @example
# describe_metric_alarms(Aws::CloudWatch::Client.new(region: 'us-east-1'))
def describe_metric_alarms(cloudwatch_client)
response = cloudwatch_client.describe_alarms
if response.metric_alarms.count.positive?
response.metric_alarms.each do |alarm|
puts '-' * 16
puts "Name: #{alarm.alarm_name}"
puts "State value: #{alarm.state_value}"
puts "State reason: #{alarm.state_reason}"
puts "Metric: #{alarm.metric_name}"
puts "Namespace: #{alarm.namespace}"
puts "Statistic: #{alarm.statistic}"
puts "Period: #{alarm.period}"
puts "Unit: #{alarm.unit}"
puts "Eval. periods: #{alarm.evaluation_periods}"
puts "Threshold: #{alarm.threshold}"
puts "Comp. operator: #{alarm.comparison_operator}"
if alarm.key?(:ok_actions) && alarm.ok_actions.count.positive?
puts 'OK actions:'
alarm.ok_actions.each do |a|
puts " #{a}"
end
end
if alarm.key?(:alarm_actions) && alarm.alarm_actions.count.positive?
puts 'Alarm actions:'
alarm.alarm_actions.each do |a|
puts " #{a}"
end
end
if alarm.key?(:insufficient_data_actions) &&
alarm.insufficient_data_actions.count.positive?
puts 'Insufficient data actions:'
alarm.insufficient_data_actions.each do |a|
puts " #{a}"
end
end
puts 'Dimensions:'
if alarm.key?(:dimensions) && alarm.dimensions.count.positive?
alarm.dimensions.each do |d|
puts " Name: #{d.name}, Value: #{d.value}"
end
else
puts ' None for this alarm.'
end
end
else
puts 'No alarms found.'
end
rescue StandardError => e
puts "Error getting information about alarms: #{e.message}"
end
# Example usage:
def run_me
region = ''
# Print usage information and then stop.
if ARGV[0] == '--help' || ARGV[0] == '-h'
puts 'Usage: ruby cw-ruby-example-show-alarms.rb REGION'
puts 'Example: ruby cw-ruby-example-show-alarms.rb us-east-1'
exit 1
# If no values are specified at the command prompt, use these default values.
elsif ARGV.count.zero?
region = 'us-east-1'
# Otherwise, use the values as specified at the command prompt.
else
region = ARGV[0]
end
cloudwatch_client = Aws::CloudWatch::Client.new(region: region)
puts 'Available alarms:'
describe_metric_alarms(cloudwatch_client)
end
run_me if $PROGRAM_NAME == __FILE__
```
+ For API details, see [DescribeAlarmsForMetric](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/DescribeAlarmsForMetric) in *AWS SDK for Ruby 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 [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cwt#code-examples).
```
TRY.
oo_result = lo_cwt->describealarmsformetric( " oo_result is returned for testing purposes. "
iv_namespace = iv_namespace
iv_metricname = iv_metric_name
it_dimensions = it_dimensions
iv_statistic = iv_statistic
iv_period = iv_period
iv_unit = iv_unit ).
MESSAGE 'Alarms for metric retrieved.' TYPE 'I'.
CATCH /aws1/cx_rt_service_generic INTO DATA(lo_exception).
DATA(lv_error) = |"{ lo_exception->av_err_code }" - { lo_exception->av_err_msg }|.
MESSAGE lv_error TYPE 'E'.
ENDTRY.
```
+ For API details, see [DescribeAlarmsForMetric](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `DescribeAnomalyDetectors` with an AWS SDK or CLI
The following code examples show how to use `DescribeAnomalyDetectors`.
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).
```
///
/// Describe anomaly detectors for a metric and namespace.
///
/// The namespace of the metric.
/// The metric of the anomaly detectors.
/// The list of detectors.
public async Task> DescribeAnomalyDetectors(string metricNamespace, string metricName)
{
List detectors = new List();
var paginatedDescribeAnomalyDetectors = _amazonCloudWatch.Paginators.DescribeAnomalyDetectors(
new DescribeAnomalyDetectorsRequest()
{
MetricName = metricName,
Namespace = metricNamespace
});
await foreach (var data in paginatedDescribeAnomalyDetectors.AnomalyDetectors)
{
detectors.Add(data);
}
return detectors;
}
```
+ For API details, see [DescribeAnomalyDetectors](https://docs.aws.amazon.com/goto/DotNetSDKV4/monitoring-2010-08-01/DescribeAnomalyDetectors) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To retrieve a list of anomaly detection models**
The following `describe-anomaly-detectors` example displays information about anomaly detector models that are associated with the `AWS/Logs` namespace in the specified account.
```
aws cloudwatch describe-anomaly-detectors \
--namespace AWS/Logs
```
Output:
```
{
"AnomalyDetectors": [
{
"Namespace": "AWS/Logs",
"MetricName": "IncomingBytes",
"Dimensions": [],
"Stat": "SampleCount",
"Configuration": {
"ExcludedTimeRanges": []
},
"StateValue": "TRAINED",
"SingleMetricAnomalyDetector": {
"AccountId": "123456789012",
"Namespace": "AWS/Logs",
"MetricName": "IncomingBytes",
"Dimensions": [],
"Stat": "SampleCount"
}
},
{
"Namespace": "AWS/Logs",
"MetricName": "IncomingBytes",
"Dimensions": [
{
"Name": "LogGroupName",
"Value": "demo"
}
],
"Stat": "Average",
"Configuration": {
"ExcludedTimeRanges": []
},
"StateValue": "PENDING_TRAINING",
"SingleMetricAnomalyDetector": {
"AccountId": "123456789012",
"Namespace": "AWS/Logs",
"MetricName": "IncomingBytes",
"Dimensions": [
{
"Name": "LogGroupName",
"Value": "demo"
}
],
"Stat": "Average"
}
}
]
}
```
For more information, see [Using CloudWatch anomaly detection](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Anomaly_Detection.html) in the *Amazon CloudWatch User Guide*.
+ For API details, see [DescribeAnomalyDetectors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/describe-anomaly-detectors.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).
```
/**
* Describes the anomaly detectors based on the specified JSON file.
*
* @param fileName the name of the JSON file containing the custom metric namespace and name
* @return a {@link CompletableFuture} that completes when the anomaly detectors have been described
* @throws RuntimeException if there is a failure during the operation, such as when reading or parsing the JSON file,
* or when describing the anomaly detectors
*/
public CompletableFuture describeAnomalyDetectorsAsync(String fileName) {
CompletableFuture readFileFuture = CompletableFuture.supplyAsync(() -> {
try {
JsonParser parser = new JsonFactory().createParser(new File(fileName));
return new ObjectMapper().readTree(parser);
} catch (IOException e) {
throw new RuntimeException("Failed to read or parse the file", e);
}
});
return readFileFuture.thenCompose(rootNode -> {
try {
String customMetricNamespace = rootNode.findValue("customMetricNamespace").asText();
String customMetricName = rootNode.findValue("customMetricName").asText();
DescribeAnomalyDetectorsRequest detectorsRequest = DescribeAnomalyDetectorsRequest.builder()
.maxResults(10)
.metricName(customMetricName)
.namespace(customMetricNamespace)
.build();
return getAsyncClient().describeAnomalyDetectors(detectorsRequest).thenAccept(response -> {
List anomalyDetectorList = response.anomalyDetectors();
for (AnomalyDetector detector : anomalyDetectorList) {
logger.info("Metric name: {} ", detector.singleMetricAnomalyDetector().metricName());
logger.info("State: {} ", detector.stateValue());
}
});
} catch (RuntimeException e) {
throw new RuntimeException("Failed to describe anomaly detectors", e);
}
}).whenComplete((result, exception) -> {
if (exception != null) {
throw new RuntimeException("Error describing anomaly detectors", exception);
}
});
}
```
+ For API details, see [DescribeAnomalyDetectors](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/DescribeAnomalyDetectors) 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 describeAnomalyDetectors(fileName: String) {
// Read values from the JSON file.
val parser = JsonFactory().createParser(File(fileName))
val rootNode = ObjectMapper().readTree(parser)
val customMetricNamespace = rootNode.findValue("customMetricNamespace").asText()
val customMetricName = rootNode.findValue("customMetricName").asText()
val detectorsRequest =
DescribeAnomalyDetectorsRequest {
maxResults = 10
metricName = customMetricName
namespace = customMetricNamespace
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
val response = cwClient.describeAnomalyDetectors(detectorsRequest)
response.anomalyDetectors?.forEach { detector ->
println("Metric name: ${detector.singleMetricAnomalyDetector?.metricName}")
println("State: ${detector.stateValue}")
}
}
}
```
+ For API details, see [DescribeAnomalyDetectors](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
# Use `DisableAlarmActions` with an AWS SDK or CLI
The following code examples show how to use `DisableAlarmActions`.
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:
+ [Get started with alarms](cloudwatch_example_cloudwatch_Scenario_GettingStarted_section.md)
+ [Manage metrics and alarms](cloudwatch_example_cloudwatch_Usage_MetricsAlarms_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).
```
///
/// Disable the actions for a list of alarms from CloudWatch.
///
/// A list of names of alarms.
/// True if successful.
public async Task DisableAlarmActions(List alarmNames)
{
var disableAlarmActionsResult = await _amazonCloudWatch.DisableAlarmActionsAsync(
new DisableAlarmActionsRequest()
{
AlarmNames = alarmNames
});
return disableAlarmActionsResult.HttpStatusCode == HttpStatusCode.OK;
}
```
+ For API details, see [DisableAlarmActions](https://docs.aws.amazon.com/goto/DotNetSDKV4/monitoring-2010-08-01/DisableAlarmActions) in *AWS SDK for .NET API Reference*.
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
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/cpp/example_code/cloudwatch#code-examples).
Include the required files.
```
#include
#include
#include
#include
```
Disable the alarm actions.
```
Aws::CloudWatch::CloudWatchClient cw;
Aws::CloudWatch::Model::DisableAlarmActionsRequest disableAlarmActionsRequest;
disableAlarmActionsRequest.AddAlarmNames(alarm_name);
auto disableAlarmActionsOutcome = cw.DisableAlarmActions(disableAlarmActionsRequest);
if (!disableAlarmActionsOutcome.IsSuccess())
{
std::cout << "Failed to disable actions for alarm " << alarm_name <<
": " << disableAlarmActionsOutcome.GetError().GetMessage() <<
std::endl;
}
else
{
std::cout << "Successfully disabled actions for alarm " <<
alarm_name << std::endl;
}
```
+ For API details, see [DisableAlarmActions](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/DisableAlarmActions) in *AWS SDK for C\$1\$1 API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To disable actions for an alarm**
The following example uses the `disable-alarm-actions` command to disable all actions for the alarm named myalarm.:
```
aws cloudwatch disable-alarm-actions --alarm-names myalarm
```
This command returns to the prompt if successful.
+ For API details, see [DisableAlarmActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/disable-alarm-actions.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).
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.cloudwatch.CloudWatchClient;
import software.amazon.awssdk.services.cloudwatch.model.CloudWatchException;
import software.amazon.awssdk.services.cloudwatch.model.DisableAlarmActionsRequest;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class DisableAlarmActions {
public static void main(String[] args) {
final String usage = """
Usage:
Where:
alarmName - An alarm name to disable (for example, MyAlarm).
""";
if (args.length != 1) {
System.out.println(usage);
System.exit(1);
}
String alarmName = args[0];
Region region = Region.US_EAST_1;
CloudWatchClient cw = CloudWatchClient.builder()
.region(region)
.build();
disableActions(cw, alarmName);
cw.close();
}
public static void disableActions(CloudWatchClient cw, String alarmName) {
try {
DisableAlarmActionsRequest request = DisableAlarmActionsRequest.builder()
.alarmNames(alarmName)
.build();
cw.disableAlarmActions(request);
System.out.printf("Successfully disabled actions on alarm %s", alarmName);
} catch (CloudWatchException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ For API details, see [DisableAlarmActions](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/DisableAlarmActions) in *AWS SDK for Java 2.x API Reference*.
------
#### [ JavaScript ]
**SDK for JavaScript (v3)**
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/javascriptv3/example_code/cloudwatch#code-examples).
Import the SDK and client modules and call the API.
```
import { DisableAlarmActionsCommand } from "@aws-sdk/client-cloudwatch";
import { client } from "../libs/client.js";
const run = async () => {
const command = new DisableAlarmActionsCommand({
AlarmNames: process.env.CLOUDWATCH_ALARM_NAME, // Set the value of CLOUDWATCH_ALARM_NAME to the name of an existing alarm.
});
try {
return await client.send(command);
} catch (err) {
console.error(err);
}
};
export default run();
```
Create the client in a separate module and export it.
```
import { CloudWatchClient } from "@aws-sdk/client-cloudwatch";
export const client = new CloudWatchClient({});
```
+ For more information, see [AWS SDK for JavaScript Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/cloudwatch-examples-using-alarm-actions.html#cloudwatch-examples-using-alarm-actions-disabling).
+ For API details, see [DisableAlarmActions](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudwatch/command/DisableAlarmActionsCommand) in *AWS SDK for JavaScript API Reference*.
**SDK for JavaScript (v2)**
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/javascript/example_code/cloudwatch#code-examples).
Import the SDK and client modules and call the API.
```
// Load the AWS SDK for Node.js
var AWS = require("aws-sdk");
// Set the region
AWS.config.update({ region: "REGION" });
// Create CloudWatch service object
var cw = new AWS.CloudWatch({ apiVersion: "2010-08-01" });
cw.disableAlarmActions(
{ AlarmNames: ["Web_Server_CPU_Utilization"] },
function (err, data) {
if (err) {
console.log("Error", err);
} else {
console.log("Success", data);
}
}
);
```
+ For more information, see [AWS SDK for JavaScript Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/cloudwatch-examples-using-alarm-actions.html#cloudwatch-examples-using-alarm-actions-disabling).
+ For API details, see [DisableAlarmActions](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/monitoring-2010-08-01/DisableAlarmActions) in *AWS SDK for JavaScript 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 disableActions(alarmName: String) {
val request =
DisableAlarmActionsRequest {
alarmNames = listOf(alarmName)
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
cwClient.disableAlarmActions(request)
println("Successfully disabled actions on alarm $alarmName")
}
}
```
+ For API details, see [DisableAlarmActions](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS 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 [AWS 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 enable_alarm_actions(self, alarm_name, enable):
"""
Enables or disables actions on the specified alarm. Alarm actions can be
used to send notifications or automate responses when an alarm enters a
particular state.
:param alarm_name: The name of the alarm.
:param enable: When True, actions are enabled for the alarm. Otherwise, they
disabled.
"""
try:
alarm = self.cloudwatch_resource.Alarm(alarm_name)
if enable:
alarm.enable_actions()
else:
alarm.disable_actions()
logger.info(
"%s actions for alarm %s.",
"Enabled" if enable else "Disabled",
alarm_name,
)
except ClientError:
logger.exception(
"Couldn't %s actions alarm %s.",
"enable" if enable else "disable",
alarm_name,
)
raise
```
+ For API details, see [DisableAlarmActions](https://docs.aws.amazon.com/goto/boto3/monitoring-2010-08-01/DisableAlarmActions) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ Ruby ]
**SDK for Ruby**
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/ruby/example_code/cloudwatch#code-examples).
```
# Disables an alarm in Amazon CloudWatch.
#
# Prerequisites.
#
# - The alarm to disable.
#
# @param cloudwatch_client [Aws::CloudWatch::Client]
# An initialized CloudWatch client.
# @param alarm_name [String] The name of the alarm to disable.
# @return [Boolean] true if the alarm was disabled; otherwise, false.
# @example
# exit 1 unless alarm_actions_disabled?(
# Aws::CloudWatch::Client.new(region: 'us-east-1'),
# 'ObjectsInBucket'
# )
def alarm_actions_disabled?(cloudwatch_client, alarm_name)
cloudwatch_client.disable_alarm_actions(alarm_names: [alarm_name])
true
rescue StandardError => e
puts "Error disabling alarm actions: #{e.message}"
false
end
# Example usage:
def run_me
alarm_name = 'ObjectsInBucket'
alarm_description = 'Objects exist in this bucket for more than 1 day.'
metric_name = 'NumberOfObjects'
# Notify this Amazon Simple Notification Service (Amazon SNS) topic when
# the alarm transitions to the ALARM state.
alarm_actions = ['arn:aws:sns:us-east-1:111111111111:Default_CloudWatch_Alarms_Topic']
namespace = 'AWS/S3'
statistic = 'Average'
dimensions = [
{
name: "BucketName",
value: "amzn-s3-demo-bucket"
},
{
name: 'StorageType',
value: 'AllStorageTypes'
}
]
period = 86_400 # Daily (24 hours * 60 minutes * 60 seconds = 86400 seconds).
unit = 'Count'
evaluation_periods = 1 # More than one day.
threshold = 1 # One object.
comparison_operator = 'GreaterThanThreshold' # More than one object.
# Replace us-west-2 with the AWS Region you're using for Amazon CloudWatch.
region = 'us-east-1'
cloudwatch_client = Aws::CloudWatch::Client.new(region: region)
if alarm_created_or_updated?(
cloudwatch_client,
alarm_name,
alarm_description,
metric_name,
alarm_actions,
namespace,
statistic,
dimensions,
period,
unit,
evaluation_periods,
threshold,
comparison_operator
)
puts "Alarm '#{alarm_name}' created or updated."
else
puts "Could not create or update alarm '#{alarm_name}'."
end
if alarm_actions_disabled?(cloudwatch_client, alarm_name)
puts "Alarm '#{alarm_name}' disabled."
else
puts "Could not disable alarm '#{alarm_name}'."
end
end
run_me if $PROGRAM_NAME == __FILE__
```
+ For API details, see [DisableAlarmActions](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/DisableAlarmActions) in *AWS SDK for Ruby 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 [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cwt#code-examples).
```
"Disables actions on the specified alarm. "
TRY.
lo_cwt->disablealarmactions(
it_alarmnames = it_alarm_names ).
MESSAGE 'Alarm actions disabled.' TYPE 'I'.
CATCH /aws1/cx_rt_service_generic INTO DATA(lo_exception).
DATA(lv_error) = |"{ lo_exception->av_err_code }" - { lo_exception->av_err_msg }|.
MESSAGE lv_error TYPE 'E'.
ENDTRY.
```
+ For API details, see [DisableAlarmActions](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `EnableAlarmActions` with an AWS SDK or CLI
The following code examples show how to use `EnableAlarmActions`.
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:
+ [Manage metrics and alarms](cloudwatch_example_cloudwatch_Usage_MetricsAlarms_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).
```
///
/// Enable the actions for a list of alarms from CloudWatch.
///
/// A list of names of alarms.
/// True if successful.
public async Task EnableAlarmActions(List alarmNames)
{
var enableAlarmActionsResult = await _amazonCloudWatch.EnableAlarmActionsAsync(
new EnableAlarmActionsRequest()
{
AlarmNames = alarmNames
});
return enableAlarmActionsResult.HttpStatusCode == HttpStatusCode.OK;
}
```
+ For API details, see [EnableAlarmActions](https://docs.aws.amazon.com/goto/DotNetSDKV4/monitoring-2010-08-01/EnableAlarmActions) in *AWS SDK for .NET API Reference*.
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
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/cpp/example_code/cloudwatch#code-examples).
Include the required files.
```
#include
#include
#include
#include
#include
```
Enable the alarm actions.
```
Aws::CloudWatch::CloudWatchClient cw;
Aws::CloudWatch::Model::PutMetricAlarmRequest request;
request.SetAlarmName(alarm_name);
request.SetComparisonOperator(
Aws::CloudWatch::Model::ComparisonOperator::GreaterThanThreshold);
request.SetEvaluationPeriods(1);
request.SetMetricName("CPUUtilization");
request.SetNamespace("AWS/EC2");
request.SetPeriod(60);
request.SetStatistic(Aws::CloudWatch::Model::Statistic::Average);
request.SetThreshold(70.0);
request.SetActionsEnabled(false);
request.SetAlarmDescription("Alarm when server CPU exceeds 70%");
request.SetUnit(Aws::CloudWatch::Model::StandardUnit::Seconds);
request.AddAlarmActions(actionArn);
Aws::CloudWatch::Model::Dimension dimension;
dimension.SetName("InstanceId");
dimension.SetValue(instanceId);
request.AddDimensions(dimension);
auto outcome = cw.PutMetricAlarm(request);
if (!outcome.IsSuccess())
{
std::cout << "Failed to create CloudWatch alarm:" <<
outcome.GetError().GetMessage() << std::endl;
return;
}
Aws::CloudWatch::Model::EnableAlarmActionsRequest enable_request;
enable_request.AddAlarmNames(alarm_name);
auto enable_outcome = cw.EnableAlarmActions(enable_request);
if (!enable_outcome.IsSuccess())
{
std::cout << "Failed to enable alarm actions:" <<
enable_outcome.GetError().GetMessage() << std::endl;
return;
}
std::cout << "Successfully created alarm " << alarm_name <<
" and enabled actions on it." << std::endl;
```
+ For API details, see [EnableAlarmActions](https://docs.aws.amazon.com/goto/SdkForCpp/monitoring-2010-08-01/EnableAlarmActions) in *AWS SDK for C\$1\$1 API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To enable all actions for an alarm**
The following example uses the `enable-alarm-actions` command to enable all actions for the alarm named myalarm.:
```
aws cloudwatch enable-alarm-actions --alarm-names myalarm
```
This command returns to the prompt if successful.
+ For API details, see [EnableAlarmActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/enable-alarm-actions.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).
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.cloudwatch.CloudWatchClient;
import software.amazon.awssdk.services.cloudwatch.model.CloudWatchException;
import software.amazon.awssdk.services.cloudwatch.model.EnableAlarmActionsRequest;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class EnableAlarmActions {
public static void main(String[] args) {
final String usage = """
Usage:
Where:
alarmName - An alarm name to enable (for example, MyAlarm).
""";
if (args.length != 1) {
System.out.println(usage);
System.exit(1);
}
String alarm = args[0];
Region region = Region.US_EAST_1;
CloudWatchClient cw = CloudWatchClient.builder()
.region(region)
.build();
enableActions(cw, alarm);
cw.close();
}
public static void enableActions(CloudWatchClient cw, String alarm) {
try {
EnableAlarmActionsRequest request = EnableAlarmActionsRequest.builder()
.alarmNames(alarm)
.build();
cw.enableAlarmActions(request);
System.out.printf("Successfully enabled actions on alarm %s", alarm);
} catch (CloudWatchException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ For API details, see [EnableAlarmActions](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/EnableAlarmActions) in *AWS SDK for Java 2.x API Reference*.
------
#### [ JavaScript ]
**SDK for JavaScript (v3)**
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/javascriptv3/example_code/cloudwatch#code-examples).
Import the SDK and client modules and call the API.
```
import { EnableAlarmActionsCommand } from "@aws-sdk/client-cloudwatch";
import { client } from "../libs/client.js";
const run = async () => {
const command = new EnableAlarmActionsCommand({
AlarmNames: [process.env.CLOUDWATCH_ALARM_NAME], // Set the value of CLOUDWATCH_ALARM_NAME to the name of an existing alarm.
});
try {
return await client.send(command);
} catch (err) {
console.error(err);
}
};
export default run();
```
Create the client in a separate module and export it.
```
import { CloudWatchClient } from "@aws-sdk/client-cloudwatch";
export const client = new CloudWatchClient({});
```
+ For more information, see [AWS SDK for JavaScript Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/cloudwatch-examples-using-alarm-actions.html#cloudwatch-examples-using-alarm-actions-enabling).
+ For API details, see [EnableAlarmActions](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudwatch/command/EnableAlarmActionsCommand) in *AWS SDK for JavaScript API Reference*.
**SDK for JavaScript (v2)**
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/javascript/example_code/cloudwatch#code-examples).
Import the SDK and client modules and call the API.
```
// Load the AWS SDK for Node.js
var AWS = require("aws-sdk");
// Set the region
AWS.config.update({ region: "REGION" });
// Create CloudWatch service object
var cw = new AWS.CloudWatch({ apiVersion: "2010-08-01" });
var params = {
AlarmName: "Web_Server_CPU_Utilization",
ComparisonOperator: "GreaterThanThreshold",
EvaluationPeriods: 1,
MetricName: "CPUUtilization",
Namespace: "AWS/EC2",
Period: 60,
Statistic: "Average",
Threshold: 70.0,
ActionsEnabled: true,
AlarmActions: ["ACTION_ARN"],
AlarmDescription: "Alarm when server CPU exceeds 70%",
Dimensions: [
{
Name: "InstanceId",
Value: "INSTANCE_ID",
},
],
Unit: "Percent",
};
cw.putMetricAlarm(params, function (err, data) {
if (err) {
console.log("Error", err);
} else {
console.log("Alarm action added", data);
var paramsEnableAlarmAction = {
AlarmNames: [params.AlarmName],
};
cw.enableAlarmActions(paramsEnableAlarmAction, function (err, data) {
if (err) {
console.log("Error", err);
} else {
console.log("Alarm action enabled", data);
}
});
}
});
```
+ For more information, see [AWS SDK for JavaScript Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/cloudwatch-examples-using-alarm-actions.html#cloudwatch-examples-using-alarm-actions-enabling).
+ For API details, see [EnableAlarmActions](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/monitoring-2010-08-01/EnableAlarmActions) in *AWS SDK for JavaScript 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 enableActions(alarm: String) {
val request =
EnableAlarmActionsRequest {
alarmNames = listOf(alarm)
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
cwClient.enableAlarmActions(request)
println("Successfully enabled actions on alarm $alarm")
}
}
```
+ For API details, see [EnableAlarmActions](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS 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 [AWS 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 enable_alarm_actions(self, alarm_name, enable):
"""
Enables or disables actions on the specified alarm. Alarm actions can be
used to send notifications or automate responses when an alarm enters a
particular state.
:param alarm_name: The name of the alarm.
:param enable: When True, actions are enabled for the alarm. Otherwise, they
disabled.
"""
try:
alarm = self.cloudwatch_resource.Alarm(alarm_name)
if enable:
alarm.enable_actions()
else:
alarm.disable_actions()
logger.info(
"%s actions for alarm %s.",
"Enabled" if enable else "Disabled",
alarm_name,
)
except ClientError:
logger.exception(
"Couldn't %s actions alarm %s.",
"enable" if enable else "disable",
alarm_name,
)
raise
```
+ For API details, see [EnableAlarmActions](https://docs.aws.amazon.com/goto/boto3/monitoring-2010-08-01/EnableAlarmActions) in *AWS 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 [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cwt#code-examples).
```
"Enable actions on the specified alarm."
TRY.
lo_cwt->enablealarmactions(
it_alarmnames = it_alarm_names ).
MESSAGE 'Alarm actions enabled.' TYPE 'I'.
CATCH /aws1/cx_rt_service_generic INTO DATA(lo_exception).
DATA(lv_error) = |"{ lo_exception->av_err_code }" - { lo_exception->av_err_msg }|.
MESSAGE lv_error TYPE 'E'.
ENDTRY.
```
+ For API details, see [EnableAlarmActions](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `GetDashboard` with an AWS SDK or CLI
The following code examples show how to use `GetDashboard`.
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:
+ [Creating a CloudWatch dashboard with function name as a variable](cloudwatch_example_cloudwatch_GettingStarted_031_section.md)
+ [Using property variables in CloudWatch dashboards to monitor multiple Lambda functions](cloudwatch_example_iam_GettingStarted_032_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 information on a dashboard.
///
/// The name of the dashboard.
/// A JSON object with dashboard information.
public async Task GetDashboard(string dashboardName)
{
var dashboardResponse = await _amazonCloudWatch.GetDashboardAsync(
new GetDashboardRequest()
{
DashboardName = dashboardName
});
return dashboardResponse.DashboardBody;
}
```
+ For API details, see [GetDashboard](https://docs.aws.amazon.com/goto/DotNetSDKV4/monitoring-2010-08-01/GetDashboard) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To retrieve information about a Dashboard**
The following `get-dashboard` example displays information about the dashboard named `Dashboard-A` in the specified account.
```
aws cloudwatch get-dashboard \
--dashboard-name Dashboard-A
```
Output:
```
{
"DashboardArn": "arn:aws:cloudwatch::123456789012:dashboard/Dashboard-A",
"DashboardBody": "{\"widgets\":[{\"type\":\"metric\",\"x\":0,\"y\":0,\"width\":6,\"height\":6,\"properties\":{\"view\":\"timeSeries\",\"stacked\":false,\"metrics\":[[\"AWS/EC2\",\"NetworkIn\",\"InstanceId\",\"i-0131f062232ade043\"],[\".\",\"NetworkOut\",\".\",\".\"]],\"region\":\"us-east-1\"}}]}",
"DashboardName": "Dashboard-A"
}
```
For more information, see [Amazon CloudWatch dashboards](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Dashboards.html) in the *Amazon CloudWatch User Guide*.
+ For API details, see [GetDashboard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/get-dashboard.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: Returns the arn the body of the specified dashboard.**
```
Get-CWDashboard -DashboardName Dashboard1
```
**Output:**
```
DashboardArn DashboardBody
------------ -------------
arn:aws:cloudwatch::123456789012:dashboard/Dashboard1 {...
```
+ For API details, see [GetDashboard](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: Returns the arn the body of the specified dashboard.**
```
Get-CWDashboard -DashboardName Dashboard1
```
**Output:**
```
DashboardArn DashboardBody
------------ -------------
arn:aws:cloudwatch::123456789012:dashboard/Dashboard1 {...
```
+ For API details, see [GetDashboard](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `GetMetricData` with an AWS SDK or CLI
The following code examples show how to use `GetMetricData`.
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](cloudwatch_example_cloudwatch_GetStartedMetricsDashboardsAlarms_section.md)
+ [Run CPU stress tests on EC2 instances using FIS](cloudwatch_example_iam_GettingStarted_069_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 data for CloudWatch metrics.
///
/// The number of minutes of data to include.
/// True to return the data descending by time.
/// The end date for the data, in UTC.
/// The maximum data points to include.
/// Optional data queries to include.
/// A list of the requested metric data.
public async Task> GetMetricData(int minutesOfData, bool useDescendingTime, DateTime? endDateUtc = null,
int maxDataPoints = 0, List? dataQueries = null)
{
var metricData = new List();
// If no end time is provided, use the current time for the end time.
endDateUtc ??= DateTime.UtcNow;
var timeZoneOffset = TimeZoneInfo.Local.GetUtcOffset(endDateUtc.Value.ToLocalTime());
var startTimeUtc = endDateUtc.Value.AddMinutes(-minutesOfData);
// The timezone string should be in the format +0000, so use the timezone offset to format it correctly.
var timeZoneString = $"{timeZoneOffset.Hours:D2}{timeZoneOffset.Minutes:D2}";
// Add the plus sign for positive offsets.
timeZoneString = timeZoneString.StartsWith('-') ? timeZoneString : "+" + timeZoneString;
var paginatedMetricData = _amazonCloudWatch.Paginators.GetMetricData(
new GetMetricDataRequest()
{
StartTimeUtc = startTimeUtc,
EndTimeUtc = endDateUtc.Value,
LabelOptions = new LabelOptions { Timezone = timeZoneString },
ScanBy = useDescendingTime ? ScanBy.TimestampDescending : ScanBy.TimestampAscending,
MaxDatapoints = maxDataPoints,
MetricDataQueries = dataQueries,
});
if (paginatedMetricData.MetricDataResults != null)
{
await foreach (var data in paginatedMetricData.MetricDataResults)
{
metricData.Add(data);
}
}
return metricData;
}
```
+ For API details, see [GetMetricData](https://docs.aws.amazon.com/goto/DotNetSDKV4/monitoring-2010-08-01/GetMetricData) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**Example 1: To get the Average Total IOPS for the specified EC2 using math expression**
The following `get-metric-data` example retrieves CloudWatch metric values for the EC2 instance with InstanceID `i-abcdef` using metric math exprssion that combines `EBSReadOps` and `EBSWriteOps` metrics.
```
aws cloudwatch get-metric-data \
--metric-data-queries file://file.json \
--start-time 2024-09-29T22:10:00Z \
--end-time 2024-09-29T22:15:00Z
```
Contents of `file.json`:
```
[
{
"Id": "m3",
"Expression": "(m1+m2)/300",
"Label": "Avg Total IOPS"
},
{
"Id": "m1",
"MetricStat": {
"Metric": {
"Namespace": "AWS/EC2",
"MetricName": "EBSReadOps",
"Dimensions": [
{
"Name": "InstanceId",
"Value": "i-abcdef"
}
]
},
"Period": 300,
"Stat": "Sum",
"Unit": "Count"
},
"ReturnData": false
},
{
"Id": "m2",
"MetricStat": {
"Metric": {
"Namespace": "AWS/EC2",
"MetricName": "EBSWriteOps",
"Dimensions": [
{
"Name": "InstanceId",
"Value": "i-abcdef"
}
]
},
"Period": 300,
"Stat": "Sum",
"Unit": "Count"
},
"ReturnData": false
}
]
```
Output:
```
{
"MetricDataResults": [
{
"Id": "m3",
"Label": "Avg Total IOPS",
"Timestamps": [
"2024-09-29T22:10:00+00:00"
],
"Values": [
96.85
],
"StatusCode": "Complete"
}
],
"Messages": []
}
```
**Example 2: To monitor the estimated AWS charges using CloudWatch billing metrics**
The following `get-metric-data` example retrieves `EstimatedCharges` CloudWatch metric from AWS/Billing namespace.
```
aws cloudwatch get-metric-data \
--metric-data-queries '[{"Id":"m1","MetricStat":{"Metric":{"Namespace":"AWS/Billing","MetricName":"EstimatedCharges","Dimensions":[{"Name":"Currency","Value":"USD"}]},"Period":21600,"Stat":"Maximum"}}]' \
--start-time 2024-09-26T12:00:00Z \
--end-time 2024-09-26T18:00:00Z \
--region us-east-1
```
Output:
```
{
"MetricDataResults": [
{
"Id": "m1",
"Label": "EstimatedCharges",
"Timestamps": [
"2024-09-26T12:00:00+00:00"
],
"Values": [
542.38
],
"StatusCode": "Complete"
}
],
"Messages": []
}
```
For more information, see [Using math expressions with CloudWatch metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html) in the *Amazon CloudWatch User Guide*.
+ For API details, see [GetMetricData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/get-metric-data.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 custom metric data from the AWS CloudWatch service.
*
* @param fileName the name of the file containing the custom metric information
* @return a {@link CompletableFuture} that completes when the metric data has been retrieved
*/
public CompletableFuture getCustomMetricDataAsync(String fileName) {
CompletableFuture readFileFuture = CompletableFuture.supplyAsync(() -> {
try {
// Read values from the JSON file.
JsonParser parser = new JsonFactory().createParser(new File(fileName));
com.fasterxml.jackson.databind.JsonNode rootNode = new ObjectMapper().readTree(parser);
return rootNode.toString(); // Return JSON as a string for further processing
} catch (IOException e) {
throw new RuntimeException("Failed to read file", e);
}
});
return readFileFuture.thenCompose(jsonContent -> {
try {
// Parse the JSON string to extract relevant values.
com.fasterxml.jackson.databind.JsonNode rootNode = new ObjectMapper().readTree(jsonContent);
String customMetricNamespace = rootNode.findValue("customMetricNamespace").asText();
String customMetricName = rootNode.findValue("customMetricName").asText();
// Set the current time and date range for metric query.
Instant nowDate = Instant.now();
long hours = 1;
long minutes = 30;
Instant endTime = nowDate.plus(hours, ChronoUnit.HOURS).plus(minutes, ChronoUnit.MINUTES);
Metric met = Metric.builder()
.metricName(customMetricName)
.namespace(customMetricNamespace)
.build();
MetricStat metStat = MetricStat.builder()
.stat("Maximum")
.period(60) // Assuming period in seconds
.metric(met)
.build();
MetricDataQuery dataQuery = MetricDataQuery.builder()
.metricStat(metStat)
.id("foo2")
.returnData(true)
.build();
List dq = new ArrayList<>();
dq.add(dataQuery);
GetMetricDataRequest getMetricDataRequest = GetMetricDataRequest.builder()
.maxDatapoints(10)
.scanBy(ScanBy.TIMESTAMP_DESCENDING)
.startTime(nowDate)
.endTime(endTime)
.metricDataQueries(dq)
.build();
// Call the async method for CloudWatch data retrieval.
return getAsyncClient().getMetricData(getMetricDataRequest);
} catch (IOException e) {
throw new RuntimeException("Failed to parse JSON content", e);
}
}).thenAccept(response -> {
List