software.amazon.awssdk.services.cloudwatch.DefaultCloudWatchClient 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.Collections;
import java.util.List;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkInternalApi;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.awscore.client.handler.AwsSyncClientHandler;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.ApiName;
import software.amazon.awssdk.core.RequestOverrideConfiguration;
import software.amazon.awssdk.core.client.config.SdkClientConfiguration;
import software.amazon.awssdk.core.client.config.SdkClientOption;
import software.amazon.awssdk.core.client.handler.ClientExecutionParams;
import software.amazon.awssdk.core.client.handler.SyncClientHandler;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.core.http.HttpResponseHandler;
import software.amazon.awssdk.core.metrics.CoreMetric;
import software.amazon.awssdk.core.util.VersionInfo;
import software.amazon.awssdk.metrics.MetricCollector;
import software.amazon.awssdk.metrics.MetricPublisher;
import software.amazon.awssdk.metrics.NoOpMetricCollector;
import software.amazon.awssdk.protocols.core.ExceptionMetadata;
import software.amazon.awssdk.protocols.query.AwsQueryProtocolFactory;
import software.amazon.awssdk.services.cloudwatch.model.CloudWatchException;
import software.amazon.awssdk.services.cloudwatch.model.CloudWatchRequest;
import software.amazon.awssdk.services.cloudwatch.model.ConcurrentModificationException;
import software.amazon.awssdk.services.cloudwatch.model.DashboardInvalidInputErrorException;
import software.amazon.awssdk.services.cloudwatch.model.DashboardNotFoundErrorException;
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.InternalServiceException;
import software.amazon.awssdk.services.cloudwatch.model.InvalidFormatException;
import software.amazon.awssdk.services.cloudwatch.model.InvalidNextTokenException;
import software.amazon.awssdk.services.cloudwatch.model.InvalidParameterCombinationException;
import software.amazon.awssdk.services.cloudwatch.model.InvalidParameterValueException;
import software.amazon.awssdk.services.cloudwatch.model.LimitExceededException;
import software.amazon.awssdk.services.cloudwatch.model.ListDashboardsRequest;
import software.amazon.awssdk.services.cloudwatch.model.ListDashboardsResponse;
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.MissingRequiredParameterException;
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.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.ResourceNotFoundException;
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.DescribeAlarmHistoryIterable;
import software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmsIterable;
import software.amazon.awssdk.services.cloudwatch.paginators.DescribeInsightRulesIterable;
import software.amazon.awssdk.services.cloudwatch.paginators.GetMetricDataIterable;
import software.amazon.awssdk.services.cloudwatch.paginators.ListDashboardsIterable;
import software.amazon.awssdk.services.cloudwatch.paginators.ListMetricStreamsIterable;
import software.amazon.awssdk.services.cloudwatch.paginators.ListMetricsIterable;
import software.amazon.awssdk.services.cloudwatch.transform.DeleteAlarmsRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.DeleteAnomalyDetectorRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.DeleteDashboardsRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.DeleteInsightRulesRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.DeleteMetricStreamRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.DescribeAlarmHistoryRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.DescribeAlarmsForMetricRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.DescribeAlarmsRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.DescribeAnomalyDetectorsRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.DescribeInsightRulesRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.DisableAlarmActionsRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.DisableInsightRulesRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.EnableAlarmActionsRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.EnableInsightRulesRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.GetDashboardRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.GetInsightRuleReportRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.GetMetricDataRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.GetMetricStatisticsRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.GetMetricStreamRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.GetMetricWidgetImageRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.ListDashboardsRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.ListMetricStreamsRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.ListMetricsRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.ListTagsForResourceRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.PutAnomalyDetectorRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.PutCompositeAlarmRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.PutDashboardRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.PutInsightRuleRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.PutMetricAlarmRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.PutMetricDataRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.PutMetricStreamRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.SetAlarmStateRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.StartMetricStreamsRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.StopMetricStreamsRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.TagResourceRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.transform.UntagResourceRequestMarshaller;
import software.amazon.awssdk.services.cloudwatch.waiters.CloudWatchWaiter;
import software.amazon.awssdk.utils.Logger;
/**
* Internal implementation of {@link CloudWatchClient}.
*
* @see CloudWatchClient#builder()
*/
@Generated("software.amazon.awssdk:codegen")
@SdkInternalApi
final class DefaultCloudWatchClient implements CloudWatchClient {
private static final Logger log = Logger.loggerFor(DefaultCloudWatchClient.class);
private final SyncClientHandler clientHandler;
private final AwsQueryProtocolFactory protocolFactory;
private final SdkClientConfiguration clientConfiguration;
protected DefaultCloudWatchClient(SdkClientConfiguration clientConfiguration) {
this.clientHandler = new AwsSyncClientHandler(clientConfiguration);
this.clientConfiguration = clientConfiguration;
this.protocolFactory = init();
}
@Override
public final String serviceName() {
return SERVICE_NAME;
}
/**
*
* 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.
*
*
* In the event of an error, no alarms are deleted.
*
*
*
* 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 Result of the DeleteAlarms operation returned by the service.
* @throws ResourceNotFoundException
* The named resource does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.DeleteAlarms
* @see AWS API
* Documentation
*/
@Override
public DeleteAlarmsResponse deleteAlarms(DeleteAlarmsRequest deleteAlarmsRequest) throws ResourceNotFoundException,
AwsServiceException, SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(DeleteAlarmsResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, deleteAlarmsRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "DeleteAlarms");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("DeleteAlarms").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(deleteAlarmsRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new DeleteAlarmsRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Deletes the specified anomaly detection model from your account.
*
*
* @param deleteAnomalyDetectorRequest
* @return Result of the DeleteAnomalyDetector operation returned by the service.
* @throws ResourceNotFoundException
* The named resource does not exist.
* @throws InternalServiceException
* Request processing has failed due to some unknown error, exception, or failure.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws MissingRequiredParameterException
* An input parameter that is required is missing.
* @throws InvalidParameterCombinationException
* Parameters were used together that cannot be used together.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.DeleteAnomalyDetector
* @see AWS API Documentation
*/
@Override
public DeleteAnomalyDetectorResponse deleteAnomalyDetector(DeleteAnomalyDetectorRequest deleteAnomalyDetectorRequest)
throws ResourceNotFoundException, InternalServiceException, InvalidParameterValueException,
MissingRequiredParameterException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(DeleteAnomalyDetectorResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, deleteAnomalyDetectorRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "DeleteAnomalyDetector");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("DeleteAnomalyDetector").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(deleteAnomalyDetectorRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new DeleteAnomalyDetectorRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* 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 Result of the DeleteDashboards operation returned by the service.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws DashboardNotFoundErrorException
* The specified dashboard does not exist.
* @throws InternalServiceException
* Request processing has failed due to some unknown error, exception, or failure.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.DeleteDashboards
* @see AWS
* API Documentation
*/
@Override
public DeleteDashboardsResponse deleteDashboards(DeleteDashboardsRequest deleteDashboardsRequest)
throws InvalidParameterValueException, DashboardNotFoundErrorException, InternalServiceException,
AwsServiceException, SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(DeleteDashboardsResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, deleteDashboardsRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "DeleteDashboards");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("DeleteDashboards").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(deleteDashboardsRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new DeleteDashboardsRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* 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 Result of the DeleteInsightRules operation returned by the service.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws MissingRequiredParameterException
* An input parameter that is required is missing.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.DeleteInsightRules
* @see AWS
* API Documentation
*/
@Override
public DeleteInsightRulesResponse deleteInsightRules(DeleteInsightRulesRequest deleteInsightRulesRequest)
throws InvalidParameterValueException, MissingRequiredParameterException, AwsServiceException, SdkClientException,
CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(DeleteInsightRulesResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, deleteInsightRulesRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "DeleteInsightRules");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("DeleteInsightRules").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(deleteInsightRulesRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new DeleteInsightRulesRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Permanently deletes the metric stream that you specify.
*
*
* @param deleteMetricStreamRequest
* @return Result of the DeleteMetricStream operation returned by the service.
* @throws InternalServiceException
* Request processing has failed due to some unknown error, exception, or failure.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws MissingRequiredParameterException
* An input parameter that is required is missing.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.DeleteMetricStream
* @see AWS
* API Documentation
*/
@Override
public DeleteMetricStreamResponse deleteMetricStream(DeleteMetricStreamRequest deleteMetricStreamRequest)
throws InternalServiceException, InvalidParameterValueException, MissingRequiredParameterException,
AwsServiceException, SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(DeleteMetricStreamResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, deleteMetricStreamRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "DeleteMetricStream");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("DeleteMetricStream").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(deleteMetricStreamRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new DeleteMetricStreamRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* 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 Result of the DescribeAlarmHistory operation returned by the service.
* @throws InvalidNextTokenException
* The next token specified is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.DescribeAlarmHistory
* @see AWS API Documentation
*/
@Override
public DescribeAlarmHistoryResponse describeAlarmHistory(DescribeAlarmHistoryRequest describeAlarmHistoryRequest)
throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(DescribeAlarmHistoryResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, describeAlarmHistoryRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "DescribeAlarmHistory");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("DescribeAlarmHistory").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(describeAlarmHistoryRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new DescribeAlarmHistoryRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* 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 variant of
* {@link #describeAlarmHistory(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmHistoryRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmHistoryIterable responses = client.describeAlarmHistoryPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmHistoryIterable responses = client
* .describeAlarmHistoryPaginator(request);
* for (software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmHistoryResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmHistoryIterable responses = client.describeAlarmHistoryPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidNextTokenException
* The next token specified is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.DescribeAlarmHistory
* @see AWS API Documentation
*/
@Override
public DescribeAlarmHistoryIterable describeAlarmHistoryPaginator(DescribeAlarmHistoryRequest describeAlarmHistoryRequest)
throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException {
return new DescribeAlarmHistoryIterable(this, applyPaginatorUserAgent(describeAlarmHistoryRequest));
}
/**
*
* 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 Result of the DescribeAlarms operation returned by the service.
* @throws InvalidNextTokenException
* The next token specified is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.DescribeAlarms
* @see AWS API
* Documentation
*/
@Override
public DescribeAlarmsResponse describeAlarms(DescribeAlarmsRequest describeAlarmsRequest) throws InvalidNextTokenException,
AwsServiceException, SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(DescribeAlarmsResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, describeAlarmsRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "DescribeAlarms");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("DescribeAlarms").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(describeAlarmsRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new DescribeAlarmsRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* 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 variant of
* {@link #describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest)} operation. The
* return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
* making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmsIterable responses = client.describeAlarmsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmsIterable responses = client
* .describeAlarmsPaginator(request);
* for (software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.DescribeAlarmsIterable responses = client.describeAlarmsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidNextTokenException
* The next token specified is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.DescribeAlarms
* @see AWS API
* Documentation
*/
@Override
public DescribeAlarmsIterable describeAlarmsPaginator(DescribeAlarmsRequest describeAlarmsRequest)
throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException {
return new DescribeAlarmsIterable(this, applyPaginatorUserAgent(describeAlarmsRequest));
}
/**
*
* 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 Result of the DescribeAlarmsForMetric operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.DescribeAlarmsForMetric
* @see AWS API Documentation
*/
@Override
public DescribeAlarmsForMetricResponse describeAlarmsForMetric(DescribeAlarmsForMetricRequest describeAlarmsForMetricRequest)
throws AwsServiceException, SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(DescribeAlarmsForMetricResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, describeAlarmsForMetricRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "DescribeAlarmsForMetric");
return clientHandler
.execute(new ClientExecutionParams()
.withOperationName("DescribeAlarmsForMetric").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(describeAlarmsForMetricRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new DescribeAlarmsForMetricRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* 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 Result of the DescribeAnomalyDetectors operation returned by the service.
* @throws InvalidNextTokenException
* The next token specified is invalid.
* @throws InternalServiceException
* Request processing has failed due to some unknown error, exception, or failure.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws InvalidParameterCombinationException
* Parameters were used together that cannot be used together.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.DescribeAnomalyDetectors
* @see AWS API Documentation
*/
@Override
public DescribeAnomalyDetectorsResponse describeAnomalyDetectors(
DescribeAnomalyDetectorsRequest describeAnomalyDetectorsRequest) throws InvalidNextTokenException,
InternalServiceException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException,
SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(DescribeAnomalyDetectorsResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, describeAnomalyDetectorsRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "DescribeAnomalyDetectors");
return clientHandler
.execute(new ClientExecutionParams()
.withOperationName("DescribeAnomalyDetectors").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(describeAnomalyDetectorsRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new DescribeAnomalyDetectorsRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* 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 Result of the DescribeInsightRules operation returned by the service.
* @throws InvalidNextTokenException
* The next token specified is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.DescribeInsightRules
* @see AWS API Documentation
*/
@Override
public DescribeInsightRulesResponse describeInsightRules(DescribeInsightRulesRequest describeInsightRulesRequest)
throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(DescribeInsightRulesResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, describeInsightRulesRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "DescribeInsightRules");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("DescribeInsightRules").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(describeInsightRulesRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new DescribeInsightRulesRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* 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 variant of
* {@link #describeInsightRules(software.amazon.awssdk.services.cloudwatch.model.DescribeInsightRulesRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.DescribeInsightRulesIterable responses = client.describeInsightRulesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.cloudwatch.paginators.DescribeInsightRulesIterable responses = client
* .describeInsightRulesPaginator(request);
* for (software.amazon.awssdk.services.cloudwatch.model.DescribeInsightRulesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.DescribeInsightRulesIterable responses = client.describeInsightRulesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidNextTokenException
* The next token specified is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.DescribeInsightRules
* @see AWS API Documentation
*/
@Override
public DescribeInsightRulesIterable describeInsightRulesPaginator(DescribeInsightRulesRequest describeInsightRulesRequest)
throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException {
return new DescribeInsightRulesIterable(this, applyPaginatorUserAgent(describeInsightRulesRequest));
}
/**
*
* 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 Result of the DisableAlarmActions operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.DisableAlarmActions
* @see AWS API Documentation
*/
@Override
public DisableAlarmActionsResponse disableAlarmActions(DisableAlarmActionsRequest disableAlarmActionsRequest)
throws AwsServiceException, SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(DisableAlarmActionsResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, disableAlarmActionsRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "DisableAlarmActions");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("DisableAlarmActions").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(disableAlarmActionsRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new DisableAlarmActionsRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Disables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do
* not incur costs.
*
*
* @param disableInsightRulesRequest
* @return Result of the DisableInsightRules operation returned by the service.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws MissingRequiredParameterException
* An input parameter that is required is missing.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.DisableInsightRules
* @see AWS API Documentation
*/
@Override
public DisableInsightRulesResponse disableInsightRules(DisableInsightRulesRequest disableInsightRulesRequest)
throws InvalidParameterValueException, MissingRequiredParameterException, AwsServiceException, SdkClientException,
CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(DisableInsightRulesResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, disableInsightRulesRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "DisableInsightRules");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("DisableInsightRules").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(disableInsightRulesRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new DisableInsightRulesRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Enables the actions for the specified alarms.
*
*
* @param enableAlarmActionsRequest
* @return Result of the EnableAlarmActions operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.EnableAlarmActions
* @see AWS
* API Documentation
*/
@Override
public EnableAlarmActionsResponse enableAlarmActions(EnableAlarmActionsRequest enableAlarmActionsRequest)
throws AwsServiceException, SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(EnableAlarmActionsResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, enableAlarmActionsRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "EnableAlarmActions");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("EnableAlarmActions").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(enableAlarmActionsRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new EnableAlarmActionsRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Enables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log
* data.
*
*
* @param enableInsightRulesRequest
* @return Result of the EnableInsightRules operation returned by the service.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws MissingRequiredParameterException
* An input parameter that is required is missing.
* @throws LimitExceededException
* The operation exceeded one or more limits.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.EnableInsightRules
* @see AWS
* API Documentation
*/
@Override
public EnableInsightRulesResponse enableInsightRules(EnableInsightRulesRequest enableInsightRulesRequest)
throws InvalidParameterValueException, MissingRequiredParameterException, LimitExceededException,
AwsServiceException, SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(EnableInsightRulesResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, enableInsightRulesRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "EnableInsightRules");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("EnableInsightRules").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(enableInsightRulesRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new EnableInsightRulesRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* 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 Result of the GetDashboard operation returned by the service.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws DashboardNotFoundErrorException
* The specified dashboard does not exist.
* @throws InternalServiceException
* Request processing has failed due to some unknown error, exception, or failure.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.GetDashboard
* @see AWS API
* Documentation
*/
@Override
public GetDashboardResponse getDashboard(GetDashboardRequest getDashboardRequest) throws InvalidParameterValueException,
DashboardNotFoundErrorException, InternalServiceException, AwsServiceException, SdkClientException,
CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(GetDashboardResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, getDashboardRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "GetDashboard");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("GetDashboard").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(getDashboardRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new GetDashboardRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* 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 Result of the GetInsightRuleReport operation returned by the service.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws MissingRequiredParameterException
* An input parameter that is required is missing.
* @throws ResourceNotFoundException
* The named resource does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.GetInsightRuleReport
* @see AWS API Documentation
*/
@Override
public GetInsightRuleReportResponse getInsightRuleReport(GetInsightRuleReportRequest getInsightRuleReportRequest)
throws InvalidParameterValueException, MissingRequiredParameterException, ResourceNotFoundException,
AwsServiceException, SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(GetInsightRuleReportResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, getInsightRuleReportRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "GetInsightRuleReport");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("GetInsightRuleReport").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(getInsightRuleReportRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new GetInsightRuleReportRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* You can use the GetMetricData API to 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 math expressions on the values of
* the returned statistics, to create new time series that represent new insights into your data. For example, using
* Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series.
* For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
*
*
* Calls to the GetMetricData API have a different pricing structure than calls to
* GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing.
*
*
* Amazon CloudWatch retains metric data as follows:
*
*
* -
*
* Data points with a period of less than 60 seconds are available for 3 hours. These data points are
* high-resolution metrics and are available only for custom metrics that have been defined with a
* StorageResolution of 1.
*
*
* -
*
* Data points with a period of 60 seconds (1-minute) are available for 15 days.
*
*
* -
*
* Data points with a period of 300 seconds (5-minute) are available for 63 days.
*
*
* -
*
* Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
*
*
*
*
* Data points that are initially published with a shorter period are aggregated together for long-term storage. For
* example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute
* resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution
* of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.
*
*
* 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.
*
*
* @param getMetricDataRequest
* @return Result of the GetMetricData operation returned by the service.
* @throws InvalidNextTokenException
* The next token specified is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.GetMetricData
* @see AWS API
* Documentation
*/
@Override
public GetMetricDataResponse getMetricData(GetMetricDataRequest getMetricDataRequest) throws InvalidNextTokenException,
AwsServiceException, SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(GetMetricDataResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, getMetricDataRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "GetMetricData");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("GetMetricData").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(getMetricDataRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new GetMetricDataRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* You can use the GetMetricData API to 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 math expressions on the values of
* the returned statistics, to create new time series that represent new insights into your data. For example, using
* Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series.
* For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
*
*
* Calls to the GetMetricData API have a different pricing structure than calls to
* GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing.
*
*
* Amazon CloudWatch retains metric data as follows:
*
*
* -
*
* Data points with a period of less than 60 seconds are available for 3 hours. These data points are
* high-resolution metrics and are available only for custom metrics that have been defined with a
* StorageResolution of 1.
*
*
* -
*
* Data points with a period of 60 seconds (1-minute) are available for 15 days.
*
*
* -
*
* Data points with a period of 300 seconds (5-minute) are available for 63 days.
*
*
* -
*
* Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
*
*
*
*
* Data points that are initially published with a shorter period are aggregated together for long-term storage. For
* example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute
* resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution
* of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.
*
*
* 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.
*
*
*
* This is a variant of
* {@link #getMetricData(software.amazon.awssdk.services.cloudwatch.model.GetMetricDataRequest)} operation. The
* return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
* making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.GetMetricDataIterable responses = client.getMetricDataPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.cloudwatch.paginators.GetMetricDataIterable responses = client
* .getMetricDataPaginator(request);
* for (software.amazon.awssdk.services.cloudwatch.model.GetMetricDataResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.GetMetricDataIterable responses = client.getMetricDataPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidNextTokenException
* The next token specified is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.GetMetricData
* @see AWS API
* Documentation
*/
@Override
public GetMetricDataIterable getMetricDataPaginator(GetMetricDataRequest getMetricDataRequest)
throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException {
return new GetMetricDataIterable(this, applyPaginatorUserAgent(getMetricDataRequest));
}
/**
*
* 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 Result of the GetMetricStatistics operation returned by the service.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws MissingRequiredParameterException
* An input parameter that is required is missing.
* @throws InvalidParameterCombinationException
* Parameters were used together that cannot be used together.
* @throws InternalServiceException
* Request processing has failed due to some unknown error, exception, or failure.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.GetMetricStatistics
* @see AWS API Documentation
*/
@Override
public GetMetricStatisticsResponse getMetricStatistics(GetMetricStatisticsRequest getMetricStatisticsRequest)
throws InvalidParameterValueException, MissingRequiredParameterException, InvalidParameterCombinationException,
InternalServiceException, AwsServiceException, SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(GetMetricStatisticsResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, getMetricStatisticsRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "GetMetricStatistics");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("GetMetricStatistics").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(getMetricStatisticsRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new GetMetricStatisticsRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Returns information about the metric stream that you specify.
*
*
* @param getMetricStreamRequest
* @return Result of the GetMetricStream operation returned by the service.
* @throws ResourceNotFoundException
* The named resource does not exist.
* @throws InternalServiceException
* Request processing has failed due to some unknown error, exception, or failure.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws MissingRequiredParameterException
* An input parameter that is required is missing.
* @throws InvalidParameterCombinationException
* Parameters were used together that cannot be used together.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.GetMetricStream
* @see AWS
* API Documentation
*/
@Override
public GetMetricStreamResponse getMetricStream(GetMetricStreamRequest getMetricStreamRequest)
throws ResourceNotFoundException, InternalServiceException, InvalidParameterValueException,
MissingRequiredParameterException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(GetMetricStreamResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, getMetricStreamRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "GetMetricStream");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("GetMetricStream").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(getMetricStreamRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new GetMetricStreamRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* 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 Result of the GetMetricWidgetImage operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.GetMetricWidgetImage
* @see AWS API Documentation
*/
@Override
public GetMetricWidgetImageResponse getMetricWidgetImage(GetMetricWidgetImageRequest getMetricWidgetImageRequest)
throws AwsServiceException, SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(GetMetricWidgetImageResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, getMetricWidgetImageRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "GetMetricWidgetImage");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("GetMetricWidgetImage").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(getMetricWidgetImageRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new GetMetricWidgetImageRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* 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 Result of the ListDashboards operation returned by the service.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws InternalServiceException
* Request processing has failed due to some unknown error, exception, or failure.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.ListDashboards
* @see AWS API
* Documentation
*/
@Override
public ListDashboardsResponse listDashboards(ListDashboardsRequest listDashboardsRequest)
throws InvalidParameterValueException, InternalServiceException, AwsServiceException, SdkClientException,
CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(ListDashboardsResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, listDashboardsRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "ListDashboards");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("ListDashboards").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(listDashboardsRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new ListDashboardsRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those
* dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.
*
*
* ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you
* can call ListDashboards again and include the value you received for NextToken in the
* first call, to receive the next 1000 results.
*
*
*
* This is a variant of
* {@link #listDashboards(software.amazon.awssdk.services.cloudwatch.model.ListDashboardsRequest)} operation. The
* return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
* making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.cloudwatch.paginators.ListDashboardsIterable responses = client
* .listDashboardsPaginator(request);
* for (software.amazon.awssdk.services.cloudwatch.model.ListDashboardsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws InternalServiceException
* Request processing has failed due to some unknown error, exception, or failure.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.ListDashboards
* @see AWS API
* Documentation
*/
@Override
public ListDashboardsIterable listDashboardsPaginator(ListDashboardsRequest listDashboardsRequest)
throws InvalidParameterValueException, InternalServiceException, AwsServiceException, SdkClientException,
CloudWatchException {
return new ListDashboardsIterable(this, applyPaginatorUserAgent(listDashboardsRequest));
}
/**
*
* Returns a list of metric streams in this account.
*
*
* @param listMetricStreamsRequest
* @return Result of the ListMetricStreams operation returned by the service.
* @throws InvalidNextTokenException
* The next token specified is invalid.
* @throws InternalServiceException
* Request processing has failed due to some unknown error, exception, or failure.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws MissingRequiredParameterException
* An input parameter that is required is missing.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.ListMetricStreams
* @see AWS
* API Documentation
*/
@Override
public ListMetricStreamsResponse listMetricStreams(ListMetricStreamsRequest listMetricStreamsRequest)
throws InvalidNextTokenException, InternalServiceException, InvalidParameterValueException,
MissingRequiredParameterException, AwsServiceException, SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(ListMetricStreamsResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, listMetricStreamsRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "ListMetricStreams");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("ListMetricStreams").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(listMetricStreamsRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new ListMetricStreamsRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Returns a list of metric streams in this account.
*
*
*
* This is a variant of
* {@link #listMetricStreams(software.amazon.awssdk.services.cloudwatch.model.ListMetricStreamsRequest)} operation.
* The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
* handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.ListMetricStreamsIterable responses = client.listMetricStreamsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.cloudwatch.paginators.ListMetricStreamsIterable responses = client
* .listMetricStreamsPaginator(request);
* for (software.amazon.awssdk.services.cloudwatch.model.ListMetricStreamsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.ListMetricStreamsIterable responses = client.listMetricStreamsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InvalidNextTokenException
* The next token specified is invalid.
* @throws InternalServiceException
* Request processing has failed due to some unknown error, exception, or failure.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws MissingRequiredParameterException
* An input parameter that is required is missing.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.ListMetricStreams
* @see AWS
* API Documentation
*/
@Override
public ListMetricStreamsIterable listMetricStreamsPaginator(ListMetricStreamsRequest listMetricStreamsRequest)
throws InvalidNextTokenException, InternalServiceException, InvalidParameterValueException,
MissingRequiredParameterException, AwsServiceException, SdkClientException, CloudWatchException {
return new ListMetricStreamsIterable(this, applyPaginatorUserAgent(listMetricStreamsRequest));
}
/**
*
* List the specified metrics. You can use the returned metrics with GetMetricData
* or
* GetMetricStatistics to obtain statistical data.
*
*
* Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with
* subsequent calls.
*
*
* After you create a metric, allow up to 15 minutes before the metric appears. You can see statistics about the
* metric sooner by using GetMetricData
* or
* GetMetricStatistics.
*
*
* 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 Result of the ListMetrics operation returned by the service.
* @throws InternalServiceException
* Request processing has failed due to some unknown error, exception, or failure.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.ListMetrics
* @see AWS API
* Documentation
*/
@Override
public ListMetricsResponse listMetrics(ListMetricsRequest listMetricsRequest) throws InternalServiceException,
InvalidParameterValueException, AwsServiceException, SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(ListMetricsResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, listMetricsRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "ListMetrics");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("ListMetrics").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(listMetricsRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new ListMetricsRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* List the specified metrics. You can use the returned metrics with GetMetricData
* or
* GetMetricStatistics to obtain statistical data.
*
*
* Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with
* subsequent calls.
*
*
* After you create a metric, allow up to 15 minutes before the metric appears. You can see statistics about the
* metric sooner by using GetMetricData
* or
* GetMetricStatistics.
*
*
* 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 variant of {@link #listMetrics(software.amazon.awssdk.services.cloudwatch.model.ListMetricsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.ListMetricsIterable responses = client.listMetricsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.cloudwatch.paginators.ListMetricsIterable responses = client.listMetricsPaginator(request);
* for (software.amazon.awssdk.services.cloudwatch.model.ListMetricsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.cloudwatch.paginators.ListMetricsIterable responses = client.listMetricsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws InternalServiceException
* Request processing has failed due to some unknown error, exception, or failure.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.ListMetrics
* @see AWS API
* Documentation
*/
@Override
public ListMetricsIterable listMetricsPaginator(ListMetricsRequest listMetricsRequest) throws InternalServiceException,
InvalidParameterValueException, AwsServiceException, SdkClientException, CloudWatchException {
return new ListMetricsIterable(this, applyPaginatorUserAgent(listMetricsRequest));
}
/**
*
* Displays the tags associated with a CloudWatch resource. Currently, alarms and Contributor Insights rules support
* tagging.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws ResourceNotFoundException
* The named resource does not exist.
* @throws InternalServiceException
* Request processing has failed due to some unknown error, exception, or failure.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.ListTagsForResource
* @see AWS API Documentation
*/
@Override
public ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
throws InvalidParameterValueException, ResourceNotFoundException, InternalServiceException, AwsServiceException,
SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(ListTagsForResourceResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, listTagsForResourceRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "ListTagsForResource");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("ListTagsForResource").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(listTagsForResourceRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new ListTagsForResourceRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Creates an anomaly detection model for a CloudWatch metric. You can use the model to display a band of expected
* normal values when the metric is graphed.
*
*
* For more information, see CloudWatch Anomaly Detection.
*
*
* @param putAnomalyDetectorRequest
* @return Result of the PutAnomalyDetector operation returned by the service.
* @throws LimitExceededException
* The operation exceeded one or more limits.
* @throws InternalServiceException
* Request processing has failed due to some unknown error, exception, or failure.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws MissingRequiredParameterException
* An input parameter that is required is missing.
* @throws InvalidParameterCombinationException
* Parameters were used together that cannot be used together.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.PutAnomalyDetector
* @see AWS
* API Documentation
*/
@Override
public PutAnomalyDetectorResponse putAnomalyDetector(PutAnomalyDetectorRequest putAnomalyDetectorRequest)
throws LimitExceededException, InternalServiceException, InvalidParameterValueException,
MissingRequiredParameterException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(PutAnomalyDetectorResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, putAnomalyDetectorRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "PutAnomalyDetector");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("PutAnomalyDetector").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(putAnomalyDetectorRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new PutAnomalyDetectorRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* 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.
*
*
* 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.
*
*
* Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics.
*
*
*
* 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 Result of the PutCompositeAlarm operation returned by the service.
* @throws LimitExceededException
* The quota for alarms for this customer has already been reached.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.PutCompositeAlarm
* @see AWS
* API Documentation
*/
@Override
public PutCompositeAlarmResponse putCompositeAlarm(PutCompositeAlarmRequest putCompositeAlarmRequest)
throws LimitExceededException, AwsServiceException, SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(PutCompositeAlarmResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, putCompositeAlarmRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "PutCompositeAlarm");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("PutCompositeAlarm").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(putCompositeAlarmRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new PutCompositeAlarmRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* 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 Result of the PutDashboard operation returned by the service.
* @throws DashboardInvalidInputErrorException
* Some part of the dashboard data is invalid.
* @throws InternalServiceException
* Request processing has failed due to some unknown error, exception, or failure.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.PutDashboard
* @see AWS API
* Documentation
*/
@Override
public PutDashboardResponse putDashboard(PutDashboardRequest putDashboardRequest) throws DashboardInvalidInputErrorException,
InternalServiceException, AwsServiceException, SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(PutDashboardResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, putDashboardRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "PutDashboard");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("PutDashboard").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(putDashboardRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new PutDashboardRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* 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 Result of the PutInsightRule operation returned by the service.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws MissingRequiredParameterException
* An input parameter that is required is missing.
* @throws LimitExceededException
* The operation exceeded one or more limits.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.PutInsightRule
* @see AWS API
* Documentation
*/
@Override
public PutInsightRuleResponse putInsightRule(PutInsightRuleRequest putInsightRuleRequest)
throws InvalidParameterValueException, MissingRequiredParameterException, LimitExceededException,
AwsServiceException, SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(PutInsightRuleResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, putInsightRuleRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "PutInsightRule");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("PutInsightRule").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(putInsightRuleRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new PutInsightRuleRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly
* detection model.
*
*
* Alarms based on anomaly detection models cannot have Auto Scaling actions.
*
*
* When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The
* alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then
* executed.
*
*
* When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous
* configuration of the alarm.
*
*
* If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:
*
*
* -
*
* The iam:CreateServiceLinkedRole for all alarms with EC2 actions
*
*
* -
*
* The iam:CreateServiceLinkedRole to create an alarm with Systems Manager OpsItem 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.
*
*
* 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 Result of the PutMetricAlarm operation returned by the service.
* @throws LimitExceededException
* The quota for alarms for this customer has already been reached.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.PutMetricAlarm
* @see AWS API
* Documentation
*/
@Override
public PutMetricAlarmResponse putMetricAlarm(PutMetricAlarmRequest putMetricAlarmRequest) throws LimitExceededException,
AwsServiceException, SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(PutMetricAlarmResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, putMetricAlarmRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "PutMetricAlarm");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("PutMetricAlarm").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(putMetricAlarmRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new PutMetricAlarmRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified
* metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric,
* it can take up to fifteen minutes for the metric to appear in calls to ListMetrics.
*
*
* You can publish either individual data points in the Value field, or arrays of values and the number
* of times each value occurred during the period by using the Values and Counts fields in
* the MetricDatum structure. Using the Values and Counts method enables you
* to publish up to 150 values per metric with one PutMetricData request, and supports retrieving
* percentile statistics on this data.
*
*
* Each PutMetricData request is limited to 40 KB in size for HTTP POST requests. You can send a
* payload compressed by gzip. Each request is also limited to no more than 20 different metrics.
*
*
* Although the Value parameter accepts numbers of type Double, CloudWatch rejects values
* that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special
* values (for example, NaN, +Infinity, -Infinity) are not supported.
*
*
* You can use up to 10 dimensions per metric to further clarify what data the metric collects. Each dimension
* consists of a Name and Value pair. For more information about specifying dimensions, see Publishing
* Metrics in the Amazon CloudWatch User Guide.
*
*
* 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 Result of the PutMetricData operation returned by the service.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws MissingRequiredParameterException
* An input parameter that is required is missing.
* @throws InvalidParameterCombinationException
* Parameters were used together that cannot be used together.
* @throws InternalServiceException
* Request processing has failed due to some unknown error, exception, or failure.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.PutMetricData
* @see AWS API
* Documentation
*/
@Override
public PutMetricDataResponse putMetricData(PutMetricDataRequest putMetricDataRequest) throws InvalidParameterValueException,
MissingRequiredParameterException, InvalidParameterCombinationException, InternalServiceException,
AwsServiceException, SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(PutMetricDataResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, putMetricDataRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "PutMetricData");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("PutMetricData").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(putMetricDataRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new PutMetricDataRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* 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 logged on 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.
*
*
*
*
* 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.
*
*
* @param putMetricStreamRequest
* @return Result of the PutMetricStream operation returned by the service.
* @throws ConcurrentModificationException
* More than one process tried to modify a resource at the same time.
* @throws InternalServiceException
* Request processing has failed due to some unknown error, exception, or failure.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws MissingRequiredParameterException
* An input parameter that is required is missing.
* @throws InvalidParameterCombinationException
* Parameters were used together that cannot be used together.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.PutMetricStream
* @see AWS
* API Documentation
*/
@Override
public PutMetricStreamResponse putMetricStream(PutMetricStreamRequest putMetricStreamRequest)
throws ConcurrentModificationException, InternalServiceException, InvalidParameterValueException,
MissingRequiredParameterException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(PutMetricStreamResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, putMetricStreamRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "PutMetricStream");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("PutMetricStream").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(putMetricStreamRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new PutMetricStreamRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* 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 Result of the SetAlarmState operation returned by the service.
* @throws ResourceNotFoundException
* The named resource does not exist.
* @throws InvalidFormatException
* Data was not syntactically valid JSON.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.SetAlarmState
* @see AWS API
* Documentation
*/
@Override
public SetAlarmStateResponse setAlarmState(SetAlarmStateRequest setAlarmStateRequest) throws ResourceNotFoundException,
InvalidFormatException, AwsServiceException, SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(SetAlarmStateResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, setAlarmStateRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "SetAlarmState");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("SetAlarmState").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(setAlarmStateRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new SetAlarmStateRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Starts the streaming of metrics for one or more of your metric streams.
*
*
* @param startMetricStreamsRequest
* @return Result of the StartMetricStreams operation returned by the service.
* @throws InternalServiceException
* Request processing has failed due to some unknown error, exception, or failure.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws MissingRequiredParameterException
* An input parameter that is required is missing.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.StartMetricStreams
* @see AWS
* API Documentation
*/
@Override
public StartMetricStreamsResponse startMetricStreams(StartMetricStreamsRequest startMetricStreamsRequest)
throws InternalServiceException, InvalidParameterValueException, MissingRequiredParameterException,
AwsServiceException, SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(StartMetricStreamsResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, startMetricStreamsRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "StartMetricStreams");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("StartMetricStreams").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(startMetricStreamsRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new StartMetricStreamsRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Stops the streaming of metrics for one or more of your metric streams.
*
*
* @param stopMetricStreamsRequest
* @return Result of the StopMetricStreams operation returned by the service.
* @throws InternalServiceException
* Request processing has failed due to some unknown error, exception, or failure.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws MissingRequiredParameterException
* An input parameter that is required is missing.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.StopMetricStreams
* @see AWS
* API Documentation
*/
@Override
public StopMetricStreamsResponse stopMetricStreams(StopMetricStreamsRequest stopMetricStreamsRequest)
throws InternalServiceException, InvalidParameterValueException, MissingRequiredParameterException,
AwsServiceException, SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(StopMetricStreamsResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, stopMetricStreamsRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "StopMetricStreams");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("StopMetricStreams").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(stopMetricStreamsRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new StopMetricStreamsRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* 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 Result of the TagResource operation returned by the service.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws ResourceNotFoundException
* The named resource does not exist.
* @throws ConcurrentModificationException
* More than one process tried to modify a resource at the same time.
* @throws InternalServiceException
* Request processing has failed due to some unknown error, exception, or failure.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.TagResource
* @see AWS API
* Documentation
*/
@Override
public TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidParameterValueException,
ResourceNotFoundException, ConcurrentModificationException, InternalServiceException, AwsServiceException,
SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(TagResourceResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, tagResourceRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "TagResource");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("TagResource").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(tagResourceRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new TagResourceRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
/**
*
* Removes one or more tags from the specified resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws ResourceNotFoundException
* The named resource does not exist.
* @throws ConcurrentModificationException
* More than one process tried to modify a resource at the same time.
* @throws InternalServiceException
* Request processing has failed due to some unknown error, exception, or failure.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws CloudWatchException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample CloudWatchClient.UntagResource
* @see AWS API
* Documentation
*/
@Override
public UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidParameterValueException,
ResourceNotFoundException, ConcurrentModificationException, InternalServiceException, AwsServiceException,
SdkClientException, CloudWatchException {
HttpResponseHandler responseHandler = protocolFactory
.createResponseHandler(UntagResourceResponse::builder);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler();
List metricPublishers = resolveMetricPublishers(clientConfiguration, untagResourceRequest
.overrideConfiguration().orElse(null));
MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
.create("ApiCall");
try {
apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "CloudWatch");
apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "UntagResource");
return clientHandler.execute(new ClientExecutionParams()
.withOperationName("UntagResource").withResponseHandler(responseHandler)
.withErrorResponseHandler(errorResponseHandler).withInput(untagResourceRequest)
.withMetricCollector(apiCallMetricCollector)
.withMarshaller(new UntagResourceRequestMarshaller(protocolFactory)));
} finally {
metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
}
}
private static List resolveMetricPublishers(SdkClientConfiguration clientConfiguration,
RequestOverrideConfiguration requestOverrideConfiguration) {
List publishers = null;
if (requestOverrideConfiguration != null) {
publishers = requestOverrideConfiguration.metricPublishers();
}
if (publishers == null || publishers.isEmpty()) {
publishers = clientConfiguration.option(SdkClientOption.METRIC_PUBLISHERS);
}
if (publishers == null) {
publishers = Collections.emptyList();
}
return publishers;
}
private AwsQueryProtocolFactory init() {
return AwsQueryProtocolFactory
.builder()
.registerModeledException(
ExceptionMetadata.builder().errorCode("ConcurrentModificationException")
.exceptionBuilderSupplier(ConcurrentModificationException::builder).httpStatusCode(429).build())
.registerModeledException(
ExceptionMetadata.builder().errorCode("InvalidParameterValue")
.exceptionBuilderSupplier(InvalidParameterValueException::builder).httpStatusCode(400).build())
.registerModeledException(
ExceptionMetadata.builder().errorCode("InvalidFormat")
.exceptionBuilderSupplier(InvalidFormatException::builder).httpStatusCode(400).build())
.registerModeledException(
ExceptionMetadata.builder().errorCode("MissingParameter")
.exceptionBuilderSupplier(MissingRequiredParameterException::builder).httpStatusCode(400).build())
.registerModeledException(
ExceptionMetadata.builder().errorCode("InvalidNextToken")
.exceptionBuilderSupplier(InvalidNextTokenException::builder).httpStatusCode(400).build())
.registerModeledException(
ExceptionMetadata.builder().errorCode("LimitExceeded")
.exceptionBuilderSupplier(LimitExceededException::builder).httpStatusCode(400).build())
.registerModeledException(
ExceptionMetadata.builder().errorCode("ResourceNotFoundException")
.exceptionBuilderSupplier(ResourceNotFoundException::builder).httpStatusCode(404).build())
.registerModeledException(
ExceptionMetadata.builder().errorCode("InvalidParameterCombination")
.exceptionBuilderSupplier(InvalidParameterCombinationException::builder).httpStatusCode(400)
.build())
.registerModeledException(
ExceptionMetadata.builder().errorCode("ResourceNotFound")
.exceptionBuilderSupplier(DashboardNotFoundErrorException::builder).httpStatusCode(404).build())
.registerModeledException(
ExceptionMetadata.builder().errorCode("InvalidParameterInput")
.exceptionBuilderSupplier(DashboardInvalidInputErrorException::builder).httpStatusCode(400)
.build())
.registerModeledException(
ExceptionMetadata.builder().errorCode("InternalServiceError")
.exceptionBuilderSupplier(InternalServiceException::builder).httpStatusCode(500).build())
.clientConfiguration(clientConfiguration).defaultServiceExceptionSupplier(CloudWatchException::builder).build();
}
@Override
public void close() {
clientHandler.close();
}
private T applyPaginatorUserAgent(T request) {
Consumer userAgentApplier = b -> b.addApiName(ApiName.builder()
.version(VersionInfo.SDK_VERSION).name("PAGINATED").build());
AwsRequestOverrideConfiguration overrideConfiguration = request.overrideConfiguration()
.map(c -> c.toBuilder().applyMutation(userAgentApplier).build())
.orElse((AwsRequestOverrideConfiguration.builder().applyMutation(userAgentApplier).build()));
return (T) request.toBuilder().overrideConfiguration(overrideConfiguration).build();
}
@Override
public CloudWatchWaiter waiter() {
return CloudWatchWaiter.builder().client(this).build();
}
}