public class AbstractAmazonCloudWatchAsync extends AbstractAmazonCloudWatch implements AmazonCloudWatchAsync
AmazonCloudWatchAsync
. Convenient method
forms pass through to the corresponding overload that takes a request object
and an AsyncHandler
, which throws an
UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier | Constructor and Description |
---|---|
protected |
AbstractAmazonCloudWatchAsync() |
deleteAlarms, describeAlarmHistory, describeAlarmHistory, describeAlarms, describeAlarms, describeAlarmsForMetric, disableAlarmActions, enableAlarmActions, getCachedResponseMetadata, getMetricStatistics, listMetrics, listMetrics, putMetricAlarm, putMetricData, setAlarmState, setEndpoint, setRegion, shutdown, waiters
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
deleteAlarms, describeAlarmHistory, describeAlarmHistory, describeAlarms, describeAlarms, describeAlarmsForMetric, disableAlarmActions, enableAlarmActions, getCachedResponseMetadata, getMetricStatistics, listMetrics, listMetrics, putMetricAlarm, putMetricData, setAlarmState, setEndpoint, setRegion, shutdown, waiters
public Future<DeleteAlarmsResult> deleteAlarmsAsync(DeleteAlarmsRequest request)
AmazonCloudWatchAsync
Deletes all specified alarms. In the event of an error, no alarms are deleted.
deleteAlarmsAsync
in interface AmazonCloudWatchAsync
request
- Describes the inputs for DeleteAlarms.public Future<DeleteAlarmsResult> deleteAlarmsAsync(DeleteAlarmsRequest request, AsyncHandler<DeleteAlarmsRequest,DeleteAlarmsResult> asyncHandler)
AmazonCloudWatchAsync
Deletes all specified alarms. In the event of an error, no alarms are deleted.
deleteAlarmsAsync
in interface AmazonCloudWatchAsync
request
- Describes the inputs for DeleteAlarms.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.public Future<DescribeAlarmHistoryResult> describeAlarmHistoryAsync(DescribeAlarmHistoryRequest request)
AmazonCloudWatchAsync
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.
Amazon CloudWatch retains the history of an alarm for two weeks, whether or not you delete the alarm.
describeAlarmHistoryAsync
in interface AmazonCloudWatchAsync
request
- Describes the inputs for DescribeAlarmHistory.public Future<DescribeAlarmHistoryResult> describeAlarmHistoryAsync(DescribeAlarmHistoryRequest request, AsyncHandler<DescribeAlarmHistoryRequest,DescribeAlarmHistoryResult> asyncHandler)
AmazonCloudWatchAsync
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.
Amazon CloudWatch retains the history of an alarm for two weeks, whether or not you delete the alarm.
describeAlarmHistoryAsync
in interface AmazonCloudWatchAsync
request
- Describes the inputs for DescribeAlarmHistory.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.public Future<DescribeAlarmHistoryResult> describeAlarmHistoryAsync()
describeAlarmHistoryAsync
in interface AmazonCloudWatchAsync
describeAlarmHistoryAsync(DescribeAlarmHistoryRequest)
public Future<DescribeAlarmHistoryResult> describeAlarmHistoryAsync(AsyncHandler<DescribeAlarmHistoryRequest,DescribeAlarmHistoryResult> asyncHandler)
describeAlarmHistoryAsync
in interface AmazonCloudWatchAsync
describeAlarmHistoryAsync(DescribeAlarmHistoryRequest,
com.amazonaws.handlers.AsyncHandler)
public Future<DescribeAlarmsResult> describeAlarmsAsync(DescribeAlarmsRequest request)
AmazonCloudWatchAsync
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.
describeAlarmsAsync
in interface AmazonCloudWatchAsync
request
- Describes the inputs for DescribeAlarms.public Future<DescribeAlarmsResult> describeAlarmsAsync(DescribeAlarmsRequest request, AsyncHandler<DescribeAlarmsRequest,DescribeAlarmsResult> asyncHandler)
AmazonCloudWatchAsync
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.
describeAlarmsAsync
in interface AmazonCloudWatchAsync
request
- Describes the inputs for DescribeAlarms.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.public Future<DescribeAlarmsResult> describeAlarmsAsync()
describeAlarmsAsync
in interface AmazonCloudWatchAsync
describeAlarmsAsync(DescribeAlarmsRequest)
public Future<DescribeAlarmsResult> describeAlarmsAsync(AsyncHandler<DescribeAlarmsRequest,DescribeAlarmsResult> asyncHandler)
describeAlarmsAsync
in interface AmazonCloudWatchAsync
describeAlarmsAsync(DescribeAlarmsRequest,
com.amazonaws.handlers.AsyncHandler)
public Future<DescribeAlarmsForMetricResult> describeAlarmsForMetricAsync(DescribeAlarmsForMetricRequest request)
AmazonCloudWatchAsync
Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further.
describeAlarmsForMetricAsync
in interface AmazonCloudWatchAsync
request
- Describes the inputs for DescribeAlarmsForMetric.public Future<DescribeAlarmsForMetricResult> describeAlarmsForMetricAsync(DescribeAlarmsForMetricRequest request, AsyncHandler<DescribeAlarmsForMetricRequest,DescribeAlarmsForMetricResult> asyncHandler)
AmazonCloudWatchAsync
Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further.
describeAlarmsForMetricAsync
in interface AmazonCloudWatchAsync
request
- Describes the inputs for DescribeAlarmsForMetric.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.public Future<DisableAlarmActionsResult> disableAlarmActionsAsync(DisableAlarmActionsRequest request)
AmazonCloudWatchAsync
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.
disableAlarmActionsAsync
in interface AmazonCloudWatchAsync
public Future<DisableAlarmActionsResult> disableAlarmActionsAsync(DisableAlarmActionsRequest request, AsyncHandler<DisableAlarmActionsRequest,DisableAlarmActionsResult> asyncHandler)
AmazonCloudWatchAsync
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.
disableAlarmActionsAsync
in interface AmazonCloudWatchAsync
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.public Future<EnableAlarmActionsResult> enableAlarmActionsAsync(EnableAlarmActionsRequest request)
AmazonCloudWatchAsync
Enables actions for the specified alarms.
enableAlarmActionsAsync
in interface AmazonCloudWatchAsync
request
- Describes the inputs for EnableAlarmActions.public Future<EnableAlarmActionsResult> enableAlarmActionsAsync(EnableAlarmActionsRequest request, AsyncHandler<EnableAlarmActionsRequest,EnableAlarmActionsResult> asyncHandler)
AmazonCloudWatchAsync
Enables actions for the specified alarms.
enableAlarmActionsAsync
in interface AmazonCloudWatchAsync
request
- Describes the inputs for EnableAlarmActions.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.public Future<GetMetricStatisticsResult> getMetricStatisticsAsync(GetMetricStatisticsRequest request)
AmazonCloudWatchAsync
Gets statistics for the specified metric.
The maximum number of data points that can be queried is 50,850, whereas
the maximum number of data points returned from a single
GetMetricStatistics
request is 1,440. If you make a request
that generates more than 1,440 data points, Amazon CloudWatch returns an
error. In such a case, you can alter the request by narrowing the
specified time range or increasing the specified period. A period can be
as short as one minute (60 seconds) or as long as one day (86,400
seconds). Alternatively, you can make multiple requests across adjacent
time ranges. GetMetricStatistics
does not return the data in
chronological order.
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:
Statistics for up to 400 instances for a span of one hour
Statistics for up to 35 instances over a span of 24 hours
Statistics for up to 2 instances over a span of 2 weeks
For information about the namespace, metric names, and dimensions that other Amazon Web Services products use to send metrics to CloudWatch, go to Amazon CloudWatch Metrics, Namespaces, and Dimensions Reference in the Amazon CloudWatch Developer Guide.
getMetricStatisticsAsync
in interface AmazonCloudWatchAsync
request
- Describes the inputs for GetMetricStatistics.public Future<GetMetricStatisticsResult> getMetricStatisticsAsync(GetMetricStatisticsRequest request, AsyncHandler<GetMetricStatisticsRequest,GetMetricStatisticsResult> asyncHandler)
AmazonCloudWatchAsync
Gets statistics for the specified metric.
The maximum number of data points that can be queried is 50,850, whereas
the maximum number of data points returned from a single
GetMetricStatistics
request is 1,440. If you make a request
that generates more than 1,440 data points, Amazon CloudWatch returns an
error. In such a case, you can alter the request by narrowing the
specified time range or increasing the specified period. A period can be
as short as one minute (60 seconds) or as long as one day (86,400
seconds). Alternatively, you can make multiple requests across adjacent
time ranges. GetMetricStatistics
does not return the data in
chronological order.
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:
Statistics for up to 400 instances for a span of one hour
Statistics for up to 35 instances over a span of 24 hours
Statistics for up to 2 instances over a span of 2 weeks
For information about the namespace, metric names, and dimensions that other Amazon Web Services products use to send metrics to CloudWatch, go to Amazon CloudWatch Metrics, Namespaces, and Dimensions Reference in the Amazon CloudWatch Developer Guide.
getMetricStatisticsAsync
in interface AmazonCloudWatchAsync
request
- Describes the inputs for GetMetricStatistics.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.public Future<ListMetricsResult> listMetricsAsync(ListMetricsRequest request)
AmazonCloudWatchAsync
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.
Up to 500 results are returned for any one call. To retrieve further
results, use returned NextToken
values with subsequent
ListMetrics
operations.
If you create a metric with PutMetricData, allow up to fifteen
minutes for the metric to appear in calls to ListMetrics
.
Statistics about the metric, however, are available sooner using
GetMetricStatistics.
listMetricsAsync
in interface AmazonCloudWatchAsync
request
- Describes the inputs for ListMetrics.public Future<ListMetricsResult> listMetricsAsync(ListMetricsRequest request, AsyncHandler<ListMetricsRequest,ListMetricsResult> asyncHandler)
AmazonCloudWatchAsync
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.
Up to 500 results are returned for any one call. To retrieve further
results, use returned NextToken
values with subsequent
ListMetrics
operations.
If you create a metric with PutMetricData, allow up to fifteen
minutes for the metric to appear in calls to ListMetrics
.
Statistics about the metric, however, are available sooner using
GetMetricStatistics.
listMetricsAsync
in interface AmazonCloudWatchAsync
request
- Describes the inputs for ListMetrics.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.public Future<ListMetricsResult> listMetricsAsync()
listMetricsAsync
in interface AmazonCloudWatchAsync
listMetricsAsync(ListMetricsRequest)
public Future<ListMetricsResult> listMetricsAsync(AsyncHandler<ListMetricsRequest,ListMetricsResult> asyncHandler)
listMetricsAsync
in interface AmazonCloudWatchAsync
listMetricsAsync(ListMetricsRequest,
com.amazonaws.handlers.AsyncHandler)
public Future<PutMetricAlarmResult> putMetricAlarmAsync(PutMetricAlarmRequest request)
AmazonCloudWatchAsync
Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric. Optionally, this operation can associate one or more Amazon SNS 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
are then executed.
When updating an existing alarm, its StateValue
is left
unchanged, but it completely overwrites the alarm's previous
configuration.
If you are using an AWS Identity and Access Management (IAM) account to create or modify an alarm, you must have the following Amazon EC2 permissions:
ec2:DescribeInstanceStatus
and
ec2:DescribeInstances
for all alarms on Amazon EC2 instance
status metrics.
ec2:StopInstances
for alarms with stop actions.
ec2:TerminateInstances
for alarms with terminate actions.
ec2:DescribeInstanceRecoveryAttribute
, and
ec2:RecoverInstances
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 won't be performed on the Amazon EC2 instance. However, if you are later granted permission to use the associated Amazon EC2 APIs, the alarm actions you created earlier will be performed. For more information about IAM permissions, see Permissions and Policies in Using IAM.
If you are using an IAM role (e.g., an Amazon 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 the AWS Security Token Service (AWS STS), you cannot stop or terminate an Amazon EC2 instance using alarm actions.
putMetricAlarmAsync
in interface AmazonCloudWatchAsync
request
- Describes the inputs for PutMetricAlarm.public Future<PutMetricAlarmResult> putMetricAlarmAsync(PutMetricAlarmRequest request, AsyncHandler<PutMetricAlarmRequest,PutMetricAlarmResult> asyncHandler)
AmazonCloudWatchAsync
Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric. Optionally, this operation can associate one or more Amazon SNS 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
are then executed.
When updating an existing alarm, its StateValue
is left
unchanged, but it completely overwrites the alarm's previous
configuration.
If you are using an AWS Identity and Access Management (IAM) account to create or modify an alarm, you must have the following Amazon EC2 permissions:
ec2:DescribeInstanceStatus
and
ec2:DescribeInstances
for all alarms on Amazon EC2 instance
status metrics.
ec2:StopInstances
for alarms with stop actions.
ec2:TerminateInstances
for alarms with terminate actions.
ec2:DescribeInstanceRecoveryAttribute
, and
ec2:RecoverInstances
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 won't be performed on the Amazon EC2 instance. However, if you are later granted permission to use the associated Amazon EC2 APIs, the alarm actions you created earlier will be performed. For more information about IAM permissions, see Permissions and Policies in Using IAM.
If you are using an IAM role (e.g., an Amazon 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 the AWS Security Token Service (AWS STS), you cannot stop or terminate an Amazon EC2 instance using alarm actions.
putMetricAlarmAsync
in interface AmazonCloudWatchAsync
request
- Describes the inputs for PutMetricAlarm.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.public Future<PutMetricDataResult> putMetricDataAsync(PutMetricDataRequest request)
AmazonCloudWatchAsync
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. When Amazon CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics.
Each PutMetricData
request is limited to 8 KB in size for
HTTP GET requests and is limited to 40 KB in size for HTTP POST requests.
Although the Value
parameter accepts numbers of type
Double
, Amazon CloudWatch rejects values that are either too
small or too large. Values must be in the range of 8.515920e-109 to
1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special
values (e.g., NaN, +Infinity, -Infinity) are not supported.
Data that is timestamped 24 hours or more in the past may take in excess
of 48 hours to become available from submission time using
GetMetricStatistics
.
putMetricDataAsync
in interface AmazonCloudWatchAsync
request
- Describes the inputs for PutMetricData.public Future<PutMetricDataResult> putMetricDataAsync(PutMetricDataRequest request, AsyncHandler<PutMetricDataRequest,PutMetricDataResult> asyncHandler)
AmazonCloudWatchAsync
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. When Amazon CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics.
Each PutMetricData
request is limited to 8 KB in size for
HTTP GET requests and is limited to 40 KB in size for HTTP POST requests.
Although the Value
parameter accepts numbers of type
Double
, Amazon CloudWatch rejects values that are either too
small or too large. Values must be in the range of 8.515920e-109 to
1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special
values (e.g., NaN, +Infinity, -Infinity) are not supported.
Data that is timestamped 24 hours or more in the past may take in excess
of 48 hours to become available from submission time using
GetMetricStatistics
.
putMetricDataAsync
in interface AmazonCloudWatchAsync
request
- Describes the inputs for PutMetricData.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.public Future<SetAlarmStateResult> setAlarmStateAsync(SetAlarmStateRequest request)
AmazonCloudWatchAsync
Temporarily sets the state of an alarm for testing purposes. When the
updated StateValue
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's state to ALARM sends
an Amazon SNS message. The alarm returns to its actual state (often
within seconds). Because the alarm state change happens very quickly, it
is typically only visible in the alarm's History tab in the Amazon
CloudWatch console or through DescribeAlarmHistory
.
setAlarmStateAsync
in interface AmazonCloudWatchAsync
request
- Describes the inputs for SetAlarmState.public Future<SetAlarmStateResult> setAlarmStateAsync(SetAlarmStateRequest request, AsyncHandler<SetAlarmStateRequest,SetAlarmStateResult> asyncHandler)
AmazonCloudWatchAsync
Temporarily sets the state of an alarm for testing purposes. When the
updated StateValue
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's state to ALARM sends
an Amazon SNS message. The alarm returns to its actual state (often
within seconds). Because the alarm state change happens very quickly, it
is typically only visible in the alarm's History tab in the Amazon
CloudWatch console or through DescribeAlarmHistory
.
setAlarmStateAsync
in interface AmazonCloudWatchAsync
request
- Describes the inputs for SetAlarmState.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.