@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonCloudWatchAsync extends AmazonCloudWatch
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonCloudWatchAsync instead.
Amazon CloudWatch monitors your Amazon Web Services (AWS) resources and the applications you run on AWS in real time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications.
CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money.
In addition to monitoring the built-in metrics that come with AWS, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health.
ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
Future<DeleteAlarmsResult> |
deleteAlarmsAsync(DeleteAlarmsRequest deleteAlarmsRequest)
Deletes the specified alarms.
|
Future<DeleteAlarmsResult> |
deleteAlarmsAsync(DeleteAlarmsRequest deleteAlarmsRequest,
AsyncHandler<DeleteAlarmsRequest,DeleteAlarmsResult> asyncHandler)
Deletes the specified alarms.
|
Future<DeleteAnomalyDetectorResult> |
deleteAnomalyDetectorAsync(DeleteAnomalyDetectorRequest deleteAnomalyDetectorRequest)
Deletes the specified anomaly detection model from your account.
|
Future<DeleteAnomalyDetectorResult> |
deleteAnomalyDetectorAsync(DeleteAnomalyDetectorRequest deleteAnomalyDetectorRequest,
AsyncHandler<DeleteAnomalyDetectorRequest,DeleteAnomalyDetectorResult> asyncHandler)
Deletes the specified anomaly detection model from your account.
|
Future<DeleteDashboardsResult> |
deleteDashboardsAsync(DeleteDashboardsRequest deleteDashboardsRequest)
Deletes all dashboards that you specify.
|
Future<DeleteDashboardsResult> |
deleteDashboardsAsync(DeleteDashboardsRequest deleteDashboardsRequest,
AsyncHandler<DeleteDashboardsRequest,DeleteDashboardsResult> asyncHandler)
Deletes all dashboards that you specify.
|
Future<DeleteInsightRulesResult> |
deleteInsightRulesAsync(DeleteInsightRulesRequest deleteInsightRulesRequest)
Permanently deletes the specified Contributor Insights rules.
|
Future<DeleteInsightRulesResult> |
deleteInsightRulesAsync(DeleteInsightRulesRequest deleteInsightRulesRequest,
AsyncHandler<DeleteInsightRulesRequest,DeleteInsightRulesResult> asyncHandler)
Permanently deletes the specified Contributor Insights rules.
|
Future<DescribeAlarmHistoryResult> |
describeAlarmHistoryAsync()
Simplified method form for invoking the DescribeAlarmHistory operation.
|
Future<DescribeAlarmHistoryResult> |
describeAlarmHistoryAsync(AsyncHandler<DescribeAlarmHistoryRequest,DescribeAlarmHistoryResult> asyncHandler)
Simplified method form for invoking the DescribeAlarmHistory operation with an AsyncHandler.
|
Future<DescribeAlarmHistoryResult> |
describeAlarmHistoryAsync(DescribeAlarmHistoryRequest describeAlarmHistoryRequest)
Retrieves the history for the specified alarm.
|
Future<DescribeAlarmHistoryResult> |
describeAlarmHistoryAsync(DescribeAlarmHistoryRequest describeAlarmHistoryRequest,
AsyncHandler<DescribeAlarmHistoryRequest,DescribeAlarmHistoryResult> asyncHandler)
Retrieves the history for the specified alarm.
|
Future<DescribeAlarmsResult> |
describeAlarmsAsync()
Simplified method form for invoking the DescribeAlarms operation.
|
Future<DescribeAlarmsResult> |
describeAlarmsAsync(AsyncHandler<DescribeAlarmsRequest,DescribeAlarmsResult> asyncHandler)
Simplified method form for invoking the DescribeAlarms operation with an AsyncHandler.
|
Future<DescribeAlarmsResult> |
describeAlarmsAsync(DescribeAlarmsRequest describeAlarmsRequest)
Retrieves the specified alarms.
|
Future<DescribeAlarmsResult> |
describeAlarmsAsync(DescribeAlarmsRequest describeAlarmsRequest,
AsyncHandler<DescribeAlarmsRequest,DescribeAlarmsResult> asyncHandler)
Retrieves the specified alarms.
|
Future<DescribeAlarmsForMetricResult> |
describeAlarmsForMetricAsync(DescribeAlarmsForMetricRequest describeAlarmsForMetricRequest)
Retrieves the alarms for the specified metric.
|
Future<DescribeAlarmsForMetricResult> |
describeAlarmsForMetricAsync(DescribeAlarmsForMetricRequest describeAlarmsForMetricRequest,
AsyncHandler<DescribeAlarmsForMetricRequest,DescribeAlarmsForMetricResult> asyncHandler)
Retrieves the alarms for the specified metric.
|
Future<DescribeAnomalyDetectorsResult> |
describeAnomalyDetectorsAsync(DescribeAnomalyDetectorsRequest describeAnomalyDetectorsRequest)
Lists the anomaly detection models that you have created in your account.
|
Future<DescribeAnomalyDetectorsResult> |
describeAnomalyDetectorsAsync(DescribeAnomalyDetectorsRequest describeAnomalyDetectorsRequest,
AsyncHandler<DescribeAnomalyDetectorsRequest,DescribeAnomalyDetectorsResult> asyncHandler)
Lists the anomaly detection models that you have created in your account.
|
Future<DescribeInsightRulesResult> |
describeInsightRulesAsync(DescribeInsightRulesRequest describeInsightRulesRequest)
Returns a list of all the Contributor Insights rules in your account.
|
Future<DescribeInsightRulesResult> |
describeInsightRulesAsync(DescribeInsightRulesRequest describeInsightRulesRequest,
AsyncHandler<DescribeInsightRulesRequest,DescribeInsightRulesResult> asyncHandler)
Returns a list of all the Contributor Insights rules in your account.
|
Future<DisableAlarmActionsResult> |
disableAlarmActionsAsync(DisableAlarmActionsRequest disableAlarmActionsRequest)
Disables the actions for the specified alarms.
|
Future<DisableAlarmActionsResult> |
disableAlarmActionsAsync(DisableAlarmActionsRequest disableAlarmActionsRequest,
AsyncHandler<DisableAlarmActionsRequest,DisableAlarmActionsResult> asyncHandler)
Disables the actions for the specified alarms.
|
Future<DisableInsightRulesResult> |
disableInsightRulesAsync(DisableInsightRulesRequest disableInsightRulesRequest)
Disables the specified Contributor Insights rules.
|
Future<DisableInsightRulesResult> |
disableInsightRulesAsync(DisableInsightRulesRequest disableInsightRulesRequest,
AsyncHandler<DisableInsightRulesRequest,DisableInsightRulesResult> asyncHandler)
Disables the specified Contributor Insights rules.
|
Future<EnableAlarmActionsResult> |
enableAlarmActionsAsync(EnableAlarmActionsRequest enableAlarmActionsRequest)
Enables the actions for the specified alarms.
|
Future<EnableAlarmActionsResult> |
enableAlarmActionsAsync(EnableAlarmActionsRequest enableAlarmActionsRequest,
AsyncHandler<EnableAlarmActionsRequest,EnableAlarmActionsResult> asyncHandler)
Enables the actions for the specified alarms.
|
Future<EnableInsightRulesResult> |
enableInsightRulesAsync(EnableInsightRulesRequest enableInsightRulesRequest)
Enables the specified Contributor Insights rules.
|
Future<EnableInsightRulesResult> |
enableInsightRulesAsync(EnableInsightRulesRequest enableInsightRulesRequest,
AsyncHandler<EnableInsightRulesRequest,EnableInsightRulesResult> asyncHandler)
Enables the specified Contributor Insights rules.
|
Future<GetDashboardResult> |
getDashboardAsync(GetDashboardRequest getDashboardRequest)
Displays the details of the dashboard that you specify.
|
Future<GetDashboardResult> |
getDashboardAsync(GetDashboardRequest getDashboardRequest,
AsyncHandler<GetDashboardRequest,GetDashboardResult> asyncHandler)
Displays the details of the dashboard that you specify.
|
Future<GetInsightRuleReportResult> |
getInsightRuleReportAsync(GetInsightRuleReportRequest getInsightRuleReportRequest)
This operation returns the time series data collected by a Contributor Insights rule.
|
Future<GetInsightRuleReportResult> |
getInsightRuleReportAsync(GetInsightRuleReportRequest getInsightRuleReportRequest,
AsyncHandler<GetInsightRuleReportRequest,GetInsightRuleReportResult> asyncHandler)
This operation returns the time series data collected by a Contributor Insights rule.
|
Future<GetMetricDataResult> |
getMetricDataAsync(GetMetricDataRequest getMetricDataRequest)
You can use the
GetMetricData API to retrieve as many as 500 different metrics in a single request,
with a total of as many as 100,800 data points. |
Future<GetMetricDataResult> |
getMetricDataAsync(GetMetricDataRequest getMetricDataRequest,
AsyncHandler<GetMetricDataRequest,GetMetricDataResult> asyncHandler)
You can use the
GetMetricData API to retrieve as many as 500 different metrics in a single request,
with a total of as many as 100,800 data points. |
Future<GetMetricStatisticsResult> |
getMetricStatisticsAsync(GetMetricStatisticsRequest getMetricStatisticsRequest)
Gets statistics for the specified metric.
|
Future<GetMetricStatisticsResult> |
getMetricStatisticsAsync(GetMetricStatisticsRequest getMetricStatisticsRequest,
AsyncHandler<GetMetricStatisticsRequest,GetMetricStatisticsResult> asyncHandler)
Gets statistics for the specified metric.
|
Future<GetMetricWidgetImageResult> |
getMetricWidgetImageAsync(GetMetricWidgetImageRequest getMetricWidgetImageRequest)
You can use the
GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon
CloudWatch metrics as a bitmap image. |
Future<GetMetricWidgetImageResult> |
getMetricWidgetImageAsync(GetMetricWidgetImageRequest getMetricWidgetImageRequest,
AsyncHandler<GetMetricWidgetImageRequest,GetMetricWidgetImageResult> asyncHandler)
You can use the
GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon
CloudWatch metrics as a bitmap image. |
Future<ListDashboardsResult> |
listDashboardsAsync(ListDashboardsRequest listDashboardsRequest)
Returns a list of the dashboards for your account.
|
Future<ListDashboardsResult> |
listDashboardsAsync(ListDashboardsRequest listDashboardsRequest,
AsyncHandler<ListDashboardsRequest,ListDashboardsResult> asyncHandler)
Returns a list of the dashboards for your account.
|
Future<ListMetricsResult> |
listMetricsAsync()
Simplified method form for invoking the ListMetrics operation.
|
Future<ListMetricsResult> |
listMetricsAsync(AsyncHandler<ListMetricsRequest,ListMetricsResult> asyncHandler)
Simplified method form for invoking the ListMetrics operation with an AsyncHandler.
|
Future<ListMetricsResult> |
listMetricsAsync(ListMetricsRequest listMetricsRequest)
List the specified metrics.
|
Future<ListMetricsResult> |
listMetricsAsync(ListMetricsRequest listMetricsRequest,
AsyncHandler<ListMetricsRequest,ListMetricsResult> asyncHandler)
List the specified metrics.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with a CloudWatch resource.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Displays the tags associated with a CloudWatch resource.
|
Future<PutAnomalyDetectorResult> |
putAnomalyDetectorAsync(PutAnomalyDetectorRequest putAnomalyDetectorRequest)
Creates an anomaly detection model for a CloudWatch metric.
|
Future<PutAnomalyDetectorResult> |
putAnomalyDetectorAsync(PutAnomalyDetectorRequest putAnomalyDetectorRequest,
AsyncHandler<PutAnomalyDetectorRequest,PutAnomalyDetectorResult> asyncHandler)
Creates an anomaly detection model for a CloudWatch metric.
|
Future<PutCompositeAlarmResult> |
putCompositeAlarmAsync(PutCompositeAlarmRequest putCompositeAlarmRequest)
Creates or updates a composite alarm.
|
Future<PutCompositeAlarmResult> |
putCompositeAlarmAsync(PutCompositeAlarmRequest putCompositeAlarmRequest,
AsyncHandler<PutCompositeAlarmRequest,PutCompositeAlarmResult> asyncHandler)
Creates or updates a composite alarm.
|
Future<PutDashboardResult> |
putDashboardAsync(PutDashboardRequest putDashboardRequest)
Creates a dashboard if it does not already exist, or updates an existing dashboard.
|
Future<PutDashboardResult> |
putDashboardAsync(PutDashboardRequest putDashboardRequest,
AsyncHandler<PutDashboardRequest,PutDashboardResult> asyncHandler)
Creates a dashboard if it does not already exist, or updates an existing dashboard.
|
Future<PutInsightRuleResult> |
putInsightRuleAsync(PutInsightRuleRequest putInsightRuleRequest)
Creates a Contributor Insights rule.
|
Future<PutInsightRuleResult> |
putInsightRuleAsync(PutInsightRuleRequest putInsightRuleRequest,
AsyncHandler<PutInsightRuleRequest,PutInsightRuleResult> asyncHandler)
Creates a Contributor Insights rule.
|
Future<PutMetricAlarmResult> |
putMetricAlarmAsync(PutMetricAlarmRequest putMetricAlarmRequest)
Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly
detection model.
|
Future<PutMetricAlarmResult> |
putMetricAlarmAsync(PutMetricAlarmRequest putMetricAlarmRequest,
AsyncHandler<PutMetricAlarmRequest,PutMetricAlarmResult> asyncHandler)
Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly
detection model.
|
Future<PutMetricDataResult> |
putMetricDataAsync(PutMetricDataRequest putMetricDataRequest)
Publishes metric data points to Amazon CloudWatch.
|
Future<PutMetricDataResult> |
putMetricDataAsync(PutMetricDataRequest putMetricDataRequest,
AsyncHandler<PutMetricDataRequest,PutMetricDataResult> asyncHandler)
Publishes metric data points to Amazon CloudWatch.
|
Future<SetAlarmStateResult> |
setAlarmStateAsync(SetAlarmStateRequest setAlarmStateRequest)
Temporarily sets the state of an alarm for testing purposes.
|
Future<SetAlarmStateResult> |
setAlarmStateAsync(SetAlarmStateRequest setAlarmStateRequest,
AsyncHandler<SetAlarmStateRequest,SetAlarmStateResult> asyncHandler)
Temporarily sets the state of an alarm for testing purposes.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified CloudWatch resource.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest,
AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Assigns one or more tags (key-value pairs) to the specified CloudWatch resource.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified resource.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest,
AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes one or more tags from the specified resource.
|
deleteAlarms, deleteAnomalyDetector, deleteDashboards, deleteInsightRules, describeAlarmHistory, describeAlarmHistory, describeAlarms, describeAlarms, describeAlarmsForMetric, describeAnomalyDetectors, describeInsightRules, disableAlarmActions, disableInsightRules, enableAlarmActions, enableInsightRules, getCachedResponseMetadata, getDashboard, getInsightRuleReport, getMetricData, getMetricStatistics, getMetricWidgetImage, listDashboards, listMetrics, listMetrics, listTagsForResource, putAnomalyDetector, putCompositeAlarm, putDashboard, putInsightRule, putMetricAlarm, putMetricData, setAlarmState, setEndpoint, setRegion, shutdown, tagResource, untagResource, waitersFuture<DeleteAlarmsResult> deleteAlarmsAsync(DeleteAlarmsRequest deleteAlarmsRequest)
Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.
In the event of an error, no alarms are deleted.
It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.
To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in
the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to
change the AlarmRule of one of the alarms to False.
Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
deleteAlarmsRequest - Future<DeleteAlarmsResult> deleteAlarmsAsync(DeleteAlarmsRequest deleteAlarmsRequest, AsyncHandler<DeleteAlarmsRequest,DeleteAlarmsResult> asyncHandler)
Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.
In the event of an error, no alarms are deleted.
It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.
To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in
the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to
change the AlarmRule of one of the alarms to False.
Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
deleteAlarmsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteAnomalyDetectorResult> deleteAnomalyDetectorAsync(DeleteAnomalyDetectorRequest deleteAnomalyDetectorRequest)
Deletes the specified anomaly detection model from your account.
deleteAnomalyDetectorRequest - Future<DeleteAnomalyDetectorResult> deleteAnomalyDetectorAsync(DeleteAnomalyDetectorRequest deleteAnomalyDetectorRequest, AsyncHandler<DeleteAnomalyDetectorRequest,DeleteAnomalyDetectorResult> asyncHandler)
Deletes the specified anomaly detection model from your account.
deleteAnomalyDetectorRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteDashboardsResult> deleteDashboardsAsync(DeleteDashboardsRequest deleteDashboardsRequest)
Deletes all dashboards that you specify. You may specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.
deleteDashboardsRequest - Future<DeleteDashboardsResult> deleteDashboardsAsync(DeleteDashboardsRequest deleteDashboardsRequest, AsyncHandler<DeleteDashboardsRequest,DeleteDashboardsResult> asyncHandler)
Deletes all dashboards that you specify. You may specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.
deleteDashboardsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteInsightRulesResult> deleteInsightRulesAsync(DeleteInsightRulesRequest deleteInsightRulesRequest)
Permanently deletes the specified Contributor Insights rules.
If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created may or may not be available.
deleteInsightRulesRequest - Future<DeleteInsightRulesResult> deleteInsightRulesAsync(DeleteInsightRulesRequest deleteInsightRulesRequest, AsyncHandler<DeleteInsightRulesRequest,DeleteInsightRulesResult> asyncHandler)
Permanently deletes the specified Contributor Insights rules.
If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created may or may not be available.
deleteInsightRulesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeAlarmHistoryResult> describeAlarmHistoryAsync(DescribeAlarmHistoryRequest describeAlarmHistoryRequest)
Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.
CloudWatch retains the history of an alarm even if you delete the alarm.
describeAlarmHistoryRequest - Future<DescribeAlarmHistoryResult> describeAlarmHistoryAsync(DescribeAlarmHistoryRequest describeAlarmHistoryRequest, AsyncHandler<DescribeAlarmHistoryRequest,DescribeAlarmHistoryResult> asyncHandler)
Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.
CloudWatch retains the history of an alarm even if you delete the alarm.
describeAlarmHistoryRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeAlarmHistoryResult> describeAlarmHistoryAsync()
Future<DescribeAlarmHistoryResult> describeAlarmHistoryAsync(AsyncHandler<DescribeAlarmHistoryRequest,DescribeAlarmHistoryResult> asyncHandler)
Future<DescribeAlarmsResult> describeAlarmsAsync(DescribeAlarmsRequest describeAlarmsRequest)
Retrieves the specified alarms. You can filter the results by specifying a a prefix for the alarm name, the alarm state, or a prefix for any action.
describeAlarmsRequest - Future<DescribeAlarmsResult> describeAlarmsAsync(DescribeAlarmsRequest describeAlarmsRequest, AsyncHandler<DescribeAlarmsRequest,DescribeAlarmsResult> asyncHandler)
Retrieves the specified alarms. You can filter the results by specifying a a prefix for the alarm name, the alarm state, or a prefix for any action.
describeAlarmsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeAlarmsResult> describeAlarmsAsync()
Future<DescribeAlarmsResult> describeAlarmsAsync(AsyncHandler<DescribeAlarmsRequest,DescribeAlarmsResult> asyncHandler)
Future<DescribeAlarmsForMetricResult> describeAlarmsForMetricAsync(DescribeAlarmsForMetricRequest describeAlarmsForMetricRequest)
Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.
describeAlarmsForMetricRequest - Future<DescribeAlarmsForMetricResult> describeAlarmsForMetricAsync(DescribeAlarmsForMetricRequest describeAlarmsForMetricRequest, AsyncHandler<DescribeAlarmsForMetricRequest,DescribeAlarmsForMetricResult> asyncHandler)
Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.
describeAlarmsForMetricRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeAnomalyDetectorsResult> describeAnomalyDetectorsAsync(DescribeAnomalyDetectorsRequest describeAnomalyDetectorsRequest)
Lists the anomaly detection models that you have created in your account. You can list all models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension.
describeAnomalyDetectorsRequest - Future<DescribeAnomalyDetectorsResult> describeAnomalyDetectorsAsync(DescribeAnomalyDetectorsRequest describeAnomalyDetectorsRequest, AsyncHandler<DescribeAnomalyDetectorsRequest,DescribeAnomalyDetectorsResult> asyncHandler)
Lists the anomaly detection models that you have created in your account. You can list all models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension.
describeAnomalyDetectorsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeInsightRulesResult> describeInsightRulesAsync(DescribeInsightRulesRequest describeInsightRulesRequest)
Returns a list of all the Contributor Insights rules in your account. All rules in your account are returned with a single operation.
For more information about Contributor Insights, see Using Contributor Insights to Analyze High-Cardinality Data.
describeInsightRulesRequest - Future<DescribeInsightRulesResult> describeInsightRulesAsync(DescribeInsightRulesRequest describeInsightRulesRequest, AsyncHandler<DescribeInsightRulesRequest,DescribeInsightRulesResult> asyncHandler)
Returns a list of all the Contributor Insights rules in your account. All rules in your account are returned with a single operation.
For more information about Contributor Insights, see Using Contributor Insights to Analyze High-Cardinality Data.
describeInsightRulesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DisableAlarmActionsResult> disableAlarmActionsAsync(DisableAlarmActionsRequest disableAlarmActionsRequest)
Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes.
disableAlarmActionsRequest - Future<DisableAlarmActionsResult> disableAlarmActionsAsync(DisableAlarmActionsRequest disableAlarmActionsRequest, AsyncHandler<DisableAlarmActionsRequest,DisableAlarmActionsResult> asyncHandler)
Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes.
disableAlarmActionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DisableInsightRulesResult> disableInsightRulesAsync(DisableInsightRulesRequest disableInsightRulesRequest)
Disables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do not incur costs.
disableInsightRulesRequest - Future<DisableInsightRulesResult> disableInsightRulesAsync(DisableInsightRulesRequest disableInsightRulesRequest, AsyncHandler<DisableInsightRulesRequest,DisableInsightRulesResult> asyncHandler)
Disables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do not incur costs.
disableInsightRulesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<EnableAlarmActionsResult> enableAlarmActionsAsync(EnableAlarmActionsRequest enableAlarmActionsRequest)
Enables the actions for the specified alarms.
enableAlarmActionsRequest - Future<EnableAlarmActionsResult> enableAlarmActionsAsync(EnableAlarmActionsRequest enableAlarmActionsRequest, AsyncHandler<EnableAlarmActionsRequest,EnableAlarmActionsResult> asyncHandler)
Enables the actions for the specified alarms.
enableAlarmActionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<EnableInsightRulesResult> enableInsightRulesAsync(EnableInsightRulesRequest enableInsightRulesRequest)
Enables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data.
enableInsightRulesRequest - Future<EnableInsightRulesResult> enableInsightRulesAsync(EnableInsightRulesRequest enableInsightRulesRequest, AsyncHandler<EnableInsightRulesRequest,EnableInsightRulesResult> asyncHandler)
Enables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data.
enableInsightRulesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetDashboardResult> getDashboardAsync(GetDashboardRequest getDashboardRequest)
Displays the details of the dashboard that you specify.
To copy an existing dashboard, use GetDashboard, and then use the data returned within
DashboardBody as the template for the new dashboard when you call PutDashboard to
create the copy.
getDashboardRequest - Future<GetDashboardResult> getDashboardAsync(GetDashboardRequest getDashboardRequest, AsyncHandler<GetDashboardRequest,GetDashboardResult> asyncHandler)
Displays the details of the dashboard that you specify.
To copy an existing dashboard, use GetDashboard, and then use the data returned within
DashboardBody as the template for the new dashboard when you call PutDashboard to
create the copy.
getDashboardRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetInsightRuleReportResult> getInsightRuleReportAsync(GetInsightRuleReportRequest getInsightRuleReportRequest)
This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of contributors to the log group.
You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:
UniqueContributors -- the number of unique contributors for each data point.
MaxContributorValue -- the value of the top contributor for each data point. The identity of the
contributor may change for each data point in the graph.
If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most
occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the
highest sum in the log field specified by the rule's Value, during that period.
SampleCount -- the number of data points matched by the rule.
Sum -- the sum of the values from all contributors during the time period represented by that data
point.
Minimum -- the minimum value from a single observation during the time period represented by that
data point.
Maximum -- the maximum value from a single observation during the time period represented by that
data point.
Average -- the average value from all contributors during the time period represented by that data
point.
getInsightRuleReportRequest - Future<GetInsightRuleReportResult> getInsightRuleReportAsync(GetInsightRuleReportRequest getInsightRuleReportRequest, AsyncHandler<GetInsightRuleReportRequest,GetInsightRuleReportResult> asyncHandler)
This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of contributors to the log group.
You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:
UniqueContributors -- the number of unique contributors for each data point.
MaxContributorValue -- the value of the top contributor for each data point. The identity of the
contributor may change for each data point in the graph.
If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most
occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the
highest sum in the log field specified by the rule's Value, during that period.
SampleCount -- the number of data points matched by the rule.
Sum -- the sum of the values from all contributors during the time period represented by that data
point.
Minimum -- the minimum value from a single observation during the time period represented by that
data point.
Maximum -- the maximum value from a single observation during the time period represented by that
data point.
Average -- the average value from all contributors during the time period represented by that data
point.
getInsightRuleReportRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetMetricDataResult> getMetricDataAsync(GetMetricDataRequest getMetricDataRequest)
You can use the GetMetricData API to retrieve as many as 500 different metrics in a single request,
with a total of as many as 100,800 data points. You can also optionally perform math expressions on the values of
the returned statistics, to create new time series that represent new insights into your data. For example, using
Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series.
For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
Calls to the GetMetricData API have a different pricing structure than calls to
GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing.
Amazon CloudWatch retains metric data as follows:
Data points with a period of less than 60 seconds are available for 3 hours. These data points are
high-resolution metrics and are available only for custom metrics that have been defined with a
StorageResolution of 1.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
Data points with a period of 300 seconds (5-minute) are available for 63 days.
Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.
If you omit Unit in your request, all data that was collected with any unit is returned, along with
the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the
operation returns only data data that was collected with that unit specified. If you specify a unit that does not
match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.
getMetricDataRequest - Future<GetMetricDataResult> getMetricDataAsync(GetMetricDataRequest getMetricDataRequest, AsyncHandler<GetMetricDataRequest,GetMetricDataResult> asyncHandler)
You can use the GetMetricData API to retrieve as many as 500 different metrics in a single request,
with a total of as many as 100,800 data points. You can also optionally perform math expressions on the values of
the returned statistics, to create new time series that represent new insights into your data. For example, using
Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series.
For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
Calls to the GetMetricData API have a different pricing structure than calls to
GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing.
Amazon CloudWatch retains metric data as follows:
Data points with a period of less than 60 seconds are available for 3 hours. These data points are
high-resolution metrics and are available only for custom metrics that have been defined with a
StorageResolution of 1.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
Data points with a period of 300 seconds (5-minute) are available for 63 days.
Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.
If you omit Unit in your request, all data that was collected with any unit is returned, along with
the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the
operation returns only data data that was collected with that unit specified. If you specify a unit that does not
match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.
getMetricDataRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetMetricStatisticsResult> getMetricStatisticsAsync(GetMetricStatisticsRequest getMetricStatisticsRequest)
Gets statistics for the specified metric.
The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.
CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.
CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:
The SampleCount value of the statistic set is 1.
The Min and the Max values of the statistic set are equal.
Percentile statistics are not available for metrics when any of the metric values are negative numbers.
Amazon CloudWatch retains metric data as follows:
Data points with a period of less than 60 seconds are available for 3 hours. These data points are
high-resolution metrics and are available only for custom metrics that have been defined with a
StorageResolution of 1.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
Data points with a period of 300 seconds (5-minute) are available for 63 days.
Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.
CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.
For information about metrics and dimensions supported by AWS services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.
getMetricStatisticsRequest - Future<GetMetricStatisticsResult> getMetricStatisticsAsync(GetMetricStatisticsRequest getMetricStatisticsRequest, AsyncHandler<GetMetricStatisticsRequest,GetMetricStatisticsResult> asyncHandler)
Gets statistics for the specified metric.
The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.
CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.
CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:
The SampleCount value of the statistic set is 1.
The Min and the Max values of the statistic set are equal.
Percentile statistics are not available for metrics when any of the metric values are negative numbers.
Amazon CloudWatch retains metric data as follows:
Data points with a period of less than 60 seconds are available for 3 hours. These data points are
high-resolution metrics and are available only for custom metrics that have been defined with a
StorageResolution of 1.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
Data points with a period of 300 seconds (5-minute) are available for 63 days.
Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.
CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.
For information about metrics and dimensions supported by AWS services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.
getMetricStatisticsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetMetricWidgetImageResult> getMetricWidgetImageAsync(GetMetricWidgetImageRequest getMetricWidgetImageRequest)
You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon
CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki
pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your
own custom live dashboard.
The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and vertical annotations.
There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has
the following limits:
As many as 100 metrics in the graph.
Up to 100 KB uncompressed payload.
getMetricWidgetImageRequest - Future<GetMetricWidgetImageResult> getMetricWidgetImageAsync(GetMetricWidgetImageRequest getMetricWidgetImageRequest, AsyncHandler<GetMetricWidgetImageRequest,GetMetricWidgetImageResult> asyncHandler)
You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon
CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki
pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your
own custom live dashboard.
The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and vertical annotations.
There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has
the following limits:
As many as 100 metrics in the graph.
Up to 100 KB uncompressed payload.
getMetricWidgetImageRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListDashboardsResult> listDashboardsAsync(ListDashboardsRequest listDashboardsRequest)
Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those
dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.
ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you
can call ListDashboards again and include the value you received for NextToken in the
first call, to receive the next 1000 results.
listDashboardsRequest - Future<ListDashboardsResult> listDashboardsAsync(ListDashboardsRequest listDashboardsRequest, AsyncHandler<ListDashboardsRequest,ListDashboardsResult> asyncHandler)
Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those
dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.
ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you
can call ListDashboards again and include the value you received for NextToken in the
first call, to receive the next 1000 results.
listDashboardsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListMetricsResult> listMetricsAsync(ListMetricsRequest listMetricsRequest)
List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain statistical data.
Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.
After you create a metric, allow up to fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using GetMetricData or GetMetricStatistics.
listMetricsRequest - Future<ListMetricsResult> listMetricsAsync(ListMetricsRequest listMetricsRequest, AsyncHandler<ListMetricsRequest,ListMetricsResult> asyncHandler)
List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain statistical data.
Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.
After you create a metric, allow up to fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using GetMetricData or GetMetricStatistics.
listMetricsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListMetricsResult> listMetricsAsync()
listMetricsAsync(ListMetricsRequest)Future<ListMetricsResult> listMetricsAsync(AsyncHandler<ListMetricsRequest,ListMetricsResult> asyncHandler)
Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with a CloudWatch resource. Currently, alarms and Contributor Insights rules support tagging.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Displays the tags associated with a CloudWatch resource. Currently, alarms and Contributor Insights rules support tagging.
listTagsForResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutAnomalyDetectorResult> putAnomalyDetectorAsync(PutAnomalyDetectorRequest putAnomalyDetectorRequest)
Creates an anomaly detection model for a CloudWatch metric. You can use the model to display a band of expected normal values when the metric is graphed.
For more information, see CloudWatch Anomaly Detection.
putAnomalyDetectorRequest - Future<PutAnomalyDetectorResult> putAnomalyDetectorAsync(PutAnomalyDetectorRequest putAnomalyDetectorRequest, AsyncHandler<PutAnomalyDetectorRequest,PutAnomalyDetectorResult> asyncHandler)
Creates an anomaly detection model for a CloudWatch metric. You can use the model to display a band of expected normal values when the metric is graphed.
For more information, see CloudWatch Anomaly Detection.
putAnomalyDetectorRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutCompositeAlarmResult> putCompositeAlarmAsync(PutCompositeAlarmRequest putCompositeAlarmRequest)
Creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.
The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.
Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.
Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics.
It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.
To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in
the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to
change the AlarmRule of one of the alarms to False.
Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The
alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then
executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in
INSUFFICIENT_DATA state.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
putCompositeAlarmRequest - Future<PutCompositeAlarmResult> putCompositeAlarmAsync(PutCompositeAlarmRequest putCompositeAlarmRequest, AsyncHandler<PutCompositeAlarmRequest,PutCompositeAlarmResult> asyncHandler)
Creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.
The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.
Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.
Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics.
It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.
To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in
the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to
change the AlarmRule of one of the alarms to False.
Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The
alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then
executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in
INSUFFICIENT_DATA state.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
putCompositeAlarmRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutDashboardResult> putDashboardAsync(PutDashboardRequest putDashboardRequest)
Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.
All dashboards in your account are global, not region-specific.
A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an
existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the
Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use
GetDashboard, and then use the data returned within DashboardBody as the template for
the new dashboard when you call PutDashboard.
When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of
the dashboard with a message that the dashboard was created by script and should not be changed in the console.
This message could also point console users to the location of the DashboardBody script or the
CloudFormation template used to create the dashboard.
putDashboardRequest - Future<PutDashboardResult> putDashboardAsync(PutDashboardRequest putDashboardRequest, AsyncHandler<PutDashboardRequest,PutDashboardResult> asyncHandler)
Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.
All dashboards in your account are global, not region-specific.
A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an
existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the
Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use
GetDashboard, and then use the data returned within DashboardBody as the template for
the new dashboard when you call PutDashboard.
When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of
the dashboard with a message that the dashboard was created by script and should not be changed in the console.
This message could also point console users to the location of the DashboardBody script or the
CloudFormation template used to create the dashboard.
putDashboardRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutInsightRuleResult> putInsightRuleAsync(PutInsightRuleRequest putInsightRuleRequest)
Creates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, see Using Contributor Insights to Analyze High-Cardinality Data.
If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created may or may not be available.
putInsightRuleRequest - Future<PutInsightRuleResult> putInsightRuleAsync(PutInsightRuleRequest putInsightRuleRequest, AsyncHandler<PutInsightRuleRequest,PutInsightRuleResult> asyncHandler)
Creates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, see Using Contributor Insights to Analyze High-Cardinality Data.
If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created may or may not be available.
putInsightRuleRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutMetricAlarmResult> putMetricAlarmAsync(PutMetricAlarmRequest putMetricAlarmRequest)
Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model.
Alarms based on anomaly detection models cannot have Auto Scaling actions.
When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The
alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then
executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:
iam:CreateServiceLinkedRole for all alarms with EC2 actions
ec2:DescribeInstanceStatus and ec2:DescribeInstances for all alarms on EC2 instance
status metrics
ec2:StopInstances for alarms with stop actions
ec2:TerminateInstances for alarms with terminate actions
No specific permissions are needed for alarms with recover actions
If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm, but the stop or terminate actions are not performed. However, if you are later granted the required permissions, the alarm actions that you created earlier are performed.
If you are using an IAM role (for example, an EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies.
If you are using temporary security credentials granted using AWS STS, you cannot stop or terminate an EC2 instance using alarm actions.
The first time you create an alarm in the AWS Management Console, the CLI, or by using the PutMetricAlarm API,
CloudWatch creates the necessary service-linked role for you. The service-linked role is called
AWSServiceRoleForCloudWatchEvents. For more information, see AWS service-linked role.
putMetricAlarmRequest - Future<PutMetricAlarmResult> putMetricAlarmAsync(PutMetricAlarmRequest putMetricAlarmRequest, AsyncHandler<PutMetricAlarmRequest,PutMetricAlarmResult> asyncHandler)
Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model.
Alarms based on anomaly detection models cannot have Auto Scaling actions.
When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The
alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then
executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:
iam:CreateServiceLinkedRole for all alarms with EC2 actions
ec2:DescribeInstanceStatus and ec2:DescribeInstances for all alarms on EC2 instance
status metrics
ec2:StopInstances for alarms with stop actions
ec2:TerminateInstances for alarms with terminate actions
No specific permissions are needed for alarms with recover actions
If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm, but the stop or terminate actions are not performed. However, if you are later granted the required permissions, the alarm actions that you created earlier are performed.
If you are using an IAM role (for example, an EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies.
If you are using temporary security credentials granted using AWS STS, you cannot stop or terminate an EC2 instance using alarm actions.
The first time you create an alarm in the AWS Management Console, the CLI, or by using the PutMetricAlarm API,
CloudWatch creates the necessary service-linked role for you. The service-linked role is called
AWSServiceRoleForCloudWatchEvents. For more information, see AWS service-linked role.
putMetricAlarmRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutMetricDataResult> putMetricDataAsync(PutMetricDataRequest putMetricDataRequest)
Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics.
You can publish either individual data points in the Value field, or arrays of values and the number
of times each value occurred during the period by using the Values and Counts fields in
the MetricDatum structure. Using the Values and Counts method enables you
to publish up to 150 values per metric with one PutMetricData request, and supports retrieving
percentile statistics on this data.
Each PutMetricData request is limited to 40 KB in size for HTTP POST requests. You can send a
payload compressed by gzip. Each request is also limited to no more than 20 different metrics.
Although the Value parameter accepts numbers of type Double, CloudWatch rejects values
that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special
values (for example, NaN, +Infinity, -Infinity) are not supported.
You can use up to 10 dimensions per metric to further clarify what data the metric collects. Each dimension consists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.
Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricData or GetMetricStatistics from the time they are submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available for for GetMetricData or GetMetricStatistics.
CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:
The SampleCount value of the statistic set is 1 and Min, Max, and
Sum are all equal.
The Min and Max are equal, and Sum is equal to Min multiplied
by SampleCount.
putMetricDataRequest - Future<PutMetricDataResult> putMetricDataAsync(PutMetricDataRequest putMetricDataRequest, AsyncHandler<PutMetricDataRequest,PutMetricDataResult> asyncHandler)
Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics.
You can publish either individual data points in the Value field, or arrays of values and the number
of times each value occurred during the period by using the Values and Counts fields in
the MetricDatum structure. Using the Values and Counts method enables you
to publish up to 150 values per metric with one PutMetricData request, and supports retrieving
percentile statistics on this data.
Each PutMetricData request is limited to 40 KB in size for HTTP POST requests. You can send a
payload compressed by gzip. Each request is also limited to no more than 20 different metrics.
Although the Value parameter accepts numbers of type Double, CloudWatch rejects values
that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special
values (for example, NaN, +Infinity, -Infinity) are not supported.
You can use up to 10 dimensions per metric to further clarify what data the metric collects. Each dimension consists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.
Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricData or GetMetricStatistics from the time they are submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available for for GetMetricData or GetMetricStatistics.
CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:
The SampleCount value of the statistic set is 1 and Min, Max, and
Sum are all equal.
The Min and Max are equal, and Sum is equal to Min multiplied
by SampleCount.
putMetricDataRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SetAlarmStateResult> setAlarmStateAsync(SetAlarmStateRequest setAlarmStateRequest)
Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous
value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to
send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to ALARM
sends an SNS message.
Metric alarms returns to their actual state quickly, often within seconds. Because the metric alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.
If you use SetAlarmState on a composite alarm, the composite alarm is not guaranteed to return to
its actual state. It will return to its actual state only once any of its children alarms change state. It is
also re-evaluated if you update its configuration.
If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include information
in the StateReasonData parameter to enable the policy to take the correct action.
setAlarmStateRequest - Future<SetAlarmStateResult> setAlarmStateAsync(SetAlarmStateRequest setAlarmStateRequest, AsyncHandler<SetAlarmStateRequest,SetAlarmStateResult> asyncHandler)
Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous
value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to
send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to ALARM
sends an SNS message.
Metric alarms returns to their actual state quickly, often within seconds. Because the metric alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.
If you use SetAlarmState on a composite alarm, the composite alarm is not guaranteed to return to
its actual state. It will return to its actual state only once any of its children alarms change state. It is
also re-evaluated if you update its configuration.
If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include information
in the StateReasonData parameter to enable the policy to take the correct action.
setAlarmStateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that can be tagged are alarms and Contributor Insights rules.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
You can use the TagResource action with an alarm that already has tags. If you specify a new tag key
for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that
is already associated with the alarm, the new tag value that you specify replaces the previous value for that
tag.
You can associate as many as 50 tags with a CloudWatch resource.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that can be tagged are alarms and Contributor Insights rules.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
You can use the TagResource action with an alarm that already has tags. If you specify a new tag key
for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that
is already associated with the alarm, the new tag value that you specify replaces the previous value for that
tag.
You can associate as many as 50 tags with a CloudWatch resource.
tagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified resource.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes one or more tags from the specified resource.
untagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Copyright © 2020. All rights reserved.