|
|||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||
public interface AmazonCloudWatch
Interface for accessing AmazonCloudWatch. Amazon CloudWatch
This is the Amazon CloudWatch API Reference . This guide provides detailed information about Amazon CloudWatch actions, data types, parameters, and errors. For detailed information about Amazon CloudWatch features and their associated API calls, go to the Amazon CloudWatch Developer Guide .
Amazon CloudWatch is a web service that enables you to publish, monitor, and manage various metrics, as well as configure alarm actions based on data from metrics. For more information about this product go to http://aws.amazon.com/cloudwatch .
Use the following links to get started using the Amazon CloudWatch API Reference :
| 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 |
putMetricData(PutMetricDataRequest putMetricDataRequest)
Publishes metric data points to Amazon CloudWatch. |
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 |
|---|
void setEndpoint(String endpoint)
throws IllegalArgumentException
Callers can pass in just the endpoint (ex: "monitoring.amazonaws.com") or a full
URL, including the protocol (ex: "https://monitoring.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
endpoint - The endpoint (ex: "monitoring.amazonaws.com") or a full URL,
including the protocol (ex: "https://monitoring.amazonaws.com") of
the region specific AWS endpoint this client will communicate
with.
IllegalArgumentException - If any problems are detected with the specified endpoint.
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.
putMetricAlarmRequest - Container for the necessary parameters to
execute the PutMetricAlarm service method on AmazonCloudWatch.
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.
void putMetricData(PutMetricDataRequest putMetricDataRequest)
throws AmazonServiceException,
AmazonClientException
Publishes metric data points to Amazon CloudWatch. Amazon Cloudwatch associates the data points with the specified metric. If the specified metric does not exist, Amazon CloudWatch creates the metric.
NOTE: If you create a metric with the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action.
The size of a PutMetricData request is limited to 8 KB for HTTP GET requests and 40 KB for HTTP POST requests.
IMPORTANT: Although the Value parameter accepts numbers of type Double, Amazon CloudWatch truncates values with very large exponents. Values with base-10 exponents greater than 126 (1 x 10^126) are truncated. Likewise, values with base-10 exponents less than -130 (1 x 10^-130) are also truncated.
putMetricDataRequest - Container for the necessary parameters to
execute the PutMetricData service method on AmazonCloudWatch.
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.
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.
NOTE: If you create a metric with the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action.
listMetricsRequest - Container for the necessary parameters to
execute the ListMetrics service method on AmazonCloudWatch.
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.
GetMetricStatisticsResult getMetricStatistics(GetMetricStatisticsRequest getMetricStatisticsRequest)
throws AmazonServiceException,
AmazonClientException
Gets statistics for the specified metric.
NOTE: The maximum number of data points returned from a single GetMetricStatistics request is 1,440. If a request is made that generates more than 1,440 data points, 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.
Amazon CloudWatch aggregates data points based on the length of the
period that you specify. For example, if you request
statistics with a one-minute granularity, Amazon CloudWatch aggregates
data points with time stamps that fall within the same one-minute
period. In such a case, the data points queried can greatly outnumber
the data points returned.
NOTE: The maximum number of data points that can be queried is 50,850; whereas the maximum number of data points returned is 1,440.
The following examples show various statistics allowed by the data
point query maximum of 50,850 when you call
GetMetricStatistics on Amazon EC2 instances with detailed
(one-minute) monitoring enabled:
getMetricStatisticsRequest - Container for the necessary
parameters to execute the GetMetricStatistics service method on
AmazonCloudWatch.
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.
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.
disableAlarmActionsRequest - Container for the necessary
parameters to execute the DisableAlarmActions service method on
AmazonCloudWatch.
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.
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.
describeAlarmsRequest - Container for the necessary parameters to
execute the DescribeAlarms service method on AmazonCloudWatch.
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.
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.
describeAlarmsForMetricRequest - Container for the necessary
parameters to execute the DescribeAlarmsForMetric service method on
AmazonCloudWatch.
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.
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 an alarm for two weeks, whether or not you delete the alarm.
describeAlarmHistoryRequest - Container for the necessary
parameters to execute the DescribeAlarmHistory service method on
AmazonCloudWatch.
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.
void enableAlarmActions(EnableAlarmActionsRequest enableAlarmActionsRequest)
throws AmazonServiceException,
AmazonClientException
Enables actions for the specified alarms.
enableAlarmActionsRequest - Container for the necessary
parameters to execute the EnableAlarmActions service method on
AmazonCloudWatch.
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.
void deleteAlarms(DeleteAlarmsRequest deleteAlarmsRequest)
throws AmazonServiceException,
AmazonClientException
Deletes all specified alarms. In the event of an error, no alarms are deleted.
deleteAlarmsRequest - Container for the necessary parameters to
execute the DeleteAlarms service method on AmazonCloudWatch.
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.
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.
setAlarmStateRequest - Container for the necessary parameters to
execute the SetAlarmState service method on AmazonCloudWatch.
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.
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.
NOTE: If you create a metric with the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action.
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.
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.
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.
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 an alarm for two weeks, whether or not you delete the alarm.
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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request - The originally executed request.
|
|||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||