public class AbstractAmazonCloudWatch extends Object implements AmazonCloudWatch
AmazonCloudWatch
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier | Constructor and Description |
---|---|
protected |
AbstractAmazonCloudWatch() |
Modifier and Type | Method and Description |
---|---|
DeleteAlarmsResult |
deleteAlarms(DeleteAlarmsRequest request)
Deletes all specified alarms.
|
DescribeAlarmHistoryResult |
describeAlarmHistory()
Simplified method form for invoking the DescribeAlarmHistory operation.
|
DescribeAlarmHistoryResult |
describeAlarmHistory(DescribeAlarmHistoryRequest request)
Retrieves history for the specified alarm.
|
DescribeAlarmsResult |
describeAlarms()
Simplified method form for invoking the DescribeAlarms operation.
|
DescribeAlarmsResult |
describeAlarms(DescribeAlarmsRequest request)
Retrieves alarms with the specified names.
|
DescribeAlarmsForMetricResult |
describeAlarmsForMetric(DescribeAlarmsForMetricRequest request)
Retrieves all alarms for a single metric.
|
DisableAlarmActionsResult |
disableAlarmActions(DisableAlarmActionsRequest request)
Disables actions for the specified alarms.
|
EnableAlarmActionsResult |
enableAlarmActions(EnableAlarmActionsRequest request)
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 request)
Gets statistics for the specified metric.
|
ListMetricsResult |
listMetrics()
Simplified method form for invoking the ListMetrics operation.
|
ListMetricsResult |
listMetrics(ListMetricsRequest request)
Returns a list of valid metrics stored for the AWS account owner.
|
PutMetricAlarmResult |
putMetricAlarm(PutMetricAlarmRequest request)
Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric.
|
PutMetricDataResult |
putMetricData(PutMetricDataRequest request)
Publishes metric data points to Amazon CloudWatch.
|
SetAlarmStateResult |
setAlarmState(SetAlarmStateRequest request)
Temporarily sets the state of an alarm for testing purposes.
|
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
AmazonCloudWatch.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.
|
AmazonCloudWatchWaiters |
waiters() |
public void setEndpoint(String endpoint)
AmazonCloudWatch
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.
setEndpoint
in interface AmazonCloudWatch
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.public void setRegion(Region region)
AmazonCloudWatch
AmazonCloudWatch.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.
setRegion
in interface AmazonCloudWatch
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)
public DeleteAlarmsResult deleteAlarms(DeleteAlarmsRequest request)
AmazonCloudWatch
Deletes all specified alarms. In the event of an error, no alarms are deleted.
deleteAlarms
in interface AmazonCloudWatch
request
- Describes the inputs for DeleteAlarms.public DescribeAlarmHistoryResult describeAlarmHistory(DescribeAlarmHistoryRequest request)
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.
describeAlarmHistory
in interface AmazonCloudWatch
request
- Describes the inputs for DescribeAlarmHistory.public DescribeAlarmHistoryResult describeAlarmHistory()
AmazonCloudWatch
describeAlarmHistory
in interface AmazonCloudWatch
AmazonCloudWatch.describeAlarmHistory(DescribeAlarmHistoryRequest)
public DescribeAlarmsResult describeAlarms(DescribeAlarmsRequest request)
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.
describeAlarms
in interface AmazonCloudWatch
request
- Describes the inputs for DescribeAlarms.public DescribeAlarmsResult describeAlarms()
AmazonCloudWatch
describeAlarms
in interface AmazonCloudWatch
AmazonCloudWatch.describeAlarms(DescribeAlarmsRequest)
public DescribeAlarmsForMetricResult describeAlarmsForMetric(DescribeAlarmsForMetricRequest request)
AmazonCloudWatch
Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further.
describeAlarmsForMetric
in interface AmazonCloudWatch
request
- Describes the inputs for DescribeAlarmsForMetric.public DisableAlarmActionsResult disableAlarmActions(DisableAlarmActionsRequest request)
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.
disableAlarmActions
in interface AmazonCloudWatch
public EnableAlarmActionsResult enableAlarmActions(EnableAlarmActionsRequest request)
AmazonCloudWatch
Enables actions for the specified alarms.
enableAlarmActions
in interface AmazonCloudWatch
request
- Describes the inputs for EnableAlarmActions.public GetMetricStatisticsResult getMetricStatistics(GetMetricStatisticsRequest request)
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. A period can be as short as one minute (60
seconds) or as long as one day (86,400 seconds). 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.
getMetricStatistics
in interface AmazonCloudWatch
request
- Describes the inputs for GetMetricStatistics.public ListMetricsResult listMetrics(ListMetricsRequest request)
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 subsequent ListMetrics
operations.
If you create a metric with PutMetricData, allow up to fifteen minutes for the metric to appear in calls
to ListMetrics
. Statistics about the metric, however, are available sooner using
GetMetricStatistics.
listMetrics
in interface AmazonCloudWatch
request
- Describes the inputs for ListMetrics.public ListMetricsResult listMetrics()
AmazonCloudWatch
listMetrics
in interface AmazonCloudWatch
AmazonCloudWatch.listMetrics(ListMetricsRequest)
public PutMetricAlarmResult putMetricAlarm(PutMetricAlarmRequest request)
AmazonCloudWatch
Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric. Optionally, this operation can associate one or more Amazon SNS 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
are then executed.
When updating an existing alarm, its StateValue
is left unchanged, but it completely overwrites the
alarm's previous configuration.
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
and ec2: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
, 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 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.
putMetricAlarm
in interface AmazonCloudWatch
request
- Describes the inputs for PutMetricAlarm.public PutMetricDataResult putMetricData(PutMetricDataRequest request)
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 ListMetrics.
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 type Double
, 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
.
putMetricData
in interface AmazonCloudWatch
request
- Describes the inputs for PutMetricData.public SetAlarmStateResult setAlarmState(SetAlarmStateRequest request)
AmazonCloudWatch
Temporarily sets the state of an alarm for testing purposes. 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 sends an Amazon SNS message. The alarm returns to its actual state (often within seconds). Because
the alarm state change happens very quickly, it is typically only visible in the alarm's History tab in
the Amazon CloudWatch console or through DescribeAlarmHistory
.
setAlarmState
in interface AmazonCloudWatch
request
- Describes the inputs for SetAlarmState.public void shutdown()
AmazonCloudWatch
shutdown
in interface AmazonCloudWatch
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonCloudWatch
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.
getCachedResponseMetadata
in interface AmazonCloudWatch
request
- The originally executed request.public AmazonCloudWatchWaiters waiters()
waiters
in interface AmazonCloudWatch
Copyright © 2016. All rights reserved.