com.amazonaws.services.cloudwatch

Class AmazonCloudWatchAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.cloudwatch.AmazonCloudWatchClient

com.amazonaws.services.cloudwatch.AmazonCloudWatchAsyncClient

All Implemented Interfaces:

AmazonCloudWatch, AmazonCloudWatchAsync

public class AmazonCloudWatchAsyncClient
extends AmazonCloudWatchClient
implements AmazonCloudWatchAsync

Asynchronous client for accessing AmazonCloudWatch. All asynchronous calls made using this client are non-blocking. Callers could either process the result and handle the exceptions in the worker thread by providing a callback handler when making the call, or use the returned Future object to check the result of the call in the calling thread. Amazon CloudWatch

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 :

• Actions : An alphabetical list of all Amazon CloudWatch actions.
• Data Types : An alphabetical list of all Amazon CloudWatch data types.
• Common Parameters : Parameters that all Query actions can use.
• Common Errors : Client and server errors that all actions can return.
• Regions and Endpoints : Itemized regions and endpoints for all AWS products.
• WSDL Location : http://monitoring.amazonaws.com/doc/2010-08-01/CloudWatch.wsdl

Field Summary

Fields inherited from class com.amazonaws.services.cloudwatch.AmazonCloudWatchClient

exceptionUnmarshallers

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AmazonCloudWatchAsyncClient() Constructs a new asynchronous client to invoke service methods on AmazonCloudWatch.
AmazonCloudWatchAsyncClient(AWSCredentials awsCredentials) Constructs a new asynchronous client to invoke service methods on AmazonCloudWatch using the specified AWS account credentials.
AmazonCloudWatchAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AmazonCloudWatch using the specified AWS account credentials, executor service, and client configuration options.
AmazonCloudWatchAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AmazonCloudWatch using the specified AWS account credentials and executor service.
AmazonCloudWatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new asynchronous client to invoke service methods on AmazonCloudWatch using the specified AWS account credentials provider.
AmazonCloudWatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on AmazonCloudWatch using the specified AWS account credentials provider and client configuration options.
AmazonCloudWatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AmazonCloudWatch using the specified AWS account credentials provider, executor service, and client configuration options.
AmazonCloudWatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AmazonCloudWatch using the specified AWS account credentials provider and executor service.
AmazonCloudWatchAsyncClient(ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on AmazonCloudWatch.

Method Summary

Methods

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(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(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.
ExecutorService	getExecutorService() Returns the executor service used by this async client to execute requests.
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(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.
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.cloudwatch.AmazonCloudWatchClient

deleteAlarms, describeAlarmHistory, describeAlarmHistory, describeAlarms, describeAlarms, describeAlarmsForMetric, disableAlarmActions, enableAlarmActions, getCachedResponseMetadata, getMetricStatistics, listMetrics, listMetrics, putMetricAlarm, putMetricData, setAlarmState

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.cloudwatch.AmazonCloudWatch

deleteAlarms, describeAlarmHistory, describeAlarmHistory, describeAlarms, describeAlarms, describeAlarmsForMetric, disableAlarmActions, enableAlarmActions, getCachedResponseMetadata, getMetricStatistics, listMetrics, listMetrics, putMetricAlarm, putMetricData, setAlarmState, setEndpoint, setRegion

Constructor Detail

AmazonCloudWatchAsyncClient

public AmazonCloudWatchAsyncClient()

Constructs a new asynchronous client to invoke service methods on AmazonCloudWatch. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonCloudWatchAsyncClient

public AmazonCloudWatchAsyncClient(ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on AmazonCloudWatch. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonCloudWatch (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonCloudWatchAsyncClient

public AmazonCloudWatchAsyncClient(AWSCredentials awsCredentials)

Constructs a new asynchronous client to invoke service methods on AmazonCloudWatch using the specified AWS account credentials. Default client settings will be used, and a fixed size thread pool will be created for executing the asynchronous tasks.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonCloudWatchAsyncClient

public AmazonCloudWatchAsyncClient(AWSCredentials awsCredentials,
                           ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonCloudWatch using the specified AWS account credentials and executor service. Default client settings will be used.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AmazonCloudWatchAsyncClient

public AmazonCloudWatchAsyncClient(AWSCredentials awsCredentials,
                           ClientConfiguration clientConfiguration,
                           ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonCloudWatch using the specified AWS account credentials, executor service, and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

AmazonCloudWatchAsyncClient

public AmazonCloudWatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new asynchronous client to invoke service methods on AmazonCloudWatch using the specified AWS account credentials provider. Default client settings will be used, and a fixed size thread pool will be created for executing the asynchronous tasks.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonCloudWatchAsyncClient

public AmazonCloudWatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                           ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonCloudWatch using the specified AWS account credentials provider and executor service. Default client settings will be used.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AmazonCloudWatchAsyncClient

public AmazonCloudWatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                           ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on AmazonCloudWatch using the specified AWS account credentials provider and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

AmazonCloudWatchAsyncClient

public AmazonCloudWatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                           ClientConfiguration clientConfiguration,
                           ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonCloudWatch using the specified AWS account credentials provider, executor service, and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

Method Detail

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this async client to execute requests.

Returns:

The executor service used by this async client to execute requests.

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AmazonCloudWatch

Overrides:

shutdown in class AmazonWebServiceClient

putMetricAlarmAsync

public Future<Void> putMetricAlarmAsync(PutMetricAlarmRequest putMetricAlarmRequest)
                                 throws AmazonServiceException,
                                        AmazonClientException

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.

NOTE: When updating an existing alarm, its StateValue is left unchanged.

Specified by:

putMetricAlarmAsync in interface AmazonCloudWatchAsync

Parameters:

putMetricAlarmRequest - Container for the necessary parameters to execute the PutMetricAlarm operation on AmazonCloudWatch.

Returns:

A Java Future object containing the response from the PutMetricAlarm service method, as returned by AmazonCloudWatch.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

putMetricAlarmAsync

public Future<Void> putMetricAlarmAsync(PutMetricAlarmRequest putMetricAlarmRequest,
                               AsyncHandler<PutMetricAlarmRequest,Void> asyncHandler)
                                 throws AmazonServiceException,
                                        AmazonClientException

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.

NOTE: When updating an existing alarm, its StateValue is left unchanged.

Specified by:

putMetricAlarmAsync in interface AmazonCloudWatchAsync

Parameters:

putMetricAlarmRequest - Container for the necessary parameters to execute the PutMetricAlarm operation on AmazonCloudWatch.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the PutMetricAlarm service method, as returned by AmazonCloudWatch.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

putMetricDataAsync

public Future<Void> putMetricDataAsync(PutMetricDataRequest putMetricDataRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

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.

NOTE: If you create a metric with the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action.

The size of a PutMetricData request is limited to 8 KB for HTTP GET requests and 40 KB for HTTP POST requests.

IMPORTANT: Although the 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.

Specified by:

putMetricDataAsync in interface AmazonCloudWatchAsync

Parameters:

putMetricDataRequest - Container for the necessary parameters to execute the PutMetricData operation on AmazonCloudWatch.

Returns:

A Java Future object containing the response from the PutMetricData service method, as returned by AmazonCloudWatch.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

putMetricDataAsync

public Future<Void> putMetricDataAsync(PutMetricDataRequest putMetricDataRequest,
                              AsyncHandler<PutMetricDataRequest,Void> asyncHandler)
                                throws AmazonServiceException,
                                       AmazonClientException

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.

NOTE: If you create a metric with the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action.

The size of a PutMetricData request is limited to 8 KB for HTTP GET requests and 40 KB for HTTP POST requests.

IMPORTANT: Although the 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.

Specified by:

putMetricDataAsync in interface AmazonCloudWatchAsync

Parameters:

putMetricDataRequest - Container for the necessary parameters to execute the PutMetricData operation on AmazonCloudWatch.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the PutMetricData service method, as returned by AmazonCloudWatch.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

listMetricsAsync

public Future<ListMetricsResult> listMetricsAsync(ListMetricsRequest listMetricsRequest)
                                           throws AmazonServiceException,
                                                  AmazonClientException

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.

NOTE: Up to 500 results are returned for any one call. To retrieve further results, use returned NextToken values with subsequent ListMetrics operations.

NOTE: If you create a metric with the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action.

Specified by:

listMetricsAsync in interface AmazonCloudWatchAsync

Parameters:

listMetricsRequest - Container for the necessary parameters to execute the ListMetrics operation on AmazonCloudWatch.

Returns:

A Java Future object containing the response from the ListMetrics service method, as returned by AmazonCloudWatch.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

listMetricsAsync

public Future<ListMetricsResult> listMetricsAsync(ListMetricsRequest listMetricsRequest,
                                         AsyncHandler<ListMetricsRequest,ListMetricsResult> asyncHandler)
                                           throws AmazonServiceException,
                                                  AmazonClientException

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.

NOTE: Up to 500 results are returned for any one call. To retrieve further results, use returned NextToken values with subsequent ListMetrics operations.

NOTE: If you create a metric with the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action.

Specified by:

listMetricsAsync in interface AmazonCloudWatchAsync

Parameters:

listMetricsRequest - Container for the necessary parameters to execute the ListMetrics operation on AmazonCloudWatch.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the ListMetrics service method, as returned by AmazonCloudWatch.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

getMetricStatisticsAsync

public Future<GetMetricStatisticsResult> getMetricStatisticsAsync(GetMetricStatisticsRequest getMetricStatisticsRequest)
                                                           throws AmazonServiceException,
                                                                  AmazonClientException

Gets statistics for the specified metric.

NOTE: The maximum number of data points returned from a single 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.

NOTE: The maximum number of data points that can be queried is 50,850; whereas the maximum number of data points returned is 1,440.

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

Specified by:

getMetricStatisticsAsync in interface AmazonCloudWatchAsync

Parameters:

getMetricStatisticsRequest - Container for the necessary parameters to execute the GetMetricStatistics operation on AmazonCloudWatch.

Returns:

A Java Future object containing the response from the GetMetricStatistics service method, as returned by AmazonCloudWatch.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

getMetricStatisticsAsync

public Future<GetMetricStatisticsResult> getMetricStatisticsAsync(GetMetricStatisticsRequest getMetricStatisticsRequest,
                                                         AsyncHandler<GetMetricStatisticsRequest,GetMetricStatisticsResult> asyncHandler)
                                                           throws AmazonServiceException,
                                                                  AmazonClientException

Gets statistics for the specified metric.

NOTE: The maximum number of data points returned from a single 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.

NOTE: The maximum number of data points that can be queried is 50,850; whereas the maximum number of data points returned is 1,440.

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

Specified by:

getMetricStatisticsAsync in interface AmazonCloudWatchAsync

Parameters:

getMetricStatisticsRequest - Container for the necessary parameters to execute the GetMetricStatistics operation on AmazonCloudWatch.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the GetMetricStatistics service method, as returned by AmazonCloudWatch.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

disableAlarmActionsAsync

public Future<Void> disableAlarmActionsAsync(DisableAlarmActionsRequest disableAlarmActionsRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

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.

Specified by:

disableAlarmActionsAsync in interface AmazonCloudWatchAsync

Parameters:

disableAlarmActionsRequest - Container for the necessary parameters to execute the DisableAlarmActions operation on AmazonCloudWatch.

Returns:

A Java Future object containing the response from the DisableAlarmActions service method, as returned by AmazonCloudWatch.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

disableAlarmActionsAsync

public Future<Void> disableAlarmActionsAsync(DisableAlarmActionsRequest disableAlarmActionsRequest,
                                    AsyncHandler<DisableAlarmActionsRequest,Void> asyncHandler)
                                      throws AmazonServiceException,
                                             AmazonClientException

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.

Specified by:

disableAlarmActionsAsync in interface AmazonCloudWatchAsync

Parameters:

disableAlarmActionsRequest - Container for the necessary parameters to execute the DisableAlarmActions operation on AmazonCloudWatch.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the DisableAlarmActions service method, as returned by AmazonCloudWatch.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

describeAlarmsAsync

public Future<DescribeAlarmsResult> describeAlarmsAsync(DescribeAlarmsRequest describeAlarmsRequest)
                                                 throws AmazonServiceException,
                                                        AmazonClientException

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.

Specified by:

describeAlarmsAsync in interface AmazonCloudWatchAsync

Parameters:

describeAlarmsRequest - Container for the necessary parameters to execute the DescribeAlarms operation on AmazonCloudWatch.

Returns:

A Java Future object containing the response from the DescribeAlarms service method, as returned by AmazonCloudWatch.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

describeAlarmsAsync

public Future<DescribeAlarmsResult> describeAlarmsAsync(DescribeAlarmsRequest describeAlarmsRequest,
                                               AsyncHandler<DescribeAlarmsRequest,DescribeAlarmsResult> asyncHandler)
                                                 throws AmazonServiceException,
                                                        AmazonClientException

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.

Specified by:

describeAlarmsAsync in interface AmazonCloudWatchAsync

Parameters:

describeAlarmsRequest - Container for the necessary parameters to execute the DescribeAlarms operation on AmazonCloudWatch.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the DescribeAlarms service method, as returned by AmazonCloudWatch.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

describeAlarmsForMetricAsync

public Future<DescribeAlarmsForMetricResult> describeAlarmsForMetricAsync(DescribeAlarmsForMetricRequest describeAlarmsForMetricRequest)
                                                                   throws AmazonServiceException,
                                                                          AmazonClientException

Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further.

Specified by:

describeAlarmsForMetricAsync in interface AmazonCloudWatchAsync

Parameters:

describeAlarmsForMetricRequest - Container for the necessary parameters to execute the DescribeAlarmsForMetric operation on AmazonCloudWatch.

Returns:

A Java Future object containing the response from the DescribeAlarmsForMetric service method, as returned by AmazonCloudWatch.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

describeAlarmsForMetricAsync

public Future<DescribeAlarmsForMetricResult> describeAlarmsForMetricAsync(DescribeAlarmsForMetricRequest describeAlarmsForMetricRequest,
                                                                 AsyncHandler<DescribeAlarmsForMetricRequest,DescribeAlarmsForMetricResult> asyncHandler)
                                                                   throws AmazonServiceException,
                                                                          AmazonClientException

Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further.

Specified by:

describeAlarmsForMetricAsync in interface AmazonCloudWatchAsync

Parameters:

describeAlarmsForMetricRequest - Container for the necessary parameters to execute the DescribeAlarmsForMetric operation on AmazonCloudWatch.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the DescribeAlarmsForMetric service method, as returned by AmazonCloudWatch.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

describeAlarmHistoryAsync

public Future<DescribeAlarmHistoryResult> describeAlarmHistoryAsync(DescribeAlarmHistoryRequest describeAlarmHistoryRequest)
                                                             throws AmazonServiceException,
                                                                    AmazonClientException

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.

NOTE: Amazon CloudWatch retains the history of an alarm for two weeks, whether or not you delete the alarm.

Specified by:

describeAlarmHistoryAsync in interface AmazonCloudWatchAsync

Parameters:

describeAlarmHistoryRequest - Container for the necessary parameters to execute the DescribeAlarmHistory operation on AmazonCloudWatch.

Returns:

A Java Future object containing the response from the DescribeAlarmHistory service method, as returned by AmazonCloudWatch.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

describeAlarmHistoryAsync

public Future<DescribeAlarmHistoryResult> describeAlarmHistoryAsync(DescribeAlarmHistoryRequest describeAlarmHistoryRequest,
                                                           AsyncHandler<DescribeAlarmHistoryRequest,DescribeAlarmHistoryResult> asyncHandler)
                                                             throws AmazonServiceException,
                                                                    AmazonClientException

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.

NOTE: Amazon CloudWatch retains the history of an alarm for two weeks, whether or not you delete the alarm.

Specified by:

describeAlarmHistoryAsync in interface AmazonCloudWatchAsync

Parameters:

describeAlarmHistoryRequest - Container for the necessary parameters to execute the DescribeAlarmHistory operation on AmazonCloudWatch.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the DescribeAlarmHistory service method, as returned by AmazonCloudWatch.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

enableAlarmActionsAsync

public Future<Void> enableAlarmActionsAsync(EnableAlarmActionsRequest enableAlarmActionsRequest)
                                     throws AmazonServiceException,
                                            AmazonClientException

Enables actions for the specified alarms.

Specified by:

enableAlarmActionsAsync in interface AmazonCloudWatchAsync

Parameters:

enableAlarmActionsRequest - Container for the necessary parameters to execute the EnableAlarmActions operation on AmazonCloudWatch.

Returns:

A Java Future object containing the response from the EnableAlarmActions service method, as returned by AmazonCloudWatch.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

enableAlarmActionsAsync

public Future<Void> enableAlarmActionsAsync(EnableAlarmActionsRequest enableAlarmActionsRequest,
                                   AsyncHandler<EnableAlarmActionsRequest,Void> asyncHandler)
                                     throws AmazonServiceException,
                                            AmazonClientException

Enables actions for the specified alarms.

Specified by:

enableAlarmActionsAsync in interface AmazonCloudWatchAsync

Parameters:

enableAlarmActionsRequest - Container for the necessary parameters to execute the EnableAlarmActions operation on AmazonCloudWatch.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the EnableAlarmActions service method, as returned by AmazonCloudWatch.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

deleteAlarmsAsync

public Future<Void> deleteAlarmsAsync(DeleteAlarmsRequest deleteAlarmsRequest)
                               throws AmazonServiceException,
                                      AmazonClientException

Deletes all specified alarms. In the event of an error, no alarms are deleted.

Specified by:

deleteAlarmsAsync in interface AmazonCloudWatchAsync

Parameters:

deleteAlarmsRequest - Container for the necessary parameters to execute the DeleteAlarms operation on AmazonCloudWatch.

Returns:

A Java Future object containing the response from the DeleteAlarms service method, as returned by AmazonCloudWatch.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

deleteAlarmsAsync

public Future<Void> deleteAlarmsAsync(DeleteAlarmsRequest deleteAlarmsRequest,
                             AsyncHandler<DeleteAlarmsRequest,Void> asyncHandler)
                               throws AmazonServiceException,
                                      AmazonClientException

Deletes all specified alarms. In the event of an error, no alarms are deleted.

Specified by:

deleteAlarmsAsync in interface AmazonCloudWatchAsync

Parameters:

deleteAlarmsRequest - Container for the necessary parameters to execute the DeleteAlarms operation on AmazonCloudWatch.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the DeleteAlarms service method, as returned by AmazonCloudWatch.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

setAlarmStateAsync

public Future<Void> setAlarmStateAsync(SetAlarmStateRequest setAlarmStateRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

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.

Specified by:

setAlarmStateAsync in interface AmazonCloudWatchAsync

Parameters:

setAlarmStateRequest - Container for the necessary parameters to execute the SetAlarmState operation on AmazonCloudWatch.

Returns:

A Java Future object containing the response from the SetAlarmState service method, as returned by AmazonCloudWatch.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

setAlarmStateAsync

public Future<Void> setAlarmStateAsync(SetAlarmStateRequest setAlarmStateRequest,
                              AsyncHandler<SetAlarmStateRequest,Void> asyncHandler)
                                throws AmazonServiceException,
                                       AmazonClientException

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.

Specified by:

setAlarmStateAsync in interface AmazonCloudWatchAsync

Parameters:

setAlarmStateRequest - Container for the necessary parameters to execute the SetAlarmState operation on AmazonCloudWatch.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the SetAlarmState service method, as returned by AmazonCloudWatch.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.