public class AmazonCloudWatchAsyncClient extends AmazonCloudWatchClient implements AmazonCloudWatchAsync
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
This is the Amazon CloudWatch API Reference. This guide provides detailed information about Amazon CloudWatch actions, data types, parameters, and errors. For detailed information about Amazon CloudWatch features and their associated API calls, go to the Amazon CloudWatch Developer Guide.
Amazon CloudWatch is a web service that enables you to publish, monitor, and manage various metrics, as well as configure alarm actions based on data from metrics. For more information about this product go to http://aws.amazon.com/cloudwatch.
Use the following links to get started using the Amazon CloudWatch API Reference:
exceptionUnmarshallers
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
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.
|
deleteAlarms, describeAlarmHistory, describeAlarmHistory, describeAlarms, describeAlarms, describeAlarmsForMetric, disableAlarmActions, enableAlarmActions, getCachedResponseMetadata, getMetricStatistics, listMetrics, listMetrics, putMetricAlarm, putMetricData, setAlarmState
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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
deleteAlarms, describeAlarmHistory, describeAlarmHistory, describeAlarms, describeAlarms, describeAlarmsForMetric, disableAlarmActions, enableAlarmActions, getCachedResponseMetadata, getMetricStatistics, listMetrics, listMetrics, putMetricAlarm, putMetricData, setAlarmState, setEndpoint, setRegion
public AmazonCloudWatchAsyncClient()
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).
public AmazonCloudWatchAsyncClient(ClientConfiguration clientConfiguration)
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()
.
clientConfiguration
- The client configuration options controlling how this client
connects to CloudWatch (ex: proxy settings, retry counts, etc).DefaultAWSCredentialsProviderChain
,
Executors.newFixedThreadPool(int)
public AmazonCloudWatchAsyncClient(AWSCredentials awsCredentials)
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).
awsCredentials
- The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.Executors.newFixedThreadPool(int)
public AmazonCloudWatchAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
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.public AmazonCloudWatchAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
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.public AmazonCloudWatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
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).
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.Executors.newFixedThreadPool(int)
public AmazonCloudWatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
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()
.
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).DefaultAWSCredentialsProviderChain
,
Executors.newFixedThreadPool(int)
public AmazonCloudWatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
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.public AmazonCloudWatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
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.public ExecutorService getExecutorService()
public Future<Void> deleteAlarmsAsync(DeleteAlarmsRequest request)
AmazonCloudWatchAsync
Deletes all specified alarms. In the event of an error, no alarms are deleted.
deleteAlarmsAsync
in interface AmazonCloudWatchAsync
public Future<Void> deleteAlarmsAsync(DeleteAlarmsRequest request, AsyncHandler<DeleteAlarmsRequest,Void> asyncHandler)
AmazonCloudWatchAsync
Deletes all specified alarms. In the event of an error, no alarms are deleted.
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.public Future<DescribeAlarmHistoryResult> describeAlarmHistoryAsync(DescribeAlarmHistoryRequest request)
AmazonCloudWatchAsync
Retrieves history for the specified alarm. Filter alarms by date range or item type. If an alarm name is not specified, Amazon CloudWatch returns histories for all of the owner's alarms.
describeAlarmHistoryAsync
in interface AmazonCloudWatchAsync
public Future<DescribeAlarmHistoryResult> describeAlarmHistoryAsync(DescribeAlarmHistoryRequest request, AsyncHandler<DescribeAlarmHistoryRequest,DescribeAlarmHistoryResult> asyncHandler)
AmazonCloudWatchAsync
Retrieves history for the specified alarm. Filter alarms by date range or item type. If an alarm name is not specified, Amazon CloudWatch returns histories for all of the owner's alarms.
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.public Future<DescribeAlarmHistoryResult> describeAlarmHistoryAsync()
describeAlarmHistoryAsync
in interface AmazonCloudWatchAsync
describeAlarmHistoryAsync(DescribeAlarmHistoryRequest)
public Future<DescribeAlarmHistoryResult> describeAlarmHistoryAsync(AsyncHandler<DescribeAlarmHistoryRequest,DescribeAlarmHistoryResult> asyncHandler)
describeAlarmHistoryAsync
in interface AmazonCloudWatchAsync
describeAlarmHistoryAsync(DescribeAlarmHistoryRequest,
com.amazonaws.handlers.AsyncHandler)
public Future<DescribeAlarmsResult> describeAlarmsAsync(DescribeAlarmsRequest request)
AmazonCloudWatchAsync
Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.
describeAlarmsAsync
in interface AmazonCloudWatchAsync
public Future<DescribeAlarmsResult> describeAlarmsAsync(DescribeAlarmsRequest request, AsyncHandler<DescribeAlarmsRequest,DescribeAlarmsResult> asyncHandler)
AmazonCloudWatchAsync
Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.
describeAlarmsAsync
in interface AmazonCloudWatchAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeAlarmsResult> describeAlarmsAsync()
describeAlarmsAsync
in interface AmazonCloudWatchAsync
describeAlarmsAsync(DescribeAlarmsRequest)
public Future<DescribeAlarmsResult> describeAlarmsAsync(AsyncHandler<DescribeAlarmsRequest,DescribeAlarmsResult> asyncHandler)
describeAlarmsAsync
in interface AmazonCloudWatchAsync
describeAlarmsAsync(DescribeAlarmsRequest,
com.amazonaws.handlers.AsyncHandler)
public Future<DescribeAlarmsForMetricResult> describeAlarmsForMetricAsync(DescribeAlarmsForMetricRequest request)
AmazonCloudWatchAsync
Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further.
describeAlarmsForMetricAsync
in interface AmazonCloudWatchAsync
public Future<DescribeAlarmsForMetricResult> describeAlarmsForMetricAsync(DescribeAlarmsForMetricRequest request, AsyncHandler<DescribeAlarmsForMetricRequest,DescribeAlarmsForMetricResult> asyncHandler)
AmazonCloudWatchAsync
Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further.
describeAlarmsForMetricAsync
in interface AmazonCloudWatchAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<Void> disableAlarmActionsAsync(DisableAlarmActionsRequest request)
AmazonCloudWatchAsync
Disables actions for the specified alarms. When an alarm's actions are disabled the alarm's state may change, but none of the alarm's actions will execute.
disableAlarmActionsAsync
in interface AmazonCloudWatchAsync
public Future<Void> disableAlarmActionsAsync(DisableAlarmActionsRequest request, AsyncHandler<DisableAlarmActionsRequest,Void> asyncHandler)
AmazonCloudWatchAsync
Disables actions for the specified alarms. When an alarm's actions are disabled the alarm's state may change, but none of the alarm's actions will execute.
disableAlarmActionsAsync
in interface AmazonCloudWatchAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<Void> enableAlarmActionsAsync(EnableAlarmActionsRequest request)
AmazonCloudWatchAsync
Enables actions for the specified alarms.
enableAlarmActionsAsync
in interface AmazonCloudWatchAsync
public Future<Void> enableAlarmActionsAsync(EnableAlarmActionsRequest request, AsyncHandler<EnableAlarmActionsRequest,Void> asyncHandler)
AmazonCloudWatchAsync
Enables actions for the specified alarms.
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.public Future<GetMetricStatisticsResult> getMetricStatisticsAsync(GetMetricStatisticsRequest request)
AmazonCloudWatchAsync
Gets statistics for the specified metric.
GetMetricStatistics
request is 1,440. If a request is made
that generates more than 1,440 data points, Amazon CloudWatch returns an
error. In such a case, alter the request by narrowing the specified time
range or increasing the specified period. Alternatively, make multiple
requests across adjacent time ranges.
Amazon CloudWatch aggregates data points based on the length of the
period
that you specify. For example, if you request
statistics with a one-minute granularity, Amazon CloudWatch aggregates
data points with time stamps that fall within the same one-minute period.
In such a case, the data points queried can greatly outnumber the data
points returned.
The following examples show various statistics allowed by the data point
query maximum of 50,850 when you call GetMetricStatistics
on
Amazon EC2 instances with detailed (one-minute) monitoring enabled:
getMetricStatisticsAsync
in interface AmazonCloudWatchAsync
public Future<GetMetricStatisticsResult> getMetricStatisticsAsync(GetMetricStatisticsRequest request, AsyncHandler<GetMetricStatisticsRequest,GetMetricStatisticsResult> asyncHandler)
AmazonCloudWatchAsync
Gets statistics for the specified metric.
GetMetricStatistics
request is 1,440. If a request is made
that generates more than 1,440 data points, Amazon CloudWatch returns an
error. In such a case, alter the request by narrowing the specified time
range or increasing the specified period. Alternatively, make multiple
requests across adjacent time ranges.
Amazon CloudWatch aggregates data points based on the length of the
period
that you specify. For example, if you request
statistics with a one-minute granularity, Amazon CloudWatch aggregates
data points with time stamps that fall within the same one-minute period.
In such a case, the data points queried can greatly outnumber the data
points returned.
The following examples show various statistics allowed by the data point
query maximum of 50,850 when you call GetMetricStatistics
on
Amazon EC2 instances with detailed (one-minute) monitoring enabled:
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.public Future<ListMetricsResult> listMetricsAsync(ListMetricsRequest request)
AmazonCloudWatchAsync
Returns a list of valid metrics stored for the AWS account owner.
Returned metrics can be used with GetMetricStatistics
to
obtain statistical data for a given metric.
NextToken
values with
subsequent ListMetrics
operations. ListMetrics
action. listMetricsAsync
in interface AmazonCloudWatchAsync
public Future<ListMetricsResult> listMetricsAsync(ListMetricsRequest request, AsyncHandler<ListMetricsRequest,ListMetricsResult> asyncHandler)
AmazonCloudWatchAsync
Returns a list of valid metrics stored for the AWS account owner.
Returned metrics can be used with GetMetricStatistics
to
obtain statistical data for a given metric.
NextToken
values with
subsequent ListMetrics
operations. ListMetrics
action. 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.public Future<ListMetricsResult> listMetricsAsync()
listMetricsAsync
in interface AmazonCloudWatchAsync
listMetricsAsync(ListMetricsRequest)
public Future<ListMetricsResult> listMetricsAsync(AsyncHandler<ListMetricsRequest,ListMetricsResult> asyncHandler)
listMetricsAsync
in interface AmazonCloudWatchAsync
listMetricsAsync(ListMetricsRequest,
com.amazonaws.handlers.AsyncHandler)
public Future<Void> putMetricAlarmAsync(PutMetricAlarmRequest request)
AmazonCloudWatchAsync
Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric. Optionally, this operation can associate one or more Amazon Simple Notification Service resources with the alarm.
When this operation creates an alarm, the alarm state is immediately set
to INSUFFICIENT_DATA
. The alarm is evaluated and its
StateValue
is set appropriately. Any actions associated with
the StateValue
is then executed.
StateValue
is
left unchanged. putMetricAlarmAsync
in interface AmazonCloudWatchAsync
public Future<Void> putMetricAlarmAsync(PutMetricAlarmRequest request, AsyncHandler<PutMetricAlarmRequest,Void> asyncHandler)
AmazonCloudWatchAsync
Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric. Optionally, this operation can associate one or more Amazon Simple Notification Service resources with the alarm.
When this operation creates an alarm, the alarm state is immediately set
to INSUFFICIENT_DATA
. The alarm is evaluated and its
StateValue
is set appropriately. Any actions associated with
the StateValue
is then executed.
StateValue
is
left unchanged. 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.public Future<Void> putMetricDataAsync(PutMetricDataRequest request)
AmazonCloudWatchAsync
Publishes metric data points to Amazon CloudWatch. Amazon Cloudwatch associates the data points with the specified metric. If the specified metric does not exist, Amazon CloudWatch creates the metric.
PutMetricData
action,
allow up to fifteen minutes for the metric to appear in calls to the
ListMetrics action.
The size of a
Value
parameter accepts numbers of
type Double
, Amazon CloudWatch truncates values with very
large exponents. Values with base-10 exponents greater than 126 (1 x
10^126) are truncated. Likewise, values with base-10 exponents less than
-130 (1 x 10^-130) are also truncated. putMetricDataAsync
in interface AmazonCloudWatchAsync
public Future<Void> putMetricDataAsync(PutMetricDataRequest request, AsyncHandler<PutMetricDataRequest,Void> asyncHandler)
AmazonCloudWatchAsync
Publishes metric data points to Amazon CloudWatch. Amazon Cloudwatch associates the data points with the specified metric. If the specified metric does not exist, Amazon CloudWatch creates the metric.
PutMetricData
action,
allow up to fifteen minutes for the metric to appear in calls to the
ListMetrics action.
The size of a
Value
parameter accepts numbers of
type Double
, Amazon CloudWatch truncates values with very
large exponents. Values with base-10 exponents greater than 126 (1 x
10^126) are truncated. Likewise, values with base-10 exponents less than
-130 (1 x 10^-130) are also truncated. 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.public Future<Void> setAlarmStateAsync(SetAlarmStateRequest request)
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. This is not a permanent
change. The next periodic alarm check (in about a minute) will set the
alarm to its actual state.
setAlarmStateAsync
in interface AmazonCloudWatchAsync
public Future<Void> setAlarmStateAsync(SetAlarmStateRequest request, AsyncHandler<SetAlarmStateRequest,Void> asyncHandler)
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. This is not a permanent
change. The next periodic alarm check (in about a minute) will set the
alarm to its actual state.
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.public void shutdown()
getExecutorService().shutdown()
followed by
getExecutorService().awaitTermination()
prior to calling this
method.shutdown
in interface AmazonCloudWatch
shutdown
in class AmazonWebServiceClient
Copyright © 2016. All rights reserved.