Class AbstractAmazonCloudWatch
- All Implemented Interfaces:
AmazonCloudWatch
- Direct Known Subclasses:
AbstractAmazonCloudWatchAsync
AmazonCloudWatch
. Convenient method forms
pass through to the corresponding overload that takes a request object, which
throws an UnsupportedOperationException
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiondeleteAlarms
(DeleteAlarmsRequest request) Deletes all specified alarms.Simplified method form for invoking the DescribeAlarmHistory operation.Retrieves history for the specified alarm.Simplified method form for invoking the DescribeAlarms operation.describeAlarms
(DescribeAlarmsRequest request) Retrieves alarms with the specified names.Retrieves all alarms for a single metric.Disables actions for the specified alarms.Enables actions for the specified alarms.Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.Gets statistics for the specified metric.Simplified method form for invoking the ListMetrics operation.listMetrics
(ListMetricsRequest request) Returns a list of valid metrics stored for the AWS account owner.putMetricAlarm
(PutMetricAlarmRequest request) Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric.putMetricData
(PutMetricDataRequest request) Publishes metric data points to Amazon CloudWatch.setAlarmState
(SetAlarmStateRequest request) 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
An alternative toAmazonCloudWatch.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.
-
Constructor Details
-
AbstractAmazonCloudWatch
protected AbstractAmazonCloudWatch()
-
-
Method Details
-
setEndpoint
Description copied from interface:AmazonCloudWatch
Overrides the default endpoint for this client ("https://monitoring.us-east-1.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: "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.
- Specified by:
setEndpoint
in interfaceAmazonCloudWatch
- Parameters:
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.
-
setRegion
Description copied from interface:AmazonCloudWatch
An alternative toAmazonCloudWatch.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.
- Specified by:
setRegion
in interfaceAmazonCloudWatch
- Parameters:
region
- The region this client will communicate with. SeeRegion.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.- See Also:
-
deleteAlarms
Description copied from interface:AmazonCloudWatch
Deletes all specified alarms. In the event of an error, no alarms are deleted.
- Specified by:
deleteAlarms
in interfaceAmazonCloudWatch
- Returns:
- Result of the DeleteAlarms operation returned by the service.
-
describeAlarmHistory
Description copied from interface:AmazonCloudWatch
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.
Amazon CloudWatch retains the history of an alarm for two weeks, whether or not you delete the alarm. - Specified by:
describeAlarmHistory
in interfaceAmazonCloudWatch
- Returns:
- Result of the DescribeAlarmHistory operation returned by the service.
-
describeAlarmHistory
Description copied from interface:AmazonCloudWatch
Simplified method form for invoking the DescribeAlarmHistory operation.- Specified by:
describeAlarmHistory
in interfaceAmazonCloudWatch
- See Also:
-
describeAlarms
Description copied from interface:AmazonCloudWatch
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.
- Specified by:
describeAlarms
in interfaceAmazonCloudWatch
- Returns:
- Result of the DescribeAlarms operation returned by the service.
-
describeAlarms
Description copied from interface:AmazonCloudWatch
Simplified method form for invoking the DescribeAlarms operation.- Specified by:
describeAlarms
in interfaceAmazonCloudWatch
- See Also:
-
describeAlarmsForMetric
public DescribeAlarmsForMetricResult describeAlarmsForMetric(DescribeAlarmsForMetricRequest request) Description copied from interface:AmazonCloudWatch
Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further.
- Specified by:
describeAlarmsForMetric
in interfaceAmazonCloudWatch
- Returns:
- Result of the DescribeAlarmsForMetric operation returned by the service.
-
disableAlarmActions
Description copied from interface:AmazonCloudWatch
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.
- Specified by:
disableAlarmActions
in interfaceAmazonCloudWatch
- Returns:
- Result of the DisableAlarmActions operation returned by the service.
-
enableAlarmActions
Description copied from interface:AmazonCloudWatch
Enables actions for the specified alarms.
- Specified by:
enableAlarmActions
in interfaceAmazonCloudWatch
- Returns:
- Result of the EnableAlarmActions operation returned by the service.
-
getMetricStatistics
Description copied from interface:AmazonCloudWatch
Gets statistics for the specified metric.
The maximum number of data points that can be queried is 50,850, whereas the maximum number of data points returned from a single
GetMetricStatistics
request is 1,440. If you make a request that generates more than 1,440 data points, Amazon CloudWatch returns an error. In such a case, you can alter the request by narrowing the specified time range or increasing the specified period. Alternatively, you can make multiple requests across adjacent time ranges.GetMetricStatistics
does not return the data in chronological order.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:- Statistics for up to 400 instances for a span of one hour
- Statistics for up to 35 instances over a span of 24 hours
- Statistics for up to 2 instances over a span of 2 weeks
For information about the namespace, metric names, and dimensions that other Amazon Web Services products use to send metrics to CloudWatch, go to Amazon CloudWatch Metrics, Namespaces, and Dimensions Reference in the Amazon CloudWatch Developer Guide.
- Specified by:
getMetricStatistics
in interfaceAmazonCloudWatch
- Returns:
- Result of the GetMetricStatistics operation returned by the service.
-
listMetrics
Description copied from interface:AmazonCloudWatch
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.
Up to 500 results are returned for any one call. To retrieve further results, use returned NextToken
values with subsequentListMetrics
operations.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. Statistics about the metric, however, are available sooner using GetMetricStatistics.- Specified by:
listMetrics
in interfaceAmazonCloudWatch
- Returns:
- Result of the ListMetrics operation returned by the service.
-
listMetrics
Description copied from interface:AmazonCloudWatch
Simplified method form for invoking the ListMetrics operation.- Specified by:
listMetrics
in interfaceAmazonCloudWatch
- See Also:
-
putMetricAlarm
Description copied from interface:AmazonCloudWatch
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 itsStateValue
is set appropriately. Any actions associated with theStateValue
is then executed.When updating an existing alarm, its StateValue
is left unchanged.If you are using an AWS Identity and Access Management (IAM) account to create or modify an alarm, you must have the following Amazon EC2 permissions: ec2:DescribeInstanceStatus
andec2:DescribeInstances
for all alarms on Amazon EC2 instance status metrics.ec2:StopInstances
for alarms with stop actions.ec2:TerminateInstances
for alarms with terminate actions.ec2:DescribeInstanceRecoveryAttribute
, andec2: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 won't be performed on the Amazon EC2 instance. However, if you are later granted permission to use the associated Amazon EC2 APIs, the alarm actions you created earlier will be performed. For more information about IAM permissions, see Permissions and Policies in Using IAM.
If you are using an IAM role (e.g., an Amazon 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 the AWS Security Token Service (AWS STS), you cannot stop or terminate an Amazon EC2 instance using alarm actions.
- Specified by:
putMetricAlarm
in interfaceAmazonCloudWatch
- Returns:
- Result of the PutMetricAlarm operation returned by the service.
-
putMetricData
Description copied from interface:AmazonCloudWatch
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. When Amazon CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to the ListMetrics action.
Each
PutMetricData
request is limited to 8 KB in size for HTTP GET requests and is limited to 40 KB in size for HTTP POST requests.Although the Value
parameter accepts numbers of typeDouble
, Amazon 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 (e.g., NaN, +Infinity, -Infinity) are not supported.Data that is timestamped 24 hours or more in the past may take in excess of 48 hours to become available from submission time using
GetMetricStatistics
.- Specified by:
putMetricData
in interfaceAmazonCloudWatch
- Returns:
- Result of the PutMetricData operation returned by the service.
-
setAlarmState
Description copied from interface:AmazonCloudWatch
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. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm's state to ALARM will send an Amazon SNS message. This is not a permanent change. The next periodic alarm check (in about a minute) will set the alarm to its actual state. Because the alarm state change happens very quickly, it is typically only visibile in the alarm's History tab in the Amazon CloudWatch console or throughDescribeAlarmHistory
.- Specified by:
setAlarmState
in interfaceAmazonCloudWatch
- Returns:
- Result of the SetAlarmState operation returned by the service.
-
shutdown
public void shutdown()Description copied from interface:AmazonCloudWatch
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.- Specified by:
shutdown
in interfaceAmazonCloudWatch
-
getCachedResponseMetadata
Description copied from interface:AmazonCloudWatch
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.
- Specified by:
getCachedResponseMetadata
in interfaceAmazonCloudWatch
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-