@Generated(value="software.amazon.awssdk:codegen") public interface CloudWatchClient extends SdkClient
builder() method.
Amazon CloudWatch monitors your Amazon Web Services (AWS) resources and the applications you run on AWS in real time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications.
CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money.
In addition to monitoring the built-in metrics that come with AWS, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static 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 DeleteDashboardsResponse |
deleteDashboards(Consumer<DeleteDashboardsRequest.Builder> deleteDashboardsRequest)
Deletes all dashboards that you specify.
|
default DeleteDashboardsResponse |
deleteDashboards(DeleteDashboardsRequest deleteDashboardsRequest)
Deletes all dashboards 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 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 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 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 GetMetricDataResponse |
getMetricData(Consumer<GetMetricDataRequest.Builder> getMetricDataRequest)
You can use the
GetMetricData API to retrieve as many as 100 different metrics in a single request,
with a total of as many as 100,800 datapoints. |
default GetMetricDataResponse |
getMetricData(GetMetricDataRequest getMetricDataRequest)
You can use the
GetMetricData API to retrieve as many as 100 different metrics in a single request,
with a total of as many as 100,800 datapoints. |
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 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 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 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 PutMetricAlarmResponse |
putMetricAlarm(Consumer<PutMetricAlarmRequest.Builder> putMetricAlarmRequest)
Creates or updates an alarm and associates it with the specified metric or metric math expression.
|
default PutMetricAlarmResponse |
putMetricAlarm(PutMetricAlarmRequest putMetricAlarmRequest)
Creates or updates an alarm and associates it with the specified metric or metric math expression.
|
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.
|
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.
|
serviceNameclosestatic final String SERVICE_NAME
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. In the event of an error, no alarms are deleted.
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.AwsServiceExceptiondefault DeleteAlarmsResponse deleteAlarms(Consumer<DeleteAlarmsRequest.Builder> deleteAlarmsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, CloudWatchException
Deletes the specified alarms. In the event of an error, no alarms are deleted.
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.AwsServiceExceptiondefault DeleteDashboardsResponse deleteDashboards(DeleteDashboardsRequest deleteDashboardsRequest) throws InvalidParameterValueException, DashboardNotFoundErrorException, InternalServiceException, AwsServiceException, SdkClientException, CloudWatchException
Deletes all dashboards that you specify. You may specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.
deleteDashboardsRequest - 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.AwsServiceExceptiondefault DeleteDashboardsResponse deleteDashboards(Consumer<DeleteDashboardsRequest.Builder> deleteDashboardsRequest) throws InvalidParameterValueException, DashboardNotFoundErrorException, InternalServiceException, AwsServiceException, SdkClientException, CloudWatchException
Deletes all dashboards that you specify. You may specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.
This is a convenience which creates an instance of the 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.AwsServiceExceptiondefault 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 all alarms are returned.
CloudWatch retains the history of an alarm even if you delete the alarm.
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.AwsServiceExceptiondescribeAlarmHistory(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 all alarms are returned.
CloudWatch retains the history of an alarm even if you delete the alarm.
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.AwsServiceExceptiondefault 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 all alarms are returned.
CloudWatch retains the history of an alarm even if you delete the alarm.
This is a convenience which creates an instance of the 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.AwsServiceExceptiondefault 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 all alarms are returned.
CloudWatch retains the history of an alarm even if you delete the alarm.
This is a variant of
describeAlarmHistory(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmHistoryRequest)
operation. The return type is a custom 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(....);
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.AwsServiceExceptiondescribeAlarmHistoryPaginator(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 all alarms are returned.
CloudWatch retains the history of an alarm even if you delete the alarm.
This is a variant of
describeAlarmHistory(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmHistoryRequest)
operation. The return type is a custom 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(....);
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.AwsServiceExceptiondefault 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 all alarms are returned.
CloudWatch retains the history of an alarm even if you delete the alarm.
This is a variant of
describeAlarmHistory(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmHistoryRequest)
operation. The return type is a custom 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(....);
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.AwsServiceExceptiondefault DescribeAlarmsResponse describeAlarms() throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
Retrieves the specified alarms. If no alarms are specified, all alarms are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.
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.AwsServiceExceptiondescribeAlarms(DescribeAlarmsRequest),
AWS API
Documentationdefault DescribeAlarmsResponse describeAlarms(DescribeAlarmsRequest describeAlarmsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
Retrieves the specified alarms. If no alarms are specified, all alarms are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.
describeAlarmsRequest - 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.AwsServiceExceptiondefault DescribeAlarmsResponse describeAlarms(Consumer<DescribeAlarmsRequest.Builder> describeAlarmsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
Retrieves the specified alarms. If no alarms are specified, all alarms are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.
This is a convenience which creates an instance of the 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.AwsServiceExceptiondefault DescribeAlarmsIterable describeAlarmsPaginator() throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
Retrieves the specified alarms. If no alarms are specified, all alarms are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.
This is a variant of
describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest) operation. The
return type is a custom 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(....);
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.AwsServiceExceptiondescribeAlarmsPaginator(DescribeAlarmsRequest),
AWS API
Documentationdefault DescribeAlarmsIterable describeAlarmsPaginator(DescribeAlarmsRequest describeAlarmsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
Retrieves the specified alarms. If no alarms are specified, all alarms are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.
This is a variant of
describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest) operation. The
return type is a custom 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(....);
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.AwsServiceExceptiondefault DescribeAlarmsIterable describeAlarmsPaginator(Consumer<DescribeAlarmsRequest.Builder> describeAlarmsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
Retrieves the specified alarms. If no alarms are specified, all alarms are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.
This is a variant of
describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest) operation. The
return type is a custom 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(....);
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.AwsServiceExceptiondefault 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.
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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault GetMetricDataResponse getMetricData(GetMetricDataRequest getMetricDataRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
You can use the GetMetricData API to retrieve as many as 100 different metrics in a single request,
with a total of as many as 100,800 datapoints. You can also optionally perform math expressions on the values of
the returned statistics, to create new time series that represent new insights into your data. For example, using
Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series.
For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
Calls to the GetMetricData API have a different pricing structure than calls to
GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing.
Amazon CloudWatch retains metric data as follows:
Data points with a period of less than 60 seconds are available for 3 hours. These data points are
high-resolution metrics and are available only for custom metrics that have been defined with a
StorageResolution of 1.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
Data points with a period of 300 seconds (5-minute) are available for 63 days.
Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.
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.AwsServiceExceptiondefault GetMetricDataResponse getMetricData(Consumer<GetMetricDataRequest.Builder> getMetricDataRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CloudWatchException
You can use the GetMetricData API to retrieve as many as 100 different metrics in a single request,
with a total of as many as 100,800 datapoints. You can also optionally perform math expressions on the values of
the returned statistics, to create new time series that represent new insights into your data. For example, using
Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series.
For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
Calls to the GetMetricData API have a different pricing structure than calls to
GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing.
Amazon CloudWatch retains metric data as follows:
Data points with a period of less than 60 seconds are available for 3 hours. These data points are
high-resolution metrics and are available only for custom metrics that have been defined with a
StorageResolution of 1.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
Data points with a period of 300 seconds (5-minute) are available for 63 days.
Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.
This is a convenience which creates an instance of the 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.AwsServiceExceptiondefault 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 AWS 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.AwsServiceExceptiondefault 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 AWS services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.
This is a convenience which creates an instance of the 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptionlistDashboards(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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault ListMetricsResponse listMetrics() throws InternalServiceException, InvalidParameterValueException, AwsServiceException, SdkClientException, CloudWatchException
List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain statistical data.
Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.
After you create a metric, allow up to fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using GetMetricData or GetMetricStatistics.
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.AwsServiceExceptionlistMetrics(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 obtain statistical data.
Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.
After you create a metric, allow up to fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using GetMetricData or GetMetricStatistics.
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.AwsServiceExceptiondefault 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 obtain statistical data.
Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.
After you create a metric, allow up to fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using GetMetricData or GetMetricStatistics.
This is a convenience which creates an instance of the 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.AwsServiceExceptiondefault ListMetricsIterable listMetricsPaginator() throws InternalServiceException, InvalidParameterValueException, AwsServiceException, SdkClientException, CloudWatchException
List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain statistical data.
Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.
After you create a metric, allow up to fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using GetMetricData or GetMetricStatistics.
This is a variant of 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(....);
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.AwsServiceExceptionlistMetricsPaginator(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 obtain statistical data.
Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.
After you create a metric, allow up to fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using GetMetricData or GetMetricStatistics.
This is a variant of 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(....);
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.AwsServiceExceptiondefault 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 obtain statistical data.
Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.
After you create a metric, allow up to fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using GetMetricData or GetMetricStatistics.
This is a variant of 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(....);
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.AwsServiceExceptiondefault 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.
There is no limit to the number of dashboards in your account. All dashboards in your account are global, not region-specific.
A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an
existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the
Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use
GetDashboard, and then use the data returned within DashboardBody as the template for
the new dashboard when you call PutDashboard.
When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of
the dashboard with a message that the dashboard was created by script and should not be changed in the console.
This message could also point console users to the location of the DashboardBody script or the
CloudFormation template used to create the dashboard.
putDashboardRequest - 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.AwsServiceExceptiondefault 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.
There is no limit to the number of dashboards in your account. All dashboards in your account are global, not region-specific.
A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an
existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the
Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use
GetDashboard, and then use the data returned within DashboardBody as the template for
the new dashboard when you call PutDashboard.
When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of
the dashboard with a message that the dashboard was created by script and should not be changed in the console.
This message could also point console users to the location of the DashboardBody script or the
CloudFormation template used to create the dashboard.
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.AwsServiceExceptiondefault PutMetricAlarmResponse putMetricAlarm(PutMetricAlarmRequest putMetricAlarmRequest) throws LimitExceededException, AwsServiceException, SdkClientException, CloudWatchException
Creates or updates an alarm and associates it with the specified metric or metric math expression.
When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The
alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then
executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:
iam:CreateServiceLinkedRole for all alarms with EC2 actions
ec2:DescribeInstanceStatus and ec2:DescribeInstances for all alarms on EC2 instance
status metrics
ec2:StopInstances for alarms with stop actions
ec2:TerminateInstances for alarms with terminate actions
ec2:DescribeInstanceRecoveryAttribute and ec2:RecoverInstances for alarms with recover
actions
If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm, but the stop or terminate actions are not performed. However, if you are later granted the required permissions, the alarm actions that you created earlier are performed.
If you are using an IAM role (for example, an EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies.
If you are using temporary security credentials granted using AWS STS, you cannot stop or terminate an EC2 instance using alarm actions.
The first time you create an alarm in the AWS Management Console, the CLI, or by using the PutMetricAlarm API,
CloudWatch creates the necessary service-linked role for you. The service-linked role is called
AWSServiceRoleForCloudWatchEvents. For more information, see AWS service-linked role.
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.AwsServiceExceptiondefault PutMetricAlarmResponse putMetricAlarm(Consumer<PutMetricAlarmRequest.Builder> putMetricAlarmRequest) throws LimitExceededException, AwsServiceException, SdkClientException, CloudWatchException
Creates or updates an alarm and associates it with the specified metric or metric math expression.
When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The
alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then
executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:
iam:CreateServiceLinkedRole for all alarms with EC2 actions
ec2:DescribeInstanceStatus and ec2:DescribeInstances for all alarms on EC2 instance
status metrics
ec2:StopInstances for alarms with stop actions
ec2:TerminateInstances for alarms with terminate actions
ec2:DescribeInstanceRecoveryAttribute and ec2:RecoverInstances for alarms with recover
actions
If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm, but the stop or terminate actions are not performed. However, if you are later granted the required permissions, the alarm actions that you created earlier are performed.
If you are using an IAM role (for example, an EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies.
If you are using temporary security credentials granted using AWS STS, you cannot stop or terminate an EC2 instance using alarm actions.
The first time you create an alarm in the AWS Management Console, the CLI, or by using the PutMetricAlarm API,
CloudWatch creates the necessary service-linked role for you. The service-linked role is called
AWSServiceRoleForCloudWatchEvents. For more information, see AWS service-linked role.
This is a convenience which creates an instance of the 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.AwsServiceExceptiondefault 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 40 KB in size for HTTP POST requests. You can send a
payload compressed by gzip. Each request is also limited to no more than 20 different metrics.
Although the Value parameter accepts numbers of type Double, CloudWatch rejects values
that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10)
or 2e-360 to 2e360 (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity) are not
supported.
You can use up to 10 dimensions per metric to further clarify what data the metric collects. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.
Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricData or GetMetricStatistics from the time they are submitted.
CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:
The SampleCount value of the statistic set is 1 and Min, Max, and
Sum are all equal.
The Min and Max are equal, and Sum is equal to Min multiplied
by SampleCount.
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.AwsServiceExceptiondefault 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 40 KB in size for HTTP POST requests. You can send a
payload compressed by gzip. Each request is also limited to no more than 20 different metrics.
Although the Value parameter accepts numbers of type Double, CloudWatch rejects values
that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10)
or 2e-360 to 2e360 (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity) are not
supported.
You can use up to 10 dimensions per metric to further clarify what data the metric collects. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.
Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricData or GetMetricStatistics from the time they are submitted.
CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:
The SampleCount value of the statistic set is 1 and Min, Max, and
Sum are all equal.
The Min and Max are equal, and Sum is equal to Min multiplied
by SampleCount.
This is a convenience which creates an instance of the 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.AwsServiceExceptiondefault 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. The alarm returns to its actual state (often within seconds). Because the alarm state
change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch
console or through DescribeAlarmHistory.
setAlarmStateRequest - 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.AwsServiceExceptiondefault 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. The alarm returns to its actual state (often within seconds). Because the alarm state
change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch
console or through DescribeAlarmHistory.
This is a convenience which creates an instance of the 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.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2018. All rights reserved.