com.amazonaws.services.cloudwatch.AmazonCloudWatchAsync Maven / Gradle / Ivy
/*
* Copyright 2014-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.cloudwatch;
import javax.annotation.Generated;
import com.amazonaws.services.cloudwatch.model.*;
/**
* Interface for accessing CloudWatch asynchronously. Each asynchronous method will return a Java Future object
* representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive
* notification when an asynchronous operation completes.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.cloudwatch.AbstractAmazonCloudWatchAsync} instead.
*
*
*
* 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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonCloudWatchAsync extends AmazonCloudWatch {
/**
*
* Deletes the specified alarms. In the event of an error, no alarms are deleted.
*
*
* @param deleteAlarmsRequest
* @return A Java Future containing the result of the DeleteAlarms operation returned by the service.
* @sample AmazonCloudWatchAsync.DeleteAlarms
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteAlarmsAsync(DeleteAlarmsRequest deleteAlarmsRequest);
/**
*
* Deletes the specified alarms. In the event of an error, no alarms are deleted.
*
*
* @param deleteAlarmsRequest
* @param 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.
* @return A Java Future containing the result of the DeleteAlarms operation returned by the service.
* @sample AmazonCloudWatchAsyncHandler.DeleteAlarms
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteAlarmsAsync(DeleteAlarmsRequest deleteAlarmsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes 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.
*
*
* @param deleteDashboardsRequest
* @return A Java Future containing the result of the DeleteDashboards operation returned by the service.
* @sample AmazonCloudWatchAsync.DeleteDashboards
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteDashboardsAsync(DeleteDashboardsRequest deleteDashboardsRequest);
/**
*
* Deletes 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.
*
*
* @param deleteDashboardsRequest
* @param 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.
* @return A Java Future containing the result of the DeleteDashboards operation returned by the service.
* @sample AmazonCloudWatchAsyncHandler.DeleteDashboards
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteDashboardsAsync(DeleteDashboardsRequest deleteDashboardsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves 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.
*
*
* @param describeAlarmHistoryRequest
* @return A Java Future containing the result of the DescribeAlarmHistory operation returned by the service.
* @sample AmazonCloudWatchAsync.DescribeAlarmHistory
* @see AWS API Documentation
*/
java.util.concurrent.Future describeAlarmHistoryAsync(DescribeAlarmHistoryRequest describeAlarmHistoryRequest);
/**
*
* Retrieves 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.
*
*
* @param describeAlarmHistoryRequest
* @param 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.
* @return A Java Future containing the result of the DescribeAlarmHistory operation returned by the service.
* @sample AmazonCloudWatchAsyncHandler.DescribeAlarmHistory
* @see AWS API Documentation
*/
java.util.concurrent.Future describeAlarmHistoryAsync(DescribeAlarmHistoryRequest describeAlarmHistoryRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the DescribeAlarmHistory operation.
*
* @see #describeAlarmHistoryAsync(DescribeAlarmHistoryRequest)
*/
java.util.concurrent.Future describeAlarmHistoryAsync();
/**
* Simplified method form for invoking the DescribeAlarmHistory operation with an AsyncHandler.
*
* @see #describeAlarmHistoryAsync(DescribeAlarmHistoryRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future describeAlarmHistoryAsync(
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves 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.
*
*
* @param describeAlarmsRequest
* @return A Java Future containing the result of the DescribeAlarms operation returned by the service.
* @sample AmazonCloudWatchAsync.DescribeAlarms
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeAlarmsAsync(DescribeAlarmsRequest describeAlarmsRequest);
/**
*
* Retrieves 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.
*
*
* @param describeAlarmsRequest
* @param 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.
* @return A Java Future containing the result of the DescribeAlarms operation returned by the service.
* @sample AmazonCloudWatchAsyncHandler.DescribeAlarms
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeAlarmsAsync(DescribeAlarmsRequest describeAlarmsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the DescribeAlarms operation.
*
* @see #describeAlarmsAsync(DescribeAlarmsRequest)
*/
java.util.concurrent.Future describeAlarmsAsync();
/**
* Simplified method form for invoking the DescribeAlarms operation with an AsyncHandler.
*
* @see #describeAlarmsAsync(DescribeAlarmsRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future describeAlarmsAsync(
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.
*
*
* @param describeAlarmsForMetricRequest
* @return A Java Future containing the result of the DescribeAlarmsForMetric operation returned by the service.
* @sample AmazonCloudWatchAsync.DescribeAlarmsForMetric
* @see AWS API Documentation
*/
java.util.concurrent.Future describeAlarmsForMetricAsync(DescribeAlarmsForMetricRequest describeAlarmsForMetricRequest);
/**
*
* Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.
*
*
* @param describeAlarmsForMetricRequest
* @param 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.
* @return A Java Future containing the result of the DescribeAlarmsForMetric operation returned by the service.
* @sample AmazonCloudWatchAsyncHandler.DescribeAlarmsForMetric
* @see AWS API Documentation
*/
java.util.concurrent.Future describeAlarmsForMetricAsync(DescribeAlarmsForMetricRequest describeAlarmsForMetricRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not
* execute when the alarm state changes.
*
*
* @param disableAlarmActionsRequest
* @return A Java Future containing the result of the DisableAlarmActions operation returned by the service.
* @sample AmazonCloudWatchAsync.DisableAlarmActions
* @see AWS
* API Documentation
*/
java.util.concurrent.Future disableAlarmActionsAsync(DisableAlarmActionsRequest disableAlarmActionsRequest);
/**
*
* Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not
* execute when the alarm state changes.
*
*
* @param disableAlarmActionsRequest
* @param 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.
* @return A Java Future containing the result of the DisableAlarmActions operation returned by the service.
* @sample AmazonCloudWatchAsyncHandler.DisableAlarmActions
* @see AWS
* API Documentation
*/
java.util.concurrent.Future disableAlarmActionsAsync(DisableAlarmActionsRequest disableAlarmActionsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Enables the actions for the specified alarms.
*
*
* @param enableAlarmActionsRequest
* @return A Java Future containing the result of the EnableAlarmActions operation returned by the service.
* @sample AmazonCloudWatchAsync.EnableAlarmActions
* @see AWS
* API Documentation
*/
java.util.concurrent.Future enableAlarmActionsAsync(EnableAlarmActionsRequest enableAlarmActionsRequest);
/**
*
* Enables the actions for the specified alarms.
*
*
* @param enableAlarmActionsRequest
* @param 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.
* @return A Java Future containing the result of the EnableAlarmActions operation returned by the service.
* @sample AmazonCloudWatchAsyncHandler.EnableAlarmActions
* @see AWS
* API Documentation
*/
java.util.concurrent.Future enableAlarmActionsAsync(EnableAlarmActionsRequest enableAlarmActionsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Displays 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.
*
*
* @param getDashboardRequest
* @return A Java Future containing the result of the GetDashboard operation returned by the service.
* @sample AmazonCloudWatchAsync.GetDashboard
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getDashboardAsync(GetDashboardRequest getDashboardRequest);
/**
*
* Displays 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.
*
*
* @param getDashboardRequest
* @param 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.
* @return A Java Future containing the result of the GetDashboard operation returned by the service.
* @sample AmazonCloudWatchAsyncHandler.GetDashboard
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getDashboardAsync(GetDashboardRequest getDashboardRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* You can use the GetMetricData API to retrieve as many as 100 different metrics in a single request,
* with a total of as many as 100,800 datapoints. You can also optionally perform math expressions on the values of
* the returned statistics, to create new time series that represent new insights into your data. For example, using
* Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series.
* For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
*
*
* Calls to the GetMetricData API have a different pricing structure than calls to
* GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing.
*
*
* 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.
*
*
* @param getMetricDataRequest
* @return A Java Future containing the result of the GetMetricData operation returned by the service.
* @sample AmazonCloudWatchAsync.GetMetricData
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getMetricDataAsync(GetMetricDataRequest getMetricDataRequest);
/**
*
* You can use the GetMetricData API to retrieve as many as 100 different metrics in a single request,
* with a total of as many as 100,800 datapoints. You can also optionally perform math expressions on the values of
* the returned statistics, to create new time series that represent new insights into your data. For example, using
* Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series.
* For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
*
*
* Calls to the GetMetricData API have a different pricing structure than calls to
* GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing.
*
*
* 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.
*
*
* @param getMetricDataRequest
* @param 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.
* @return A Java Future containing the result of the GetMetricData operation returned by the service.
* @sample AmazonCloudWatchAsyncHandler.GetMetricData
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getMetricDataAsync(GetMetricDataRequest getMetricDataRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets 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.
*
*
*
*
* Percentile statistics are not available for metrics when any of the metric values are negative numbers.
*
*
* 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.
*
*
* @param getMetricStatisticsRequest
* @return A Java Future containing the result of the GetMetricStatistics operation returned by the service.
* @sample AmazonCloudWatchAsync.GetMetricStatistics
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getMetricStatisticsAsync(GetMetricStatisticsRequest getMetricStatisticsRequest);
/**
*
* Gets 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.
*
*
*
*
* Percentile statistics are not available for metrics when any of the metric values are negative numbers.
*
*
* 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.
*
*
* @param getMetricStatisticsRequest
* @param 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.
* @return A Java Future containing the result of the GetMetricStatistics operation returned by the service.
* @sample AmazonCloudWatchAsyncHandler.GetMetricStatistics
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getMetricStatisticsAsync(GetMetricStatisticsRequest getMetricStatisticsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon
* CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki
* pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your
* own custom live dashboard.
*
*
* The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and
* vertical annotations.
*
*
* There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has
* the following limits:
*
*
* -
*
* As many as 100 metrics in the graph.
*
*
* -
*
* Up to 100 KB uncompressed payload.
*
*
*
*
* @param getMetricWidgetImageRequest
* @return A Java Future containing the result of the GetMetricWidgetImage operation returned by the service.
* @sample AmazonCloudWatchAsync.GetMetricWidgetImage
* @see AWS API Documentation
*/
java.util.concurrent.Future getMetricWidgetImageAsync(GetMetricWidgetImageRequest getMetricWidgetImageRequest);
/**
*
* You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon
* CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki
* pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your
* own custom live dashboard.
*
*
* The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and
* vertical annotations.
*
*
* There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has
* the following limits:
*
*
* -
*
* As many as 100 metrics in the graph.
*
*
* -
*
* Up to 100 KB uncompressed payload.
*
*
*
*
* @param getMetricWidgetImageRequest
* @param 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.
* @return A Java Future containing the result of the GetMetricWidgetImage operation returned by the service.
* @sample AmazonCloudWatchAsyncHandler.GetMetricWidgetImage
* @see AWS API Documentation
*/
java.util.concurrent.Future getMetricWidgetImageAsync(GetMetricWidgetImageRequest getMetricWidgetImageRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you
* can call ListDashboards again and include the value you received for NextToken in the
* first call, to receive the next 1000 results.
*
*
* @param listDashboardsRequest
* @return A Java Future containing the result of the ListDashboards operation returned by the service.
* @sample AmazonCloudWatchAsync.ListDashboards
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listDashboardsAsync(ListDashboardsRequest listDashboardsRequest);
/**
*
* 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.
*
*
* ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you
* can call ListDashboards again and include the value you received for NextToken in the
* first call, to receive the next 1000 results.
*
*
* @param listDashboardsRequest
* @param 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.
* @return A Java Future containing the result of the ListDashboards operation returned by the service.
* @sample AmazonCloudWatchAsyncHandler.ListDashboards
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listDashboardsAsync(ListDashboardsRequest listDashboardsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* List the specified metrics. You can use the returned metrics with GetMetricData or
* 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 GetMetricData or GetMetricStatistics.
*
*
* @param listMetricsRequest
* @return A Java Future containing the result of the ListMetrics operation returned by the service.
* @sample AmazonCloudWatchAsync.ListMetrics
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listMetricsAsync(ListMetricsRequest listMetricsRequest);
/**
*
* List the specified metrics. You can use the returned metrics with GetMetricData or
* 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 GetMetricData or GetMetricStatistics.
*
*
* @param listMetricsRequest
* @param 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.
* @return A Java Future containing the result of the ListMetrics operation returned by the service.
* @sample AmazonCloudWatchAsyncHandler.ListMetrics
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listMetricsAsync(ListMetricsRequest listMetricsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the ListMetrics operation.
*
* @see #listMetricsAsync(ListMetricsRequest)
*/
java.util.concurrent.Future listMetricsAsync();
/**
* Simplified method form for invoking the ListMetrics operation with an AsyncHandler.
*
* @see #listMetricsAsync(ListMetricsRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future listMetricsAsync(com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates 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.
*
*
* There is no limit to the number of dashboards in your 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.
*
*
* @param putDashboardRequest
* @return A Java Future containing the result of the PutDashboard operation returned by the service.
* @sample AmazonCloudWatchAsync.PutDashboard
* @see AWS API
* Documentation
*/
java.util.concurrent.Future putDashboardAsync(PutDashboardRequest putDashboardRequest);
/**
*
* Creates 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.
*
*
* There is no limit to the number of dashboards in your 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.
*
*
* @param putDashboardRequest
* @param 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.
* @return A Java Future containing the result of the PutDashboard operation returned by the service.
* @sample AmazonCloudWatchAsyncHandler.PutDashboard
* @see AWS API
* Documentation
*/
java.util.concurrent.Future putDashboardAsync(PutDashboardRequest putDashboardRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates or updates an alarm and associates it with the specified metric or metric math expression.
*
*
* When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The
* alarm is then evaluated and its state is set appropriately. Any actions associated with the new 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 alarm operations:
*
*
* -
*
* iam:CreateServiceLinkedRole for all alarms with EC2 actions
*
*
* -
*
* 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.
*
*
* The first time you create an alarm in the AWS Management Console, the CLI, or by using the PutMetricAlarm API,
* CloudWatch creates the necessary service-linked role for you. The service-linked role is called
* AWSServiceRoleForCloudWatchEvents. For more information, see AWS service-linked role.
*
*
* @param putMetricAlarmRequest
* @return A Java Future containing the result of the PutMetricAlarm operation returned by the service.
* @sample AmazonCloudWatchAsync.PutMetricAlarm
* @see AWS API
* Documentation
*/
java.util.concurrent.Future putMetricAlarmAsync(PutMetricAlarmRequest putMetricAlarmRequest);
/**
*
* Creates or updates an alarm and associates it with the specified metric or metric math expression.
*
*
* When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The
* alarm is then evaluated and its state is set appropriately. Any actions associated with the new 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 alarm operations:
*
*
* -
*
* iam:CreateServiceLinkedRole for all alarms with EC2 actions
*
*
* -
*
* 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.
*
*
* The first time you create an alarm in the AWS Management Console, the CLI, or by using the PutMetricAlarm API,
* CloudWatch creates the necessary service-linked role for you. The service-linked role is called
* AWSServiceRoleForCloudWatchEvents. For more information, see AWS service-linked role.
*
*
* @param putMetricAlarmRequest
* @param 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.
* @return A Java Future containing the result of the PutMetricAlarm operation returned by the service.
* @sample AmazonCloudWatchAsyncHandler.PutMetricAlarm
* @see AWS API
* Documentation
*/
java.util.concurrent.Future putMetricAlarmAsync(PutMetricAlarmRequest putMetricAlarmRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Publishes 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.
*
*
* You can publish either individual data points in the Value field, or arrays of values and the number
* of times each value occurred during the period by using the Values and Counts fields in
* the MetricDatum structure. Using the Values and Counts method enables you
* to publish up to 150 values per metric with one PutMetricData request, and supports retrieving
* percentile statistics on this data.
*
*
* Each PutMetricData request is limited to 40 KB in size for HTTP POST requests. You can send a
* payload compressed by gzip. Each request is also limited to no more than 20 different metrics.
*
*
* 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
* GetMetricData or 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 and Min, Max, and
* Sum are all equal.
*
*
* -
*
* The Min and Max are equal, and Sum is equal to Min multiplied
* by SampleCount.
*
*
*
*
* @param putMetricDataRequest
* @return A Java Future containing the result of the PutMetricData operation returned by the service.
* @sample AmazonCloudWatchAsync.PutMetricData
* @see AWS API
* Documentation
*/
java.util.concurrent.Future putMetricDataAsync(PutMetricDataRequest putMetricDataRequest);
/**
*
* Publishes 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.
*
*
* You can publish either individual data points in the Value field, or arrays of values and the number
* of times each value occurred during the period by using the Values and Counts fields in
* the MetricDatum structure. Using the Values and Counts method enables you
* to publish up to 150 values per metric with one PutMetricData request, and supports retrieving
* percentile statistics on this data.
*
*
* Each PutMetricData request is limited to 40 KB in size for HTTP POST requests. You can send a
* payload compressed by gzip. Each request is also limited to no more than 20 different metrics.
*
*
* 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
* GetMetricData or 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 and Min, Max, and
* Sum are all equal.
*
*
* -
*
* The Min and Max are equal, and Sum is equal to Min multiplied
* by SampleCount.
*
*
*
*
* @param putMetricDataRequest
* @param 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.
* @return A Java Future containing the result of the PutMetricData operation returned by the service.
* @sample AmazonCloudWatchAsyncHandler.PutMetricData
* @see AWS API
* Documentation
*/
java.util.concurrent.Future putMetricDataAsync(PutMetricDataRequest putMetricDataRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param setAlarmStateRequest
* @return A Java Future containing the result of the SetAlarmState operation returned by the service.
* @sample AmazonCloudWatchAsync.SetAlarmState
* @see AWS API
* Documentation
*/
java.util.concurrent.Future setAlarmStateAsync(SetAlarmStateRequest setAlarmStateRequest);
/**
*
* 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.
*
*
* @param setAlarmStateRequest
* @param 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.
* @return A Java Future containing the result of the SetAlarmState operation returned by the service.
* @sample AmazonCloudWatchAsyncHandler.SetAlarmState
* @see AWS API
* Documentation
*/
java.util.concurrent.Future setAlarmStateAsync(SetAlarmStateRequest setAlarmStateRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}