software.amazon.awssdk.services.cloudwatch.CloudWatchAsyncClient Maven / Gradle / Ivy
Show all versions of cloudwatch Show documentation
/*
* 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 software.amazon.awssdk.services.cloudwatch;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.services.cloudwatch.model.DeleteAlarmsRequest;
import software.amazon.awssdk.services.cloudwatch.model.DeleteAlarmsResponse;
import software.amazon.awssdk.services.cloudwatch.model.DeleteAnomalyDetectorRequest;
import software.amazon.awssdk.services.cloudwatch.model.DeleteAnomalyDetectorResponse;
import software.amazon.awssdk.services.cloudwatch.model.DeleteDashboardsRequest;
import software.amazon.awssdk.services.cloudwatch.model.DeleteDashboardsResponse;
import software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmHistoryRequest;
import software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmHistoryResponse;
import software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsForMetricRequest;
import software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsForMetricResponse;
import software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest;
import software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsResponse;
import software.amazon.awssdk.services.cloudwatch.model.DescribeAnomalyDetectorsRequest;
import software.amazon.awssdk.services.cloudwatch.model.DescribeAnomalyDetectorsResponse;
import software.amazon.awssdk.services.cloudwatch.model.DisableAlarmActionsRequest;
import software.amazon.awssdk.services.cloudwatch.model.DisableAlarmActionsResponse;
import software.amazon.awssdk.services.cloudwatch.model.EnableAlarmActionsRequest;
import software.amazon.awssdk.services.cloudwatch.model.EnableAlarmActionsResponse;
import software.amazon.awssdk.services.cloudwatch.model.GetDashboardRequest;
import software.amazon.awssdk.services.cloudwatch.model.GetDashboardResponse;
import software.amazon.awssdk.services.cloudwatch.model.GetMetricDataRequest;
import software.amazon.awssdk.services.cloudwatch.model.GetMetricDataResponse;
import software.amazon.awssdk.services.cloudwatch.model.GetMetricStatisticsRequest;
import software.amazon.awssdk.services.cloudwatch.model.GetMetricStatisticsResponse;
import software.amazon.awssdk.services.cloudwatch.model.GetMetricWidgetImageRequest;
import software.amazon.awssdk.services.cloudwatch.model.GetMetricWidgetImageResponse;
import software.amazon.awssdk.services.cloudwatch.model.ListDashboardsRequest;
import software.amazon.awssdk.services.cloudwatch.model.ListDashboardsResponse;
import software.amazon.awssdk.services.cloudwatch.model.ListMetricsRequest;
import software.amazon.awssdk.services.cloudwatch.model.ListMetricsResponse;
import software.amazon.awssdk.services.cloudwatch.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.cloudwatch.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.cloudwatch.model.PutAnomalyDetectorRequest;
import software.amazon.awssdk.services.cloudwatch.model.PutAnomalyDetectorResponse;
import software.amazon.awssdk.services.cloudwatch.model.PutDashboardRequest;
import software.amazon.awssdk.services.cloudwatch.model.PutDashboardResponse;
import software.amazon.awssdk.services.cloudwatch.model.PutMetricAlarmRequest;
import software.amazon.awssdk.services.cloudwatch.model.PutMetricAlarmResponse;
import software.amazon.awssdk.services.cloudwatch.model.PutMetricDataRequest;
import software.amazon.awssdk.services.cloudwatch.model.PutMetricDataResponse;
import software.amazon.awssdk.services.cloudwatch.model.SetAlarmStateRequest;
import software.amazon.awssdk.services.cloudwatch.model.SetAlarmStateResponse;
import software.amazon.awssdk.services.cloudwatch.model.TagResourceRequest;
import software.amazon.awssdk.services.cloudwatch.model.TagResourceResponse;
import software.amazon.awssdk.services.cloudwatch.model.UntagResourceRequest;
import software.amazon.awssdk.services.cloudwatch.model.UntagResourceResponse;
import software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmHistoryPublisher;
import software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmsPublisher;
import software.amazon.awssdk.services.cloudwatch.paginators.GetMetricDataPublisher;
import software.amazon.awssdk.services.cloudwatch.paginators.ListDashboardsPublisher;
import software.amazon.awssdk.services.cloudwatch.paginators.ListMetricsPublisher;
/**
* Service client for accessing CloudWatch asynchronously. This can be created using the static {@link #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.
*
*/
@Generated("software.amazon.awssdk:codegen")
public interface CloudWatchAsyncClient extends SdkClient {
String SERVICE_NAME = "monitoring";
/**
* Create a {@link CloudWatchAsyncClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static CloudWatchAsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link CloudWatchAsyncClient}.
*/
static CloudWatchAsyncClientBuilder builder() {
return new DefaultCloudWatchAsyncClientBuilder();
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The named resource does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.DeleteAlarms
* @see AWS API
* Documentation
*/
default CompletableFuture deleteAlarms(DeleteAlarmsRequest deleteAlarmsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified alarms. In the event of an error, no alarms are deleted.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteAlarmsRequest.Builder} avoiding the need to
* create one manually via {@link DeleteAlarmsRequest#builder()}
*
*
* @param deleteAlarmsRequest
* A {@link Consumer} that will call methods on {@link DeleteAlarmsInput.Builder} to create a request.
* @return A Java Future containing the result of the DeleteAlarms operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The named resource does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.DeleteAlarms
* @see AWS API
* Documentation
*/
default CompletableFuture deleteAlarms(Consumer deleteAlarmsRequest) {
return deleteAlarms(DeleteAlarmsRequest.builder().applyMutation(deleteAlarmsRequest).build());
}
/**
*
* Deletes the specified anomaly detection model from your account.
*
*
* @param deleteAnomalyDetectorRequest
* @return A Java Future containing the result of the DeleteAnomalyDetector operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The named resource does not exist.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - MissingRequiredParameterException An input parameter that is required is missing.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.DeleteAnomalyDetector
* @see AWS API Documentation
*/
default CompletableFuture deleteAnomalyDetector(
DeleteAnomalyDetectorRequest deleteAnomalyDetectorRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified anomaly detection model from your account.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteAnomalyDetectorRequest.Builder} avoiding the
* need to create one manually via {@link DeleteAnomalyDetectorRequest#builder()}
*
*
* @param deleteAnomalyDetectorRequest
* A {@link Consumer} that will call methods on {@link DeleteAnomalyDetectorInput.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteAnomalyDetector operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The named resource does not exist.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - MissingRequiredParameterException An input parameter that is required is missing.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.DeleteAnomalyDetector
* @see AWS API Documentation
*/
default CompletableFuture deleteAnomalyDetector(
Consumer deleteAnomalyDetectorRequest) {
return deleteAnomalyDetector(DeleteAnomalyDetectorRequest.builder().applyMutation(deleteAnomalyDetectorRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - DashboardNotFoundErrorException The specified dashboard does not exist.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.DeleteDashboards
* @see AWS
* API Documentation
*/
default CompletableFuture deleteDashboards(DeleteDashboardsRequest deleteDashboardsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteDashboardsRequest.Builder} avoiding the need
* to create one manually via {@link DeleteDashboardsRequest#builder()}
*
*
* @param deleteDashboardsRequest
* A {@link Consumer} that will call methods on {@link DeleteDashboardsInput.Builder} to create a request.
* @return A Java Future containing the result of the DeleteDashboards operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - DashboardNotFoundErrorException The specified dashboard does not exist.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.DeleteDashboards
* @see AWS
* API Documentation
*/
default CompletableFuture deleteDashboards(
Consumer deleteDashboardsRequest) {
return deleteDashboards(DeleteDashboardsRequest.builder().applyMutation(deleteDashboardsRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The next token specified is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.DescribeAlarmHistory
* @see AWS API Documentation
*/
default CompletableFuture describeAlarmHistory(
DescribeAlarmHistoryRequest describeAlarmHistoryRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 convenience which creates an instance of the {@link DescribeAlarmHistoryRequest.Builder} avoiding the
* need to create one manually via {@link DescribeAlarmHistoryRequest#builder()}
*
*
* @param describeAlarmHistoryRequest
* A {@link Consumer} that will call methods on {@link DescribeAlarmHistoryInput.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeAlarmHistory operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The next token specified is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.DescribeAlarmHistory
* @see AWS API Documentation
*/
default CompletableFuture describeAlarmHistory(
Consumer describeAlarmHistoryRequest) {
return describeAlarmHistory(DescribeAlarmHistoryRequest.builder().applyMutation(describeAlarmHistoryRequest).build());
}
/**
*
* 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.
*
*
* @return A Java Future containing the result of the DescribeAlarmHistory operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The next token specified is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.DescribeAlarmHistory
* @see AWS API Documentation
*/
default CompletableFuture describeAlarmHistory() {
return describeAlarmHistory(DescribeAlarmHistoryRequest.builder().build());
}
/**
*
* 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmHistoryPublisher publisher = client.describeAlarmHistoryPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmHistoryPublisher publisher = client.describeAlarmHistoryPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #describeAlarmHistory(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmHistoryRequest)}
* operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The next token specified is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.DescribeAlarmHistory
* @see AWS API Documentation
*/
default DescribeAlarmHistoryPublisher describeAlarmHistoryPaginator() {
return describeAlarmHistoryPaginator(DescribeAlarmHistoryRequest.builder().build());
}
/**
*
* 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmHistoryPublisher publisher = client.describeAlarmHistoryPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmHistoryPublisher publisher = client.describeAlarmHistoryPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #describeAlarmHistory(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmHistoryRequest)}
* operation.
*
*
* @param describeAlarmHistoryRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The next token specified is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.DescribeAlarmHistory
* @see AWS API Documentation
*/
default DescribeAlarmHistoryPublisher describeAlarmHistoryPaginator(DescribeAlarmHistoryRequest describeAlarmHistoryRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmHistoryPublisher publisher = client.describeAlarmHistoryPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmHistoryPublisher publisher = client.describeAlarmHistoryPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #describeAlarmHistory(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmHistoryRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeAlarmHistoryRequest.Builder} avoiding the
* need to create one manually via {@link DescribeAlarmHistoryRequest#builder()}
*
*
* @param describeAlarmHistoryRequest
* A {@link Consumer} that will call methods on {@link DescribeAlarmHistoryInput.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The next token specified is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.DescribeAlarmHistory
* @see AWS API Documentation
*/
default DescribeAlarmHistoryPublisher describeAlarmHistoryPaginator(
Consumer describeAlarmHistoryRequest) {
return describeAlarmHistoryPaginator(DescribeAlarmHistoryRequest.builder().applyMutation(describeAlarmHistoryRequest)
.build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The next token specified is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.DescribeAlarms
* @see AWS API
* Documentation
*/
default CompletableFuture describeAlarms(DescribeAlarmsRequest describeAlarmsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 convenience which creates an instance of the {@link DescribeAlarmsRequest.Builder} avoiding the need to
* create one manually via {@link DescribeAlarmsRequest#builder()}
*
*
* @param describeAlarmsRequest
* A {@link Consumer} that will call methods on {@link DescribeAlarmsInput.Builder} to create a request.
* @return A Java Future containing the result of the DescribeAlarms operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The next token specified is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.DescribeAlarms
* @see AWS API
* Documentation
*/
default CompletableFuture describeAlarms(Consumer describeAlarmsRequest) {
return describeAlarms(DescribeAlarmsRequest.builder().applyMutation(describeAlarmsRequest).build());
}
/**
*
* 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.
*
*
* @return A Java Future containing the result of the DescribeAlarms operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The next token specified is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.DescribeAlarms
* @see AWS API
* Documentation
*/
default CompletableFuture describeAlarms() {
return describeAlarms(DescribeAlarmsRequest.builder().build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.DescribeAlarmsForMetric
* @see AWS API Documentation
*/
default CompletableFuture describeAlarmsForMetric(
DescribeAlarmsForMetricRequest describeAlarmsForMetricRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeAlarmsForMetricRequest.Builder} avoiding
* the need to create one manually via {@link DescribeAlarmsForMetricRequest#builder()}
*
*
* @param describeAlarmsForMetricRequest
* A {@link Consumer} that will call methods on {@link DescribeAlarmsForMetricInput.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeAlarmsForMetric operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.DescribeAlarmsForMetric
* @see AWS API Documentation
*/
default CompletableFuture describeAlarmsForMetric(
Consumer describeAlarmsForMetricRequest) {
return describeAlarmsForMetric(DescribeAlarmsForMetricRequest.builder().applyMutation(describeAlarmsForMetricRequest)
.build());
}
/**
*
* 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmsPublisher publisher = client.describeAlarmsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmsPublisher publisher = client.describeAlarmsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest)} operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The next token specified is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.DescribeAlarms
* @see AWS API
* Documentation
*/
default DescribeAlarmsPublisher describeAlarmsPaginator() {
return describeAlarmsPaginator(DescribeAlarmsRequest.builder().build());
}
/**
*
* 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmsPublisher publisher = client.describeAlarmsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmsPublisher publisher = client.describeAlarmsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest)} operation.
*
*
* @param describeAlarmsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The next token specified is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.DescribeAlarms
* @see AWS API
* Documentation
*/
default DescribeAlarmsPublisher describeAlarmsPaginator(DescribeAlarmsRequest describeAlarmsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmsPublisher publisher = client.describeAlarmsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmsPublisher publisher = client.describeAlarmsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeAlarmsRequest.Builder} avoiding the need to
* create one manually via {@link DescribeAlarmsRequest#builder()}
*
*
* @param describeAlarmsRequest
* A {@link Consumer} that will call methods on {@link DescribeAlarmsInput.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The next token specified is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.DescribeAlarms
* @see AWS API
* Documentation
*/
default DescribeAlarmsPublisher describeAlarmsPaginator(Consumer describeAlarmsRequest) {
return describeAlarmsPaginator(DescribeAlarmsRequest.builder().applyMutation(describeAlarmsRequest).build());
}
/**
*
* Lists the anomaly detection models that you have created in your account. You can list all models in your account
* or filter the results to only the models that are related to a certain namespace, metric name, or metric
* dimension.
*
*
* @param describeAnomalyDetectorsRequest
* @return A Java Future containing the result of the DescribeAnomalyDetectors operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The next token specified is invalid.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.DescribeAnomalyDetectors
* @see AWS API Documentation
*/
default CompletableFuture describeAnomalyDetectors(
DescribeAnomalyDetectorsRequest describeAnomalyDetectorsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the anomaly detection models that you have created in your account. You can list all models in your account
* or filter the results to only the models that are related to a certain namespace, metric name, or metric
* dimension.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeAnomalyDetectorsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeAnomalyDetectorsRequest#builder()}
*
*
* @param describeAnomalyDetectorsRequest
* A {@link Consumer} that will call methods on {@link DescribeAnomalyDetectorsInput.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeAnomalyDetectors operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The next token specified is invalid.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.DescribeAnomalyDetectors
* @see AWS API Documentation
*/
default CompletableFuture describeAnomalyDetectors(
Consumer describeAnomalyDetectorsRequest) {
return describeAnomalyDetectors(DescribeAnomalyDetectorsRequest.builder().applyMutation(describeAnomalyDetectorsRequest)
.build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.DisableAlarmActions
* @see AWS
* API Documentation
*/
default CompletableFuture disableAlarmActions(
DisableAlarmActionsRequest disableAlarmActionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link DisableAlarmActionsRequest.Builder} avoiding the
* need to create one manually via {@link DisableAlarmActionsRequest#builder()}
*
*
* @param disableAlarmActionsRequest
* A {@link Consumer} that will call methods on {@link DisableAlarmActionsInput.Builder} to create a request.
* @return A Java Future containing the result of the DisableAlarmActions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.DisableAlarmActions
* @see AWS
* API Documentation
*/
default CompletableFuture disableAlarmActions(
Consumer disableAlarmActionsRequest) {
return disableAlarmActions(DisableAlarmActionsRequest.builder().applyMutation(disableAlarmActionsRequest).build());
}
/**
*
* Enables the actions for the specified alarms.
*
*
* @param enableAlarmActionsRequest
* @return A Java Future containing the result of the EnableAlarmActions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.EnableAlarmActions
* @see AWS
* API Documentation
*/
default CompletableFuture enableAlarmActions(EnableAlarmActionsRequest enableAlarmActionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Enables the actions for the specified alarms.
*
*
*
* This is a convenience which creates an instance of the {@link EnableAlarmActionsRequest.Builder} avoiding the
* need to create one manually via {@link EnableAlarmActionsRequest#builder()}
*
*
* @param enableAlarmActionsRequest
* A {@link Consumer} that will call methods on {@link EnableAlarmActionsInput.Builder} to create a request.
* @return A Java Future containing the result of the EnableAlarmActions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.EnableAlarmActions
* @see AWS
* API Documentation
*/
default CompletableFuture enableAlarmActions(
Consumer enableAlarmActionsRequest) {
return enableAlarmActions(EnableAlarmActionsRequest.builder().applyMutation(enableAlarmActionsRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - DashboardNotFoundErrorException The specified dashboard does not exist.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.GetDashboard
* @see AWS API
* Documentation
*/
default CompletableFuture getDashboard(GetDashboardRequest getDashboardRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link GetDashboardRequest.Builder} avoiding the need to
* create one manually via {@link GetDashboardRequest#builder()}
*
*
* @param getDashboardRequest
* A {@link Consumer} that will call methods on {@link GetDashboardInput.Builder} to create a request.
* @return A Java Future containing the result of the GetDashboard operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - DashboardNotFoundErrorException The specified dashboard does not exist.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.GetDashboard
* @see AWS API
* Documentation
*/
default CompletableFuture getDashboard(Consumer getDashboardRequest) {
return getDashboard(GetDashboardRequest.builder().applyMutation(getDashboardRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The next token specified is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.GetMetricData
* @see AWS API
* Documentation
*/
default CompletableFuture getMetricData(GetMetricDataRequest getMetricDataRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link GetMetricDataRequest.Builder} avoiding the need to
* create one manually via {@link GetMetricDataRequest#builder()}
*
*
* @param getMetricDataRequest
* A {@link Consumer} that will call methods on {@link GetMetricDataInput.Builder} to create a request.
* @return A Java Future containing the result of the GetMetricData operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The next token specified is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.GetMetricData
* @see AWS API
* Documentation
*/
default CompletableFuture getMetricData(Consumer getMetricDataRequest) {
return getMetricData(GetMetricDataRequest.builder().applyMutation(getMetricDataRequest).build());
}
/**
*
* 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.
*
*
*
* This is a variant of
* {@link #getMetricData(software.amazon.awssdk.services.cloudwatch.model.GetMetricDataRequest)} 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.GetMetricDataPublisher publisher = client.getMetricDataPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.GetMetricDataPublisher publisher = client.getMetricDataPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatch.model.GetMetricDataResponse 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
* {@link #getMetricData(software.amazon.awssdk.services.cloudwatch.model.GetMetricDataRequest)} operation.
*
*
* @param getMetricDataRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The next token specified is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.GetMetricData
* @see AWS API
* Documentation
*/
default GetMetricDataPublisher getMetricDataPaginator(GetMetricDataRequest getMetricDataRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a variant of
* {@link #getMetricData(software.amazon.awssdk.services.cloudwatch.model.GetMetricDataRequest)} 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.GetMetricDataPublisher publisher = client.getMetricDataPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.GetMetricDataPublisher publisher = client.getMetricDataPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatch.model.GetMetricDataResponse 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
* {@link #getMetricData(software.amazon.awssdk.services.cloudwatch.model.GetMetricDataRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link GetMetricDataRequest.Builder} avoiding the need to
* create one manually via {@link GetMetricDataRequest#builder()}
*
*
* @param getMetricDataRequest
* A {@link Consumer} that will call methods on {@link GetMetricDataInput.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The next token specified is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.GetMetricData
* @see AWS API
* Documentation
*/
default GetMetricDataPublisher getMetricDataPaginator(Consumer getMetricDataRequest) {
return getMetricDataPaginator(GetMetricDataRequest.builder().applyMutation(getMetricDataRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - MissingRequiredParameterException An input parameter that is required is missing.
* - InvalidParameterCombinationException Parameters were used together that cannot be used together.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.GetMetricStatistics
* @see AWS
* API Documentation
*/
default CompletableFuture getMetricStatistics(
GetMetricStatisticsRequest getMetricStatisticsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link GetMetricStatisticsRequest.Builder} avoiding the
* need to create one manually via {@link GetMetricStatisticsRequest#builder()}
*
*
* @param getMetricStatisticsRequest
* A {@link Consumer} that will call methods on {@link GetMetricStatisticsInput.Builder} to create a request.
* @return A Java Future containing the result of the GetMetricStatistics operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - MissingRequiredParameterException An input parameter that is required is missing.
* - InvalidParameterCombinationException Parameters were used together that cannot be used together.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.GetMetricStatistics
* @see AWS
* API Documentation
*/
default CompletableFuture getMetricStatistics(
Consumer getMetricStatisticsRequest) {
return getMetricStatistics(GetMetricStatisticsRequest.builder().applyMutation(getMetricStatisticsRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.GetMetricWidgetImage
* @see AWS API Documentation
*/
default CompletableFuture getMetricWidgetImage(
GetMetricWidgetImageRequest getMetricWidgetImageRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetMetricWidgetImageRequest.Builder} avoiding the
* need to create one manually via {@link GetMetricWidgetImageRequest#builder()}
*
*
* @param getMetricWidgetImageRequest
* A {@link Consumer} that will call methods on {@link GetMetricWidgetImageInput.Builder} to create a
* request.
* @return A Java Future containing the result of the GetMetricWidgetImage operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.GetMetricWidgetImage
* @see AWS API Documentation
*/
default CompletableFuture getMetricWidgetImage(
Consumer getMetricWidgetImageRequest) {
return getMetricWidgetImage(GetMetricWidgetImageRequest.builder().applyMutation(getMetricWidgetImageRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.ListDashboards
* @see AWS API
* Documentation
*/
default CompletableFuture listDashboards(ListDashboardsRequest listDashboardsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link ListDashboardsRequest.Builder} avoiding the need to
* create one manually via {@link ListDashboardsRequest#builder()}
*
*
* @param listDashboardsRequest
* A {@link Consumer} that will call methods on {@link ListDashboardsInput.Builder} to create a request.
* @return A Java Future containing the result of the ListDashboards operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.ListDashboards
* @see AWS API
* Documentation
*/
default CompletableFuture listDashboards(Consumer listDashboardsRequest) {
return listDashboards(ListDashboardsRequest.builder().applyMutation(listDashboardsRequest).build());
}
/**
*
* 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.
*
*
* @return A Java Future containing the result of the ListDashboards operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.ListDashboards
* @see AWS API
* Documentation
*/
default CompletableFuture listDashboards() {
return listDashboards(ListDashboardsRequest.builder().build());
}
/**
*
* 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.
*
*
*
* This is a variant of
* {@link #listDashboards(software.amazon.awssdk.services.cloudwatch.model.ListDashboardsRequest)} 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.ListDashboardsPublisher publisher = client.listDashboardsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.ListDashboardsPublisher publisher = client.listDashboardsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatch.model.ListDashboardsResponse 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
* {@link #listDashboards(software.amazon.awssdk.services.cloudwatch.model.ListDashboardsRequest)} operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.ListDashboards
* @see AWS API
* Documentation
*/
default ListDashboardsPublisher listDashboardsPaginator() {
return listDashboardsPaginator(ListDashboardsRequest.builder().build());
}
/**
*
* 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.
*
*
*
* This is a variant of
* {@link #listDashboards(software.amazon.awssdk.services.cloudwatch.model.ListDashboardsRequest)} 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.ListDashboardsPublisher publisher = client.listDashboardsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.ListDashboardsPublisher publisher = client.listDashboardsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatch.model.ListDashboardsResponse 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
* {@link #listDashboards(software.amazon.awssdk.services.cloudwatch.model.ListDashboardsRequest)} operation.
*
*
* @param listDashboardsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.ListDashboards
* @see AWS API
* Documentation
*/
default ListDashboardsPublisher listDashboardsPaginator(ListDashboardsRequest listDashboardsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a variant of
* {@link #listDashboards(software.amazon.awssdk.services.cloudwatch.model.ListDashboardsRequest)} 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.ListDashboardsPublisher publisher = client.listDashboardsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.ListDashboardsPublisher publisher = client.listDashboardsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatch.model.ListDashboardsResponse 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
* {@link #listDashboards(software.amazon.awssdk.services.cloudwatch.model.ListDashboardsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListDashboardsRequest.Builder} avoiding the need to
* create one manually via {@link ListDashboardsRequest#builder()}
*
*
* @param listDashboardsRequest
* A {@link Consumer} that will call methods on {@link ListDashboardsInput.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.ListDashboards
* @see AWS API
* Documentation
*/
default ListDashboardsPublisher listDashboardsPaginator(Consumer listDashboardsRequest) {
return listDashboardsPaginator(ListDashboardsRequest.builder().applyMutation(listDashboardsRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.ListMetrics
* @see AWS API
* Documentation
*/
default CompletableFuture listMetrics(ListMetricsRequest listMetricsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link ListMetricsRequest.Builder} avoiding the need to
* create one manually via {@link ListMetricsRequest#builder()}
*
*
* @param listMetricsRequest
* A {@link Consumer} that will call methods on {@link ListMetricsInput.Builder} to create a request.
* @return A Java Future containing the result of the ListMetrics operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.ListMetrics
* @see AWS API
* Documentation
*/
default CompletableFuture listMetrics(Consumer listMetricsRequest) {
return listMetrics(ListMetricsRequest.builder().applyMutation(listMetricsRequest).build());
}
/**
*
* 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.
*
*
* @return A Java Future containing the result of the ListMetrics operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.ListMetrics
* @see AWS API
* Documentation
*/
default CompletableFuture listMetrics() {
return listMetrics(ListMetricsRequest.builder().build());
}
/**
*
* 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.
*
*
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.ListMetricsPublisher publisher = client.listMetricsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.ListMetricsPublisher publisher = client.listMetricsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listMetrics(software.amazon.awssdk.services.cloudwatch.model.ListMetricsRequest)} operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.ListMetrics
* @see AWS API
* Documentation
*/
default ListMetricsPublisher listMetricsPaginator() {
return listMetricsPaginator(ListMetricsRequest.builder().build());
}
/**
*
* 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.
*
*
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.ListMetricsPublisher publisher = client.listMetricsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.ListMetricsPublisher publisher = client.listMetricsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listMetrics(software.amazon.awssdk.services.cloudwatch.model.ListMetricsRequest)} operation.
*
*
* @param listMetricsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.ListMetrics
* @see AWS API
* Documentation
*/
default ListMetricsPublisher listMetricsPaginator(ListMetricsRequest listMetricsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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 subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.ListMetricsPublisher publisher = client.listMetricsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.ListMetricsPublisher publisher = client.listMetricsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listMetrics(software.amazon.awssdk.services.cloudwatch.model.ListMetricsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListMetricsRequest.Builder} avoiding the need to
* create one manually via {@link ListMetricsRequest#builder()}
*
*
* @param listMetricsRequest
* A {@link Consumer} that will call methods on {@link ListMetricsInput.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.ListMetrics
* @see AWS API
* Documentation
*/
default ListMetricsPublisher listMetricsPaginator(Consumer listMetricsRequest) {
return listMetricsPaginator(ListMetricsRequest.builder().applyMutation(listMetricsRequest).build());
}
/**
*
* Displays the tags associated with a CloudWatch resource. Alarms support tagging.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - ResourceNotFoundException The named resource does not exist.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.ListTagsForResource
* @see AWS
* API Documentation
*/
default CompletableFuture listTagsForResource(
ListTagsForResourceRequest listTagsForResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Displays the tags associated with a CloudWatch resource. Alarms support tagging.
*
*
*
* This is a convenience which creates an instance of the {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on {@link ListTagsForResourceInput.Builder} to create a request.
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - ResourceNotFoundException The named resource does not exist.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.ListTagsForResource
* @see AWS
* API Documentation
*/
default CompletableFuture listTagsForResource(
Consumer listTagsForResourceRequest) {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* Creates an anomaly detection model for a CloudWatch metric. You can use the model to display a band of expected
* normal values when the metric is graphed.
*
*
* For more information, see CloudWatch Anomaly Detection.
*
*
* @param putAnomalyDetectorRequest
* @return A Java Future containing the result of the PutAnomalyDetector operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - LimitExceededException The operation exceeded one or more limits.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - MissingRequiredParameterException An input parameter that is required is missing.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.PutAnomalyDetector
* @see AWS
* API Documentation
*/
default CompletableFuture putAnomalyDetector(PutAnomalyDetectorRequest putAnomalyDetectorRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates an anomaly detection model for a CloudWatch metric. You can use the model to display a band of expected
* normal values when the metric is graphed.
*
*
* For more information, see CloudWatch Anomaly Detection.
*
*
*
* This is a convenience which creates an instance of the {@link PutAnomalyDetectorRequest.Builder} avoiding the
* need to create one manually via {@link PutAnomalyDetectorRequest#builder()}
*
*
* @param putAnomalyDetectorRequest
* A {@link Consumer} that will call methods on {@link PutAnomalyDetectorInput.Builder} to create a request.
* @return A Java Future containing the result of the PutAnomalyDetector operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - LimitExceededException The operation exceeded one or more limits.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - MissingRequiredParameterException An input parameter that is required is missing.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.PutAnomalyDetector
* @see AWS
* API Documentation
*/
default CompletableFuture putAnomalyDetector(
Consumer putAnomalyDetectorRequest) {
return putAnomalyDetector(PutAnomalyDetectorRequest.builder().applyMutation(putAnomalyDetectorRequest).build());
}
/**
*
* 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.
*
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - DashboardInvalidInputErrorException Some part of the dashboard data is invalid.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.PutDashboard
* @see AWS API
* Documentation
*/
default CompletableFuture putDashboard(PutDashboardRequest putDashboardRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link PutDashboardRequest.Builder} avoiding the need to
* create one manually via {@link PutDashboardRequest#builder()}
*
*
* @param putDashboardRequest
* A {@link Consumer} that will call methods on {@link PutDashboardInput.Builder} to create a request.
* @return A Java Future containing the result of the PutDashboard operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - DashboardInvalidInputErrorException Some part of the dashboard data is invalid.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.PutDashboard
* @see AWS API
* Documentation
*/
default CompletableFuture putDashboard(Consumer putDashboardRequest) {
return putDashboard(PutDashboardRequest.builder().applyMutation(putDashboardRequest).build());
}
/**
*
* Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly
* detection model.
*
*
* Alarms based on anomaly detection models cannot have Auto Scaling actions.
*
*
* 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
*
*
* -
*
* No specific permissions are needed 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - LimitExceededException The quota for alarms for this customer has already been reached.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.PutMetricAlarm
* @see AWS API
* Documentation
*/
default CompletableFuture putMetricAlarm(PutMetricAlarmRequest putMetricAlarmRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly
* detection model.
*
*
* Alarms based on anomaly detection models cannot have Auto Scaling actions.
*
*
* 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
*
*
* -
*
* No specific permissions are needed 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.
*
*
*
* This is a convenience which creates an instance of the {@link PutMetricAlarmRequest.Builder} avoiding the need to
* create one manually via {@link PutMetricAlarmRequest#builder()}
*
*
* @param putMetricAlarmRequest
* A {@link Consumer} that will call methods on {@link PutMetricAlarmInput.Builder} to create a request.
* @return A Java Future containing the result of the PutMetricAlarm operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - LimitExceededException The quota for alarms for this customer has already been reached.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.PutMetricAlarm
* @see AWS API
* Documentation
*/
default CompletableFuture putMetricAlarm(Consumer putMetricAlarmRequest) {
return putMetricAlarm(PutMetricAlarmRequest.builder().applyMutation(putMetricAlarmRequest).build());
}
/**
*
* 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. Each dimension
* consists of a Name and Value pair. 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - MissingRequiredParameterException An input parameter that is required is missing.
* - InvalidParameterCombinationException Parameters were used together that cannot be used together.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.PutMetricData
* @see AWS API
* Documentation
*/
default CompletableFuture putMetricData(PutMetricDataRequest putMetricDataRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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. Each dimension
* consists of a Name and Value pair. 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.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link PutMetricDataRequest.Builder} avoiding the need to
* create one manually via {@link PutMetricDataRequest#builder()}
*
*
* @param putMetricDataRequest
* A {@link Consumer} that will call methods on {@link PutMetricDataInput.Builder} to create a request.
* @return A Java Future containing the result of the PutMetricData operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - MissingRequiredParameterException An input parameter that is required is missing.
* - InvalidParameterCombinationException Parameters were used together that cannot be used together.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.PutMetricData
* @see AWS API
* Documentation
*/
default CompletableFuture putMetricData(Consumer putMetricDataRequest) {
return putMetricData(PutMetricDataRequest.builder().applyMutation(putMetricDataRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The named resource does not exist.
* - InvalidFormatException Data was not syntactically valid JSON.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.SetAlarmState
* @see AWS API
* Documentation
*/
default CompletableFuture setAlarmState(SetAlarmStateRequest setAlarmStateRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link SetAlarmStateRequest.Builder} avoiding the need to
* create one manually via {@link SetAlarmStateRequest#builder()}
*
*
* @param setAlarmStateRequest
* A {@link Consumer} that will call methods on {@link SetAlarmStateInput.Builder} to create a request.
* @return A Java Future containing the result of the SetAlarmState operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The named resource does not exist.
* - InvalidFormatException Data was not syntactically valid JSON.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.SetAlarmState
* @see AWS API
* Documentation
*/
default CompletableFuture setAlarmState(Consumer setAlarmStateRequest) {
return setAlarmState(SetAlarmStateRequest.builder().applyMutation(setAlarmStateRequest).build());
}
/**
*
* Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Tags can help you organize and
* categorize your resources. You can also use them to scope user permissions, by granting a user permission to
* access or change only resources with certain tag values. In CloudWatch, alarms can be tagged.
*
*
* Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
*
*
* You can use the TagResource action with a resource that already has tags. If you specify a new tag
* key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag
* key that is already associated with the resource, the new tag value that you specify replaces the previous value
* for that tag.
*
*
* You can associate as many as 50 tags with a resource.
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - ResourceNotFoundException The named resource does not exist.
* - ConcurrentModificationException More than one process tried to modify a resource at the same time.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.TagResource
* @see AWS API
* Documentation
*/
default CompletableFuture tagResource(TagResourceRequest tagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Tags can help you organize and
* categorize your resources. You can also use them to scope user permissions, by granting a user permission to
* access or change only resources with certain tag values. In CloudWatch, alarms can be tagged.
*
*
* Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
*
*
* You can use the TagResource action with a resource that already has tags. If you specify a new tag
* key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag
* key that is already associated with the resource, the new tag value that you specify replaces the previous value
* for that tag.
*
*
* You can associate as many as 50 tags with a resource.
*
*
*
* This is a convenience which creates an instance of the {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on {@link TagResourceInput.Builder} to create a request.
* @return A Java Future containing the result of the TagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - ResourceNotFoundException The named resource does not exist.
* - ConcurrentModificationException More than one process tried to modify a resource at the same time.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.TagResource
* @see AWS API
* Documentation
*/
default CompletableFuture tagResource(Consumer tagResourceRequest) {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* Removes one or more tags from the specified resource.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - ResourceNotFoundException The named resource does not exist.
* - ConcurrentModificationException More than one process tried to modify a resource at the same time.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.UntagResource
* @see AWS API
* Documentation
*/
default CompletableFuture untagResource(UntagResourceRequest untagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Removes one or more tags from the specified resource.
*
*
*
* This is a convenience which creates an instance of the {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on {@link UntagResourceInput.Builder} to create a request.
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - ResourceNotFoundException The named resource does not exist.
* - ConcurrentModificationException More than one process tried to modify a resource at the same time.
* - InternalServiceException Request processing has failed due to some unknown error, exception, or
* failure.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample CloudWatchAsyncClient.UntagResource
* @see AWS API
* Documentation
*/
default CompletableFuture untagResource(Consumer untagResourceRequest) {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
}