public interface AmazonCloudWatchAsync extends AmazonCloudWatch
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
This is the Amazon CloudWatch API Reference. This guide provides detailed information about Amazon CloudWatch actions, data types, parameters, and errors. For detailed information about Amazon CloudWatch features and their associated API calls, go to the Amazon CloudWatch Developer Guide.
Amazon CloudWatch is a web service that enables you to publish, monitor, and manage various metrics, as well as configure alarm actions based on data from metrics. For more information about this product go to http://aws.amazon.com/cloudwatch.
Use the following links to get started using the Amazon CloudWatch API Reference:
Modifier and Type | Method and Description |
---|---|
Future<Void> |
deleteAlarmsAsync(DeleteAlarmsRequest deleteAlarmsRequest)
Deletes all specified alarms.
|
Future<Void> |
deleteAlarmsAsync(DeleteAlarmsRequest deleteAlarmsRequest,
AsyncHandler<DeleteAlarmsRequest,Void> asyncHandler)
Deletes all specified alarms.
|
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 history for the specified alarm.
|
Future<DescribeAlarmHistoryResult> |
describeAlarmHistoryAsync(DescribeAlarmHistoryRequest describeAlarmHistoryRequest,
AsyncHandler<DescribeAlarmHistoryRequest,DescribeAlarmHistoryResult> asyncHandler)
Retrieves 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 alarms with the specified names.
|
Future<DescribeAlarmsResult> |
describeAlarmsAsync(DescribeAlarmsRequest describeAlarmsRequest,
AsyncHandler<DescribeAlarmsRequest,DescribeAlarmsResult> asyncHandler)
Retrieves alarms with the specified names.
|
Future<DescribeAlarmsForMetricResult> |
describeAlarmsForMetricAsync(DescribeAlarmsForMetricRequest describeAlarmsForMetricRequest)
Retrieves all alarms for a single metric.
|
Future<DescribeAlarmsForMetricResult> |
describeAlarmsForMetricAsync(DescribeAlarmsForMetricRequest describeAlarmsForMetricRequest,
AsyncHandler<DescribeAlarmsForMetricRequest,DescribeAlarmsForMetricResult> asyncHandler)
Retrieves all alarms for a single metric.
|
Future<Void> |
disableAlarmActionsAsync(DisableAlarmActionsRequest disableAlarmActionsRequest)
Disables actions for the specified alarms.
|
Future<Void> |
disableAlarmActionsAsync(DisableAlarmActionsRequest disableAlarmActionsRequest,
AsyncHandler<DisableAlarmActionsRequest,Void> asyncHandler)
Disables actions for the specified alarms.
|
Future<Void> |
enableAlarmActionsAsync(EnableAlarmActionsRequest enableAlarmActionsRequest)
Enables actions for the specified alarms.
|
Future<Void> |
enableAlarmActionsAsync(EnableAlarmActionsRequest enableAlarmActionsRequest,
AsyncHandler<EnableAlarmActionsRequest,Void> asyncHandler)
Enables actions for the specified alarms.
|
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<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)
Returns a list of valid metrics stored for the AWS account owner.
|
Future<ListMetricsResult> |
listMetricsAsync(ListMetricsRequest listMetricsRequest,
AsyncHandler<ListMetricsRequest,ListMetricsResult> asyncHandler)
Returns a list of valid metrics stored for the AWS account owner.
|
Future<Void> |
putMetricAlarmAsync(PutMetricAlarmRequest putMetricAlarmRequest)
Creates or updates an alarm and associates it with the specified Amazon
CloudWatch metric.
|
Future<Void> |
putMetricAlarmAsync(PutMetricAlarmRequest putMetricAlarmRequest,
AsyncHandler<PutMetricAlarmRequest,Void> asyncHandler)
Creates or updates an alarm and associates it with the specified Amazon
CloudWatch metric.
|
Future<Void> |
putMetricDataAsync(PutMetricDataRequest putMetricDataRequest)
Publishes metric data points to Amazon CloudWatch.
|
Future<Void> |
putMetricDataAsync(PutMetricDataRequest putMetricDataRequest,
AsyncHandler<PutMetricDataRequest,Void> asyncHandler)
Publishes metric data points to Amazon CloudWatch.
|
Future<Void> |
setAlarmStateAsync(SetAlarmStateRequest setAlarmStateRequest)
Temporarily sets the state of an alarm.
|
Future<Void> |
setAlarmStateAsync(SetAlarmStateRequest setAlarmStateRequest,
AsyncHandler<SetAlarmStateRequest,Void> asyncHandler)
Temporarily sets the state of an alarm.
|
deleteAlarms, describeAlarmHistory, describeAlarmHistory, describeAlarms, describeAlarms, describeAlarmsForMetric, disableAlarmActions, enableAlarmActions, getCachedResponseMetadata, getMetricStatistics, listMetrics, listMetrics, putMetricAlarm, putMetricData, setAlarmState, setEndpoint, setRegion, shutdown
Future<Void> deleteAlarmsAsync(DeleteAlarmsRequest deleteAlarmsRequest)
Deletes all specified alarms. In the event of an error, no alarms are deleted.
deleteAlarmsRequest
- Future<Void> deleteAlarmsAsync(DeleteAlarmsRequest deleteAlarmsRequest, AsyncHandler<DeleteAlarmsRequest,Void> asyncHandler)
Deletes all specified alarms. In the event of an error, no alarms are deleted.
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<DescribeAlarmHistoryResult> describeAlarmHistoryAsync(DescribeAlarmHistoryRequest describeAlarmHistoryRequest)
Retrieves history for the specified alarm. Filter alarms by date range or item type. If an alarm name is not specified, Amazon CloudWatch returns histories for all of the owner's alarms.
describeAlarmHistoryRequest
- Future<DescribeAlarmHistoryResult> describeAlarmHistoryAsync(DescribeAlarmHistoryRequest describeAlarmHistoryRequest, AsyncHandler<DescribeAlarmHistoryRequest,DescribeAlarmHistoryResult> asyncHandler)
Retrieves history for the specified alarm. Filter alarms by date range or item type. If an alarm name is not specified, Amazon CloudWatch returns histories for all of the owner's alarms.
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 alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only 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 alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only 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 all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further.
describeAlarmsForMetricRequest
- Future<DescribeAlarmsForMetricResult> describeAlarmsForMetricAsync(DescribeAlarmsForMetricRequest describeAlarmsForMetricRequest, AsyncHandler<DescribeAlarmsForMetricRequest,DescribeAlarmsForMetricResult> asyncHandler)
Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further.
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<Void> disableAlarmActionsAsync(DisableAlarmActionsRequest disableAlarmActionsRequest)
Disables actions for the specified alarms. When an alarm's actions are disabled the alarm's state may change, but none of the alarm's actions will execute.
disableAlarmActionsRequest
- Future<Void> disableAlarmActionsAsync(DisableAlarmActionsRequest disableAlarmActionsRequest, AsyncHandler<DisableAlarmActionsRequest,Void> asyncHandler)
Disables actions for the specified alarms. When an alarm's actions are disabled the alarm's state may change, but none of the alarm's actions will execute.
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<Void> enableAlarmActionsAsync(EnableAlarmActionsRequest enableAlarmActionsRequest)
Enables actions for the specified alarms.
enableAlarmActionsRequest
- Future<Void> enableAlarmActionsAsync(EnableAlarmActionsRequest enableAlarmActionsRequest, AsyncHandler<EnableAlarmActionsRequest,Void> asyncHandler)
Enables 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<GetMetricStatisticsResult> getMetricStatisticsAsync(GetMetricStatisticsRequest getMetricStatisticsRequest)
Gets statistics for the specified metric.
GetMetricStatistics
request is 1,440. If a request is made
that generates more than 1,440 data points, Amazon CloudWatch returns an
error. In such a case, alter the request by narrowing the specified time
range or increasing the specified period. Alternatively, make multiple
requests across adjacent time ranges.
Amazon CloudWatch aggregates data points based on the length of the
period
that you specify. For example, if you request
statistics with a one-minute granularity, Amazon CloudWatch aggregates
data points with time stamps that fall within the same one-minute period.
In such a case, the data points queried can greatly outnumber the data
points returned.
The following examples show various statistics allowed by the data point
query maximum of 50,850 when you call GetMetricStatistics
on
Amazon EC2 instances with detailed (one-minute) monitoring enabled:
getMetricStatisticsRequest
- Future<GetMetricStatisticsResult> getMetricStatisticsAsync(GetMetricStatisticsRequest getMetricStatisticsRequest, AsyncHandler<GetMetricStatisticsRequest,GetMetricStatisticsResult> asyncHandler)
Gets statistics for the specified metric.
GetMetricStatistics
request is 1,440. If a request is made
that generates more than 1,440 data points, Amazon CloudWatch returns an
error. In such a case, alter the request by narrowing the specified time
range or increasing the specified period. Alternatively, make multiple
requests across adjacent time ranges.
Amazon CloudWatch aggregates data points based on the length of the
period
that you specify. For example, if you request
statistics with a one-minute granularity, Amazon CloudWatch aggregates
data points with time stamps that fall within the same one-minute period.
In such a case, the data points queried can greatly outnumber the data
points returned.
The following examples show various statistics allowed by the data point
query maximum of 50,850 when you call GetMetricStatistics
on
Amazon EC2 instances with detailed (one-minute) monitoring enabled:
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<ListMetricsResult> listMetricsAsync(ListMetricsRequest listMetricsRequest)
Returns a list of valid metrics stored for the AWS account owner.
Returned metrics can be used with GetMetricStatistics
to
obtain statistical data for a given metric.
NextToken
values with
subsequent ListMetrics
operations. ListMetrics
action. listMetricsRequest
- Future<ListMetricsResult> listMetricsAsync(ListMetricsRequest listMetricsRequest, AsyncHandler<ListMetricsRequest,ListMetricsResult> asyncHandler)
Returns a list of valid metrics stored for the AWS account owner.
Returned metrics can be used with GetMetricStatistics
to
obtain statistical data for a given metric.
NextToken
values with
subsequent ListMetrics
operations. ListMetrics
action. 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<Void> putMetricAlarmAsync(PutMetricAlarmRequest putMetricAlarmRequest)
Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric. Optionally, this operation can associate one or more Amazon Simple Notification Service resources with the alarm.
When this operation creates an alarm, the alarm state is immediately set
to INSUFFICIENT_DATA
. The alarm is evaluated and its
StateValue
is set appropriately. Any actions associated with
the StateValue
is then executed.
StateValue
is
left unchanged. putMetricAlarmRequest
- Future<Void> putMetricAlarmAsync(PutMetricAlarmRequest putMetricAlarmRequest, AsyncHandler<PutMetricAlarmRequest,Void> asyncHandler)
Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric. Optionally, this operation can associate one or more Amazon Simple Notification Service resources with the alarm.
When this operation creates an alarm, the alarm state is immediately set
to INSUFFICIENT_DATA
. The alarm is evaluated and its
StateValue
is set appropriately. Any actions associated with
the StateValue
is then executed.
StateValue
is
left unchanged. 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<Void> putMetricDataAsync(PutMetricDataRequest putMetricDataRequest)
Publishes metric data points to Amazon CloudWatch. Amazon Cloudwatch associates the data points with the specified metric. If the specified metric does not exist, Amazon CloudWatch creates the metric.
PutMetricData
action,
allow up to fifteen minutes for the metric to appear in calls to the
ListMetrics action.
The size of a
Value
parameter accepts numbers of
type Double
, Amazon CloudWatch truncates values with very
large exponents. Values with base-10 exponents greater than 126 (1 x
10^126) are truncated. Likewise, values with base-10 exponents less than
-130 (1 x 10^-130) are also truncated. putMetricDataRequest
- Future<Void> putMetricDataAsync(PutMetricDataRequest putMetricDataRequest, AsyncHandler<PutMetricDataRequest,Void> asyncHandler)
Publishes metric data points to Amazon CloudWatch. Amazon Cloudwatch associates the data points with the specified metric. If the specified metric does not exist, Amazon CloudWatch creates the metric.
PutMetricData
action,
allow up to fifteen minutes for the metric to appear in calls to the
ListMetrics action.
The size of a
Value
parameter accepts numbers of
type Double
, Amazon CloudWatch truncates values with very
large exponents. Values with base-10 exponents greater than 126 (1 x
10^126) are truncated. Likewise, values with base-10 exponents less than
-130 (1 x 10^-130) are also truncated. 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<Void> setAlarmStateAsync(SetAlarmStateRequest setAlarmStateRequest)
Temporarily sets the state of an alarm. When the updated
StateValue
differs from the previous value, the action
configured for the appropriate state is invoked. This is not a permanent
change. The next periodic alarm check (in about a minute) will set the
alarm to its actual state.
setAlarmStateRequest
- Future<Void> setAlarmStateAsync(SetAlarmStateRequest setAlarmStateRequest, AsyncHandler<SetAlarmStateRequest,Void> asyncHandler)
Temporarily sets the state of an alarm. When the updated
StateValue
differs from the previous value, the action
configured for the appropriate state is invoked. This is not a permanent
change. The next periodic alarm check (in about a minute) will set the
alarm to its actual state.
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.Copyright © 2016. All rights reserved.