@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonCloudWatchAsyncClient extends AmazonCloudWatchClient implements AmazonCloudWatchAsync
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 change 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 EC2 instances. 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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AmazonCloudWatchAsyncClient()
Deprecated.
|
AmazonCloudWatchAsyncClient(AWSCredentials awsCredentials)
Deprecated.
|
AmazonCloudWatchAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AmazonCloudWatchAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
|
AmazonCloudWatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonCloudWatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonCloudWatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AmazonCloudWatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
|
AmazonCloudWatchAsyncClient(ClientConfiguration clientConfiguration)
Deprecated.
|
builder, deleteAlarms, deleteDashboards, describeAlarmHistory, describeAlarmHistory, describeAlarms, describeAlarms, describeAlarmsForMetric, disableAlarmActions, enableAlarmActions, getCachedResponseMetadata, getDashboard, getMetricStatistics, listDashboards, listMetrics, listMetrics, putDashboard, putMetricAlarm, putMetricData, setAlarmState, waitersaddRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitdeleteAlarms, deleteDashboards, describeAlarmHistory, describeAlarmHistory, describeAlarms, describeAlarms, describeAlarmsForMetric, disableAlarmActions, enableAlarmActions, getCachedResponseMetadata, getDashboard, getMetricStatistics, listDashboards, listMetrics, listMetrics, putDashboard, putMetricAlarm, putMetricData, setAlarmState, setEndpoint, setRegion, waiters@Deprecated public AmazonCloudWatchAsyncClient()
AmazonCloudWatchAsyncClientBuilder.defaultClient()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).
@Deprecated public AmazonCloudWatchAsyncClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(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)@Deprecated public AmazonCloudWatchAsyncClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(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).
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AmazonCloudWatchAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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.@Deprecated public AmazonCloudWatchAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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.@Deprecated public AmazonCloudWatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(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)@Deprecated public AmazonCloudWatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(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)@Deprecated public AmazonCloudWatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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.@Deprecated public AmazonCloudWatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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 static AmazonCloudWatchAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<DeleteAlarmsResult> deleteAlarmsAsync(DeleteAlarmsRequest request)
AmazonCloudWatchAsyncDeletes the specified alarms. In the event of an error, no alarms are deleted.
deleteAlarmsAsync in interface AmazonCloudWatchAsyncpublic Future<DeleteAlarmsResult> deleteAlarmsAsync(DeleteAlarmsRequest request, AsyncHandler<DeleteAlarmsRequest,DeleteAlarmsResult> asyncHandler)
AmazonCloudWatchAsyncDeletes the specified alarms. In the event of an error, no alarms are deleted.
deleteAlarmsAsync in interface AmazonCloudWatchAsyncasyncHandler - 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<DeleteDashboardsResult> deleteDashboardsAsync(DeleteDashboardsRequest request)
AmazonCloudWatchAsyncDeletes all dashboards that you specify. You may specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.
deleteDashboardsAsync in interface AmazonCloudWatchAsyncpublic Future<DeleteDashboardsResult> deleteDashboardsAsync(DeleteDashboardsRequest request, AsyncHandler<DeleteDashboardsRequest,DeleteDashboardsResult> asyncHandler)
AmazonCloudWatchAsyncDeletes all dashboards that you specify. You may specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.
deleteDashboardsAsync in interface AmazonCloudWatchAsyncasyncHandler - 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)
AmazonCloudWatchAsyncRetrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for all alarms are returned.
CloudWatch retains the history of an alarm even if you delete the alarm.
describeAlarmHistoryAsync in interface AmazonCloudWatchAsyncpublic Future<DescribeAlarmHistoryResult> describeAlarmHistoryAsync(DescribeAlarmHistoryRequest request, AsyncHandler<DescribeAlarmHistoryRequest,DescribeAlarmHistoryResult> asyncHandler)
AmazonCloudWatchAsyncRetrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for all alarms are returned.
CloudWatch retains the history of an alarm even if you delete the alarm.
describeAlarmHistoryAsync in interface AmazonCloudWatchAsyncasyncHandler - 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 AmazonCloudWatchAsyncdescribeAlarmHistoryAsync(DescribeAlarmHistoryRequest)public Future<DescribeAlarmHistoryResult> describeAlarmHistoryAsync(AsyncHandler<DescribeAlarmHistoryRequest,DescribeAlarmHistoryResult> asyncHandler)
describeAlarmHistoryAsync in interface AmazonCloudWatchAsyncdescribeAlarmHistoryAsync(DescribeAlarmHistoryRequest, com.amazonaws.handlers.AsyncHandler)public Future<DescribeAlarmsResult> describeAlarmsAsync(DescribeAlarmsRequest request)
AmazonCloudWatchAsyncRetrieves the specified alarms. If no alarms are specified, all alarms 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 AmazonCloudWatchAsyncpublic Future<DescribeAlarmsResult> describeAlarmsAsync(DescribeAlarmsRequest request, AsyncHandler<DescribeAlarmsRequest,DescribeAlarmsResult> asyncHandler)
AmazonCloudWatchAsyncRetrieves the specified alarms. If no alarms are specified, all alarms 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 AmazonCloudWatchAsyncasyncHandler - 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 AmazonCloudWatchAsyncdescribeAlarmsAsync(DescribeAlarmsRequest)public Future<DescribeAlarmsResult> describeAlarmsAsync(AsyncHandler<DescribeAlarmsRequest,DescribeAlarmsResult> asyncHandler)
describeAlarmsAsync in interface AmazonCloudWatchAsyncdescribeAlarmsAsync(DescribeAlarmsRequest, com.amazonaws.handlers.AsyncHandler)public Future<DescribeAlarmsForMetricResult> describeAlarmsForMetricAsync(DescribeAlarmsForMetricRequest request)
AmazonCloudWatchAsyncRetrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.
describeAlarmsForMetricAsync in interface AmazonCloudWatchAsyncpublic Future<DescribeAlarmsForMetricResult> describeAlarmsForMetricAsync(DescribeAlarmsForMetricRequest request, AsyncHandler<DescribeAlarmsForMetricRequest,DescribeAlarmsForMetricResult> asyncHandler)
AmazonCloudWatchAsyncRetrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.
describeAlarmsForMetricAsync in interface AmazonCloudWatchAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisableAlarmActionsResult> disableAlarmActionsAsync(DisableAlarmActionsRequest request)
AmazonCloudWatchAsyncDisables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes.
disableAlarmActionsAsync in interface AmazonCloudWatchAsyncpublic Future<DisableAlarmActionsResult> disableAlarmActionsAsync(DisableAlarmActionsRequest request, AsyncHandler<DisableAlarmActionsRequest,DisableAlarmActionsResult> asyncHandler)
AmazonCloudWatchAsyncDisables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes.
disableAlarmActionsAsync in interface AmazonCloudWatchAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<EnableAlarmActionsResult> enableAlarmActionsAsync(EnableAlarmActionsRequest request)
AmazonCloudWatchAsyncEnables the actions for the specified alarms.
enableAlarmActionsAsync in interface AmazonCloudWatchAsyncpublic Future<EnableAlarmActionsResult> enableAlarmActionsAsync(EnableAlarmActionsRequest request, AsyncHandler<EnableAlarmActionsRequest,EnableAlarmActionsResult> asyncHandler)
AmazonCloudWatchAsyncEnables the actions for the specified alarms.
enableAlarmActionsAsync in interface AmazonCloudWatchAsyncasyncHandler - 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<GetDashboardResult> getDashboardAsync(GetDashboardRequest request)
AmazonCloudWatchAsyncDisplays the details of the dashboard that you specify.
To copy an existing dashboard, use GetDashboard, and then use the data returned within
DashboardBody as the template for the new dashboard when you call PutDashboard to
create the copy.
getDashboardAsync in interface AmazonCloudWatchAsyncpublic Future<GetDashboardResult> getDashboardAsync(GetDashboardRequest request, AsyncHandler<GetDashboardRequest,GetDashboardResult> asyncHandler)
AmazonCloudWatchAsyncDisplays the details of the dashboard that you specify.
To copy an existing dashboard, use GetDashboard, and then use the data returned within
DashboardBody as the template for the new dashboard when you call PutDashboard to
create the copy.
getDashboardAsync in interface AmazonCloudWatchAsyncasyncHandler - 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)
AmazonCloudWatchAsyncGets statistics for the specified metric.
The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.
CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.
CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:
The SampleCount value of the statistic set is 1.
The Min and the Max values of the statistic set are equal.
Amazon CloudWatch retains metric data as follows:
Data points with a period of less than 60 seconds are available for 3 hours. These data points are
high-resolution metrics and are available only for custom metrics that have been defined with a
StorageResolution of 1.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
Data points with a period of 300 seconds (5-minute) are available for 63 days.
Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.
CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.
For information about metrics and dimensions supported by AWS services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.
getMetricStatisticsAsync in interface AmazonCloudWatchAsyncpublic Future<GetMetricStatisticsResult> getMetricStatisticsAsync(GetMetricStatisticsRequest request, AsyncHandler<GetMetricStatisticsRequest,GetMetricStatisticsResult> asyncHandler)
AmazonCloudWatchAsyncGets statistics for the specified metric.
The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.
CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.
CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:
The SampleCount value of the statistic set is 1.
The Min and the Max values of the statistic set are equal.
Amazon CloudWatch retains metric data as follows:
Data points with a period of less than 60 seconds are available for 3 hours. These data points are
high-resolution metrics and are available only for custom metrics that have been defined with a
StorageResolution of 1.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
Data points with a period of 300 seconds (5-minute) are available for 63 days.
Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.
CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.
For information about metrics and dimensions supported by AWS services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.
getMetricStatisticsAsync in interface AmazonCloudWatchAsyncasyncHandler - 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<ListDashboardsResult> listDashboardsAsync(ListDashboardsRequest request)
AmazonCloudWatchAsync
Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those
dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.
listDashboardsAsync in interface AmazonCloudWatchAsyncpublic Future<ListDashboardsResult> listDashboardsAsync(ListDashboardsRequest request, AsyncHandler<ListDashboardsRequest,ListDashboardsResult> asyncHandler)
AmazonCloudWatchAsync
Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those
dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.
listDashboardsAsync in interface AmazonCloudWatchAsyncasyncHandler - 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)
AmazonCloudWatchAsyncList the specified metrics. You can use the returned metrics with GetMetricStatistics to obtain statistical data.
Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.
After you create a metric, allow up to fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using GetMetricStatistics.
listMetricsAsync in interface AmazonCloudWatchAsyncpublic Future<ListMetricsResult> listMetricsAsync(ListMetricsRequest request, AsyncHandler<ListMetricsRequest,ListMetricsResult> asyncHandler)
AmazonCloudWatchAsyncList the specified metrics. You can use the returned metrics with GetMetricStatistics to obtain statistical data.
Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.
After you create a metric, allow up to fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using GetMetricStatistics.
listMetricsAsync in interface AmazonCloudWatchAsyncasyncHandler - 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 AmazonCloudWatchAsynclistMetricsAsync(ListMetricsRequest)public Future<ListMetricsResult> listMetricsAsync(AsyncHandler<ListMetricsRequest,ListMetricsResult> asyncHandler)
listMetricsAsync in interface AmazonCloudWatchAsynclistMetricsAsync(ListMetricsRequest, com.amazonaws.handlers.AsyncHandler)public Future<PutDashboardResult> putDashboardAsync(PutDashboardRequest request)
AmazonCloudWatchAsyncCreates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.
You can have up to 500 dashboards per account. All dashboards in your account are global, not region-specific.
A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an
existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the
Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use
GetDashboard, and then use the data returned within DashboardBody as the template for
the new dashboard when you call PutDashboard.
When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of
the dashboard with a message that the dashboard was created by script and should not be changed in the console.
This message could also point console users to the location of the DashboardBody script or the
CloudFormation template used to create the dashboard.
putDashboardAsync in interface AmazonCloudWatchAsyncpublic Future<PutDashboardResult> putDashboardAsync(PutDashboardRequest request, AsyncHandler<PutDashboardRequest,PutDashboardResult> asyncHandler)
AmazonCloudWatchAsyncCreates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.
You can have up to 500 dashboards per account. All dashboards in your account are global, not region-specific.
A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an
existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the
Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use
GetDashboard, and then use the data returned within DashboardBody as the template for
the new dashboard when you call PutDashboard.
When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of
the dashboard with a message that the dashboard was created by script and should not be changed in the console.
This message could also point console users to the location of the DashboardBody script or the
CloudFormation template used to create the dashboard.
putDashboardAsync in interface AmazonCloudWatchAsyncasyncHandler - 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<PutMetricAlarmResult> putMetricAlarmAsync(PutMetricAlarmRequest request)
AmazonCloudWatchAsyncCreates or updates an alarm and associates it with the specified metric. Optionally, this operation can associate one or more Amazon SNS resources with the alarm.
When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The
alarm is evaluated and its state is set appropriately. Any actions associated with the state are then executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
If you are an IAM user, you must have Amazon EC2 permissions for some operations:
ec2:DescribeInstanceStatus and ec2:DescribeInstances for all alarms on 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 are not performed. However, if you are later granted the required permissions, the alarm actions that you created earlier are performed.
If you are using an IAM role (for example, an 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 AWS STS, you cannot stop or terminate an EC2 instance using alarm actions.
You must create at least one stop, terminate, or reboot alarm using either the Amazon EC2 or CloudWatch consoles to create the EC2ActionsAccess IAM role. After this IAM role is created, you can create stop, terminate, or reboot alarms using a command-line interface or API.
putMetricAlarmAsync in interface AmazonCloudWatchAsyncpublic Future<PutMetricAlarmResult> putMetricAlarmAsync(PutMetricAlarmRequest request, AsyncHandler<PutMetricAlarmRequest,PutMetricAlarmResult> asyncHandler)
AmazonCloudWatchAsyncCreates or updates an alarm and associates it with the specified metric. Optionally, this operation can associate one or more Amazon SNS resources with the alarm.
When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The
alarm is evaluated and its state is set appropriately. Any actions associated with the state are then executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
If you are an IAM user, you must have Amazon EC2 permissions for some operations:
ec2:DescribeInstanceStatus and ec2:DescribeInstances for all alarms on 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 are not performed. However, if you are later granted the required permissions, the alarm actions that you created earlier are performed.
If you are using an IAM role (for example, an 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 AWS STS, you cannot stop or terminate an EC2 instance using alarm actions.
You must create at least one stop, terminate, or reboot alarm using either the Amazon EC2 or CloudWatch consoles to create the EC2ActionsAccess IAM role. After this IAM role is created, you can create stop, terminate, or reboot alarms using a command-line interface or API.
putMetricAlarmAsync in interface AmazonCloudWatchAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutMetricDataResult> putMetricDataAsync(PutMetricDataRequest request)
AmazonCloudWatchAsyncPublishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics.
Each PutMetricData request is limited to 40 KB in size for HTTP POST requests.
Although the Value parameter accepts numbers of type Double, 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 (for example, NaN, +Infinity, -Infinity) are not
supported.
You can use up to 10 dimensions per metric to further clarify what data the metric collects. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.
Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricStatistics from the time they are submitted.
CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:
The SampleCount value of the statistic set is 1
The Min and the Max values of the statistic set are equal
putMetricDataAsync in interface AmazonCloudWatchAsyncpublic Future<PutMetricDataResult> putMetricDataAsync(PutMetricDataRequest request, AsyncHandler<PutMetricDataRequest,PutMetricDataResult> asyncHandler)
AmazonCloudWatchAsyncPublishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics.
Each PutMetricData request is limited to 40 KB in size for HTTP POST requests.
Although the Value parameter accepts numbers of type Double, 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 (for example, NaN, +Infinity, -Infinity) are not
supported.
You can use up to 10 dimensions per metric to further clarify what data the metric collects. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.
Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricStatistics from the time they are submitted.
CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:
The SampleCount value of the statistic set is 1
The Min and the Max values of the statistic set are equal
putMetricDataAsync in interface AmazonCloudWatchAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SetAlarmStateResult> setAlarmStateAsync(SetAlarmStateRequest request)
AmazonCloudWatchAsync
Temporarily sets the state of an alarm for testing purposes. When the updated state 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 state to ALARM
sends an SNS message. The alarm returns to its actual state (often within seconds). Because the alarm state
change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch
console or through DescribeAlarmHistory.
setAlarmStateAsync in interface AmazonCloudWatchAsyncpublic Future<SetAlarmStateResult> setAlarmStateAsync(SetAlarmStateRequest request, AsyncHandler<SetAlarmStateRequest,SetAlarmStateResult> asyncHandler)
AmazonCloudWatchAsync
Temporarily sets the state of an alarm for testing purposes. When the updated state 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 state to ALARM
sends an SNS message. The alarm returns to its actual state (often within seconds). Because the alarm state
change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch
console or through DescribeAlarmHistory.
setAlarmStateAsync in interface AmazonCloudWatchAsyncasyncHandler - 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 AmazonCloudWatchshutdown in class AmazonCloudWatchClientCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.