public interface AmazonCloudWatch
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:
Modifier and Type | Method and Description |
---|---|
void |
deleteAlarms(DeleteAlarmsRequest deleteAlarmsRequest)
Deletes all specified alarms.
|
DescribeAlarmHistoryResult |
describeAlarmHistory()
Simplified method form for invoking the DescribeAlarmHistory operation.
|
DescribeAlarmHistoryResult |
describeAlarmHistory(DescribeAlarmHistoryRequest describeAlarmHistoryRequest)
Retrieves history for the specified alarm.
|
DescribeAlarmsResult |
describeAlarms()
Simplified method form for invoking the DescribeAlarms operation.
|
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()
Simplified method form for invoking the ListMetrics operation.
|
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.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
setEndpoint(String) , sets the
regional endpoint for this client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
void setEndpoint(String endpoint)
Callers can pass in just the endpoint (ex:
"monitoring.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "https://monitoring.us-east-1.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
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint
- The endpoint (ex: "monitoring.us-east-1.amazonaws.com") or a full
URL, including the protocol (ex:
"https://monitoring.us-east-1.amazonaws.com") of the region
specific AWS endpoint this client will communicate with.void setRegion(Region region)
setEndpoint(String)
, sets the
regional endpoint for this client's service calls. Callers can use this
method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol.
To use http instead, specify it in the ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region
- The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions)
for
accessing a given region. Must not be null and must be a region
where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class,
com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
void deleteAlarms(DeleteAlarmsRequest deleteAlarmsRequest)
Deletes all specified alarms. In the event of an error, no alarms are deleted.
deleteAlarmsRequest
- ResourceNotFoundException
- The named resource does not exist.DescribeAlarmHistoryResult describeAlarmHistory(DescribeAlarmHistoryRequest describeAlarmHistoryRequest)
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.
describeAlarmHistoryRequest
- InvalidNextTokenException
- The next token specified is invalid.DescribeAlarmHistoryResult describeAlarmHistory()
DescribeAlarmsResult describeAlarms(DescribeAlarmsRequest describeAlarmsRequest)
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
- InvalidNextTokenException
- The next token specified is invalid.DescribeAlarmsResult describeAlarms()
DescribeAlarmsForMetricResult describeAlarmsForMetric(DescribeAlarmsForMetricRequest describeAlarmsForMetricRequest)
Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further.
describeAlarmsForMetricRequest
- void disableAlarmActions(DisableAlarmActionsRequest disableAlarmActionsRequest)
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
- void enableAlarmActions(EnableAlarmActionsRequest enableAlarmActionsRequest)
Enables actions for the specified alarms.
enableAlarmActionsRequest
- GetMetricStatisticsResult getMetricStatistics(GetMetricStatisticsRequest getMetricStatisticsRequest)
Gets statistics for the specified metric.
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.
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
- InvalidParameterValueException
- Bad or out-of-range value was supplied for the input parameter.MissingRequiredParameterException
- An input parameter that is mandatory for processing the request
is not supplied.InvalidParameterCombinationException
- Parameters that must not be used together were used together.InternalServiceException
- Indicates that the request processing has failed due to some
unknown error, exception, or failure.ListMetricsResult listMetrics(ListMetricsRequest listMetricsRequest)
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.
NextToken
values with
subsequent ListMetrics
operations. ListMetrics
action. listMetricsRequest
- InternalServiceException
- Indicates that the request processing has failed due to some
unknown error, exception, or failure.InvalidParameterValueException
- Bad or out-of-range value was supplied for the input parameter.ListMetricsResult listMetrics()
listMetrics(ListMetricsRequest)
void putMetricAlarm(PutMetricAlarmRequest putMetricAlarmRequest)
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.
StateValue
is
left unchanged. putMetricAlarmRequest
- LimitExceededException
- The quota for alarms for this customer has already been reached.void putMetricData(PutMetricDataRequest putMetricDataRequest)
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.
PutMetricData
action,
allow up to fifteen minutes for the metric to appear in calls to the
ListMetrics action.
The size of a
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
- InvalidParameterValueException
- Bad or out-of-range value was supplied for the input parameter.MissingRequiredParameterException
- An input parameter that is mandatory for processing the request
is not supplied.InvalidParameterCombinationException
- Parameters that must not be used together were used together.InternalServiceException
- Indicates that the request processing has failed due to some
unknown error, exception, or failure.void setAlarmState(SetAlarmStateRequest setAlarmStateRequest)
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
- ResourceNotFoundException
- The named resource does not exist.InvalidFormatException
- Data was not syntactically valid JSON.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.Copyright © 2015. All rights reserved.