com.amazonaws.services.cloudwatch
Interface AmazonCloudWatch

All Known Subinterfaces:

AmazonCloudWatchAsync

All Known Implementing Classes:

AmazonCloudWatchAsyncClient, AmazonCloudWatchClient

public interface AmazonCloudWatch

Interface for accessing AmazonCloudWatch. Amazon CloudWatch

Amazon CloudWatch is a web service that enables you to monitor and manage various metrics, as well as configure alarm actions based on data from metrics.

Amazon CloudWatch monitoring enables you to collect, analyze, and view system and application metrics so that you can make operational and business decisions more quickly and with greater confidence. You can use Amazon CloudWatch to collect metrics about your AWS resources, such as the performance of your Amazon EC2 instances.

If you are registered for an AWS product that supports Amazon CloudWatch, the service automatically pushes basic metrics to CloudWatch for you. Once Amazon CloudWatch contains metrics, you can calculate statistics based on that data.

Amazon CloudWatch alarms help you implement decisions more easily by enabling you do things like send notifications or automatically make changes to the resources you are monitoring, based on rules that you define. For example, you can create alarms that initiate Auto Scaling and Simple Notification Service actions on your behalf.

Method Summary

void	deleteAlarms(DeleteAlarmsRequest deleteAlarmsRequest) Deletes all specified alarms.
DescribeAlarmHistoryResult	describeAlarmHistory() Retrieves history for the specified alarm.
DescribeAlarmHistoryResult	describeAlarmHistory(DescribeAlarmHistoryRequest describeAlarmHistoryRequest) Retrieves history for the specified alarm.
DescribeAlarmsResult	describeAlarms() Retrieves alarms with the specified names.
DescribeAlarmsResult	describeAlarms(DescribeAlarmsRequest describeAlarmsRequest) Retrieves alarms with the specified names.
DescribeAlarmsForMetricResult	describeAlarmsForMetric(DescribeAlarmsForMetricRequest describeAlarmsForMetricRequest) Retrieves all alarms for a single metric.
void	disableAlarmActions(DisableAlarmActionsRequest disableAlarmActionsRequest) Disables actions for the specified alarms.
void	enableAlarmActions(EnableAlarmActionsRequest enableAlarmActionsRequest) Enables actions for the specified alarms.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetMetricStatisticsResult	getMetricStatistics(GetMetricStatisticsRequest getMetricStatisticsRequest) Gets statistics for the specified metric.
ListMetricsResult	listMetrics() Returns a list of valid metrics stored for the AWS account owner.
ListMetricsResult	listMetrics(ListMetricsRequest listMetricsRequest) Returns a list of valid metrics stored for the AWS account owner.
void	putMetricAlarm(PutMetricAlarmRequest putMetricAlarmRequest) Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric.
void	setAlarmState(SetAlarmStateRequest setAlarmStateRequest) Temporarily sets the state of an alarm.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://monitoring.amazonaws.com").
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
                 throws IllegalArgumentException

Overrides the default endpoint for this client ("https://monitoring.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

Parameters:

endpoint - The endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

putMetricAlarm

void putMetricAlarm(PutMetricAlarmRequest putMetricAlarmRequest)
                    throws AmazonServiceException,
                           AmazonClientException

Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric. Optionally, this operation can associate one or more Amazon Simple Notification Service resources with the alarm.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA . The alarm is evaluated and its StateValue is set appropriately. Any actions associated with the StateValue is then executed.

NOTE: When updating an existing alarm, its StateValue is left unchanged.

Parameters:

putMetricAlarmRequest - Container for the necessary parameters to execute the PutMetricAlarm service method on AmazonCloudWatch.

Throws:

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

listMetrics

ListMetricsResult listMetrics(ListMetricsRequest listMetricsRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Returns a list of valid metrics stored for the AWS account owner. Returned metrics can be used with GetMetricStatistics to obtain statistical data for a given metric.

NOTE: Up to 500 results are returned for any one call. To retrieve further results, use returned NextToken values with subsequent ListMetrics operations.

Parameters:

listMetricsRequest - Container for the necessary parameters to execute the ListMetrics service method on AmazonCloudWatch.

Returns:

The response from the ListMetrics service method, as returned by AmazonCloudWatch.

Throws:

InternalServiceException

InvalidParameterValueException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

getMetricStatistics

GetMetricStatisticsResult getMetricStatistics(GetMetricStatisticsRequest getMetricStatisticsRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

Gets statistics for the specified metric.

NOTE: The maximum number of datapoints returned from a single GetMetricStatistics request is 1,440. If a request is made that generates more than 1,440 datapoints, Amazon CloudWatch returns an error. In such a case, alter the request by narrowing the specified time range or increasing the specified period. Alternatively, make multiple requests across adjacent time ranges.

Parameters:

getMetricStatisticsRequest - Container for the necessary parameters to execute the GetMetricStatistics service method on AmazonCloudWatch.

Returns:

The response from the GetMetricStatistics service method, as returned by AmazonCloudWatch.

Throws:

InvalidParameterValueException

InternalServiceException

InvalidParameterCombinationException

MissingRequiredParameterException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

disableAlarmActions

void disableAlarmActions(DisableAlarmActionsRequest disableAlarmActionsRequest)
                         throws AmazonServiceException,
                                AmazonClientException

Disables actions for the specified alarms. When an alarm's actions are disabled the alarm's state may change, but none of the alarm's actions will execute.

Parameters:

disableAlarmActionsRequest - Container for the necessary parameters to execute the DisableAlarmActions service method on AmazonCloudWatch.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

describeAlarms

DescribeAlarmsResult describeAlarms(DescribeAlarmsRequest describeAlarmsRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.

Parameters:

describeAlarmsRequest - Container for the necessary parameters to execute the DescribeAlarms service method on AmazonCloudWatch.

Returns:

The response from the DescribeAlarms service method, as returned by AmazonCloudWatch.

Throws:

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

describeAlarmsForMetric

DescribeAlarmsForMetricResult describeAlarmsForMetric(DescribeAlarmsForMetricRequest describeAlarmsForMetricRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further.

Parameters:

describeAlarmsForMetricRequest - Container for the necessary parameters to execute the DescribeAlarmsForMetric service method on AmazonCloudWatch.

Returns:

The response from the DescribeAlarmsForMetric service method, as returned by AmazonCloudWatch.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

describeAlarmHistory

DescribeAlarmHistoryResult describeAlarmHistory(DescribeAlarmHistoryRequest describeAlarmHistoryRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Retrieves history for the specified alarm. Filter alarms by date range or item type. If an alarm name is not specified, Amazon CloudWatch returns histories for all of the owner's alarms.

NOTE: Amazon CloudWatch retains the history of deleted alarms for a period of six weeks. If an alarm has been deleted, its history can still be queried.

Parameters:

describeAlarmHistoryRequest - Container for the necessary parameters to execute the DescribeAlarmHistory service method on AmazonCloudWatch.

Returns:

The response from the DescribeAlarmHistory service method, as returned by AmazonCloudWatch.

Throws:

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

enableAlarmActions

void enableAlarmActions(EnableAlarmActionsRequest enableAlarmActionsRequest)
                        throws AmazonServiceException,
                               AmazonClientException

Enables actions for the specified alarms.

Parameters:

enableAlarmActionsRequest - Container for the necessary parameters to execute the EnableAlarmActions service method on AmazonCloudWatch.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

deleteAlarms

void deleteAlarms(DeleteAlarmsRequest deleteAlarmsRequest)
                  throws AmazonServiceException,
                         AmazonClientException

Deletes all specified alarms. In the event of an error, no alarms are deleted.

Parameters:

deleteAlarmsRequest - Container for the necessary parameters to execute the DeleteAlarms service method on AmazonCloudWatch.

Throws:

ResourceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

setAlarmState

void setAlarmState(SetAlarmStateRequest setAlarmStateRequest)
                   throws AmazonServiceException,
                          AmazonClientException

Temporarily sets the state of an alarm. When the updated StateValue differs from the previous value, the action configured for the appropriate state is invoked. This is not a permanent change. The next periodic alarm check (in about a minute) will set the alarm to its actual state.

Parameters:

setAlarmStateRequest - Container for the necessary parameters to execute the SetAlarmState service method on AmazonCloudWatch.

Throws:

ResourceNotFoundException

InvalidFormatException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

listMetrics

ListMetricsResult listMetrics()
                              throws AmazonServiceException,
                                     AmazonClientException

Returns a list of valid metrics stored for the AWS account owner. Returned metrics can be used with GetMetricStatistics to obtain statistical data for a given metric.

NOTE: Up to 500 results are returned for any one call. To retrieve further results, use returned NextToken values with subsequent ListMetrics operations.

Returns:

The response from the ListMetrics service method, as returned by AmazonCloudWatch.

Throws:

InternalServiceException

InvalidParameterValueException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

describeAlarms

DescribeAlarmsResult describeAlarms()
                                    throws AmazonServiceException,
                                           AmazonClientException

Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.

Returns:

The response from the DescribeAlarms service method, as returned by AmazonCloudWatch.

Throws:

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

describeAlarmHistory

DescribeAlarmHistoryResult describeAlarmHistory()
                                                throws AmazonServiceException,
                                                       AmazonClientException

Retrieves history for the specified alarm. Filter alarms by date range or item type. If an alarm name is not specified, Amazon CloudWatch returns histories for all of the owner's alarms.

NOTE: Amazon CloudWatch retains the history of deleted alarms for a period of six weeks. If an alarm has been deleted, its history can still be queried.

Returns:

The response from the DescribeAlarmHistory service method, as returned by AmazonCloudWatch.

Throws:

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudWatch indicating either a problem with the data in the request, or a server side issue.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.