@Generated(value="software.amazon.awssdk:codegen") public interface CloudWatchAsyncClient extends SdkClient, SdkAutoCloseable
builder()
method.
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.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static CloudWatchAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
CloudWatchAsyncClient . |
static CloudWatchAsyncClient |
create()
Create a
CloudWatchAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from
the DefaultCredentialsProvider . |
default CompletableFuture<DeleteAlarmsResponse> |
deleteAlarms(Consumer<DeleteAlarmsRequest.Builder> deleteAlarmsRequest)
Deletes the specified alarms.
|
default CompletableFuture<DeleteAlarmsResponse> |
deleteAlarms(DeleteAlarmsRequest deleteAlarmsRequest)
Deletes the specified alarms.
|
default CompletableFuture<DeleteDashboardsResponse> |
deleteDashboards(Consumer<DeleteDashboardsRequest.Builder> deleteDashboardsRequest)
Deletes all dashboards that you specify.
|
default CompletableFuture<DeleteDashboardsResponse> |
deleteDashboards(DeleteDashboardsRequest deleteDashboardsRequest)
Deletes all dashboards that you specify.
|
default CompletableFuture<DescribeAlarmHistoryResponse> |
describeAlarmHistory()
Retrieves the history for the specified alarm.
|
default CompletableFuture<DescribeAlarmHistoryResponse> |
describeAlarmHistory(Consumer<DescribeAlarmHistoryRequest.Builder> describeAlarmHistoryRequest)
Retrieves the history for the specified alarm.
|
default CompletableFuture<DescribeAlarmHistoryResponse> |
describeAlarmHistory(DescribeAlarmHistoryRequest describeAlarmHistoryRequest)
Retrieves the history for the specified alarm.
|
default DescribeAlarmHistoryPublisher |
describeAlarmHistoryPaginator()
Retrieves the history for the specified alarm.
|
default DescribeAlarmHistoryPublisher |
describeAlarmHistoryPaginator(DescribeAlarmHistoryRequest describeAlarmHistoryRequest)
Retrieves the history for the specified alarm.
|
default CompletableFuture<DescribeAlarmsResponse> |
describeAlarms()
Retrieves the specified alarms.
|
default CompletableFuture<DescribeAlarmsResponse> |
describeAlarms(Consumer<DescribeAlarmsRequest.Builder> describeAlarmsRequest)
Retrieves the specified alarms.
|
default CompletableFuture<DescribeAlarmsResponse> |
describeAlarms(DescribeAlarmsRequest describeAlarmsRequest)
Retrieves the specified alarms.
|
default CompletableFuture<DescribeAlarmsForMetricResponse> |
describeAlarmsForMetric(Consumer<DescribeAlarmsForMetricRequest.Builder> describeAlarmsForMetricRequest)
Retrieves the alarms for the specified metric.
|
default CompletableFuture<DescribeAlarmsForMetricResponse> |
describeAlarmsForMetric(DescribeAlarmsForMetricRequest describeAlarmsForMetricRequest)
Retrieves the alarms for the specified metric.
|
default DescribeAlarmsPublisher |
describeAlarmsPaginator()
Retrieves the specified alarms.
|
default DescribeAlarmsPublisher |
describeAlarmsPaginator(DescribeAlarmsRequest describeAlarmsRequest)
Retrieves the specified alarms.
|
default CompletableFuture<DisableAlarmActionsResponse> |
disableAlarmActions(Consumer<DisableAlarmActionsRequest.Builder> disableAlarmActionsRequest)
Disables the actions for the specified alarms.
|
default CompletableFuture<DisableAlarmActionsResponse> |
disableAlarmActions(DisableAlarmActionsRequest disableAlarmActionsRequest)
Disables the actions for the specified alarms.
|
default CompletableFuture<EnableAlarmActionsResponse> |
enableAlarmActions(Consumer<EnableAlarmActionsRequest.Builder> enableAlarmActionsRequest)
Enables the actions for the specified alarms.
|
default CompletableFuture<EnableAlarmActionsResponse> |
enableAlarmActions(EnableAlarmActionsRequest enableAlarmActionsRequest)
Enables the actions for the specified alarms.
|
default CompletableFuture<GetDashboardResponse> |
getDashboard(Consumer<GetDashboardRequest.Builder> getDashboardRequest)
Displays the details of the dashboard that you specify.
|
default CompletableFuture<GetDashboardResponse> |
getDashboard(GetDashboardRequest getDashboardRequest)
Displays the details of the dashboard that you specify.
|
default CompletableFuture<GetMetricStatisticsResponse> |
getMetricStatistics(Consumer<GetMetricStatisticsRequest.Builder> getMetricStatisticsRequest)
Gets statistics for the specified metric.
|
default CompletableFuture<GetMetricStatisticsResponse> |
getMetricStatistics(GetMetricStatisticsRequest getMetricStatisticsRequest)
Gets statistics for the specified metric.
|
default CompletableFuture<ListDashboardsResponse> |
listDashboards()
Returns a list of the dashboards for your account.
|
default CompletableFuture<ListDashboardsResponse> |
listDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)
Returns a list of the dashboards for your account.
|
default CompletableFuture<ListDashboardsResponse> |
listDashboards(ListDashboardsRequest listDashboardsRequest)
Returns a list of the dashboards for your account.
|
default CompletableFuture<ListMetricsResponse> |
listMetrics()
List the specified metrics.
|
default CompletableFuture<ListMetricsResponse> |
listMetrics(Consumer<ListMetricsRequest.Builder> listMetricsRequest)
List the specified metrics.
|
default CompletableFuture<ListMetricsResponse> |
listMetrics(ListMetricsRequest listMetricsRequest)
List the specified metrics.
|
default ListMetricsPublisher |
listMetricsPaginator()
List the specified metrics.
|
default ListMetricsPublisher |
listMetricsPaginator(ListMetricsRequest listMetricsRequest)
List the specified metrics.
|
default CompletableFuture<PutDashboardResponse> |
putDashboard(Consumer<PutDashboardRequest.Builder> putDashboardRequest)
Creates a dashboard if it does not already exist, or updates an existing dashboard.
|
default CompletableFuture<PutDashboardResponse> |
putDashboard(PutDashboardRequest putDashboardRequest)
Creates a dashboard if it does not already exist, or updates an existing dashboard.
|
default CompletableFuture<PutMetricAlarmResponse> |
putMetricAlarm(Consumer<PutMetricAlarmRequest.Builder> putMetricAlarmRequest)
Creates or updates an alarm and associates it with the specified metric.
|
default CompletableFuture<PutMetricAlarmResponse> |
putMetricAlarm(PutMetricAlarmRequest putMetricAlarmRequest)
Creates or updates an alarm and associates it with the specified metric.
|
default CompletableFuture<PutMetricDataResponse> |
putMetricData(Consumer<PutMetricDataRequest.Builder> putMetricDataRequest)
Publishes metric data points to Amazon CloudWatch.
|
default CompletableFuture<PutMetricDataResponse> |
putMetricData(PutMetricDataRequest putMetricDataRequest)
Publishes metric data points to Amazon CloudWatch.
|
default CompletableFuture<SetAlarmStateResponse> |
setAlarmState(Consumer<SetAlarmStateRequest.Builder> setAlarmStateRequest)
Temporarily sets the state of an alarm for testing purposes.
|
default CompletableFuture<SetAlarmStateResponse> |
setAlarmState(SetAlarmStateRequest setAlarmStateRequest)
Temporarily sets the state of an alarm for testing purposes.
|
serviceName
close
static final String SERVICE_NAME
static CloudWatchAsyncClient create()
CloudWatchAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from
the DefaultCredentialsProvider
.static CloudWatchAsyncClientBuilder builder()
CloudWatchAsyncClient
.default CompletableFuture<DeleteAlarmsResponse> deleteAlarms(DeleteAlarmsRequest deleteAlarmsRequest)
Deletes the specified alarms. In the event of an error, no alarms are deleted.
deleteAlarmsRequest
- default CompletableFuture<DeleteAlarmsResponse> deleteAlarms(Consumer<DeleteAlarmsRequest.Builder> deleteAlarmsRequest)
Deletes the specified alarms. In the event of an error, no alarms are deleted.
DeleteAlarmsRequest.Builder
avoiding the need to
create one manually via DeleteAlarmsRequest.builder()
deleteAlarmsRequest
- a Consumer
that will call methods on DeleteAlarmsInput.Builder
.default CompletableFuture<DeleteDashboardsResponse> deleteDashboards(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.
deleteDashboardsRequest
- default CompletableFuture<DeleteDashboardsResponse> deleteDashboards(Consumer<DeleteDashboardsRequest.Builder> 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.
DeleteDashboardsRequest.Builder
avoiding the need
to create one manually via DeleteDashboardsRequest.builder()
deleteDashboardsRequest
- a Consumer
that will call methods on DeleteDashboardsInput.Builder
.default CompletableFuture<DescribeAlarmHistoryResponse> describeAlarmHistory(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.
describeAlarmHistoryRequest
- default CompletableFuture<DescribeAlarmHistoryResponse> describeAlarmHistory()
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.
default CompletableFuture<DescribeAlarmHistoryResponse> describeAlarmHistory(Consumer<DescribeAlarmHistoryRequest.Builder> 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.
DescribeAlarmHistoryRequest.Builder
avoiding the
need to create one manually via DescribeAlarmHistoryRequest.builder()
describeAlarmHistoryRequest
- a Consumer
that will call methods on DescribeAlarmHistoryInput.Builder
.default DescribeAlarmHistoryPublisher describeAlarmHistoryPaginator(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.
This is a variant of
describeAlarmHistory(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmHistoryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmHistoryPublisher publisher = client.describeAlarmHistoryPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmHistoryPublisher publisher = client.describeAlarmHistoryPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmHistoryResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmHistoryResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeAlarmHistory(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmHistoryRequest)
operation.
describeAlarmHistoryRequest
- default DescribeAlarmHistoryPublisher describeAlarmHistoryPaginator()
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.
This is a variant of
describeAlarmHistory(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmHistoryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmHistoryPublisher publisher = client.describeAlarmHistoryPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmHistoryPublisher publisher = client.describeAlarmHistoryPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmHistoryResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmHistoryResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeAlarmHistory(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmHistoryRequest)
operation.
default CompletableFuture<DescribeAlarmsResponse> describeAlarms(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.
describeAlarmsRequest
- default CompletableFuture<DescribeAlarmsResponse> describeAlarms()
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.
default CompletableFuture<DescribeAlarmsResponse> describeAlarms(Consumer<DescribeAlarmsRequest.Builder> 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.
DescribeAlarmsRequest.Builder
avoiding the need to
create one manually via DescribeAlarmsRequest.builder()
describeAlarmsRequest
- a Consumer
that will call methods on DescribeAlarmsInput.Builder
.default CompletableFuture<DescribeAlarmsForMetricResponse> describeAlarmsForMetric(DescribeAlarmsForMetricRequest describeAlarmsForMetricRequest)
Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.
describeAlarmsForMetricRequest
- default CompletableFuture<DescribeAlarmsForMetricResponse> describeAlarmsForMetric(Consumer<DescribeAlarmsForMetricRequest.Builder> describeAlarmsForMetricRequest)
Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.
DescribeAlarmsForMetricRequest.Builder
avoiding
the need to create one manually via DescribeAlarmsForMetricRequest.builder()
describeAlarmsForMetricRequest
- a Consumer
that will call methods on DescribeAlarmsForMetricInput.Builder
.default DescribeAlarmsPublisher describeAlarmsPaginator(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.
This is a variant of
describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmsPublisher publisher = client.describeAlarmsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmsPublisher publisher = client.describeAlarmsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest)
operation.
describeAlarmsRequest
- default DescribeAlarmsPublisher describeAlarmsPaginator()
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.
This is a variant of
describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmsPublisher publisher = client.describeAlarmsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmsPublisher publisher = client.describeAlarmsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest)
operation.
default CompletableFuture<DisableAlarmActionsResponse> disableAlarmActions(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.
disableAlarmActionsRequest
- default CompletableFuture<DisableAlarmActionsResponse> disableAlarmActions(Consumer<DisableAlarmActionsRequest.Builder> 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.
DisableAlarmActionsRequest.Builder
avoiding the
need to create one manually via DisableAlarmActionsRequest.builder()
disableAlarmActionsRequest
- a Consumer
that will call methods on DisableAlarmActionsInput.Builder
.default CompletableFuture<EnableAlarmActionsResponse> enableAlarmActions(EnableAlarmActionsRequest enableAlarmActionsRequest)
Enables the actions for the specified alarms.
enableAlarmActionsRequest
- default CompletableFuture<EnableAlarmActionsResponse> enableAlarmActions(Consumer<EnableAlarmActionsRequest.Builder> enableAlarmActionsRequest)
Enables the actions for the specified alarms.
EnableAlarmActionsRequest.Builder
avoiding the
need to create one manually via EnableAlarmActionsRequest.builder()
enableAlarmActionsRequest
- a Consumer
that will call methods on EnableAlarmActionsInput.Builder
.default CompletableFuture<GetDashboardResponse> getDashboard(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.
getDashboardRequest
- default CompletableFuture<GetDashboardResponse> getDashboard(Consumer<GetDashboardRequest.Builder> 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.
GetDashboardRequest.Builder
avoiding the need to
create one manually via GetDashboardRequest.builder()
getDashboardRequest
- a Consumer
that will call methods on GetDashboardInput.Builder
.default CompletableFuture<GetMetricStatisticsResponse> getMetricStatistics(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.
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.
getMetricStatisticsRequest
- default CompletableFuture<GetMetricStatisticsResponse> getMetricStatistics(Consumer<GetMetricStatisticsRequest.Builder> 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.
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.
GetMetricStatisticsRequest.Builder
avoiding the
need to create one manually via GetMetricStatisticsRequest.builder()
getMetricStatisticsRequest
- a Consumer
that will call methods on GetMetricStatisticsInput.Builder
.default CompletableFuture<ListDashboardsResponse> listDashboards(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.
listDashboardsRequest
- default CompletableFuture<ListDashboardsResponse> listDashboards()
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.
default CompletableFuture<ListDashboardsResponse> listDashboards(Consumer<ListDashboardsRequest.Builder> 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.
ListDashboardsRequest.Builder
avoiding the need to
create one manually via ListDashboardsRequest.builder()
listDashboardsRequest
- a Consumer
that will call methods on ListDashboardsInput.Builder
.default CompletableFuture<ListMetricsResponse> listMetrics(ListMetricsRequest listMetricsRequest)
List 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.
listMetricsRequest
- default CompletableFuture<ListMetricsResponse> listMetrics()
List 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.
default CompletableFuture<ListMetricsResponse> listMetrics(Consumer<ListMetricsRequest.Builder> listMetricsRequest)
List 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.
ListMetricsRequest.Builder
avoiding the need to
create one manually via ListMetricsRequest.builder()
listMetricsRequest
- a Consumer
that will call methods on ListMetricsInput.Builder
.default ListMetricsPublisher listMetricsPaginator(ListMetricsRequest listMetricsRequest)
List 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.
This is a variant of listMetrics(software.amazon.awssdk.services.cloudwatch.model.ListMetricsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.cloudwatch.paginators.ListMetricsPublisher publisher = client.listMetricsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudwatch.paginators.ListMetricsPublisher publisher = client.listMetricsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatch.model.ListMetricsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudwatch.model.ListMetricsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listMetrics(software.amazon.awssdk.services.cloudwatch.model.ListMetricsRequest)
operation.
listMetricsRequest
- default ListMetricsPublisher listMetricsPaginator()
List 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.
This is a variant of listMetrics(software.amazon.awssdk.services.cloudwatch.model.ListMetricsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.cloudwatch.paginators.ListMetricsPublisher publisher = client.listMetricsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudwatch.paginators.ListMetricsPublisher publisher = client.listMetricsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatch.model.ListMetricsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudwatch.model.ListMetricsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listMetrics(software.amazon.awssdk.services.cloudwatch.model.ListMetricsRequest)
operation.
default CompletableFuture<PutDashboardResponse> putDashboard(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.
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.
putDashboardRequest
- default CompletableFuture<PutDashboardResponse> putDashboard(Consumer<PutDashboardRequest.Builder> 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.
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.
PutDashboardRequest.Builder
avoiding the need to
create one manually via PutDashboardRequest.builder()
putDashboardRequest
- a Consumer
that will call methods on PutDashboardInput.Builder
.default CompletableFuture<PutMetricAlarmResponse> putMetricAlarm(PutMetricAlarmRequest putMetricAlarmRequest)
Creates 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.
putMetricAlarmRequest
- default CompletableFuture<PutMetricAlarmResponse> putMetricAlarm(Consumer<PutMetricAlarmRequest.Builder> putMetricAlarmRequest)
Creates 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.
PutMetricAlarmRequest.Builder
avoiding the need to
create one manually via PutMetricAlarmRequest.builder()
putMetricAlarmRequest
- a Consumer
that will call methods on PutMetricAlarmInput.Builder
.default CompletableFuture<PutMetricDataResponse> putMetricData(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.
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
putMetricDataRequest
- default CompletableFuture<PutMetricDataResponse> putMetricData(Consumer<PutMetricDataRequest.Builder> 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.
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
PutMetricDataRequest.Builder
avoiding the need to
create one manually via PutMetricDataRequest.builder()
putMetricDataRequest
- a Consumer
that will call methods on PutMetricDataInput.Builder
.default CompletableFuture<SetAlarmStateResponse> setAlarmState(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.
setAlarmStateRequest
- default CompletableFuture<SetAlarmStateResponse> setAlarmState(Consumer<SetAlarmStateRequest.Builder> 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.
SetAlarmStateRequest.Builder
avoiding the need to
create one manually via SetAlarmStateRequest.builder()
setAlarmStateRequest
- a Consumer
that will call methods on SetAlarmStateInput.Builder
.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.