@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface CloudWatchClient extends SdkClient
builder()
method.
Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the applications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications.
CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money.
In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static CloudWatchClientBuilder |
builder()
Create a builder that can be used to configure and create a
CloudWatchClient . |
static CloudWatchClient |
create()
Create a
CloudWatchClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default DeleteAlarmsResponse |
deleteAlarms(Consumer<DeleteAlarmsRequest.Builder> deleteAlarmsRequest)
Deletes the specified alarms.
|
default DeleteAlarmsResponse |
deleteAlarms(DeleteAlarmsRequest deleteAlarmsRequest)
Deletes the specified alarms.
|
default DeleteAnomalyDetectorResponse |
deleteAnomalyDetector(Consumer<DeleteAnomalyDetectorRequest.Builder> deleteAnomalyDetectorRequest)
Deletes the specified anomaly detection model from your account.
|
default DeleteAnomalyDetectorResponse |
deleteAnomalyDetector(DeleteAnomalyDetectorRequest deleteAnomalyDetectorRequest)
Deletes the specified anomaly detection model from your account.
|
default DeleteDashboardsResponse |
deleteDashboards(Consumer<DeleteDashboardsRequest.Builder> deleteDashboardsRequest)
Deletes all dashboards that you specify.
|
default DeleteDashboardsResponse |
deleteDashboards(DeleteDashboardsRequest deleteDashboardsRequest)
Deletes all dashboards that you specify.
|
default DeleteInsightRulesResponse |
deleteInsightRules(Consumer<DeleteInsightRulesRequest.Builder> deleteInsightRulesRequest)
Permanently deletes the specified Contributor Insights rules.
|
default DeleteInsightRulesResponse |
deleteInsightRules(DeleteInsightRulesRequest deleteInsightRulesRequest)
Permanently deletes the specified Contributor Insights rules.
|
default DeleteMetricStreamResponse |
deleteMetricStream(Consumer<DeleteMetricStreamRequest.Builder> deleteMetricStreamRequest)
Permanently deletes the metric stream that you specify.
|
default DeleteMetricStreamResponse |
deleteMetricStream(DeleteMetricStreamRequest deleteMetricStreamRequest)
Permanently deletes the metric stream that you specify.
|
default DescribeAlarmHistoryResponse |
describeAlarmHistory()
Retrieves the history for the specified alarm.
|
default DescribeAlarmHistoryResponse |
describeAlarmHistory(Consumer<DescribeAlarmHistoryRequest.Builder> describeAlarmHistoryRequest)
Retrieves the history for the specified alarm.
|
default DescribeAlarmHistoryResponse |
describeAlarmHistory(DescribeAlarmHistoryRequest describeAlarmHistoryRequest)
Retrieves the history for the specified alarm.
|
default DescribeAlarmHistoryIterable |
describeAlarmHistoryPaginator()
Retrieves the history for the specified alarm.
|
default DescribeAlarmHistoryIterable |
describeAlarmHistoryPaginator(Consumer<DescribeAlarmHistoryRequest.Builder> describeAlarmHistoryRequest)
Retrieves the history for the specified alarm.
|
default DescribeAlarmHistoryIterable |
describeAlarmHistoryPaginator(DescribeAlarmHistoryRequest describeAlarmHistoryRequest)
Retrieves the history for the specified alarm.
|
default DescribeAlarmsResponse |
describeAlarms()
Retrieves the specified alarms.
|
default DescribeAlarmsResponse |
describeAlarms(Consumer<DescribeAlarmsRequest.Builder> describeAlarmsRequest)
Retrieves the specified alarms.
|
default DescribeAlarmsResponse |
describeAlarms(DescribeAlarmsRequest describeAlarmsRequest)
Retrieves the specified alarms.
|
default DescribeAlarmsForMetricResponse |
describeAlarmsForMetric(Consumer<DescribeAlarmsForMetricRequest.Builder> describeAlarmsForMetricRequest)
Retrieves the alarms for the specified metric.
|
default DescribeAlarmsForMetricResponse |
describeAlarmsForMetric(DescribeAlarmsForMetricRequest describeAlarmsForMetricRequest)
Retrieves the alarms for the specified metric.
|
default DescribeAlarmsIterable |
describeAlarmsPaginator()
Retrieves the specified alarms.
|
default DescribeAlarmsIterable |
describeAlarmsPaginator(Consumer<DescribeAlarmsRequest.Builder> describeAlarmsRequest)
Retrieves the specified alarms.
|
default DescribeAlarmsIterable |
describeAlarmsPaginator(DescribeAlarmsRequest describeAlarmsRequest)
Retrieves the specified alarms.
|
default DescribeAnomalyDetectorsResponse |
describeAnomalyDetectors(Consumer<DescribeAnomalyDetectorsRequest.Builder> describeAnomalyDetectorsRequest)
Lists the anomaly detection models that you have created in your account.
|
default DescribeAnomalyDetectorsResponse |
describeAnomalyDetectors(DescribeAnomalyDetectorsRequest describeAnomalyDetectorsRequest)
Lists the anomaly detection models that you have created in your account.
|
default DescribeAnomalyDetectorsIterable |
describeAnomalyDetectorsPaginator(Consumer<DescribeAnomalyDetectorsRequest.Builder> describeAnomalyDetectorsRequest)
Lists the anomaly detection models that you have created in your account.
|
default DescribeAnomalyDetectorsIterable |
describeAnomalyDetectorsPaginator(DescribeAnomalyDetectorsRequest describeAnomalyDetectorsRequest)
Lists the anomaly detection models that you have created in your account.
|
default DescribeInsightRulesResponse |
describeInsightRules(Consumer<DescribeInsightRulesRequest.Builder> describeInsightRulesRequest)
Returns a list of all the Contributor Insights rules in your account.
|
default DescribeInsightRulesResponse |
describeInsightRules(DescribeInsightRulesRequest describeInsightRulesRequest)
Returns a list of all the Contributor Insights rules in your account.
|
default DescribeInsightRulesIterable |
describeInsightRulesPaginator(Consumer<DescribeInsightRulesRequest.Builder> describeInsightRulesRequest)
Returns a list of all the Contributor Insights rules in your account.
|
default DescribeInsightRulesIterable |
describeInsightRulesPaginator(DescribeInsightRulesRequest describeInsightRulesRequest)
Returns a list of all the Contributor Insights rules in your account.
|
default DisableAlarmActionsResponse |
disableAlarmActions(Consumer<DisableAlarmActionsRequest.Builder> disableAlarmActionsRequest)
Disables the actions for the specified alarms.
|
default DisableAlarmActionsResponse |
disableAlarmActions(DisableAlarmActionsRequest disableAlarmActionsRequest)
Disables the actions for the specified alarms.
|
default DisableInsightRulesResponse |
disableInsightRules(Consumer<DisableInsightRulesRequest.Builder> disableInsightRulesRequest)
Disables the specified Contributor Insights rules.
|
default DisableInsightRulesResponse |
disableInsightRules(DisableInsightRulesRequest disableInsightRulesRequest)
Disables the specified Contributor Insights rules.
|
default EnableAlarmActionsResponse |
enableAlarmActions(Consumer<EnableAlarmActionsRequest.Builder> enableAlarmActionsRequest)
Enables the actions for the specified alarms.
|
default EnableAlarmActionsResponse |
enableAlarmActions(EnableAlarmActionsRequest enableAlarmActionsRequest)
Enables the actions for the specified alarms.
|
default EnableInsightRulesResponse |
enableInsightRules(Consumer<EnableInsightRulesRequest.Builder> enableInsightRulesRequest)
Enables the specified Contributor Insights rules.
|
default EnableInsightRulesResponse |
enableInsightRules(EnableInsightRulesRequest enableInsightRulesRequest)
Enables the specified Contributor Insights rules.
|
default GetDashboardResponse |
getDashboard(Consumer<GetDashboardRequest.Builder> getDashboardRequest)
Displays the details of the dashboard that you specify.
|
default GetDashboardResponse |
getDashboard(GetDashboardRequest getDashboardRequest)
Displays the details of the dashboard that you specify.
|
default GetInsightRuleReportResponse |
getInsightRuleReport(Consumer<GetInsightRuleReportRequest.Builder> getInsightRuleReportRequest)
This operation returns the time series data collected by a Contributor Insights rule.
|
default GetInsightRuleReportResponse |
getInsightRuleReport(GetInsightRuleReportRequest getInsightRuleReportRequest)
This operation returns the time series data collected by a Contributor Insights rule.
|
default GetMetricDataResponse |
getMetricData(Consumer<GetMetricDataRequest.Builder> getMetricDataRequest)
You can use the
GetMetricData API to retrieve CloudWatch metric values. |
default GetMetricDataResponse |
getMetricData(GetMetricDataRequest getMetricDataRequest)
You can use the
GetMetricData API to retrieve CloudWatch metric values. |
default GetMetricDataIterable |
getMetricDataPaginator(Consumer<GetMetricDataRequest.Builder> getMetricDataRequest)
You can use the
GetMetricData API to retrieve CloudWatch metric values. |
default GetMetricDataIterable |
getMetricDataPaginator(GetMetricDataRequest getMetricDataRequest)
You can use the
GetMetricData API to retrieve CloudWatch metric values. |
default GetMetricStatisticsResponse |
getMetricStatistics(Consumer<GetMetricStatisticsRequest.Builder> getMetricStatisticsRequest)
Gets statistics for the specified metric.
|
default GetMetricStatisticsResponse |
getMetricStatistics(GetMetricStatisticsRequest getMetricStatisticsRequest)
Gets statistics for the specified metric.
|
default GetMetricStreamResponse |
getMetricStream(Consumer<GetMetricStreamRequest.Builder> getMetricStreamRequest)
Returns information about the metric stream that you specify.
|
default GetMetricStreamResponse |
getMetricStream(GetMetricStreamRequest getMetricStreamRequest)
Returns information about the metric stream that you specify.
|
default GetMetricWidgetImageResponse |
getMetricWidgetImage(Consumer<GetMetricWidgetImageRequest.Builder> getMetricWidgetImageRequest)
You can use the
GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon
CloudWatch metrics as a bitmap image. |
default GetMetricWidgetImageResponse |
getMetricWidgetImage(GetMetricWidgetImageRequest getMetricWidgetImageRequest)
You can use the
GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon
CloudWatch metrics as a bitmap image. |
default ListDashboardsResponse |
listDashboards()
Returns a list of the dashboards for your account.
|
default ListDashboardsResponse |
listDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)
Returns a list of the dashboards for your account.
|
default ListDashboardsResponse |
listDashboards(ListDashboardsRequest listDashboardsRequest)
Returns a list of the dashboards for your account.
|
default ListDashboardsIterable |
listDashboardsPaginator()
Returns a list of the dashboards for your account.
|
default ListDashboardsIterable |
listDashboardsPaginator(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)
Returns a list of the dashboards for your account.
|
default ListDashboardsIterable |
listDashboardsPaginator(ListDashboardsRequest listDashboardsRequest)
Returns a list of the dashboards for your account.
|
default ListManagedInsightRulesResponse |
listManagedInsightRules(Consumer<ListManagedInsightRulesRequest.Builder> listManagedInsightRulesRequest)
Returns a list that contains the number of managed Contributor Insights rules in your account.
|
default ListManagedInsightRulesResponse |
listManagedInsightRules(ListManagedInsightRulesRequest listManagedInsightRulesRequest)
Returns a list that contains the number of managed Contributor Insights rules in your account.
|
default ListManagedInsightRulesIterable |
listManagedInsightRulesPaginator(Consumer<ListManagedInsightRulesRequest.Builder> listManagedInsightRulesRequest)
Returns a list that contains the number of managed Contributor Insights rules in your account.
|
default ListManagedInsightRulesIterable |
listManagedInsightRulesPaginator(ListManagedInsightRulesRequest listManagedInsightRulesRequest)
Returns a list that contains the number of managed Contributor Insights rules in your account.
|
default ListMetricsResponse |
listMetrics()
List the specified metrics.
|
default ListMetricsResponse |
listMetrics(Consumer<ListMetricsRequest.Builder> listMetricsRequest)
List the specified metrics.
|
default ListMetricsResponse |
listMetrics(ListMetricsRequest listMetricsRequest)
List the specified metrics.
|
default ListMetricsIterable |
listMetricsPaginator()
List the specified metrics.
|
default ListMetricsIterable |
listMetricsPaginator(Consumer<ListMetricsRequest.Builder> listMetricsRequest)
List the specified metrics.
|
default ListMetricsIterable |
listMetricsPaginator(ListMetricsRequest listMetricsRequest)
List the specified metrics.
|
default ListMetricStreamsResponse |
listMetricStreams(Consumer<ListMetricStreamsRequest.Builder> listMetricStreamsRequest)
Returns a list of metric streams in this account.
|
default ListMetricStreamsResponse |
listMetricStreams(ListMetricStreamsRequest listMetricStreamsRequest)
Returns a list of metric streams in this account.
|
default ListMetricStreamsIterable |
listMetricStreamsPaginator(Consumer<ListMetricStreamsRequest.Builder> listMetricStreamsRequest)
Returns a list of metric streams in this account.
|
default ListMetricStreamsIterable |
listMetricStreamsPaginator(ListMetricStreamsRequest listMetricStreamsRequest)
Returns a list of metric streams in this account.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Displays the tags associated with a CloudWatch resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with a CloudWatch resource.
|
default PutAnomalyDetectorResponse |
putAnomalyDetector(Consumer<PutAnomalyDetectorRequest.Builder> putAnomalyDetectorRequest)
Creates an anomaly detection model for a CloudWatch metric.
|
default PutAnomalyDetectorResponse |
putAnomalyDetector(PutAnomalyDetectorRequest putAnomalyDetectorRequest)
Creates an anomaly detection model for a CloudWatch metric.
|
default PutCompositeAlarmResponse |
putCompositeAlarm(Consumer<PutCompositeAlarmRequest.Builder> putCompositeAlarmRequest)
Creates or updates a composite alarm.
|
default PutCompositeAlarmResponse |
putCompositeAlarm(PutCompositeAlarmRequest putCompositeAlarmRequest)
Creates or updates a composite alarm.
|
default PutDashboardResponse |
putDashboard(Consumer<PutDashboardRequest.Builder> putDashboardRequest)
Creates a dashboard if it does not already exist, or updates an existing dashboard.
|
default PutDashboardResponse |
putDashboard(PutDashboardRequest putDashboardRequest)
Creates a dashboard if it does not already exist, or updates an existing dashboard.
|
default PutInsightRuleResponse |
putInsightRule(Consumer<PutInsightRuleRequest.Builder> putInsightRuleRequest)
Creates a Contributor Insights rule.
|
default PutInsightRuleResponse |
putInsightRule(PutInsightRuleRequest putInsightRuleRequest)
Creates a Contributor Insights rule.
|
default PutManagedInsightRulesResponse |
putManagedInsightRules(Consumer<PutManagedInsightRulesRequest.Builder> putManagedInsightRulesRequest)
Creates a managed Contributor Insights rule for a specified Amazon Web Services resource.
|
default PutManagedInsightRulesResponse |
putManagedInsightRules(PutManagedInsightRulesRequest putManagedInsightRulesRequest)
Creates a managed Contributor Insights rule for a specified Amazon Web Services resource.
|
default PutMetricAlarmResponse |
putMetricAlarm(Consumer<PutMetricAlarmRequest.Builder> putMetricAlarmRequest)
Creates or updates an alarm and associates it with the specified metric, metric math expression, anomaly
detection model, or Metrics Insights query.
|
default PutMetricAlarmResponse |
putMetricAlarm(PutMetricAlarmRequest putMetricAlarmRequest)
Creates or updates an alarm and associates it with the specified metric, metric math expression, anomaly
detection model, or Metrics Insights query.
|
default PutMetricDataResponse |
putMetricData(Consumer<PutMetricDataRequest.Builder> putMetricDataRequest)
Publishes metric data points to Amazon CloudWatch.
|
default PutMetricDataResponse |
putMetricData(PutMetricDataRequest putMetricDataRequest)
Publishes metric data points to Amazon CloudWatch.
|
default PutMetricStreamResponse |
putMetricStream(Consumer<PutMetricStreamRequest.Builder> putMetricStreamRequest)
Creates or updates a metric stream.
|
default PutMetricStreamResponse |
putMetricStream(PutMetricStreamRequest putMetricStreamRequest)
Creates or updates a metric stream.
|
static ServiceMetadata |
serviceMetadata() |
default SetAlarmStateResponse |
setAlarmState(Consumer<SetAlarmStateRequest.Builder> setAlarmStateRequest)
Temporarily sets the state of an alarm for testing purposes.
|
default SetAlarmStateResponse |
setAlarmState(SetAlarmStateRequest setAlarmStateRequest)
Temporarily sets the state of an alarm for testing purposes.
|
default StartMetricStreamsResponse |
startMetricStreams(Consumer<StartMetricStreamsRequest.Builder> startMetricStreamsRequest)
Starts the streaming of metrics for one or more of your metric streams.
|
default StartMetricStreamsResponse |
startMetricStreams(StartMetricStreamsRequest startMetricStreamsRequest)
Starts the streaming of metrics for one or more of your metric streams.
|
default StopMetricStreamsResponse |
stopMetricStreams(Consumer<StopMetricStreamsRequest.Builder> stopMetricStreamsRequest)
Stops the streaming of metrics for one or more of your metric streams.
|
default StopMetricStreamsResponse |
stopMetricStreams(StopMetricStreamsRequest stopMetricStreamsRequest)
Stops the streaming of metrics for one or more of your metric streams.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified CloudWatch resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified CloudWatch resource.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes one or more tags from the specified resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified resource.
|
default CloudWatchWaiter |
waiter()
Create an instance of
CloudWatchWaiter using this client. |
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.static CloudWatchClient create()
CloudWatchClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static CloudWatchClientBuilder builder()
CloudWatchClient
.default DeleteAlarmsResponse deleteAlarms(DeleteAlarmsRequest deleteAlarmsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, CloudWatchException
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.
deleteAlarmsRequest
- ResourceNotFoundException
- The named resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteAlarmsResponse deleteAlarms(Consumer<DeleteAlarmsRequest.Builder> deleteAlarmsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, CloudWatchException
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.
This is a convenience which creates an instance of the DeleteAlarmsRequest.Builder
avoiding the need to
create one manually via DeleteAlarmsRequest.builder()
deleteAlarmsRequest
- A Consumer
that will call methods on DeleteAlarmsInput.Builder
to create a request.ResourceNotFoundException
- The named resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteAnomalyDetectorResponse deleteAnomalyDetector(DeleteAnomalyDetectorRequest deleteAnomalyDetectorRequest) throws ResourceNotFoundException, InternalServiceException, InvalidParameterValueException, MissingRequiredParameterException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, CloudWatchException
Deletes the specified anomaly detection model from your account. For more information about how to delete an anomaly detection model, see Deleting an anomaly detection model in the CloudWatch User Guide.
deleteAnomalyDetectorRequest
- ResourceNotFoundException
- The named resource does not exist.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.InvalidParameterCombinationException
- Parameters were used together that cannot be used together.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteAnomalyDetectorResponse deleteAnomalyDetector(Consumer<DeleteAnomalyDetectorRequest.Builder> deleteAnomalyDetectorRequest) throws ResourceNotFoundException, InternalServiceException, InvalidParameterValueException, MissingRequiredParameterException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, CloudWatchException
Deletes the specified anomaly detection model from your account. For more information about how to delete an anomaly detection model, see Deleting an anomaly detection model in the CloudWatch User Guide.
This is a convenience which creates an instance of the DeleteAnomalyDetectorRequest.Builder
avoiding the
need to create one manually via DeleteAnomalyDetectorRequest.builder()
deleteAnomalyDetectorRequest
- A Consumer
that will call methods on DeleteAnomalyDetectorInput.Builder
to create a
request.ResourceNotFoundException
- The named resource does not exist.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.InvalidParameterCombinationException
- Parameters were used together that cannot be used together.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDashboardsResponse deleteDashboards(DeleteDashboardsRequest deleteDashboardsRequest) throws InvalidParameterValueException, DashboardNotFoundErrorException, InternalServiceException, AwsServiceException, SdkClientException, CloudWatchException
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.
deleteDashboardsRequest
- InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.DashboardNotFoundErrorException
- The specified dashboard does not exist.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDashboardsResponse deleteDashboards(Consumer<DeleteDashboardsRequest.Builder> deleteDashboardsRequest) throws InvalidParameterValueException, DashboardNotFoundErrorException, InternalServiceException, AwsServiceException, SdkClientException, CloudWatchException
Deletes all dashboards that you specify. You can specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.
This is a convenience which creates an instance of the DeleteDashboardsRequest.Builder
avoiding the need
to create one manually via DeleteDashboardsRequest.builder()
deleteDashboardsRequest
- A Consumer
that will call methods on DeleteDashboardsInput.Builder
to create a request.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.DashboardNotFoundErrorException
- The specified dashboard does not exist.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteInsightRulesResponse deleteInsightRules(DeleteInsightRulesRequest deleteInsightRulesRequest) throws InvalidParameterValueException, MissingRequiredParameterException, AwsServiceException, SdkClientException, CloudWatchException
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.
deleteInsightRulesRequest
- InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteInsightRulesResponse deleteInsightRules(Consumer<DeleteInsightRulesRequest.Builder> deleteInsightRulesRequest) throws InvalidParameterValueException, MissingRequiredParameterException, AwsServiceException, SdkClientException, CloudWatchException
Permanently deletes the specified Contributor Insights rules.
If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.
This is a convenience which creates an instance of the DeleteInsightRulesRequest.Builder
avoiding the
need to create one manually via DeleteInsightRulesRequest.builder()
deleteInsightRulesRequest
- A Consumer
that will call methods on DeleteInsightRulesInput.Builder
to create a request.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteMetricStreamResponse deleteMetricStream(DeleteMetricStreamRequest deleteMetricStreamRequest) throws InternalServiceException, InvalidParameterValueException, MissingRequiredParameterException, AwsServiceException, SdkClientException, CloudWatchException
Permanently deletes the metric stream that you specify.
deleteMetricStreamRequest
- InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteMetricStreamResponse deleteMetricStream(Consumer<DeleteMetricStreamRequest.Builder> deleteMetricStreamRequest) throws InternalServiceException, InvalidParameterValueException, MissingRequiredParameterException, AwsServiceException, SdkClientException, CloudWatchException
Permanently deletes the metric stream that you specify.
This is a convenience which creates an instance of the DeleteMetricStreamRequest.Builder
avoiding the
need to create one manually via DeleteMetricStreamRequest.builder()
deleteMetricStreamRequest
- A Consumer
that will call methods on DeleteMetricStreamInput.Builder
to create a request.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAlarmHistoryResponse describeAlarmHistory() throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
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.
InvalidNextTokenException
- The next token specified is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeAlarmHistory(DescribeAlarmHistoryRequest)
,
AWS API Documentationdefault DescribeAlarmHistoryResponse describeAlarmHistory(DescribeAlarmHistoryRequest describeAlarmHistoryRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
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.
describeAlarmHistoryRequest
- InvalidNextTokenException
- The next token specified is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAlarmHistoryResponse describeAlarmHistory(Consumer<DescribeAlarmHistoryRequest.Builder> describeAlarmHistoryRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.
CloudWatch retains the history of an alarm even if you delete the alarm.
To use this operation and return information about a composite alarm, you must be signed on with the
cloudwatch:DescribeAlarmHistory
permission that is scoped to *
. You can't return
information about composite alarms if your cloudwatch:DescribeAlarmHistory
permission has a narrower
scope.
This is a convenience which creates an instance of the DescribeAlarmHistoryRequest.Builder
avoiding the
need to create one manually via DescribeAlarmHistoryRequest.builder()
describeAlarmHistoryRequest
- A Consumer
that will call methods on DescribeAlarmHistoryInput.Builder
to create a
request.InvalidNextTokenException
- The next token specified is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAlarmHistoryIterable describeAlarmHistoryPaginator() throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
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
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
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
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
describeAlarmHistory(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmHistoryRequest)
operation.
InvalidNextTokenException
- The next token specified is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeAlarmHistoryPaginator(DescribeAlarmHistoryRequest)
,
AWS API Documentationdefault DescribeAlarmHistoryIterable describeAlarmHistoryPaginator(DescribeAlarmHistoryRequest describeAlarmHistoryRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
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
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
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
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
describeAlarmHistory(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmHistoryRequest)
operation.
describeAlarmHistoryRequest
- InvalidNextTokenException
- The next token specified is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAlarmHistoryIterable describeAlarmHistoryPaginator(Consumer<DescribeAlarmHistoryRequest.Builder> describeAlarmHistoryRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
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
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
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
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
describeAlarmHistory(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmHistoryRequest)
operation.
This is a convenience which creates an instance of the DescribeAlarmHistoryRequest.Builder
avoiding the
need to create one manually via DescribeAlarmHistoryRequest.builder()
describeAlarmHistoryRequest
- A Consumer
that will call methods on DescribeAlarmHistoryInput.Builder
to create a
request.InvalidNextTokenException
- The next token specified is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAlarmsResponse describeAlarms() throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
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.
InvalidNextTokenException
- The next token specified is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeAlarms(DescribeAlarmsRequest)
,
AWS API
Documentationdefault DescribeAlarmsResponse describeAlarms(DescribeAlarmsRequest describeAlarmsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
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.
describeAlarmsRequest
- InvalidNextTokenException
- The next token specified is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAlarmsResponse describeAlarms(Consumer<DescribeAlarmsRequest.Builder> describeAlarmsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm name, the alarm state, or a prefix for any action.
To use this operation and return information about composite alarms, you must be signed on with the
cloudwatch:DescribeAlarms
permission that is scoped to *
. You can't return information
about composite alarms if your cloudwatch:DescribeAlarms
permission has a narrower scope.
This is a convenience which creates an instance of the DescribeAlarmsRequest.Builder
avoiding the need to
create one manually via DescribeAlarmsRequest.builder()
describeAlarmsRequest
- A Consumer
that will call methods on DescribeAlarmsInput.Builder
to create a request.InvalidNextTokenException
- The next token specified is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAlarmsIterable describeAlarmsPaginator() throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
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
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
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
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
describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest)
operation.
InvalidNextTokenException
- The next token specified is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeAlarmsPaginator(DescribeAlarmsRequest)
,
AWS API
Documentationdefault DescribeAlarmsIterable describeAlarmsPaginator(DescribeAlarmsRequest describeAlarmsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
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
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
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
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
describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest)
operation.
describeAlarmsRequest
- InvalidNextTokenException
- The next token specified is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAlarmsIterable describeAlarmsPaginator(Consumer<DescribeAlarmsRequest.Builder> describeAlarmsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
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
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
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
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
describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest)
operation.
This is a convenience which creates an instance of the DescribeAlarmsRequest.Builder
avoiding the need to
create one manually via DescribeAlarmsRequest.builder()
describeAlarmsRequest
- A Consumer
that will call methods on DescribeAlarmsInput.Builder
to create a request.InvalidNextTokenException
- The next token specified is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAlarmsForMetricResponse describeAlarmsForMetric(DescribeAlarmsForMetricRequest describeAlarmsForMetricRequest) throws AwsServiceException, SdkClientException, CloudWatchException
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.
describeAlarmsForMetricRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAlarmsForMetricResponse describeAlarmsForMetric(Consumer<DescribeAlarmsForMetricRequest.Builder> describeAlarmsForMetricRequest) throws AwsServiceException, SdkClientException, CloudWatchException
Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.
This operation retrieves only standard alarms that are based on the specified metric. It does not return alarms based on math expressions that use the specified metric, or composite alarms that use the specified metric.
This is a convenience which creates an instance of the DescribeAlarmsForMetricRequest.Builder
avoiding
the need to create one manually via DescribeAlarmsForMetricRequest.builder()
describeAlarmsForMetricRequest
- A Consumer
that will call methods on DescribeAlarmsForMetricInput.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAnomalyDetectorsResponse describeAnomalyDetectors(DescribeAnomalyDetectorsRequest describeAnomalyDetectorsRequest) throws InvalidNextTokenException, InternalServiceException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, CloudWatchException
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.
describeAnomalyDetectorsRequest
- InvalidNextTokenException
- The next token specified is invalid.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.InvalidParameterCombinationException
- Parameters were used together that cannot be used together.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAnomalyDetectorsResponse describeAnomalyDetectors(Consumer<DescribeAnomalyDetectorsRequest.Builder> describeAnomalyDetectorsRequest) throws InvalidNextTokenException, InternalServiceException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, CloudWatchException
Lists the anomaly detection models that you have created in your account. For single metric anomaly detectors,
you can list all of the models in your account or filter the results to only the models that are related to a
certain namespace, metric name, or metric dimension. For metric math anomaly detectors, you can list them by
adding METRIC_MATH
to the AnomalyDetectorTypes
array. This will return all metric math
anomaly detectors in your account.
This is a convenience which creates an instance of the DescribeAnomalyDetectorsRequest.Builder
avoiding
the need to create one manually via DescribeAnomalyDetectorsRequest.builder()
describeAnomalyDetectorsRequest
- A Consumer
that will call methods on DescribeAnomalyDetectorsInput.Builder
to create a
request.InvalidNextTokenException
- The next token specified is invalid.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.InvalidParameterCombinationException
- Parameters were used together that cannot be used together.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAnomalyDetectorsIterable describeAnomalyDetectorsPaginator(DescribeAnomalyDetectorsRequest describeAnomalyDetectorsRequest) throws InvalidNextTokenException, InternalServiceException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, CloudWatchException
Lists the anomaly detection models that you have created in your account. For single metric anomaly detectors,
you can list all of the models in your account or filter the results to only the models that are related to a
certain namespace, metric name, or metric dimension. For metric math anomaly detectors, you can list them by
adding METRIC_MATH
to the AnomalyDetectorTypes
array. This will return all metric math
anomaly detectors in your account.
This is a variant of
describeAnomalyDetectors(software.amazon.awssdk.services.cloudwatch.model.DescribeAnomalyDetectorsRequest)
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
software.amazon.awssdk.services.cloudwatch.paginators.DescribeAnomalyDetectorsIterable responses = client.describeAnomalyDetectorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.cloudwatch.paginators.DescribeAnomalyDetectorsIterable responses = client .describeAnomalyDetectorsPaginator(request); for (software.amazon.awssdk.services.cloudwatch.model.DescribeAnomalyDetectorsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.cloudwatch.paginators.DescribeAnomalyDetectorsIterable responses = client.describeAnomalyDetectorsPaginator(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
describeAnomalyDetectors(software.amazon.awssdk.services.cloudwatch.model.DescribeAnomalyDetectorsRequest)
operation.
describeAnomalyDetectorsRequest
- InvalidNextTokenException
- The next token specified is invalid.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.InvalidParameterCombinationException
- Parameters were used together that cannot be used together.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAnomalyDetectorsIterable describeAnomalyDetectorsPaginator(Consumer<DescribeAnomalyDetectorsRequest.Builder> describeAnomalyDetectorsRequest) throws InvalidNextTokenException, InternalServiceException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, CloudWatchException
Lists the anomaly detection models that you have created in your account. For single metric anomaly detectors,
you can list all of the models in your account or filter the results to only the models that are related to a
certain namespace, metric name, or metric dimension. For metric math anomaly detectors, you can list them by
adding METRIC_MATH
to the AnomalyDetectorTypes
array. This will return all metric math
anomaly detectors in your account.
This is a variant of
describeAnomalyDetectors(software.amazon.awssdk.services.cloudwatch.model.DescribeAnomalyDetectorsRequest)
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
software.amazon.awssdk.services.cloudwatch.paginators.DescribeAnomalyDetectorsIterable responses = client.describeAnomalyDetectorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.cloudwatch.paginators.DescribeAnomalyDetectorsIterable responses = client .describeAnomalyDetectorsPaginator(request); for (software.amazon.awssdk.services.cloudwatch.model.DescribeAnomalyDetectorsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.cloudwatch.paginators.DescribeAnomalyDetectorsIterable responses = client.describeAnomalyDetectorsPaginator(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
describeAnomalyDetectors(software.amazon.awssdk.services.cloudwatch.model.DescribeAnomalyDetectorsRequest)
operation.
This is a convenience which creates an instance of the DescribeAnomalyDetectorsRequest.Builder
avoiding
the need to create one manually via DescribeAnomalyDetectorsRequest.builder()
describeAnomalyDetectorsRequest
- A Consumer
that will call methods on DescribeAnomalyDetectorsInput.Builder
to create a
request.InvalidNextTokenException
- The next token specified is invalid.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.InvalidParameterCombinationException
- Parameters were used together that cannot be used together.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeInsightRulesResponse describeInsightRules(DescribeInsightRulesRequest describeInsightRulesRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
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.
describeInsightRulesRequest
- InvalidNextTokenException
- The next token specified is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeInsightRulesResponse describeInsightRules(Consumer<DescribeInsightRulesRequest.Builder> describeInsightRulesRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
Returns a list of all the Contributor Insights rules in your account.
For more information about Contributor Insights, see Using Contributor Insights to Analyze High-Cardinality Data.
This is a convenience which creates an instance of the DescribeInsightRulesRequest.Builder
avoiding the
need to create one manually via DescribeInsightRulesRequest.builder()
describeInsightRulesRequest
- A Consumer
that will call methods on DescribeInsightRulesInput.Builder
to create a
request.InvalidNextTokenException
- The next token specified is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeInsightRulesIterable describeInsightRulesPaginator(DescribeInsightRulesRequest describeInsightRulesRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
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
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
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
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
describeInsightRules(software.amazon.awssdk.services.cloudwatch.model.DescribeInsightRulesRequest)
operation.
describeInsightRulesRequest
- InvalidNextTokenException
- The next token specified is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeInsightRulesIterable describeInsightRulesPaginator(Consumer<DescribeInsightRulesRequest.Builder> describeInsightRulesRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
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
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
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
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
describeInsightRules(software.amazon.awssdk.services.cloudwatch.model.DescribeInsightRulesRequest)
operation.
This is a convenience which creates an instance of the DescribeInsightRulesRequest.Builder
avoiding the
need to create one manually via DescribeInsightRulesRequest.builder()
describeInsightRulesRequest
- A Consumer
that will call methods on DescribeInsightRulesInput.Builder
to create a
request.InvalidNextTokenException
- The next token specified is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisableAlarmActionsResponse disableAlarmActions(DisableAlarmActionsRequest disableAlarmActionsRequest) throws AwsServiceException, SdkClientException, CloudWatchException
Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes.
disableAlarmActionsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisableAlarmActionsResponse disableAlarmActions(Consumer<DisableAlarmActionsRequest.Builder> disableAlarmActionsRequest) throws AwsServiceException, SdkClientException, CloudWatchException
Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes.
This is a convenience which creates an instance of the DisableAlarmActionsRequest.Builder
avoiding the
need to create one manually via DisableAlarmActionsRequest.builder()
disableAlarmActionsRequest
- A Consumer
that will call methods on DisableAlarmActionsInput.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisableInsightRulesResponse disableInsightRules(DisableInsightRulesRequest disableInsightRulesRequest) throws InvalidParameterValueException, MissingRequiredParameterException, AwsServiceException, SdkClientException, CloudWatchException
Disables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do not incur costs.
disableInsightRulesRequest
- InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisableInsightRulesResponse disableInsightRules(Consumer<DisableInsightRulesRequest.Builder> disableInsightRulesRequest) throws InvalidParameterValueException, MissingRequiredParameterException, AwsServiceException, SdkClientException, CloudWatchException
Disables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do not incur costs.
This is a convenience which creates an instance of the DisableInsightRulesRequest.Builder
avoiding the
need to create one manually via DisableInsightRulesRequest.builder()
disableInsightRulesRequest
- A Consumer
that will call methods on DisableInsightRulesInput.Builder
to create a request.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default EnableAlarmActionsResponse enableAlarmActions(EnableAlarmActionsRequest enableAlarmActionsRequest) throws AwsServiceException, SdkClientException, CloudWatchException
Enables the actions for the specified alarms.
enableAlarmActionsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default EnableAlarmActionsResponse enableAlarmActions(Consumer<EnableAlarmActionsRequest.Builder> enableAlarmActionsRequest) throws AwsServiceException, SdkClientException, CloudWatchException
Enables the actions for the specified alarms.
This is a convenience which creates an instance of the EnableAlarmActionsRequest.Builder
avoiding the
need to create one manually via EnableAlarmActionsRequest.builder()
enableAlarmActionsRequest
- A Consumer
that will call methods on EnableAlarmActionsInput.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default EnableInsightRulesResponse enableInsightRules(EnableInsightRulesRequest enableInsightRulesRequest) throws InvalidParameterValueException, MissingRequiredParameterException, LimitExceededException, AwsServiceException, SdkClientException, CloudWatchException
Enables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data.
enableInsightRulesRequest
- InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.LimitExceededException
- The operation exceeded one or more limits.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default EnableInsightRulesResponse enableInsightRules(Consumer<EnableInsightRulesRequest.Builder> enableInsightRulesRequest) throws InvalidParameterValueException, MissingRequiredParameterException, LimitExceededException, AwsServiceException, SdkClientException, CloudWatchException
Enables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data.
This is a convenience which creates an instance of the EnableInsightRulesRequest.Builder
avoiding the
need to create one manually via EnableInsightRulesRequest.builder()
enableInsightRulesRequest
- A Consumer
that will call methods on EnableInsightRulesInput.Builder
to create a request.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.LimitExceededException
- The operation exceeded one or more limits.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetDashboardResponse getDashboard(GetDashboardRequest getDashboardRequest) throws InvalidParameterValueException, DashboardNotFoundErrorException, InternalServiceException, AwsServiceException, SdkClientException, CloudWatchException
Displays the details of the dashboard that you specify.
To copy an existing dashboard, use GetDashboard
, and then use the data returned within
DashboardBody
as the template for the new dashboard when you call PutDashboard
to
create the copy.
getDashboardRequest
- InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.DashboardNotFoundErrorException
- The specified dashboard does not exist.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetDashboardResponse getDashboard(Consumer<GetDashboardRequest.Builder> getDashboardRequest) throws InvalidParameterValueException, DashboardNotFoundErrorException, InternalServiceException, AwsServiceException, SdkClientException, CloudWatchException
Displays the details of the dashboard that you specify.
To copy an existing dashboard, use GetDashboard
, and then use the data returned within
DashboardBody
as the template for the new dashboard when you call PutDashboard
to
create the copy.
This is a convenience which creates an instance of the GetDashboardRequest.Builder
avoiding the need to
create one manually via GetDashboardRequest.builder()
getDashboardRequest
- A Consumer
that will call methods on GetDashboardInput.Builder
to create a request.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.DashboardNotFoundErrorException
- The specified dashboard does not exist.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetInsightRuleReportResponse getInsightRuleReport(GetInsightRuleReportRequest getInsightRuleReportRequest) throws InvalidParameterValueException, MissingRequiredParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudWatchException
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.
getInsightRuleReportRequest
- InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.ResourceNotFoundException
- The named resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetInsightRuleReportResponse getInsightRuleReport(Consumer<GetInsightRuleReportRequest.Builder> getInsightRuleReportRequest) throws InvalidParameterValueException, MissingRequiredParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudWatchException
This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of contributors to the log group.
You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:
UniqueContributors
-- the number of unique contributors for each data point.
MaxContributorValue
-- the value of the top contributor for each data point. The identity of the
contributor might change for each data point in the graph.
If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most
occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the
highest sum in the log field specified by the rule's Value
, during that period.
SampleCount
-- the number of data points matched by the rule.
Sum
-- the sum of the values from all contributors during the time period represented by that data
point.
Minimum
-- the minimum value from a single observation during the time period represented by that
data point.
Maximum
-- the maximum value from a single observation during the time period represented by that
data point.
Average
-- the average value from all contributors during the time period represented by that data
point.
This is a convenience which creates an instance of the GetInsightRuleReportRequest.Builder
avoiding the
need to create one manually via GetInsightRuleReportRequest.builder()
getInsightRuleReportRequest
- A Consumer
that will call methods on GetInsightRuleReportInput.Builder
to create a
request.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.ResourceNotFoundException
- The named resource does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetMetricDataResponse getMetricData(GetMetricDataRequest getMetricDataRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
You can use the GetMetricData
API to retrieve CloudWatch metric values. The operation can also
include a CloudWatch Metrics Insights query, and one or more metric math functions.
A GetMetricData
operation that does not include a query can retrieve as many as 500 different
metrics in a single request, with a total of as many as 100,800 data points. You can also optionally perform
metric math expressions on the values of the returned statistics, to create new time series that represent new
insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations
metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
If you include a Metrics Insights query, each GetMetricData
operation can include only one query.
But the same GetMetricData
operation can also retrieve other metrics. Metrics Insights queries can
query only the most recent three hours of metric data. For more information about Metrics Insights, see Query your metrics with CloudWatch Metrics Insights.
Calls to the GetMetricData
API have a different pricing structure than calls to
GetMetricStatistics
. For more information about pricing, see Amazon CloudWatch Pricing.
Amazon CloudWatch retains metric data as follows:
Data points with a period of less than 60 seconds are available for 3 hours. These data points are
high-resolution metrics and are available only for custom metrics that have been defined with a
StorageResolution
of 1.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
Data points with a period of 300 seconds (5-minute) are available for 63 days.
Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.
If you omit Unit
in your request, all data that was collected with any unit is returned, along with
the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the
operation returns only data that was collected with that unit specified. If you specify a unit that does not
match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.
Using Metrics Insights queries with metric math
You can't mix a Metric Insights query and metric math syntax in the same expression, but you can reference results from a Metrics Insights query within other Metric math expressions. A Metrics Insights query without a GROUP BY clause returns a single time-series (TS), and can be used as input for a metric math expression that expects a single time series. A Metrics Insights query with a GROUP BY clause returns an array of time-series (TS[]), and can be used as input for a metric math expression that expects an array of time series.
getMetricDataRequest
- InvalidNextTokenException
- The next token specified is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetMetricDataResponse getMetricData(Consumer<GetMetricDataRequest.Builder> getMetricDataRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
You can use the GetMetricData
API to retrieve CloudWatch metric values. The operation can also
include a CloudWatch Metrics Insights query, and one or more metric math functions.
A GetMetricData
operation that does not include a query can retrieve as many as 500 different
metrics in a single request, with a total of as many as 100,800 data points. You can also optionally perform
metric math expressions on the values of the returned statistics, to create new time series that represent new
insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations
metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
If you include a Metrics Insights query, each GetMetricData
operation can include only one query.
But the same GetMetricData
operation can also retrieve other metrics. Metrics Insights queries can
query only the most recent three hours of metric data. For more information about Metrics Insights, see Query your metrics with CloudWatch Metrics Insights.
Calls to the GetMetricData
API have a different pricing structure than calls to
GetMetricStatistics
. For more information about pricing, see Amazon CloudWatch Pricing.
Amazon CloudWatch retains metric data as follows:
Data points with a period of less than 60 seconds are available for 3 hours. These data points are
high-resolution metrics and are available only for custom metrics that have been defined with a
StorageResolution
of 1.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
Data points with a period of 300 seconds (5-minute) are available for 63 days.
Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.
If you omit Unit
in your request, all data that was collected with any unit is returned, along with
the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the
operation returns only data that was collected with that unit specified. If you specify a unit that does not
match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.
Using Metrics Insights queries with metric math
You can't mix a Metric Insights query and metric math syntax in the same expression, but you can reference results from a Metrics Insights query within other Metric math expressions. A Metrics Insights query without a GROUP BY clause returns a single time-series (TS), and can be used as input for a metric math expression that expects a single time series. A Metrics Insights query with a GROUP BY clause returns an array of time-series (TS[]), and can be used as input for a metric math expression that expects an array of time series.
This is a convenience which creates an instance of the GetMetricDataRequest.Builder
avoiding the need to
create one manually via GetMetricDataRequest.builder()
getMetricDataRequest
- A Consumer
that will call methods on GetMetricDataInput.Builder
to create a request.InvalidNextTokenException
- The next token specified is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetMetricDataIterable getMetricDataPaginator(GetMetricDataRequest getMetricDataRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
You can use the GetMetricData
API to retrieve CloudWatch metric values. The operation can also
include a CloudWatch Metrics Insights query, and one or more metric math functions.
A GetMetricData
operation that does not include a query can retrieve as many as 500 different
metrics in a single request, with a total of as many as 100,800 data points. You can also optionally perform
metric math expressions on the values of the returned statistics, to create new time series that represent new
insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations
metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
If you include a Metrics Insights query, each GetMetricData
operation can include only one query.
But the same GetMetricData
operation can also retrieve other metrics. Metrics Insights queries can
query only the most recent three hours of metric data. For more information about Metrics Insights, see Query your metrics with CloudWatch Metrics Insights.
Calls to the GetMetricData
API have a different pricing structure than calls to
GetMetricStatistics
. For more information about pricing, see Amazon CloudWatch Pricing.
Amazon CloudWatch retains metric data as follows:
Data points with a period of less than 60 seconds are available for 3 hours. These data points are
high-resolution metrics and are available only for custom metrics that have been defined with a
StorageResolution
of 1.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
Data points with a period of 300 seconds (5-minute) are available for 63 days.
Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.
If you omit Unit
in your request, all data that was collected with any unit is returned, along with
the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the
operation returns only data that was collected with that unit specified. If you specify a unit that does not
match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.
Using Metrics Insights queries with metric math
You can't mix a Metric Insights query and metric math syntax in the same expression, but you can reference results from a Metrics Insights query within other Metric math expressions. A Metrics Insights query without a GROUP BY clause returns a single time-series (TS), and can be used as input for a metric math expression that expects a single time series. A Metrics Insights query with a GROUP BY clause returns an array of time-series (TS[]), and can be used as input for a metric math expression that expects an array of time series.
This is a variant of
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
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
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
getMetricData(software.amazon.awssdk.services.cloudwatch.model.GetMetricDataRequest)
operation.
getMetricDataRequest
- InvalidNextTokenException
- The next token specified is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetMetricDataIterable getMetricDataPaginator(Consumer<GetMetricDataRequest.Builder> getMetricDataRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
You can use the GetMetricData
API to retrieve CloudWatch metric values. The operation can also
include a CloudWatch Metrics Insights query, and one or more metric math functions.
A GetMetricData
operation that does not include a query can retrieve as many as 500 different
metrics in a single request, with a total of as many as 100,800 data points. You can also optionally perform
metric math expressions on the values of the returned statistics, to create new time series that represent new
insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations
metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
If you include a Metrics Insights query, each GetMetricData
operation can include only one query.
But the same GetMetricData
operation can also retrieve other metrics. Metrics Insights queries can
query only the most recent three hours of metric data. For more information about Metrics Insights, see Query your metrics with CloudWatch Metrics Insights.
Calls to the GetMetricData
API have a different pricing structure than calls to
GetMetricStatistics
. For more information about pricing, see Amazon CloudWatch Pricing.
Amazon CloudWatch retains metric data as follows:
Data points with a period of less than 60 seconds are available for 3 hours. These data points are
high-resolution metrics and are available only for custom metrics that have been defined with a
StorageResolution
of 1.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
Data points with a period of 300 seconds (5-minute) are available for 63 days.
Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.
If you omit Unit
in your request, all data that was collected with any unit is returned, along with
the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the
operation returns only data that was collected with that unit specified. If you specify a unit that does not
match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.
Using Metrics Insights queries with metric math
You can't mix a Metric Insights query and metric math syntax in the same expression, but you can reference results from a Metrics Insights query within other Metric math expressions. A Metrics Insights query without a GROUP BY clause returns a single time-series (TS), and can be used as input for a metric math expression that expects a single time series. A Metrics Insights query with a GROUP BY clause returns an array of time-series (TS[]), and can be used as input for a metric math expression that expects an array of time series.
This is a variant of
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
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
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
getMetricData(software.amazon.awssdk.services.cloudwatch.model.GetMetricDataRequest)
operation.
This is a convenience which creates an instance of the GetMetricDataRequest.Builder
avoiding the need to
create one manually via GetMetricDataRequest.builder()
getMetricDataRequest
- A Consumer
that will call methods on GetMetricDataInput.Builder
to create a request.InvalidNextTokenException
- The next token specified is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetMetricStatisticsResponse getMetricStatistics(GetMetricStatisticsRequest getMetricStatisticsRequest) throws InvalidParameterValueException, MissingRequiredParameterException, InvalidParameterCombinationException, InternalServiceException, AwsServiceException, SdkClientException, CloudWatchException
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.
getMetricStatisticsRequest
- InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.InvalidParameterCombinationException
- Parameters were used together that cannot be used together.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetMetricStatisticsResponse getMetricStatistics(Consumer<GetMetricStatisticsRequest.Builder> getMetricStatisticsRequest) throws InvalidParameterValueException, MissingRequiredParameterException, InvalidParameterCombinationException, InternalServiceException, AwsServiceException, SdkClientException, CloudWatchException
Gets statistics for the specified metric.
The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.
CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.
CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:
The SampleCount value of the statistic set is 1.
The Min and the Max values of the statistic set are equal.
Percentile statistics are not available for metrics when any of the metric values are negative numbers.
Amazon CloudWatch retains metric data as follows:
Data points with a period of less than 60 seconds are available for 3 hours. These data points are
high-resolution metrics and are available only for custom metrics that have been defined with a
StorageResolution
of 1.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
Data points with a period of 300 seconds (5-minute) are available for 63 days.
Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.
CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.
For information about metrics and dimensions supported by Amazon Web Services services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.
This is a convenience which creates an instance of the GetMetricStatisticsRequest.Builder
avoiding the
need to create one manually via GetMetricStatisticsRequest.builder()
getMetricStatisticsRequest
- A Consumer
that will call methods on GetMetricStatisticsInput.Builder
to create a request.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.InvalidParameterCombinationException
- Parameters were used together that cannot be used together.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetMetricStreamResponse getMetricStream(GetMetricStreamRequest getMetricStreamRequest) throws ResourceNotFoundException, InternalServiceException, InvalidParameterValueException, MissingRequiredParameterException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, CloudWatchException
Returns information about the metric stream that you specify.
getMetricStreamRequest
- ResourceNotFoundException
- The named resource does not exist.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.InvalidParameterCombinationException
- Parameters were used together that cannot be used together.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetMetricStreamResponse getMetricStream(Consumer<GetMetricStreamRequest.Builder> getMetricStreamRequest) throws ResourceNotFoundException, InternalServiceException, InvalidParameterValueException, MissingRequiredParameterException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, CloudWatchException
Returns information about the metric stream that you specify.
This is a convenience which creates an instance of the GetMetricStreamRequest.Builder
avoiding the need
to create one manually via GetMetricStreamRequest.builder()
getMetricStreamRequest
- A Consumer
that will call methods on GetMetricStreamInput.Builder
to create a request.ResourceNotFoundException
- The named resource does not exist.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.InvalidParameterCombinationException
- Parameters were used together that cannot be used together.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetMetricWidgetImageResponse getMetricWidgetImage(GetMetricWidgetImageRequest getMetricWidgetImageRequest) throws AwsServiceException, SdkClientException, CloudWatchException
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.
getMetricWidgetImageRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetMetricWidgetImageResponse getMetricWidgetImage(Consumer<GetMetricWidgetImageRequest.Builder> getMetricWidgetImageRequest) throws AwsServiceException, SdkClientException, CloudWatchException
You can use the GetMetricWidgetImage
API to retrieve a snapshot graph of one or more Amazon
CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki
pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your
own custom live dashboard.
The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and vertical annotations.
There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage
action has
the following limits:
As many as 100 metrics in the graph.
Up to 100 KB uncompressed payload.
This is a convenience which creates an instance of the GetMetricWidgetImageRequest.Builder
avoiding the
need to create one manually via GetMetricWidgetImageRequest.builder()
getMetricWidgetImageRequest
- A Consumer
that will call methods on GetMetricWidgetImageInput.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDashboardsResponse listDashboards() throws InvalidParameterValueException, InternalServiceException, AwsServiceException, SdkClientException, CloudWatchException
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.
InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listDashboards(ListDashboardsRequest)
,
AWS API
Documentationdefault ListDashboardsResponse listDashboards(ListDashboardsRequest listDashboardsRequest) throws InvalidParameterValueException, InternalServiceException, AwsServiceException, SdkClientException, CloudWatchException
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.
listDashboardsRequest
- InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDashboardsResponse listDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest) throws InvalidParameterValueException, InternalServiceException, AwsServiceException, SdkClientException, CloudWatchException
Returns a list of the dashboards for your account. If you include DashboardNamePrefix
, only those
dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.
ListDashboards
returns up to 1000 results on one page. If there are more than 1000 dashboards, you
can call ListDashboards
again and include the value you received for NextToken
in the
first call, to receive the next 1000 results.
This is a convenience which creates an instance of the ListDashboardsRequest.Builder
avoiding the need to
create one manually via ListDashboardsRequest.builder()
listDashboardsRequest
- A Consumer
that will call methods on ListDashboardsInput.Builder
to create a request.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDashboardsIterable listDashboardsPaginator() throws InvalidParameterValueException, InternalServiceException, AwsServiceException, SdkClientException, CloudWatchException
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
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
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
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
listDashboards(software.amazon.awssdk.services.cloudwatch.model.ListDashboardsRequest)
operation.
InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listDashboardsPaginator(ListDashboardsRequest)
,
AWS API
Documentationdefault ListDashboardsIterable listDashboardsPaginator(ListDashboardsRequest listDashboardsRequest) throws InvalidParameterValueException, InternalServiceException, AwsServiceException, SdkClientException, CloudWatchException
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
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
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
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
listDashboards(software.amazon.awssdk.services.cloudwatch.model.ListDashboardsRequest)
operation.
listDashboardsRequest
- InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDashboardsIterable listDashboardsPaginator(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest) throws InvalidParameterValueException, InternalServiceException, AwsServiceException, SdkClientException, CloudWatchException
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
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
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
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
listDashboards(software.amazon.awssdk.services.cloudwatch.model.ListDashboardsRequest)
operation.
This is a convenience which creates an instance of the ListDashboardsRequest.Builder
avoiding the need to
create one manually via ListDashboardsRequest.builder()
listDashboardsRequest
- A Consumer
that will call methods on ListDashboardsInput.Builder
to create a request.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListManagedInsightRulesResponse listManagedInsightRules(ListManagedInsightRulesRequest listManagedInsightRulesRequest) throws InvalidParameterValueException, MissingRequiredParameterException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
Returns a list that contains the number of managed Contributor Insights rules in your account.
listManagedInsightRulesRequest
- InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.InvalidNextTokenException
- The next token specified is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListManagedInsightRulesResponse listManagedInsightRules(Consumer<ListManagedInsightRulesRequest.Builder> listManagedInsightRulesRequest) throws InvalidParameterValueException, MissingRequiredParameterException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
Returns a list that contains the number of managed Contributor Insights rules in your account.
This is a convenience which creates an instance of the ListManagedInsightRulesRequest.Builder
avoiding
the need to create one manually via ListManagedInsightRulesRequest.builder()
listManagedInsightRulesRequest
- A Consumer
that will call methods on ListManagedInsightRulesInput.Builder
to create a
request.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.InvalidNextTokenException
- The next token specified is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListManagedInsightRulesIterable listManagedInsightRulesPaginator(ListManagedInsightRulesRequest listManagedInsightRulesRequest) throws InvalidParameterValueException, MissingRequiredParameterException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
Returns a list that contains the number of managed Contributor Insights rules in your account.
This is a variant of
listManagedInsightRules(software.amazon.awssdk.services.cloudwatch.model.ListManagedInsightRulesRequest)
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
software.amazon.awssdk.services.cloudwatch.paginators.ListManagedInsightRulesIterable responses = client.listManagedInsightRulesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.cloudwatch.paginators.ListManagedInsightRulesIterable responses = client .listManagedInsightRulesPaginator(request); for (software.amazon.awssdk.services.cloudwatch.model.ListManagedInsightRulesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.cloudwatch.paginators.ListManagedInsightRulesIterable responses = client.listManagedInsightRulesPaginator(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
listManagedInsightRules(software.amazon.awssdk.services.cloudwatch.model.ListManagedInsightRulesRequest)
operation.
listManagedInsightRulesRequest
- InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.InvalidNextTokenException
- The next token specified is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListManagedInsightRulesIterable listManagedInsightRulesPaginator(Consumer<ListManagedInsightRulesRequest.Builder> listManagedInsightRulesRequest) throws InvalidParameterValueException, MissingRequiredParameterException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
Returns a list that contains the number of managed Contributor Insights rules in your account.
This is a variant of
listManagedInsightRules(software.amazon.awssdk.services.cloudwatch.model.ListManagedInsightRulesRequest)
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
software.amazon.awssdk.services.cloudwatch.paginators.ListManagedInsightRulesIterable responses = client.listManagedInsightRulesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.cloudwatch.paginators.ListManagedInsightRulesIterable responses = client .listManagedInsightRulesPaginator(request); for (software.amazon.awssdk.services.cloudwatch.model.ListManagedInsightRulesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.cloudwatch.paginators.ListManagedInsightRulesIterable responses = client.listManagedInsightRulesPaginator(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
listManagedInsightRules(software.amazon.awssdk.services.cloudwatch.model.ListManagedInsightRulesRequest)
operation.
This is a convenience which creates an instance of the ListManagedInsightRulesRequest.Builder
avoiding
the need to create one manually via ListManagedInsightRulesRequest.builder()
listManagedInsightRulesRequest
- A Consumer
that will call methods on ListManagedInsightRulesInput.Builder
to create a
request.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.InvalidNextTokenException
- The next token specified is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListMetricStreamsResponse listMetricStreams(ListMetricStreamsRequest listMetricStreamsRequest) throws InvalidNextTokenException, InternalServiceException, InvalidParameterValueException, MissingRequiredParameterException, AwsServiceException, SdkClientException, CloudWatchException
Returns a list of metric streams in this account.
listMetricStreamsRequest
- InvalidNextTokenException
- The next token specified is invalid.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListMetricStreamsResponse listMetricStreams(Consumer<ListMetricStreamsRequest.Builder> listMetricStreamsRequest) throws InvalidNextTokenException, InternalServiceException, InvalidParameterValueException, MissingRequiredParameterException, AwsServiceException, SdkClientException, CloudWatchException
Returns a list of metric streams in this account.
This is a convenience which creates an instance of the ListMetricStreamsRequest.Builder
avoiding the need
to create one manually via ListMetricStreamsRequest.builder()
listMetricStreamsRequest
- A Consumer
that will call methods on ListMetricStreamsInput.Builder
to create a request.InvalidNextTokenException
- The next token specified is invalid.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListMetricStreamsIterable listMetricStreamsPaginator(ListMetricStreamsRequest listMetricStreamsRequest) throws InvalidNextTokenException, InternalServiceException, InvalidParameterValueException, MissingRequiredParameterException, AwsServiceException, SdkClientException, CloudWatchException
Returns a list of metric streams in this account.
This is a variant of
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
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
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
listMetricStreams(software.amazon.awssdk.services.cloudwatch.model.ListMetricStreamsRequest)
operation.
listMetricStreamsRequest
- InvalidNextTokenException
- The next token specified is invalid.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListMetricStreamsIterable listMetricStreamsPaginator(Consumer<ListMetricStreamsRequest.Builder> listMetricStreamsRequest) throws InvalidNextTokenException, InternalServiceException, InvalidParameterValueException, MissingRequiredParameterException, AwsServiceException, SdkClientException, CloudWatchException
Returns a list of metric streams in this account.
This is a variant of
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
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
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
listMetricStreams(software.amazon.awssdk.services.cloudwatch.model.ListMetricStreamsRequest)
operation.
This is a convenience which creates an instance of the ListMetricStreamsRequest.Builder
avoiding the need
to create one manually via ListMetricStreamsRequest.builder()
listMetricStreamsRequest
- A Consumer
that will call methods on ListMetricStreamsInput.Builder
to create a request.InvalidNextTokenException
- The next token specified is invalid.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListMetricsResponse listMetrics() throws InternalServiceException, InvalidParameterValueException, AwsServiceException, SdkClientException, CloudWatchException
List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to get statistical data.
Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.
After you create a metric, allow up to 15 minutes for the metric to appear. To see metric statistics sooner, use GetMetricData or GetMetricStatistics.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view metrics from the linked source accounts. For more information, see CloudWatch cross-account observability.
ListMetrics
doesn't return information about metrics if those metrics haven't reported data in the
past two weeks. To retrieve those metrics, use GetMetricData
or
GetMetricStatistics.
InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listMetrics(ListMetricsRequest)
,
AWS API
Documentationdefault ListMetricsResponse listMetrics(ListMetricsRequest listMetricsRequest) throws InternalServiceException, InvalidParameterValueException, AwsServiceException, SdkClientException, CloudWatchException
List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to get statistical data.
Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.
After you create a metric, allow up to 15 minutes for the metric to appear. To see metric statistics sooner, use GetMetricData or GetMetricStatistics.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view metrics from the linked source accounts. For more information, see CloudWatch cross-account observability.
ListMetrics
doesn't return information about metrics if those metrics haven't reported data in the
past two weeks. To retrieve those metrics, use GetMetricData
or
GetMetricStatistics.
listMetricsRequest
- InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListMetricsResponse listMetrics(Consumer<ListMetricsRequest.Builder> listMetricsRequest) throws InternalServiceException, InvalidParameterValueException, AwsServiceException, SdkClientException, CloudWatchException
List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to get statistical data.
Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.
After you create a metric, allow up to 15 minutes for the metric to appear. To see metric statistics sooner, use GetMetricData or GetMetricStatistics.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view metrics from the linked source accounts. For more information, see CloudWatch cross-account observability.
ListMetrics
doesn't return information about metrics if those metrics haven't reported data in the
past two weeks. To retrieve those metrics, use GetMetricData
or
GetMetricStatistics.
This is a convenience which creates an instance of the ListMetricsRequest.Builder
avoiding the need to
create one manually via ListMetricsRequest.builder()
listMetricsRequest
- A Consumer
that will call methods on ListMetricsInput.Builder
to create a request.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListMetricsIterable listMetricsPaginator() throws InternalServiceException, InvalidParameterValueException, AwsServiceException, SdkClientException, CloudWatchException
List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to get statistical data.
Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.
After you create a metric, allow up to 15 minutes for the metric to appear. To see metric statistics sooner, use GetMetricData or GetMetricStatistics.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view metrics from the linked source accounts. For more information, see CloudWatch cross-account observability.
ListMetrics
doesn't return information about metrics if those metrics haven't reported data in the
past two weeks. To retrieve those metrics, use GetMetricData
or
GetMetricStatistics.
This is a variant of 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
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
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
listMetrics(software.amazon.awssdk.services.cloudwatch.model.ListMetricsRequest)
operation.
InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listMetricsPaginator(ListMetricsRequest)
,
AWS API
Documentationdefault ListMetricsIterable listMetricsPaginator(ListMetricsRequest listMetricsRequest) throws InternalServiceException, InvalidParameterValueException, AwsServiceException, SdkClientException, CloudWatchException
List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to get statistical data.
Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.
After you create a metric, allow up to 15 minutes for the metric to appear. To see metric statistics sooner, use GetMetricData or GetMetricStatistics.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view metrics from the linked source accounts. For more information, see CloudWatch cross-account observability.
ListMetrics
doesn't return information about metrics if those metrics haven't reported data in the
past two weeks. To retrieve those metrics, use GetMetricData
or
GetMetricStatistics.
This is a variant of 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
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
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
listMetrics(software.amazon.awssdk.services.cloudwatch.model.ListMetricsRequest)
operation.
listMetricsRequest
- InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListMetricsIterable listMetricsPaginator(Consumer<ListMetricsRequest.Builder> listMetricsRequest) throws InternalServiceException, InvalidParameterValueException, AwsServiceException, SdkClientException, CloudWatchException
List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to get statistical data.
Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.
After you create a metric, allow up to 15 minutes for the metric to appear. To see metric statistics sooner, use GetMetricData or GetMetricStatistics.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view metrics from the linked source accounts. For more information, see CloudWatch cross-account observability.
ListMetrics
doesn't return information about metrics if those metrics haven't reported data in the
past two weeks. To retrieve those metrics, use GetMetricData
or
GetMetricStatistics.
This is a variant of 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
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
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
listMetrics(software.amazon.awssdk.services.cloudwatch.model.ListMetricsRequest)
operation.
This is a convenience which creates an instance of the ListMetricsRequest.Builder
avoiding the need to
create one manually via ListMetricsRequest.builder()
listMetricsRequest
- A Consumer
that will call methods on ListMetricsInput.Builder
to create a request.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidParameterValueException, ResourceNotFoundException, InternalServiceException, AwsServiceException, SdkClientException, CloudWatchException
Displays the tags associated with a CloudWatch resource. Currently, alarms and Contributor Insights rules support tagging.
listTagsForResourceRequest
- InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.ResourceNotFoundException
- The named resource does not exist.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidParameterValueException, ResourceNotFoundException, InternalServiceException, AwsServiceException, SdkClientException, CloudWatchException
Displays the tags associated with a CloudWatch resource. Currently, alarms and Contributor Insights rules support tagging.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder
avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest
- A Consumer
that will call methods on ListTagsForResourceInput.Builder
to create a request.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.ResourceNotFoundException
- The named resource does not exist.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutAnomalyDetectorResponse putAnomalyDetector(PutAnomalyDetectorRequest putAnomalyDetectorRequest) throws LimitExceededException, InternalServiceException, InvalidParameterValueException, MissingRequiredParameterException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, CloudWatchException
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.
putAnomalyDetectorRequest
- LimitExceededException
- The operation exceeded one or more limits.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.InvalidParameterCombinationException
- Parameters were used together that cannot be used together.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutAnomalyDetectorResponse putAnomalyDetector(Consumer<PutAnomalyDetectorRequest.Builder> putAnomalyDetectorRequest) throws LimitExceededException, InternalServiceException, InvalidParameterValueException, MissingRequiredParameterException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, CloudWatchException
Creates an anomaly detection model for a CloudWatch metric. You can use the model to display a band of expected normal values when the metric is graphed.
For more information, see CloudWatch Anomaly Detection.
This is a convenience which creates an instance of the PutAnomalyDetectorRequest.Builder
avoiding the
need to create one manually via PutAnomalyDetectorRequest.builder()
putAnomalyDetectorRequest
- A Consumer
that will call methods on PutAnomalyDetectorInput.Builder
to create a request.LimitExceededException
- The operation exceeded one or more limits.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.InvalidParameterCombinationException
- Parameters were used together that cannot be used together.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutCompositeAlarmResponse putCompositeAlarm(PutCompositeAlarmRequest putCompositeAlarmRequest) throws LimitExceededException, AwsServiceException, SdkClientException, CloudWatchException
Creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.
The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms. The rule expression of a composite alarm can include as many as 100 underlying alarms. Any single alarm can be included in the rule expressions of as many as 150 composite alarms.
Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.
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.
putCompositeAlarmRequest
- LimitExceededException
- The quota for alarms for this customer has already been reached.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutCompositeAlarmResponse putCompositeAlarm(Consumer<PutCompositeAlarmRequest.Builder> putCompositeAlarmRequest) throws LimitExceededException, AwsServiceException, SdkClientException, CloudWatchException
Creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.
The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms. The rule expression of a composite alarm can include as many as 100 underlying alarms. Any single alarm can be included in the rule expressions of as many as 150 composite alarms.
Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.
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.
This is a convenience which creates an instance of the PutCompositeAlarmRequest.Builder
avoiding the need
to create one manually via PutCompositeAlarmRequest.builder()
putCompositeAlarmRequest
- A Consumer
that will call methods on PutCompositeAlarmInput.Builder
to create a request.LimitExceededException
- The quota for alarms for this customer has already been reached.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutDashboardResponse putDashboard(PutDashboardRequest putDashboardRequest) throws DashboardInvalidInputErrorException, InternalServiceException, AwsServiceException, SdkClientException, CloudWatchException
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.
putDashboardRequest
- DashboardInvalidInputErrorException
- Some part of the dashboard data is invalid.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutDashboardResponse putDashboard(Consumer<PutDashboardRequest.Builder> putDashboardRequest) throws DashboardInvalidInputErrorException, InternalServiceException, AwsServiceException, SdkClientException, CloudWatchException
Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.
All dashboards in your account are global, not region-specific.
A simple way to create a dashboard using PutDashboard
is to copy an existing dashboard. To copy an
existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the
Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use
GetDashboard
, and then use the data returned within DashboardBody
as the template for
the new dashboard when you call PutDashboard
.
When you create a dashboard with PutDashboard
, a good practice is to add a text widget at the top of
the dashboard with a message that the dashboard was created by script and should not be changed in the console.
This message could also point console users to the location of the DashboardBody
script or the
CloudFormation template used to create the dashboard.
This is a convenience which creates an instance of the PutDashboardRequest.Builder
avoiding the need to
create one manually via PutDashboardRequest.builder()
putDashboardRequest
- A Consumer
that will call methods on PutDashboardInput.Builder
to create a request.DashboardInvalidInputErrorException
- Some part of the dashboard data is invalid.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutInsightRuleResponse putInsightRule(PutInsightRuleRequest putInsightRuleRequest) throws InvalidParameterValueException, MissingRequiredParameterException, LimitExceededException, AwsServiceException, SdkClientException, CloudWatchException
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.
putInsightRuleRequest
- InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.LimitExceededException
- The operation exceeded one or more limits.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutInsightRuleResponse putInsightRule(Consumer<PutInsightRuleRequest.Builder> putInsightRuleRequest) throws InvalidParameterValueException, MissingRequiredParameterException, LimitExceededException, AwsServiceException, SdkClientException, CloudWatchException
Creates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, see Using Contributor Insights to Analyze High-Cardinality Data.
If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.
This is a convenience which creates an instance of the PutInsightRuleRequest.Builder
avoiding the need to
create one manually via PutInsightRuleRequest.builder()
putInsightRuleRequest
- A Consumer
that will call methods on PutInsightRuleInput.Builder
to create a request.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.LimitExceededException
- The operation exceeded one or more limits.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutManagedInsightRulesResponse putManagedInsightRules(PutManagedInsightRulesRequest putManagedInsightRulesRequest) throws InvalidParameterValueException, MissingRequiredParameterException, AwsServiceException, SdkClientException, CloudWatchException
Creates a managed Contributor Insights rule for a specified Amazon Web Services resource. When you enable a
managed rule, you create a Contributor Insights rule that collects data from Amazon Web Services services. You
cannot edit these rules with PutInsightRule
. The rules can be enabled, disabled, and deleted using
EnableInsightRules
, DisableInsightRules
, and DeleteInsightRules
. If a
previously created managed rule is currently disabled, a subsequent call to this API will re-enable it. Use
ListManagedInsightRules
to describe all available rules.
putManagedInsightRulesRequest
- InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutManagedInsightRulesResponse putManagedInsightRules(Consumer<PutManagedInsightRulesRequest.Builder> putManagedInsightRulesRequest) throws InvalidParameterValueException, MissingRequiredParameterException, AwsServiceException, SdkClientException, CloudWatchException
Creates a managed Contributor Insights rule for a specified Amazon Web Services resource. When you enable a
managed rule, you create a Contributor Insights rule that collects data from Amazon Web Services services. You
cannot edit these rules with PutInsightRule
. The rules can be enabled, disabled, and deleted using
EnableInsightRules
, DisableInsightRules
, and DeleteInsightRules
. If a
previously created managed rule is currently disabled, a subsequent call to this API will re-enable it. Use
ListManagedInsightRules
to describe all available rules.
This is a convenience which creates an instance of the PutManagedInsightRulesRequest.Builder
avoiding the
need to create one manually via PutManagedInsightRulesRequest.builder()
putManagedInsightRulesRequest
- A Consumer
that will call methods on PutManagedInsightRulesInput.Builder
to create a
request.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutMetricAlarmResponse putMetricAlarm(PutMetricAlarmRequest putMetricAlarmRequest) throws LimitExceededException, AwsServiceException, SdkClientException, CloudWatchException
Creates or updates an alarm and associates it with the specified metric, metric math expression, anomaly detection model, or Metrics Insights query. For more information about using a Metrics Insights query for an alarm, see Create alarms on Metrics Insights queries.
Alarms based on anomaly detection models cannot have Auto Scaling actions.
When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA
. The
alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then
executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:
The iam:CreateServiceLinkedRole
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.
putMetricAlarmRequest
- LimitExceededException
- The quota for alarms for this customer has already been reached.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutMetricAlarmResponse putMetricAlarm(Consumer<PutMetricAlarmRequest.Builder> putMetricAlarmRequest) throws LimitExceededException, AwsServiceException, SdkClientException, CloudWatchException
Creates or updates an alarm and associates it with the specified metric, metric math expression, anomaly detection model, or Metrics Insights query. For more information about using a Metrics Insights query for an alarm, see Create alarms on Metrics Insights queries.
Alarms based on anomaly detection models cannot have Auto Scaling actions.
When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA
. The
alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then
executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:
The iam:CreateServiceLinkedRole
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.
This is a convenience which creates an instance of the PutMetricAlarmRequest.Builder
avoiding the need to
create one manually via PutMetricAlarmRequest.builder()
putMetricAlarmRequest
- A Consumer
that will call methods on PutMetricAlarmInput.Builder
to create a request.LimitExceededException
- The quota for alarms for this customer has already been reached.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutMetricDataResponse putMetricData(PutMetricDataRequest putMetricDataRequest) throws InvalidParameterValueException, MissingRequiredParameterException, InvalidParameterCombinationException, InternalServiceException, AwsServiceException, SdkClientException, CloudWatchException
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 1 MB in size for HTTP POST requests. You can send a payload
compressed by gzip. Each request is also limited to no more than 1000 different metrics.
Although the Value
parameter accepts numbers of type Double
, CloudWatch rejects values
that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special
values (for example, NaN, +Infinity, -Infinity) are not supported.
You can use up to 30 dimensions per metric to further clarify what data the metric collects. Each dimension consists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.
You specify the time stamp to be associated with each data point. You can specify time stamps that are as much as two weeks before the current date, and as much as 2 hours after the current day and time.
Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricData or GetMetricStatistics from the time they are submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available for for GetMetricData or GetMetricStatistics.
CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:
The SampleCount
value of the statistic set is 1 and Min
, Max
, and
Sum
are all equal.
The Min
and Max
are equal, and Sum
is equal to Min
multiplied
by SampleCount
.
putMetricDataRequest
- InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.InvalidParameterCombinationException
- Parameters were used together that cannot be used together.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutMetricDataResponse putMetricData(Consumer<PutMetricDataRequest.Builder> putMetricDataRequest) throws InvalidParameterValueException, MissingRequiredParameterException, InvalidParameterCombinationException, InternalServiceException, AwsServiceException, SdkClientException, CloudWatchException
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 1 MB in size for HTTP POST requests. You can send a payload
compressed by gzip. Each request is also limited to no more than 1000 different metrics.
Although the Value
parameter accepts numbers of type Double
, CloudWatch rejects values
that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special
values (for example, NaN, +Infinity, -Infinity) are not supported.
You can use up to 30 dimensions per metric to further clarify what data the metric collects. Each dimension consists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.
You specify the time stamp to be associated with each data point. You can specify time stamps that are as much as two weeks before the current date, and as much as 2 hours after the current day and time.
Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricData or GetMetricStatistics from the time they are submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available for for GetMetricData or GetMetricStatistics.
CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:
The SampleCount
value of the statistic set is 1 and Min
, Max
, and
Sum
are all equal.
The Min
and Max
are equal, and Sum
is equal to Min
multiplied
by SampleCount
.
This is a convenience which creates an instance of the PutMetricDataRequest.Builder
avoiding the need to
create one manually via PutMetricDataRequest.builder()
putMetricDataRequest
- A Consumer
that will call methods on PutMetricDataInput.Builder
to create a request.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.InvalidParameterCombinationException
- Parameters were used together that cannot be used together.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutMetricStreamResponse putMetricStream(PutMetricStreamRequest putMetricStreamRequest) throws ConcurrentModificationException, InternalServiceException, InvalidParameterValueException, MissingRequiredParameterException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, CloudWatchException
Creates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics to Amazon Web Services destinations, including Amazon S3, and to many third-party solutions.
For more information, see Using Metric Streams.
To create a metric stream, you must be signed in to an account that has the iam:PassRole
permission
and either the CloudWatchFullAccess
policy or the cloudwatch:PutMetricStream
permission.
When you create or update a metric stream, you choose one of the following:
Stream metrics from all metric namespaces in the account.
Stream metrics from all metric namespaces in the account, except for the namespaces that you list in
ExcludeFilters
.
Stream metrics from only the metric namespaces that you list in IncludeFilters
.
By default, a metric stream always sends the MAX
, MIN
, SUM
, and
SAMPLECOUNT
statistics for each metric that is streamed. You can use the
StatisticsConfigurations
parameter to have the metric stream send additional statistics in the
stream. Streaming additional statistics incurs additional costs. For more information, see Amazon CloudWatch Pricing.
When you use PutMetricStream
to create a new metric stream, the stream is created in the
running
state. If you use it to update an existing stream, the state of the stream is not changed.
If you are using CloudWatch cross-account observability and you create a metric stream in a monitoring account, you can choose whether to include metrics from source accounts in the stream. For more information, see CloudWatch cross-account observability.
putMetricStreamRequest
- ConcurrentModificationException
- More than one process tried to modify a resource at the same time.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.InvalidParameterCombinationException
- Parameters were used together that cannot be used together.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutMetricStreamResponse putMetricStream(Consumer<PutMetricStreamRequest.Builder> putMetricStreamRequest) throws ConcurrentModificationException, InternalServiceException, InvalidParameterValueException, MissingRequiredParameterException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, CloudWatchException
Creates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics to Amazon Web Services destinations, including Amazon S3, and to many third-party solutions.
For more information, see Using Metric Streams.
To create a metric stream, you must be signed in to an account that has the iam:PassRole
permission
and either the CloudWatchFullAccess
policy or the cloudwatch:PutMetricStream
permission.
When you create or update a metric stream, you choose one of the following:
Stream metrics from all metric namespaces in the account.
Stream metrics from all metric namespaces in the account, except for the namespaces that you list in
ExcludeFilters
.
Stream metrics from only the metric namespaces that you list in IncludeFilters
.
By default, a metric stream always sends the MAX
, MIN
, SUM
, and
SAMPLECOUNT
statistics for each metric that is streamed. You can use the
StatisticsConfigurations
parameter to have the metric stream send additional statistics in the
stream. Streaming additional statistics incurs additional costs. For more information, see Amazon CloudWatch Pricing.
When you use PutMetricStream
to create a new metric stream, the stream is created in the
running
state. If you use it to update an existing stream, the state of the stream is not changed.
If you are using CloudWatch cross-account observability and you create a metric stream in a monitoring account, you can choose whether to include metrics from source accounts in the stream. For more information, see CloudWatch cross-account observability.
This is a convenience which creates an instance of the PutMetricStreamRequest.Builder
avoiding the need
to create one manually via PutMetricStreamRequest.builder()
putMetricStreamRequest
- A Consumer
that will call methods on PutMetricStreamInput.Builder
to create a request.ConcurrentModificationException
- More than one process tried to modify a resource at the same time.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.InvalidParameterCombinationException
- Parameters were used together that cannot be used together.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SetAlarmStateResponse setAlarmState(SetAlarmStateRequest setAlarmStateRequest) throws ResourceNotFoundException, InvalidFormatException, AwsServiceException, SdkClientException, CloudWatchException
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.
setAlarmStateRequest
- ResourceNotFoundException
- The named resource does not exist.InvalidFormatException
- Data was not syntactically valid JSON.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SetAlarmStateResponse setAlarmState(Consumer<SetAlarmStateRequest.Builder> setAlarmStateRequest) throws ResourceNotFoundException, InvalidFormatException, AwsServiceException, SdkClientException, CloudWatchException
Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous
value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to
send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to ALARM
sends an SNS message.
Metric alarms returns to their actual state quickly, often within seconds. Because the metric alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.
If you use SetAlarmState
on a composite alarm, the composite alarm is not guaranteed to return to
its actual state. It returns to its actual state only once any of its children alarms change state. It is also
reevaluated if you update its configuration.
If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include information
in the StateReasonData
parameter to enable the policy to take the correct action.
This is a convenience which creates an instance of the SetAlarmStateRequest.Builder
avoiding the need to
create one manually via SetAlarmStateRequest.builder()
setAlarmStateRequest
- A Consumer
that will call methods on SetAlarmStateInput.Builder
to create a request.ResourceNotFoundException
- The named resource does not exist.InvalidFormatException
- Data was not syntactically valid JSON.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartMetricStreamsResponse startMetricStreams(StartMetricStreamsRequest startMetricStreamsRequest) throws InternalServiceException, InvalidParameterValueException, MissingRequiredParameterException, AwsServiceException, SdkClientException, CloudWatchException
Starts the streaming of metrics for one or more of your metric streams.
startMetricStreamsRequest
- InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartMetricStreamsResponse startMetricStreams(Consumer<StartMetricStreamsRequest.Builder> startMetricStreamsRequest) throws InternalServiceException, InvalidParameterValueException, MissingRequiredParameterException, AwsServiceException, SdkClientException, CloudWatchException
Starts the streaming of metrics for one or more of your metric streams.
This is a convenience which creates an instance of the StartMetricStreamsRequest.Builder
avoiding the
need to create one manually via StartMetricStreamsRequest.builder()
startMetricStreamsRequest
- A Consumer
that will call methods on StartMetricStreamsInput.Builder
to create a request.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopMetricStreamsResponse stopMetricStreams(StopMetricStreamsRequest stopMetricStreamsRequest) throws InternalServiceException, InvalidParameterValueException, MissingRequiredParameterException, AwsServiceException, SdkClientException, CloudWatchException
Stops the streaming of metrics for one or more of your metric streams.
stopMetricStreamsRequest
- InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopMetricStreamsResponse stopMetricStreams(Consumer<StopMetricStreamsRequest.Builder> stopMetricStreamsRequest) throws InternalServiceException, InvalidParameterValueException, MissingRequiredParameterException, AwsServiceException, SdkClientException, CloudWatchException
Stops the streaming of metrics for one or more of your metric streams.
This is a convenience which creates an instance of the StopMetricStreamsRequest.Builder
avoiding the need
to create one manually via StopMetricStreamsRequest.builder()
stopMetricStreamsRequest
- A Consumer
that will call methods on StopMetricStreamsInput.Builder
to create a request.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.MissingRequiredParameterException
- An input parameter that is required is missing.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidParameterValueException, ResourceNotFoundException, ConcurrentModificationException, InternalServiceException, AwsServiceException, SdkClientException, CloudWatchException
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.
tagResourceRequest
- InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.ResourceNotFoundException
- The named resource does not exist.ConcurrentModificationException
- More than one process tried to modify a resource at the same time.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidParameterValueException, ResourceNotFoundException, ConcurrentModificationException, InternalServiceException, AwsServiceException, SdkClientException, CloudWatchException
Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that can be tagged are alarms and Contributor Insights rules.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource
action with an alarm that already has tags. If you specify a new tag key
for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that
is already associated with the alarm, the new tag value that you specify replaces the previous value for that
tag.
You can associate as many as 50 tags with a CloudWatch resource.
This is a convenience which creates an instance of the TagResourceRequest.Builder
avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest
- A Consumer
that will call methods on TagResourceInput.Builder
to create a request.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.ResourceNotFoundException
- The named resource does not exist.ConcurrentModificationException
- More than one process tried to modify a resource at the same time.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidParameterValueException, ResourceNotFoundException, ConcurrentModificationException, InternalServiceException, AwsServiceException, SdkClientException, CloudWatchException
Removes one or more tags from the specified resource.
untagResourceRequest
- InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.ResourceNotFoundException
- The named resource does not exist.ConcurrentModificationException
- More than one process tried to modify a resource at the same time.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InvalidParameterValueException, ResourceNotFoundException, ConcurrentModificationException, InternalServiceException, AwsServiceException, SdkClientException, CloudWatchException
Removes one or more tags from the specified resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder
avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest
- A Consumer
that will call methods on UntagResourceInput.Builder
to create a request.InvalidParameterValueException
- The value of an input parameter is bad or out-of-range.ResourceNotFoundException
- The named resource does not exist.ConcurrentModificationException
- More than one process tried to modify a resource at the same time.InternalServiceException
- Request processing has failed due to some unknown error, exception, or failure.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()
default CloudWatchWaiter waiter()
CloudWatchWaiter
using this client.
Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
CloudWatchWaiter
Copyright © 2023. All rights reserved.