software.amazon.awssdk.services.cloudwatch.CloudWatchAsyncClient Maven / Gradle / Ivy
Show all versions of cloudwatch Show documentation
/*
* Copyright 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.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
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.DeleteInsightRulesRequest;
import software.amazon.awssdk.services.cloudwatch.model.DeleteInsightRulesResponse;
import software.amazon.awssdk.services.cloudwatch.model.DeleteMetricStreamRequest;
import software.amazon.awssdk.services.cloudwatch.model.DeleteMetricStreamResponse;
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.DescribeInsightRulesRequest;
import software.amazon.awssdk.services.cloudwatch.model.DescribeInsightRulesResponse;
import software.amazon.awssdk.services.cloudwatch.model.DisableAlarmActionsRequest;
import software.amazon.awssdk.services.cloudwatch.model.DisableAlarmActionsResponse;
import software.amazon.awssdk.services.cloudwatch.model.DisableInsightRulesRequest;
import software.amazon.awssdk.services.cloudwatch.model.DisableInsightRulesResponse;
import software.amazon.awssdk.services.cloudwatch.model.EnableAlarmActionsRequest;
import software.amazon.awssdk.services.cloudwatch.model.EnableAlarmActionsResponse;
import software.amazon.awssdk.services.cloudwatch.model.EnableInsightRulesRequest;
import software.amazon.awssdk.services.cloudwatch.model.EnableInsightRulesResponse;
import software.amazon.awssdk.services.cloudwatch.model.GetDashboardRequest;
import software.amazon.awssdk.services.cloudwatch.model.GetDashboardResponse;
import software.amazon.awssdk.services.cloudwatch.model.GetInsightRuleReportRequest;
import software.amazon.awssdk.services.cloudwatch.model.GetInsightRuleReportResponse;
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.GetMetricStreamRequest;
import software.amazon.awssdk.services.cloudwatch.model.GetMetricStreamResponse;
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.ListManagedInsightRulesRequest;
import software.amazon.awssdk.services.cloudwatch.model.ListManagedInsightRulesResponse;
import software.amazon.awssdk.services.cloudwatch.model.ListMetricStreamsRequest;
import software.amazon.awssdk.services.cloudwatch.model.ListMetricStreamsResponse;
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.PutCompositeAlarmRequest;
import software.amazon.awssdk.services.cloudwatch.model.PutCompositeAlarmResponse;
import software.amazon.awssdk.services.cloudwatch.model.PutDashboardRequest;
import software.amazon.awssdk.services.cloudwatch.model.PutDashboardResponse;
import software.amazon.awssdk.services.cloudwatch.model.PutInsightRuleRequest;
import software.amazon.awssdk.services.cloudwatch.model.PutInsightRuleResponse;
import software.amazon.awssdk.services.cloudwatch.model.PutManagedInsightRulesRequest;
import software.amazon.awssdk.services.cloudwatch.model.PutManagedInsightRulesResponse;
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.PutMetricStreamRequest;
import software.amazon.awssdk.services.cloudwatch.model.PutMetricStreamResponse;
import software.amazon.awssdk.services.cloudwatch.model.SetAlarmStateRequest;
import software.amazon.awssdk.services.cloudwatch.model.SetAlarmStateResponse;
import software.amazon.awssdk.services.cloudwatch.model.StartMetricStreamsRequest;
import software.amazon.awssdk.services.cloudwatch.model.StartMetricStreamsResponse;
import software.amazon.awssdk.services.cloudwatch.model.StopMetricStreamsRequest;
import software.amazon.awssdk.services.cloudwatch.model.StopMetricStreamsResponse;
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.DescribeAnomalyDetectorsPublisher;
import software.amazon.awssdk.services.cloudwatch.paginators.DescribeInsightRulesPublisher;
import software.amazon.awssdk.services.cloudwatch.paginators.GetMetricDataPublisher;
import software.amazon.awssdk.services.cloudwatch.paginators.ListDashboardsPublisher;
import software.amazon.awssdk.services.cloudwatch.paginators.ListManagedInsightRulesPublisher;
import software.amazon.awssdk.services.cloudwatch.paginators.ListMetricStreamsPublisher;
import software.amazon.awssdk.services.cloudwatch.paginators.ListMetricsPublisher;
import software.amazon.awssdk.services.cloudwatch.waiters.CloudWatchAsyncWaiter;
/**
* Service client for accessing CloudWatch asynchronously. This can be created using the static {@link #builder()}
* method.The asynchronous client performs non-blocking I/O when configured with any {@code SdkAsyncHttpClient}
* supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
* some cases such as credentials retrieval and endpoint discovery as part of the async API call.
*
*
* Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the applications you run on
* Amazon Web Services 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 Amazon Web Services, 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")
@SdkPublicApi
@ThreadSafe
public interface CloudWatchAsyncClient extends AwsClient {
String SERVICE_NAME = "monitoring";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "monitoring";
/**
*
* Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include
* no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with
* one operation, but you can't delete two composite alarms with one operation.
*
*
* If you specify an incorrect alarm name or make any other error in the operation, no alarms are deleted. To
* confirm that alarms were deleted successfully, you can use the DescribeAlarms operation after using DeleteAlarms.
*
*
*
* It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm
* B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite
* alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that
* you want to delete.
*
*
* To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in
* the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to
* change the AlarmRule of one of the alarms to false.
*
*
* Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
*
*
*
* @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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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. You can delete up to 100 alarms in one operation. However, this total can include
* no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with
* one operation, but you can't delete two composite alarms with one operation.
*
*
* If you specify an incorrect alarm name or make any other error in the operation, no alarms are deleted. To
* confirm that alarms were deleted successfully, you can use the DescribeAlarms operation after using DeleteAlarms.
*
*
*
* It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm
* B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite
* alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that
* you want to delete.
*
*
* To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in
* the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to
* change the AlarmRule of one of the alarms to false.
*
*
* Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
*
*
*
* 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 software.amazon.awssdk.services.cloudwatch.model.DeleteAlarmsRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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. For more information about how to delete an
* anomaly detection model, see Deleting an anomaly detection model in the CloudWatch User Guide.
*
*
* @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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
* - InvalidParameterCombinationException Parameters were used together that cannot be used together.
* - 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. For more information about how to delete an
* anomaly detection model, see Deleting an anomaly detection model in the CloudWatch User Guide.
*
*
*
* 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 software.amazon.awssdk.services.cloudwatch.model.DeleteAnomalyDetectorRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
* - InvalidParameterCombinationException Parameters were used together that cannot be used together.
* - 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 can 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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 can 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 software.amazon.awssdk.services.cloudwatch.model.DeleteDashboardsRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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());
}
/**
*
* Permanently deletes the specified Contributor Insights rules.
*
*
* If you create a rule, delete it, and then re-create it with the same name, historical data from the first time
* the rule was created might not be available.
*
*
* @param deleteInsightRulesRequest
* @return A Java Future containing the result of the DeleteInsightRules operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.DeleteInsightRules
* @see AWS
* API Documentation
*/
default CompletableFuture deleteInsightRules(DeleteInsightRulesRequest deleteInsightRulesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Permanently deletes the specified Contributor Insights rules.
*
*
* If you create a rule, delete it, and then re-create it with the same name, historical data from the first time
* the rule was created might not be available.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteInsightRulesRequest.Builder} avoiding the
* need to create one manually via {@link DeleteInsightRulesRequest#builder()}
*
*
* @param deleteInsightRulesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatch.model.DeleteInsightRulesRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteInsightRules operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.DeleteInsightRules
* @see AWS
* API Documentation
*/
default CompletableFuture deleteInsightRules(
Consumer deleteInsightRulesRequest) {
return deleteInsightRules(DeleteInsightRulesRequest.builder().applyMutation(deleteInsightRulesRequest).build());
}
/**
*
* Permanently deletes the metric stream that you specify.
*
*
* @param deleteMetricStreamRequest
* @return A Java Future containing the result of the DeleteMetricStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.DeleteMetricStream
* @see AWS
* API Documentation
*/
default CompletableFuture deleteMetricStream(DeleteMetricStreamRequest deleteMetricStreamRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Permanently deletes the metric stream that you specify.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteMetricStreamRequest.Builder} avoiding the
* need to create one manually via {@link DeleteMetricStreamRequest#builder()}
*
*
* @param deleteMetricStreamRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatch.model.DeleteMetricStreamRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteMetricStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.DeleteMetricStream
* @see AWS
* API Documentation
*/
default CompletableFuture deleteMetricStream(
Consumer deleteMetricStreamRequest) {
return deleteMetricStream(DeleteMetricStreamRequest.builder().applyMutation(deleteMetricStreamRequest).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 either all metric alarms or all composite alarms are returned.
*
*
* CloudWatch retains the history of an alarm even if you delete the alarm.
*
*
* To use this operation and return information about a composite alarm, you must be signed on with the
* cloudwatch:DescribeAlarmHistory permission that is scoped to *. You can't return
* information about composite alarms if your cloudwatch:DescribeAlarmHistory permission has a narrower
* scope.
*
*
* @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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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 either all metric alarms or all composite alarms are returned.
*
*
* CloudWatch retains the history of an alarm even if you delete the alarm.
*
*
* To use this operation and return information about a composite alarm, you must be signed on with the
* cloudwatch:DescribeAlarmHistory permission that is scoped to *. You can't return
* information about composite alarms if your cloudwatch:DescribeAlarmHistory permission has a narrower
* scope.
*
*
*
* 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 software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmHistoryRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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 either all metric alarms or all composite alarms are returned.
*
*
* CloudWatch retains the history of an alarm even if you delete the alarm.
*
*
* To use this operation and return information about a composite alarm, you must be signed on with the
* cloudwatch:DescribeAlarmHistory permission that is scoped to *. You can't return
* information about composite alarms if your cloudwatch:DescribeAlarmHistory permission has a narrower
* scope.
*
*
* @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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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());
}
/**
*
* 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.
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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());
}
/**
*
* 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.
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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) {
return new DescribeAlarmHistoryPublisher(this, describeAlarmHistoryRequest);
}
/**
*
* 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.
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* 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 software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmHistoryRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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. You can filter the results by specifying a prefix for the alarm name, the alarm
* state, or a prefix for any action.
*
*
* To use this operation and return information about composite alarms, you must be signed on with the
* cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information
* about composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope.
*
*
* @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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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. You can filter the results by specifying a prefix for the alarm name, the alarm
* state, or a prefix for any action.
*
*
* To use this operation and return information about composite alarms, you must be signed on with the
* cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information
* about composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope.
*
*
*
* 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 software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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. You can filter the results by specifying a prefix for the alarm name, the alarm
* state, or a prefix for any action.
*
*
* To use this operation and return information about composite alarms, you must be signed on with the
* cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information
* about composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope.
*
*
* @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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
*
* This operation retrieves only standard alarms that are based on the specified metric. It does not return alarms
* based on math expressions that use the specified metric, or composite alarms that use the specified metric.
*
*
* @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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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 operation retrieves only standard alarms that are based on the specified metric. It does not return alarms
* based on math expressions that use the specified metric, or composite alarms that use the specified metric.
*
*
*
* 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 software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsForMetricRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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());
}
/**
*
* 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.
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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());
}
/**
*
* 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.
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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) {
return new DescribeAlarmsPublisher(this, describeAlarmsRequest);
}
/**
*
* 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.
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* 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 software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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. For single metric anomaly detectors,
* you can list all of the models in your account or filter the results to only the models that are related to a
* certain namespace, metric name, or metric dimension. For metric math anomaly detectors, you can list them by
* adding METRIC_MATH to the AnomalyDetectorTypes array. This will return all metric math
* anomaly detectors in your account.
*
*
* @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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
* - InvalidParameterCombinationException Parameters were used together that cannot be used together.
* - 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. For single metric anomaly detectors,
* you can list all of the models in your account or filter the results to only the models that are related to a
* certain namespace, metric name, or metric dimension. For metric math anomaly detectors, you can list them by
* adding METRIC_MATH to the AnomalyDetectorTypes array. This will return all metric math
* anomaly detectors in your account.
*
*
*
* 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 software.amazon.awssdk.services.cloudwatch.model.DescribeAnomalyDetectorsRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
* - InvalidParameterCombinationException Parameters were used together that cannot be used together.
* - 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());
}
/**
*
* This is a variant of
* {@link #describeAnomalyDetectors(software.amazon.awssdk.services.cloudwatch.model.DescribeAnomalyDetectorsRequest)}
* 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.DescribeAnomalyDetectorsPublisher publisher = client.describeAnomalyDetectorsPaginator(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.DescribeAnomalyDetectorsPublisher publisher = client.describeAnomalyDetectorsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatch.model.DescribeAnomalyDetectorsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeAnomalyDetectors(software.amazon.awssdk.services.cloudwatch.model.DescribeAnomalyDetectorsRequest)}
* operation.
*
*
* @param describeAnomalyDetectorsRequest
* @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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
* - InvalidParameterCombinationException Parameters were used together that cannot be used together.
* - 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 DescribeAnomalyDetectorsPublisher describeAnomalyDetectorsPaginator(
DescribeAnomalyDetectorsRequest describeAnomalyDetectorsRequest) {
return new DescribeAnomalyDetectorsPublisher(this, describeAnomalyDetectorsRequest);
}
/**
*
* This is a variant of
* {@link #describeAnomalyDetectors(software.amazon.awssdk.services.cloudwatch.model.DescribeAnomalyDetectorsRequest)}
* 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.DescribeAnomalyDetectorsPublisher publisher = client.describeAnomalyDetectorsPaginator(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.DescribeAnomalyDetectorsPublisher publisher = client.describeAnomalyDetectorsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatch.model.DescribeAnomalyDetectorsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeAnomalyDetectors(software.amazon.awssdk.services.cloudwatch.model.DescribeAnomalyDetectorsRequest)}
* operation.
*
*
*
* 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 software.amazon.awssdk.services.cloudwatch.model.DescribeAnomalyDetectorsRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
* - InvalidParameterCombinationException Parameters were used together that cannot be used together.
* - 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 DescribeAnomalyDetectorsPublisher describeAnomalyDetectorsPaginator(
Consumer describeAnomalyDetectorsRequest) {
return describeAnomalyDetectorsPaginator(DescribeAnomalyDetectorsRequest.builder()
.applyMutation(describeAnomalyDetectorsRequest).build());
}
/**
*
* Returns a list of all the Contributor Insights rules in your account.
*
*
* For more information about Contributor Insights, see Using Contributor
* Insights to Analyze High-Cardinality Data.
*
*
* @param describeInsightRulesRequest
* @return A Java Future containing the result of the DescribeInsightRules operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.DescribeInsightRules
* @see AWS API Documentation
*/
default CompletableFuture describeInsightRules(
DescribeInsightRulesRequest describeInsightRulesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of all the Contributor Insights rules in your account.
*
*
* For more information about Contributor Insights, see Using Contributor
* Insights to Analyze High-Cardinality Data.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeInsightRulesRequest.Builder} avoiding the
* need to create one manually via {@link DescribeInsightRulesRequest#builder()}
*
*
* @param describeInsightRulesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatch.model.DescribeInsightRulesRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeInsightRules operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.DescribeInsightRules
* @see AWS API Documentation
*/
default CompletableFuture describeInsightRules(
Consumer describeInsightRulesRequest) {
return describeInsightRules(DescribeInsightRulesRequest.builder().applyMutation(describeInsightRulesRequest).build());
}
/**
*
* This is a variant of
* {@link #describeInsightRules(software.amazon.awssdk.services.cloudwatch.model.DescribeInsightRulesRequest)}
* 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.DescribeInsightRulesPublisher publisher = client.describeInsightRulesPaginator(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.DescribeInsightRulesPublisher publisher = client.describeInsightRulesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatch.model.DescribeInsightRulesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeInsightRules(software.amazon.awssdk.services.cloudwatch.model.DescribeInsightRulesRequest)}
* operation.
*
*
* @param describeInsightRulesRequest
* @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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.DescribeInsightRules
* @see AWS API Documentation
*/
default DescribeInsightRulesPublisher describeInsightRulesPaginator(DescribeInsightRulesRequest describeInsightRulesRequest) {
return new DescribeInsightRulesPublisher(this, describeInsightRulesRequest);
}
/**
*
* This is a variant of
* {@link #describeInsightRules(software.amazon.awssdk.services.cloudwatch.model.DescribeInsightRulesRequest)}
* 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.DescribeInsightRulesPublisher publisher = client.describeInsightRulesPaginator(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.DescribeInsightRulesPublisher publisher = client.describeInsightRulesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatch.model.DescribeInsightRulesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeInsightRules(software.amazon.awssdk.services.cloudwatch.model.DescribeInsightRulesRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeInsightRulesRequest.Builder} avoiding the
* need to create one manually via {@link DescribeInsightRulesRequest#builder()}
*
*
* @param describeInsightRulesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatch.model.DescribeInsightRulesRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.DescribeInsightRules
* @see AWS API Documentation
*/
default DescribeInsightRulesPublisher describeInsightRulesPaginator(
Consumer describeInsightRulesRequest) {
return describeInsightRulesPaginator(DescribeInsightRulesRequest.builder().applyMutation(describeInsightRulesRequest)
.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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 software.amazon.awssdk.services.cloudwatch.model.DisableAlarmActionsRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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());
}
/**
*
* Disables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do
* not incur costs.
*
*
* @param disableInsightRulesRequest
* @return A Java Future containing the result of the DisableInsightRules operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.DisableInsightRules
* @see AWS API Documentation
*/
default CompletableFuture disableInsightRules(
DisableInsightRulesRequest disableInsightRulesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Disables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do
* not incur costs.
*
*
*
* This is a convenience which creates an instance of the {@link DisableInsightRulesRequest.Builder} avoiding the
* need to create one manually via {@link DisableInsightRulesRequest#builder()}
*
*
* @param disableInsightRulesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatch.model.DisableInsightRulesRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DisableInsightRules operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.DisableInsightRules
* @see AWS API Documentation
*/
default CompletableFuture disableInsightRules(
Consumer disableInsightRulesRequest) {
return disableInsightRules(DisableInsightRulesRequest.builder().applyMutation(disableInsightRulesRequest).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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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 software.amazon.awssdk.services.cloudwatch.model.EnableAlarmActionsRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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());
}
/**
*
* Enables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log
* data.
*
*
* @param enableInsightRulesRequest
* @return A Java Future containing the result of the EnableInsightRules operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - MissingRequiredParameterException An input parameter that is required is missing.
* - LimitExceededException The operation exceeded one or more limits.
* - 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.EnableInsightRules
* @see AWS
* API Documentation
*/
default CompletableFuture enableInsightRules(EnableInsightRulesRequest enableInsightRulesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Enables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log
* data.
*
*
*
* This is a convenience which creates an instance of the {@link EnableInsightRulesRequest.Builder} avoiding the
* need to create one manually via {@link EnableInsightRulesRequest#builder()}
*
*
* @param enableInsightRulesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatch.model.EnableInsightRulesRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the EnableInsightRules operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - MissingRequiredParameterException An input parameter that is required is missing.
* - LimitExceededException The operation exceeded one or more limits.
* - 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.EnableInsightRules
* @see AWS
* API Documentation
*/
default CompletableFuture enableInsightRules(
Consumer enableInsightRulesRequest) {
return enableInsightRules(EnableInsightRulesRequest.builder().applyMutation(enableInsightRulesRequest).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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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 software.amazon.awssdk.services.cloudwatch.model.GetDashboardRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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());
}
/**
*
* This operation returns the time series data collected by a Contributor Insights rule. The data includes the
* identity and number of contributors to the log group.
*
*
* You can also optionally return one or more statistics about each data point in the time series. These statistics
* can include the following:
*
*
* -
*
* UniqueContributors -- the number of unique contributors for each data point.
*
*
* -
*
* MaxContributorValue -- the value of the top contributor for each data point. The identity of the
* contributor might change for each data point in the graph.
*
*
* If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most
* occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the
* highest sum in the log field specified by the rule's Value, during that period.
*
*
* -
*
* SampleCount -- the number of data points matched by the rule.
*
*
* -
*
* Sum -- the sum of the values from all contributors during the time period represented by that data
* point.
*
*
* -
*
* Minimum -- the minimum value from a single observation during the time period represented by that
* data point.
*
*
* -
*
* Maximum -- the maximum value from a single observation during the time period represented by that
* data point.
*
*
* -
*
* Average -- the average value from all contributors during the time period represented by that data
* point.
*
*
*
*
* @param getInsightRuleReportRequest
* @return A Java Future containing the result of the GetInsightRuleReport operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - MissingRequiredParameterException An input parameter that is required is missing.
* - 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.GetInsightRuleReport
* @see AWS API Documentation
*/
default CompletableFuture getInsightRuleReport(
GetInsightRuleReportRequest getInsightRuleReportRequest) {
throw new UnsupportedOperationException();
}
/**
*
* This operation returns the time series data collected by a Contributor Insights rule. The data includes the
* identity and number of contributors to the log group.
*
*
* You can also optionally return one or more statistics about each data point in the time series. These statistics
* can include the following:
*
*
* -
*
* UniqueContributors -- the number of unique contributors for each data point.
*
*
* -
*
* MaxContributorValue -- the value of the top contributor for each data point. The identity of the
* contributor might change for each data point in the graph.
*
*
* If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most
* occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the
* highest sum in the log field specified by the rule's Value, during that period.
*
*
* -
*
* SampleCount -- the number of data points matched by the rule.
*
*
* -
*
* Sum -- the sum of the values from all contributors during the time period represented by that data
* point.
*
*
* -
*
* Minimum -- the minimum value from a single observation during the time period represented by that
* data point.
*
*
* -
*
* Maximum -- the maximum value from a single observation during the time period represented by that
* data point.
*
*
* -
*
* Average -- the average value from all contributors during the time period represented by that data
* point.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link GetInsightRuleReportRequest.Builder} avoiding the
* need to create one manually via {@link GetInsightRuleReportRequest#builder()}
*
*
* @param getInsightRuleReportRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatch.model.GetInsightRuleReportRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetInsightRuleReport operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - MissingRequiredParameterException An input parameter that is required is missing.
* - 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.GetInsightRuleReport
* @see AWS API Documentation
*/
default CompletableFuture getInsightRuleReport(
Consumer getInsightRuleReportRequest) {
return getInsightRuleReport(GetInsightRuleReportRequest.builder().applyMutation(getInsightRuleReportRequest).build());
}
/**
*
* You can use the GetMetricData API to retrieve CloudWatch metric values. The operation can also
* include a CloudWatch Metrics Insights query, and one or more metric math functions.
*
*
* A GetMetricData operation that does not include a query can retrieve as many as 500 different
* metrics in a single request, with a total of as many as 100,800 data points. You can also optionally perform
* metric 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.
*
*
* If you include a Metrics Insights query, each GetMetricData operation can include only one query.
* But the same GetMetricData operation can also retrieve other metrics. Metrics Insights queries can
* query only the most recent three hours of metric data. For more information about Metrics Insights, see Query your metrics with CloudWatch Metrics Insights.
*
*
* 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.
*
*
* If you omit Unit in your request, all data that was collected with any unit is returned, along with
* the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the
* operation returns only data that was collected with that unit specified. If you specify a unit that does not
* match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.
*
*
* Using Metrics Insights queries with metric math
*
*
* You can't mix a Metric Insights query and metric math syntax in the same expression, but you can reference
* results from a Metrics Insights query within other Metric math expressions. A Metrics Insights query without a
* GROUP BY clause returns a single time-series (TS), and can be used as input for a metric math expression
* that expects a single time series. A Metrics Insights query with a GROUP BY clause returns an array of
* time-series (TS[]), and can be used as input for a metric math expression that expects an array of time series.
*
*
* @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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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 CloudWatch metric values. The operation can also
* include a CloudWatch Metrics Insights query, and one or more metric math functions.
*
*
* A GetMetricData operation that does not include a query can retrieve as many as 500 different
* metrics in a single request, with a total of as many as 100,800 data points. You can also optionally perform
* metric 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.
*
*
* If you include a Metrics Insights query, each GetMetricData operation can include only one query.
* But the same GetMetricData operation can also retrieve other metrics. Metrics Insights queries can
* query only the most recent three hours of metric data. For more information about Metrics Insights, see Query your metrics with CloudWatch Metrics Insights.
*
*
* 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.
*
*
* If you omit Unit in your request, all data that was collected with any unit is returned, along with
* the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the
* operation returns only data that was collected with that unit specified. If you specify a unit that does not
* match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.
*
*
* Using Metrics Insights queries with metric math
*
*
* You can't mix a Metric Insights query and metric math syntax in the same expression, but you can reference
* results from a Metrics Insights query within other Metric math expressions. A Metrics Insights query without a
* GROUP BY clause returns a single time-series (TS), and can be used as input for a metric math expression
* that expects a single time series. A Metrics Insights query with a GROUP BY clause returns an array of
* time-series (TS[]), and can be used as input for a metric math expression that expects an array of time series.
*
*
*
* 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 software.amazon.awssdk.services.cloudwatch.model.GetMetricDataRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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());
}
/**
*
* 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.
*
* Please notice that the configuration of MaxDatapoints won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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) {
return new GetMetricDataPublisher(this, getMetricDataRequest);
}
/**
*
* 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.
*
* Please notice that the configuration of MaxDatapoints won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* 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 software.amazon.awssdk.services.cloudwatch.model.GetMetricDataRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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 Amazon Web Services 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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 Amazon Web Services 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 software.amazon.awssdk.services.cloudwatch.model.GetMetricStatisticsRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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());
}
/**
*
* Returns information about the metric stream that you specify.
*
*
* @param getMetricStreamRequest
* @return A Java Future containing the result of the GetMetricStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
* - InvalidParameterCombinationException Parameters were used together that cannot be used together.
* - 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.GetMetricStream
* @see AWS
* API Documentation
*/
default CompletableFuture getMetricStream(GetMetricStreamRequest getMetricStreamRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about the metric stream that you specify.
*
*
*
* This is a convenience which creates an instance of the {@link GetMetricStreamRequest.Builder} avoiding the need
* to create one manually via {@link GetMetricStreamRequest#builder()}
*
*
* @param getMetricStreamRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatch.model.GetMetricStreamRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetMetricStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
* - InvalidParameterCombinationException Parameters were used together that cannot be used together.
* - 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.GetMetricStream
* @see AWS
* API Documentation
*/
default CompletableFuture getMetricStream(
Consumer getMetricStreamRequest) {
return getMetricStream(GetMetricStreamRequest.builder().applyMutation(getMetricStreamRequest).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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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 software.amazon.awssdk.services.cloudwatch.model.GetMetricWidgetImageRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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 software.amazon.awssdk.services.cloudwatch.model.ListDashboardsRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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());
}
/**
*
* 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.
*
* Please notice that the configuration of null won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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());
}
/**
*
* 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.
*
* Please notice that the configuration of null won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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) {
return new ListDashboardsPublisher(this, listDashboardsRequest);
}
/**
*
* 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.
*
* Please notice that the configuration of null won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* 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 software.amazon.awssdk.services.cloudwatch.model.ListDashboardsRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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());
}
/**
*
* Returns a list that contains the number of managed Contributor Insights rules in your account.
*
*
* @param listManagedInsightRulesRequest
* @return A Java Future containing the result of the ListManagedInsightRules operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - MissingRequiredParameterException An input parameter that is required is missing.
* - 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.ListManagedInsightRules
* @see AWS API Documentation
*/
default CompletableFuture listManagedInsightRules(
ListManagedInsightRulesRequest listManagedInsightRulesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list that contains the number of managed Contributor Insights rules in your account.
*
*
*
* This is a convenience which creates an instance of the {@link ListManagedInsightRulesRequest.Builder} avoiding
* the need to create one manually via {@link ListManagedInsightRulesRequest#builder()}
*
*
* @param listManagedInsightRulesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatch.model.ListManagedInsightRulesRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the ListManagedInsightRules operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - MissingRequiredParameterException An input parameter that is required is missing.
* - 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.ListManagedInsightRules
* @see AWS API Documentation
*/
default CompletableFuture listManagedInsightRules(
Consumer listManagedInsightRulesRequest) {
return listManagedInsightRules(ListManagedInsightRulesRequest.builder().applyMutation(listManagedInsightRulesRequest)
.build());
}
/**
*
* This is a variant of
* {@link #listManagedInsightRules(software.amazon.awssdk.services.cloudwatch.model.ListManagedInsightRulesRequest)}
* 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.ListManagedInsightRulesPublisher publisher = client.listManagedInsightRulesPaginator(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.ListManagedInsightRulesPublisher publisher = client.listManagedInsightRulesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatch.model.ListManagedInsightRulesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listManagedInsightRules(software.amazon.awssdk.services.cloudwatch.model.ListManagedInsightRulesRequest)}
* operation.
*
*
* @param listManagedInsightRulesRequest
* @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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - MissingRequiredParameterException An input parameter that is required is missing.
* - 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.ListManagedInsightRules
* @see AWS API Documentation
*/
default ListManagedInsightRulesPublisher listManagedInsightRulesPaginator(
ListManagedInsightRulesRequest listManagedInsightRulesRequest) {
return new ListManagedInsightRulesPublisher(this, listManagedInsightRulesRequest);
}
/**
*
* This is a variant of
* {@link #listManagedInsightRules(software.amazon.awssdk.services.cloudwatch.model.ListManagedInsightRulesRequest)}
* 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.ListManagedInsightRulesPublisher publisher = client.listManagedInsightRulesPaginator(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.ListManagedInsightRulesPublisher publisher = client.listManagedInsightRulesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatch.model.ListManagedInsightRulesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listManagedInsightRules(software.amazon.awssdk.services.cloudwatch.model.ListManagedInsightRulesRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListManagedInsightRulesRequest.Builder} avoiding
* the need to create one manually via {@link ListManagedInsightRulesRequest#builder()}
*
*
* @param listManagedInsightRulesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatch.model.ListManagedInsightRulesRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - MissingRequiredParameterException An input parameter that is required is missing.
* - 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.ListManagedInsightRules
* @see AWS API Documentation
*/
default ListManagedInsightRulesPublisher listManagedInsightRulesPaginator(
Consumer listManagedInsightRulesRequest) {
return listManagedInsightRulesPaginator(ListManagedInsightRulesRequest.builder()
.applyMutation(listManagedInsightRulesRequest).build());
}
/**
*
* Returns a list of metric streams in this account.
*
*
* @param listMetricStreamsRequest
* @return A Java Future containing the result of the ListMetricStreams operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
* - 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.ListMetricStreams
* @see AWS
* API Documentation
*/
default CompletableFuture listMetricStreams(ListMetricStreamsRequest listMetricStreamsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of metric streams in this account.
*
*
*
* This is a convenience which creates an instance of the {@link ListMetricStreamsRequest.Builder} avoiding the need
* to create one manually via {@link ListMetricStreamsRequest#builder()}
*
*
* @param listMetricStreamsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatch.model.ListMetricStreamsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListMetricStreams operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
* - 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.ListMetricStreams
* @see AWS
* API Documentation
*/
default CompletableFuture listMetricStreams(
Consumer listMetricStreamsRequest) {
return listMetricStreams(ListMetricStreamsRequest.builder().applyMutation(listMetricStreamsRequest).build());
}
/**
*
* This is a variant of
* {@link #listMetricStreams(software.amazon.awssdk.services.cloudwatch.model.ListMetricStreamsRequest)} 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.ListMetricStreamsPublisher publisher = client.listMetricStreamsPaginator(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.ListMetricStreamsPublisher publisher = client.listMetricStreamsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatch.model.ListMetricStreamsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listMetricStreams(software.amazon.awssdk.services.cloudwatch.model.ListMetricStreamsRequest)}
* operation.
*
*
* @param listMetricStreamsRequest
* @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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
* - 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.ListMetricStreams
* @see AWS
* API Documentation
*/
default ListMetricStreamsPublisher listMetricStreamsPaginator(ListMetricStreamsRequest listMetricStreamsRequest) {
return new ListMetricStreamsPublisher(this, listMetricStreamsRequest);
}
/**
*
* This is a variant of
* {@link #listMetricStreams(software.amazon.awssdk.services.cloudwatch.model.ListMetricStreamsRequest)} 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.ListMetricStreamsPublisher publisher = client.listMetricStreamsPaginator(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.ListMetricStreamsPublisher publisher = client.listMetricStreamsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatch.model.ListMetricStreamsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listMetricStreams(software.amazon.awssdk.services.cloudwatch.model.ListMetricStreamsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListMetricStreamsRequest.Builder} avoiding the need
* to create one manually via {@link ListMetricStreamsRequest#builder()}
*
*
* @param listMetricStreamsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatch.model.ListMetricStreamsRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
* - 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.ListMetricStreams
* @see AWS
* API Documentation
*/
default ListMetricStreamsPublisher listMetricStreamsPaginator(
Consumer listMetricStreamsRequest) {
return listMetricStreamsPaginator(ListMetricStreamsRequest.builder().applyMutation(listMetricStreamsRequest).build());
}
/**
*
* List the specified metrics. You can use the returned metrics with GetMetricData
* or
* GetMetricStatistics to get 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 15 minutes for the metric to appear. To see metric statistics sooner, use
* GetMetricData
* or
* GetMetricStatistics.
*
*
* If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and
* view metrics from the linked source accounts. For more information, see CloudWatch cross-account observability.
*
*
* ListMetrics doesn't return information about metrics if those metrics haven't reported data in the
* past two weeks. To retrieve those metrics, use 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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 get 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 15 minutes for the metric to appear. To see metric statistics sooner, use
* GetMetricData
* or
* GetMetricStatistics.
*
*
* If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and
* view metrics from the linked source accounts. For more information, see CloudWatch cross-account observability.
*
*
* ListMetrics doesn't return information about metrics if those metrics haven't reported data in the
* past two weeks. To retrieve those metrics, use 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 software.amazon.awssdk.services.cloudwatch.model.ListMetricsRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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 get 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 15 minutes for the metric to appear. To see metric statistics sooner, use
* GetMetricData
* or
* GetMetricStatistics.
*
*
* If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and
* view metrics from the linked source accounts. For more information, see CloudWatch cross-account observability.
*
*
* ListMetrics doesn't return information about metrics if those metrics haven't reported data in the
* past two weeks. To retrieve those metrics, use 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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());
}
/**
*
* 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.
*
* Please notice that the configuration of null won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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());
}
/**
*
* 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.
*
* Please notice that the configuration of null won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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) {
return new ListMetricsPublisher(this, listMetricsRequest);
}
/**
*
* 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.
*
* Please notice that the configuration of null won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* 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 software.amazon.awssdk.services.cloudwatch.model.ListMetricsRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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. Currently, alarms and Contributor Insights rules 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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. Currently, alarms and Contributor Insights rules 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 software.amazon.awssdk.services.cloudwatch.model.ListTagsForResourceRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
*
* If you have enabled unified cross-account observability, and this account is a monitoring account, the metric can
* be in the same account or a source account. You can specify the account ID in the object you specify in the
* SingleMetricAnomalyDetector parameter.
*
*
* 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
* - InvalidParameterCombinationException Parameters were used together that cannot be used together.
* - 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.
*
*
* If you have enabled unified cross-account observability, and this account is a monitoring account, the metric can
* be in the same account or a source account. You can specify the account ID in the object you specify in the
* SingleMetricAnomalyDetector parameter.
*
*
* 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 software.amazon.awssdk.services.cloudwatch.model.PutAnomalyDetectorRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
* - InvalidParameterCombinationException Parameters were used together that cannot be used together.
* - 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 or updates a composite alarm. When you create a composite alarm, you specify a rule expression for
* the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm
* goes into ALARM state only if all conditions of the rule are met.
*
*
* The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.
* The rule expression of a composite alarm can include as many as 100 underlying alarms. Any single alarm can be
* included in the rule expressions of as many as 150 composite alarms.
*
*
* Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite
* alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes
* into ALARM state only when more than one of the underlying metric alarms are in ALARM state.
*
*
* Composite alarms can take the following actions:
*
*
* -
*
* Notify Amazon SNS topics.
*
*
* -
*
* Invoke Lambda functions.
*
*
* -
*
* Create OpsItems in Systems Manager Ops Center.
*
*
* -
*
* Create incidents in Systems Manager Incident Manager.
*
*
*
*
*
* It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm
* B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite
* alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that
* you want to delete.
*
*
* To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in
* the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to
* change the AlarmRule of one of the alarms to false.
*
*
* Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
*
*
*
* 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. For a composite alarm, this initial time after creation is the only time that the alarm can be in
* INSUFFICIENT_DATA state.
*
*
* When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous
* configuration of the alarm.
*
*
* To use this operation, you must be signed on with the cloudwatch:PutCompositeAlarm permission that
* is scoped to *. You can't create a composite alarms if your
* cloudwatch:PutCompositeAlarm permission has a narrower scope.
*
*
* If you are an IAM user, you must have iam:CreateServiceLinkedRole to create a composite alarm that
* has Systems Manager OpsItem actions.
*
*
* @param putCompositeAlarmRequest
* @return A Java Future containing the result of the PutCompositeAlarm operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.PutCompositeAlarm
* @see AWS
* API Documentation
*/
default CompletableFuture putCompositeAlarm(PutCompositeAlarmRequest putCompositeAlarmRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for
* the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm
* goes into ALARM state only if all conditions of the rule are met.
*
*
* The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.
* The rule expression of a composite alarm can include as many as 100 underlying alarms. Any single alarm can be
* included in the rule expressions of as many as 150 composite alarms.
*
*
* Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite
* alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes
* into ALARM state only when more than one of the underlying metric alarms are in ALARM state.
*
*
* Composite alarms can take the following actions:
*
*
* -
*
* Notify Amazon SNS topics.
*
*
* -
*
* Invoke Lambda functions.
*
*
* -
*
* Create OpsItems in Systems Manager Ops Center.
*
*
* -
*
* Create incidents in Systems Manager Incident Manager.
*
*
*
*
*
* It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm
* B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite
* alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that
* you want to delete.
*
*
* To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in
* the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to
* change the AlarmRule of one of the alarms to false.
*
*
* Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
*
*
*
* 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. For a composite alarm, this initial time after creation is the only time that the alarm can be in
* INSUFFICIENT_DATA state.
*
*
* When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous
* configuration of the alarm.
*
*
* To use this operation, you must be signed on with the cloudwatch:PutCompositeAlarm permission that
* is scoped to *. You can't create a composite alarms if your
* cloudwatch:PutCompositeAlarm permission has a narrower scope.
*
*
* If you are an IAM user, you must have iam:CreateServiceLinkedRole to create a composite alarm that
* has Systems Manager OpsItem actions.
*
*
*
* This is a convenience which creates an instance of the {@link PutCompositeAlarmRequest.Builder} avoiding the need
* to create one manually via {@link PutCompositeAlarmRequest#builder()}
*
*
* @param putCompositeAlarmRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatch.model.PutCompositeAlarmRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the PutCompositeAlarm operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.PutCompositeAlarm
* @see AWS
* API Documentation
*/
default CompletableFuture putCompositeAlarm(
Consumer putCompositeAlarmRequest) {
return putCompositeAlarm(PutCompositeAlarmRequest.builder().applyMutation(putCompositeAlarmRequest).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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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 software.amazon.awssdk.services.cloudwatch.model.PutDashboardRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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 a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to
* find contributor data for the log events in that log group. For more information, see Using Contributor
* Insights to Analyze High-Cardinality Data.
*
*
* If you create a rule, delete it, and then re-create it with the same name, historical data from the first time
* the rule was created might not be available.
*
*
* @param putInsightRuleRequest
* @return A Java Future containing the result of the PutInsightRule operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - MissingRequiredParameterException An input parameter that is required is missing.
* - LimitExceededException The operation exceeded one or more limits.
* - 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.PutInsightRule
* @see AWS API
* Documentation
*/
default CompletableFuture putInsightRule(PutInsightRuleRequest putInsightRuleRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to
* find contributor data for the log events in that log group. For more information, see Using Contributor
* Insights to Analyze High-Cardinality Data.
*
*
* If you create a rule, delete it, and then re-create it with the same name, historical data from the first time
* the rule was created might not be available.
*
*
*
* This is a convenience which creates an instance of the {@link PutInsightRuleRequest.Builder} avoiding the need to
* create one manually via {@link PutInsightRuleRequest#builder()}
*
*
* @param putInsightRuleRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatch.model.PutInsightRuleRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the PutInsightRule operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidParameterValueException The value of an input parameter is bad or out-of-range.
* - MissingRequiredParameterException An input parameter that is required is missing.
* - LimitExceededException The operation exceeded one or more limits.
* - 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.PutInsightRule
* @see AWS API
* Documentation
*/
default CompletableFuture putInsightRule(Consumer putInsightRuleRequest) {
return putInsightRule(PutInsightRuleRequest.builder().applyMutation(putInsightRuleRequest).build());
}
/**
*
* Creates a managed Contributor Insights rule for a specified Amazon Web Services resource. When you enable a
* managed rule, you create a Contributor Insights rule that collects data from Amazon Web Services services. You
* cannot edit these rules with PutInsightRule. The rules can be enabled, disabled, and deleted using
* EnableInsightRules, DisableInsightRules, and DeleteInsightRules. If a
* previously created managed rule is currently disabled, a subsequent call to this API will re-enable it. Use
* ListManagedInsightRules to describe all available rules.
*
*
* @param putManagedInsightRulesRequest
* @return A Java Future containing the result of the PutManagedInsightRules operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.PutManagedInsightRules
* @see AWS API Documentation
*/
default CompletableFuture putManagedInsightRules(
PutManagedInsightRulesRequest putManagedInsightRulesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a managed Contributor Insights rule for a specified Amazon Web Services resource. When you enable a
* managed rule, you create a Contributor Insights rule that collects data from Amazon Web Services services. You
* cannot edit these rules with PutInsightRule. The rules can be enabled, disabled, and deleted using
* EnableInsightRules, DisableInsightRules, and DeleteInsightRules. If a
* previously created managed rule is currently disabled, a subsequent call to this API will re-enable it. Use
* ListManagedInsightRules to describe all available rules.
*
*
*
* This is a convenience which creates an instance of the {@link PutManagedInsightRulesRequest.Builder} avoiding the
* need to create one manually via {@link PutManagedInsightRulesRequest#builder()}
*
*
* @param putManagedInsightRulesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatch.model.PutManagedInsightRulesRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the PutManagedInsightRules operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.PutManagedInsightRules
* @see AWS API Documentation
*/
default CompletableFuture putManagedInsightRules(
Consumer putManagedInsightRulesRequest) {
return putManagedInsightRules(PutManagedInsightRulesRequest.builder().applyMutation(putManagedInsightRulesRequest)
.build());
}
/**
*
* Creates or updates an alarm and associates it with the specified metric, metric math expression, anomaly
* detection model, or Metrics Insights query. For more information about using a Metrics Insights query for an
* alarm, see Create
* alarms on Metrics Insights queries.
*
*
* 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:
*
*
* -
*
* The iam:CreateServiceLinkedRole permission for all alarms with EC2 actions
*
*
* -
*
* The iam:CreateServiceLinkedRole permissions to create an alarm with Systems Manager OpsItem or
* response plan actions.
*
*
*
*
* The first time you create an alarm in the Amazon Web Services Management Console, the CLI, or by using the
* PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked roles are
* called AWSServiceRoleForCloudWatchEvents and
* AWSServiceRoleForCloudWatchAlarms_ActionSSM. For more information, see Amazon Web Services service-linked role.
*
*
* Each PutMetricAlarm action has a maximum uncompressed payload of 120 KB.
*
*
* Cross-account alarms
*
*
* You can set an alarm on metrics in the current account, or in another account. To create a cross-account alarm
* that watches a metric in a different account, you must have completed the following pre-requisites:
*
*
* -
*
* The account where the metrics are located (the sharing account) must already have a sharing role named
* CloudWatch-CrossAccountSharingRole. If it does not already have this role, you must create it using the
* instructions in Set up a sharing account in Cross-account cross-Region CloudWatch console. The policy for that role must grant access to the ID of the
* account where you are creating the alarm.
*
*
* -
*
* The account where you are creating the alarm (the monitoring account) must already have a service-linked
* role named AWSServiceRoleForCloudWatchCrossAccount to allow CloudWatch to assume the sharing role in the
* sharing account. If it does not, you must create it following the directions in Set up a monitoring
* account in Cross-account cross-Region CloudWatch console.
*
*
*
*
* @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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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, anomaly
* detection model, or Metrics Insights query. For more information about using a Metrics Insights query for an
* alarm, see Create
* alarms on Metrics Insights queries.
*
*
* 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:
*
*
* -
*
* The iam:CreateServiceLinkedRole permission for all alarms with EC2 actions
*
*
* -
*
* The iam:CreateServiceLinkedRole permissions to create an alarm with Systems Manager OpsItem or
* response plan actions.
*
*
*
*
* The first time you create an alarm in the Amazon Web Services Management Console, the CLI, or by using the
* PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked roles are
* called AWSServiceRoleForCloudWatchEvents and
* AWSServiceRoleForCloudWatchAlarms_ActionSSM. For more information, see Amazon Web Services service-linked role.
*
*
* Each PutMetricAlarm action has a maximum uncompressed payload of 120 KB.
*
*
* Cross-account alarms
*
*
* You can set an alarm on metrics in the current account, or in another account. To create a cross-account alarm
* that watches a metric in a different account, you must have completed the following pre-requisites:
*
*
* -
*
* The account where the metrics are located (the sharing account) must already have a sharing role named
* CloudWatch-CrossAccountSharingRole. If it does not already have this role, you must create it using the
* instructions in Set up a sharing account in Cross-account cross-Region CloudWatch console. The policy for that role must grant access to the ID of the
* account where you are creating the alarm.
*
*
* -
*
* The account where you are creating the alarm (the monitoring account) must already have a service-linked
* role named AWSServiceRoleForCloudWatchCrossAccount to allow CloudWatch to assume the sharing role in the
* sharing account. If it does not, you must create it following the directions in Set up a monitoring
* account in Cross-account cross-Region CloudWatch console.
*
*
*
*
*
* 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 software.amazon.awssdk.services.cloudwatch.model.PutMetricAlarmRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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 MetricData 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 1 MB in size for HTTP POST requests. You can send a payload
* compressed by gzip. Each request is also limited to no more than 1000 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 -2^360 to 2^360. In addition, special
* values (for example, NaN, +Infinity, -Infinity) are not supported.
*
*
* You can use up to 30 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.
*
*
* You specify the time stamp to be associated with each data point. You can specify time stamps that are as much as
* two weeks before the current date, and as much as 2 hours after the current day and time.
*
*
* 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. Data points with time stamps between 3 and 24 hours ago
* can take as much as 2 hours to become available for for GetMetricData
* or
* GetMetricStatistics.
*
*
* 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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 MetricData 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 1 MB in size for HTTP POST requests. You can send a payload
* compressed by gzip. Each request is also limited to no more than 1000 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 -2^360 to 2^360. In addition, special
* values (for example, NaN, +Infinity, -Infinity) are not supported.
*
*
* You can use up to 30 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.
*
*
* You specify the time stamp to be associated with each data point. You can specify time stamps that are as much as
* two weeks before the current date, and as much as 2 hours after the current day and time.
*
*
* 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. Data points with time stamps between 3 and 24 hours ago
* can take as much as 2 hours to become available for for GetMetricData
* or
* GetMetricStatistics.
*
*
* 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 software.amazon.awssdk.services.cloudwatch.model.PutMetricDataRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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());
}
/**
*
* Creates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics to Amazon Web
* Services destinations, including Amazon S3, and to many third-party solutions.
*
*
* For more information, see Using
* Metric Streams.
*
*
* To create a metric stream, you must be signed in to an account that has the iam:PassRole permission
* and either the CloudWatchFullAccess policy or the cloudwatch:PutMetricStream
* permission.
*
*
* When you create or update a metric stream, you choose one of the following:
*
*
* -
*
* Stream metrics from all metric namespaces in the account.
*
*
* -
*
* Stream metrics from all metric namespaces in the account, except for the namespaces that you list in
* ExcludeFilters.
*
*
* -
*
* Stream metrics from only the metric namespaces that you list in IncludeFilters.
*
*
*
*
* By default, a metric stream always sends the MAX, MIN, SUM, and
* SAMPLECOUNT statistics for each metric that is streamed. You can use the
* StatisticsConfigurations parameter to have the metric stream send additional statistics in the
* stream. Streaming additional statistics incurs additional costs. For more information, see Amazon CloudWatch Pricing.
*
*
* When you use PutMetricStream to create a new metric stream, the stream is created in the
* running state. If you use it to update an existing stream, the state of the stream is not changed.
*
*
* If you are using CloudWatch cross-account observability and you create a metric stream in a monitoring account,
* you can choose whether to include metrics from source accounts in the stream. For more information, see CloudWatch cross-account observability.
*
*
* @param putMetricStreamRequest
* @return A Java Future containing the result of the PutMetricStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
* - 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.
* - 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.PutMetricStream
* @see AWS
* API Documentation
*/
default CompletableFuture putMetricStream(PutMetricStreamRequest putMetricStreamRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics to Amazon Web
* Services destinations, including Amazon S3, and to many third-party solutions.
*
*
* For more information, see Using
* Metric Streams.
*
*
* To create a metric stream, you must be signed in to an account that has the iam:PassRole permission
* and either the CloudWatchFullAccess policy or the cloudwatch:PutMetricStream
* permission.
*
*
* When you create or update a metric stream, you choose one of the following:
*
*
* -
*
* Stream metrics from all metric namespaces in the account.
*
*
* -
*
* Stream metrics from all metric namespaces in the account, except for the namespaces that you list in
* ExcludeFilters.
*
*
* -
*
* Stream metrics from only the metric namespaces that you list in IncludeFilters.
*
*
*
*
* By default, a metric stream always sends the MAX, MIN, SUM, and
* SAMPLECOUNT statistics for each metric that is streamed. You can use the
* StatisticsConfigurations parameter to have the metric stream send additional statistics in the
* stream. Streaming additional statistics incurs additional costs. For more information, see Amazon CloudWatch Pricing.
*
*
* When you use PutMetricStream to create a new metric stream, the stream is created in the
* running state. If you use it to update an existing stream, the state of the stream is not changed.
*
*
* If you are using CloudWatch cross-account observability and you create a metric stream in a monitoring account,
* you can choose whether to include metrics from source accounts in the stream. For more information, see CloudWatch cross-account observability.
*
*
*
* This is a convenience which creates an instance of the {@link PutMetricStreamRequest.Builder} avoiding the need
* to create one manually via {@link PutMetricStreamRequest#builder()}
*
*
* @param putMetricStreamRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatch.model.PutMetricStreamRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the PutMetricStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
* - 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.
* - 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.PutMetricStream
* @see AWS
* API Documentation
*/
default CompletableFuture putMetricStream(
Consumer putMetricStreamRequest) {
return putMetricStream(PutMetricStreamRequest.builder().applyMutation(putMetricStreamRequest).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.
*
*
* Metric alarms returns to their actual state quickly, often within seconds. Because the metric alarm state change
* happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console
* or through DescribeAlarmHistory.
*
*
* If you use SetAlarmState on a composite alarm, the composite alarm is not guaranteed to return to
* its actual state. It returns to its actual state only once any of its children alarms change state. It is also
* reevaluated if you update its configuration.
*
*
* If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include information
* in the StateReasonData parameter to enable the policy to take the correct action.
*
*
* @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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
*
* Metric alarms returns to their actual state quickly, often within seconds. Because the metric alarm state change
* happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console
* or through DescribeAlarmHistory.
*
*
* If you use SetAlarmState on a composite alarm, the composite alarm is not guaranteed to return to
* its actual state. It returns to its actual state only once any of its children alarms change state. It is also
* reevaluated if you update its configuration.
*
*
* If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include information
* in the StateReasonData parameter to enable the policy to take the correct action.
*
*
*
* 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 software.amazon.awssdk.services.cloudwatch.model.SetAlarmStateRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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());
}
/**
*
* Starts the streaming of metrics for one or more of your metric streams.
*
*
* @param startMetricStreamsRequest
* @return A Java Future containing the result of the StartMetricStreams operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.StartMetricStreams
* @see AWS
* API Documentation
*/
default CompletableFuture startMetricStreams(StartMetricStreamsRequest startMetricStreamsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Starts the streaming of metrics for one or more of your metric streams.
*
*
*
* This is a convenience which creates an instance of the {@link StartMetricStreamsRequest.Builder} avoiding the
* need to create one manually via {@link StartMetricStreamsRequest#builder()}
*
*
* @param startMetricStreamsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatch.model.StartMetricStreamsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the StartMetricStreams operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.StartMetricStreams
* @see AWS
* API Documentation
*/
default CompletableFuture startMetricStreams(
Consumer startMetricStreamsRequest) {
return startMetricStreams(StartMetricStreamsRequest.builder().applyMutation(startMetricStreamsRequest).build());
}
/**
*
* Stops the streaming of metrics for one or more of your metric streams.
*
*
* @param stopMetricStreamsRequest
* @return A Java Future containing the result of the StopMetricStreams operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.StopMetricStreams
* @see AWS
* API Documentation
*/
default CompletableFuture stopMetricStreams(StopMetricStreamsRequest stopMetricStreamsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Stops the streaming of metrics for one or more of your metric streams.
*
*
*
* This is a convenience which creates an instance of the {@link StopMetricStreamsRequest.Builder} avoiding the need
* to create one manually via {@link StopMetricStreamsRequest#builder()}
*
*
* @param stopMetricStreamsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudwatch.model.StopMetricStreamsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the StopMetricStreams operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.StopMetricStreams
* @see AWS
* API Documentation
*/
default CompletableFuture stopMetricStreams(
Consumer stopMetricStreamsRequest) {
return stopMetricStreams(StopMetricStreamsRequest.builder().applyMutation(stopMetricStreamsRequest).build());
}
/**
*
* Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch
* resources that can be tagged are alarms and Contributor Insights rules.
*
*
* 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.
*
*
* Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of
* characters.
*
*
* You can use the TagResource action with an alarm that already has tags. If you specify a new tag key
* for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that
* is already associated with the alarm, the new tag value that you specify replaces the previous value for that
* tag.
*
*
* You can associate as many as 50 tags with a CloudWatch 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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. Currently, the only CloudWatch
* resources that can be tagged are alarms and Contributor Insights rules.
*
*
* 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.
*
*
* Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of
* characters.
*
*
* You can use the TagResource action with an alarm that already has tags. If you specify a new tag key
* for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that
* is already associated with the alarm, the new tag value that you specify replaces the previous value for that
* tag.
*
*
* You can associate as many as 50 tags with a CloudWatch 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 software.amazon.awssdk.services.cloudwatch.model.TagResourceRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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 software.amazon.awssdk.services.cloudwatch.model.UntagResourceRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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());
}
/**
* Create an instance of {@link CloudWatchAsyncWaiter} using this client.
*
* Waiters created via this method are managed by the SDK and resources will be released when the service client is
* closed.
*
* @return an instance of {@link CloudWatchAsyncWaiter}
*/
default CloudWatchAsyncWaiter waiter() {
throw new UnsupportedOperationException();
}
@Override
default CloudWatchServiceClientConfiguration serviceClientConfiguration() {
throw new UnsupportedOperationException();
}
/**
* 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();
}
}