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

@ThreadSafe
public class AmazonCloudWatchAsyncClient
extends AmazonCloudWatchClient
implements AmazonCloudWatchAsync

Interface for accessing CloudWatch asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Amazon CloudWatch monitors your Amazon Web Services (AWS) resources and the applications you run on AWS in real-time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications.

CloudWatch alarms send notifications or automatically make changes to the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon Elastic Compute Cloud (Amazon EC2) instances and then use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money.

In addition to monitoring the built-in metrics that come with AWS, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health.

Field Summary

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

configFactory, 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 CloudWatch.
AmazonCloudWatchAsyncClient(AWSCredentials awsCredentials) Constructs a new asynchronous client to invoke service methods on CloudWatch using the specified AWS account credentials.
AmazonCloudWatchAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on CloudWatch 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 CloudWatch using the specified AWS account credentials and executor service.
AmazonCloudWatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new asynchronous client to invoke service methods on CloudWatch using the specified AWS account credentials provider.
AmazonCloudWatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on CloudWatch using the provided 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 CloudWatch 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 CloudWatch using the specified AWS account credentials provider and executor service.
AmazonCloudWatchAsyncClient(ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on CloudWatch.

Method Summary

Methods

Modifier and Type	Method and Description
Future<Void>	deleteAlarmsAsync(DeleteAlarmsRequest request) Deletes all specified alarms.
Future<Void>	deleteAlarmsAsync(DeleteAlarmsRequest request, 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 request) Retrieves history for the specified alarm.
Future<DescribeAlarmHistoryResult>	describeAlarmHistoryAsync(DescribeAlarmHistoryRequest request, 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 request) Retrieves alarms with the specified names.
Future<DescribeAlarmsResult>	describeAlarmsAsync(DescribeAlarmsRequest request, AsyncHandler<DescribeAlarmsRequest,DescribeAlarmsResult> asyncHandler) Retrieves alarms with the specified names.
Future<DescribeAlarmsForMetricResult>	describeAlarmsForMetricAsync(DescribeAlarmsForMetricRequest request) Retrieves all alarms for a single metric.
Future<DescribeAlarmsForMetricResult>	describeAlarmsForMetricAsync(DescribeAlarmsForMetricRequest request, AsyncHandler<DescribeAlarmsForMetricRequest,DescribeAlarmsForMetricResult> asyncHandler) Retrieves all alarms for a single metric.
Future<Void>	disableAlarmActionsAsync(DisableAlarmActionsRequest request) Disables actions for the specified alarms.
Future<Void>	disableAlarmActionsAsync(DisableAlarmActionsRequest request, AsyncHandler<DisableAlarmActionsRequest,Void> asyncHandler) Disables actions for the specified alarms.
Future<Void>	enableAlarmActionsAsync(EnableAlarmActionsRequest request) Enables actions for the specified alarms.
Future<Void>	enableAlarmActionsAsync(EnableAlarmActionsRequest request, AsyncHandler<EnableAlarmActionsRequest,Void> asyncHandler) Enables actions for the specified alarms.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<GetMetricStatisticsResult>	getMetricStatisticsAsync(GetMetricStatisticsRequest request) Gets statistics for the specified metric.
Future<GetMetricStatisticsResult>	getMetricStatisticsAsync(GetMetricStatisticsRequest request, 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 request) Returns a list of valid metrics stored for the AWS account owner.
Future<ListMetricsResult>	listMetricsAsync(ListMetricsRequest request, AsyncHandler<ListMetricsRequest,ListMetricsResult> asyncHandler) Returns a list of valid metrics stored for the AWS account owner.
Future<Void>	putMetricAlarmAsync(PutMetricAlarmRequest request) Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric.
Future<Void>	putMetricAlarmAsync(PutMetricAlarmRequest request, AsyncHandler<PutMetricAlarmRequest,Void> asyncHandler) Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric.
Future<Void>	putMetricDataAsync(PutMetricDataRequest request) Publishes metric data points to Amazon CloudWatch.
Future<Void>	putMetricDataAsync(PutMetricDataRequest request, AsyncHandler<PutMetricDataRequest,Void> asyncHandler) Publishes metric data points to Amazon CloudWatch.
Future<Void>	setAlarmStateAsync(SetAlarmStateRequest request) Temporarily sets the state of an alarm.
Future<Void>	setAlarmStateAsync(SetAlarmStateRequest request, 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, setEndpointPrefix, 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 CloudWatch. 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
• Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
• Instance profile credentials delivered through the Amazon EC2 metadata service

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

See Also:

DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

AmazonCloudWatchAsyncClient

public AmazonCloudWatchAsyncClient(ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on CloudWatch. 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
• Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
• Instance profile credentials delivered through the Amazon EC2 metadata service

Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().

Parameters:

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

See Also:

DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

AmazonCloudWatchAsyncClient

public AmazonCloudWatchAsyncClient(AWSCredentials awsCredentials)

Constructs a new asynchronous client to invoke service methods on CloudWatch using the specified AWS account credentials.

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

Parameters:

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

See Also:

Executors.newFixedThreadPool(int)

AmazonCloudWatchAsyncClient

public AmazonCloudWatchAsyncClient(AWSCredentials awsCredentials,
                           ExecutorService executorService)

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

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 CloudWatch using the specified AWS account credentials, executor service, and client configuration options.

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 CloudWatch using the specified AWS account credentials provider. Default client settings will be used.

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

Parameters:

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

See Also:

Executors.newFixedThreadPool(int)

AmazonCloudWatchAsyncClient

public AmazonCloudWatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                           ClientConfiguration clientConfiguration)

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

Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().

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).

See Also:

DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

AmazonCloudWatchAsyncClient

public AmazonCloudWatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                           ExecutorService executorService)

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

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,
                           ExecutorService executorService)

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

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 client to execute async requests.

Returns:

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

deleteAlarmsAsync

public Future<Void> deleteAlarmsAsync(DeleteAlarmsRequest request)

Description copied from interface: AmazonCloudWatchAsync

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

Specified by:

deleteAlarmsAsync in interface AmazonCloudWatchAsync

deleteAlarmsAsync

public Future<Void> deleteAlarmsAsync(DeleteAlarmsRequest request,
                             AsyncHandler<DeleteAlarmsRequest,Void> asyncHandler)

Description copied from interface: AmazonCloudWatchAsync

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

Specified by:

deleteAlarmsAsync 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.

describeAlarmHistoryAsync

public Future<DescribeAlarmHistoryResult> describeAlarmHistoryAsync(DescribeAlarmHistoryRequest request)

Description copied from interface: 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.

Specified by:

describeAlarmHistoryAsync in interface AmazonCloudWatchAsync

Returns:

A Java Future containing the result of the DescribeAlarmHistory operation returned by the service.

describeAlarmHistoryAsync

public Future<DescribeAlarmHistoryResult> describeAlarmHistoryAsync(DescribeAlarmHistoryRequest request,
                                                           AsyncHandler<DescribeAlarmHistoryRequest,DescribeAlarmHistoryResult> asyncHandler)

Description copied from interface: 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.

Specified by:

describeAlarmHistoryAsync 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.

Returns:

A Java Future containing the result of the DescribeAlarmHistory operation returned by the service.

describeAlarmHistoryAsync

public Future<DescribeAlarmHistoryResult> describeAlarmHistoryAsync()

Simplified method form for invoking the DescribeAlarmHistory operation.

Specified by:

describeAlarmHistoryAsync in interface AmazonCloudWatchAsync

See Also:

describeAlarmHistoryAsync(DescribeAlarmHistoryRequest)

describeAlarmHistoryAsync

public Future<DescribeAlarmHistoryResult> describeAlarmHistoryAsync(AsyncHandler<DescribeAlarmHistoryRequest,DescribeAlarmHistoryResult> asyncHandler)

Simplified method form for invoking the DescribeAlarmHistory operation with an AsyncHandler.

Specified by:

describeAlarmHistoryAsync in interface AmazonCloudWatchAsync

See Also:

describeAlarmHistoryAsync(DescribeAlarmHistoryRequest, com.amazonaws.handlers.AsyncHandler)

describeAlarmsAsync

public Future<DescribeAlarmsResult> describeAlarmsAsync(DescribeAlarmsRequest request)

Description copied from interface: 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.

Specified by:

describeAlarmsAsync in interface AmazonCloudWatchAsync

Returns:

A Java Future containing the result of the DescribeAlarms operation returned by the service.

describeAlarmsAsync

public Future<DescribeAlarmsResult> describeAlarmsAsync(DescribeAlarmsRequest request,
                                               AsyncHandler<DescribeAlarmsRequest,DescribeAlarmsResult> asyncHandler)

Description copied from interface: 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.

Specified by:

describeAlarmsAsync 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.

Returns:

A Java Future containing the result of the DescribeAlarms operation returned by the service.

describeAlarmsAsync

public Future<DescribeAlarmsResult> describeAlarmsAsync()

Simplified method form for invoking the DescribeAlarms operation.

Specified by:

describeAlarmsAsync in interface AmazonCloudWatchAsync

See Also:

describeAlarmsAsync(DescribeAlarmsRequest)

describeAlarmsAsync

public Future<DescribeAlarmsResult> describeAlarmsAsync(AsyncHandler<DescribeAlarmsRequest,DescribeAlarmsResult> asyncHandler)

Simplified method form for invoking the DescribeAlarms operation with an AsyncHandler.

Specified by:

describeAlarmsAsync in interface AmazonCloudWatchAsync

See Also:

describeAlarmsAsync(DescribeAlarmsRequest, com.amazonaws.handlers.AsyncHandler)

describeAlarmsForMetricAsync

public Future<DescribeAlarmsForMetricResult> describeAlarmsForMetricAsync(DescribeAlarmsForMetricRequest request)

Description copied from interface: AmazonCloudWatchAsync

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

Returns:

A Java Future containing the result of the DescribeAlarmsForMetric operation returned by the service.

describeAlarmsForMetricAsync

public Future<DescribeAlarmsForMetricResult> describeAlarmsForMetricAsync(DescribeAlarmsForMetricRequest request,
                                                                 AsyncHandler<DescribeAlarmsForMetricRequest,DescribeAlarmsForMetricResult> asyncHandler)

Description copied from interface: AmazonCloudWatchAsync

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

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.

Returns:

A Java Future containing the result of the DescribeAlarmsForMetric operation returned by the service.

disableAlarmActionsAsync

public Future<Void> disableAlarmActionsAsync(DisableAlarmActionsRequest request)

Description copied from interface: 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.

Specified by:

disableAlarmActionsAsync in interface AmazonCloudWatchAsync

disableAlarmActionsAsync

public Future<Void> disableAlarmActionsAsync(DisableAlarmActionsRequest request,
                                    AsyncHandler<DisableAlarmActionsRequest,Void> asyncHandler)

Description copied from interface: 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.

Specified by:

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.

enableAlarmActionsAsync

public Future<Void> enableAlarmActionsAsync(EnableAlarmActionsRequest request)

Description copied from interface: AmazonCloudWatchAsync

Enables actions for the specified alarms.

Specified by:

enableAlarmActionsAsync in interface AmazonCloudWatchAsync

enableAlarmActionsAsync

public Future<Void> enableAlarmActionsAsync(EnableAlarmActionsRequest request,
                                   AsyncHandler<EnableAlarmActionsRequest,Void> asyncHandler)

Description copied from interface: AmazonCloudWatchAsync

Enables actions for the specified alarms.

Specified by:

enableAlarmActionsAsync 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.

getMetricStatisticsAsync

public Future<GetMetricStatisticsResult> getMetricStatisticsAsync(GetMetricStatisticsRequest request)

Description copied from interface: 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. 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.

Specified by:

getMetricStatisticsAsync in interface AmazonCloudWatchAsync

Returns:

A Java Future containing the result of the GetMetricStatistics operation returned by the service.

getMetricStatisticsAsync

public Future<GetMetricStatisticsResult> getMetricStatisticsAsync(GetMetricStatisticsRequest request,
                                                         AsyncHandler<GetMetricStatisticsRequest,GetMetricStatisticsResult> asyncHandler)

Description copied from interface: 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. 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.

Specified by:

getMetricStatisticsAsync 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.

Returns:

A Java Future containing the result of the GetMetricStatistics operation returned by the service.

listMetricsAsync

public Future<ListMetricsResult> listMetricsAsync(ListMetricsRequest request)

Description copied from interface: 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 the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action. Statistics about the metric, however, are available sooner using GetMetricStatistics.

Specified by:

listMetricsAsync in interface AmazonCloudWatchAsync

Returns:

A Java Future containing the result of the ListMetrics operation returned by the service.

listMetricsAsync

public Future<ListMetricsResult> listMetricsAsync(ListMetricsRequest request,
                                         AsyncHandler<ListMetricsRequest,ListMetricsResult> asyncHandler)

Description copied from interface: 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 the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action. Statistics about the metric, however, are available sooner using GetMetricStatistics.

Specified by:

listMetricsAsync 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.

Returns:

A Java Future containing the result of the ListMetrics operation returned by the service.

listMetricsAsync

public Future<ListMetricsResult> listMetricsAsync()

Simplified method form for invoking the ListMetrics operation.

Specified by:

listMetricsAsync in interface AmazonCloudWatchAsync

See Also:

listMetricsAsync(ListMetricsRequest)

listMetricsAsync

public Future<ListMetricsResult> listMetricsAsync(AsyncHandler<ListMetricsRequest,ListMetricsResult> asyncHandler)

Simplified method form for invoking the ListMetrics operation with an AsyncHandler.

Specified by:

listMetricsAsync in interface AmazonCloudWatchAsync

See Also:

listMetricsAsync(ListMetricsRequest, com.amazonaws.handlers.AsyncHandler)

putMetricAlarmAsync

public Future<Void> putMetricAlarmAsync(PutMetricAlarmRequest request)

Description copied from interface: AmazonCloudWatchAsync

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.

When updating an existing alarm, its StateValue is left unchanged. 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.

Specified by:

putMetricAlarmAsync in interface AmazonCloudWatchAsync

putMetricAlarmAsync

public Future<Void> putMetricAlarmAsync(PutMetricAlarmRequest request,
                               AsyncHandler<PutMetricAlarmRequest,Void> asyncHandler)

Description copied from interface: AmazonCloudWatchAsync

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.

When updating an existing alarm, its StateValue is left unchanged. 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.

Specified by:

putMetricAlarmAsync 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.

putMetricDataAsync

public Future<Void> putMetricDataAsync(PutMetricDataRequest request)

Description copied from interface: 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 the ListMetrics action.

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.

Specified by:

putMetricDataAsync in interface AmazonCloudWatchAsync

putMetricDataAsync

public Future<Void> putMetricDataAsync(PutMetricDataRequest request,
                              AsyncHandler<PutMetricDataRequest,Void> asyncHandler)

Description copied from interface: 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 the ListMetrics action.

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.

Specified by:

putMetricDataAsync 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.

setAlarmStateAsync

public Future<Void> setAlarmStateAsync(SetAlarmStateRequest request)

Description copied from interface: AmazonCloudWatchAsync

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. 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 will send an Amazon SNS message. This is not a permanent change. The next periodic alarm check (in about a minute) will set the alarm to its actual state. Because the alarm state change happens very quickly, it is typically only visibile in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.

Specified by:

setAlarmStateAsync in interface AmazonCloudWatchAsync

setAlarmStateAsync

public Future<Void> setAlarmStateAsync(SetAlarmStateRequest request,
                              AsyncHandler<SetAlarmStateRequest,Void> asyncHandler)

Description copied from interface: AmazonCloudWatchAsync

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. 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 will send an Amazon SNS message. This is not a permanent change. The next periodic alarm check (in about a minute) will set the alarm to its actual state. Because the alarm state change happens very quickly, it is typically only visibile in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.

Specified by:

setAlarmStateAsync 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.

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