@ThreadSafe public class AmazonCloudWatchClient extends AmazonWebServiceClient implements AmazonCloudWatch
Amazon CloudWatch monitors your Amazon Web Services (AWS) resources and the applications you run on AWS in real-time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications.
CloudWatch alarms send notifications or automatically make changes to the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon Elastic Compute Cloud (Amazon EC2) instances and then use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money.
In addition to monitoring the built-in metrics that come with AWS, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health.
Modifier and Type | Field and Description |
---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to
this client
|
protected List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> |
exceptionUnmarshallers
List of exception unmarshallers for all CloudWatch exceptions.
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
Constructor and Description |
---|
AmazonCloudWatchClient()
Constructs a new client to invoke service methods on CloudWatch.
|
AmazonCloudWatchClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on CloudWatch using the
specified AWS account credentials.
|
AmazonCloudWatchClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on CloudWatch using the
specified AWS account credentials and client configuration options.
|
AmazonCloudWatchClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on CloudWatch using the
specified AWS account credentials provider.
|
AmazonCloudWatchClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on CloudWatch using the
specified AWS account credentials provider and client configuration
options.
|
AmazonCloudWatchClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on CloudWatch using the
specified AWS account credentials provider, client configuration options,
and request metric collector.
|
AmazonCloudWatchClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on CloudWatch.
|
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.
|
addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
protected static final ClientConfigurationFactory configFactory
protected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallers
public AmazonCloudWatchClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
public AmazonCloudWatchClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client
connects to CloudWatch (ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
public AmazonCloudWatchClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.public AmazonCloudWatchClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client
connects to CloudWatch (ex: proxy settings, retry counts, etc.).public AmazonCloudWatchClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.public AmazonCloudWatchClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client
connects to CloudWatch (ex: proxy settings, retry counts, etc.).public AmazonCloudWatchClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client
connects to CloudWatch (ex: proxy settings, retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic void deleteAlarms(DeleteAlarmsRequest deleteAlarmsRequest)
Deletes all specified alarms. In the event of an error, no alarms are deleted.
deleteAlarms
in interface AmazonCloudWatch
deleteAlarmsRequest
- ResourceNotFoundException
- The named resource does not exist.public 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.
describeAlarmHistory
in interface AmazonCloudWatch
describeAlarmHistoryRequest
- InvalidNextTokenException
- The next token specified is invalid.public DescribeAlarmHistoryResult describeAlarmHistory()
AmazonCloudWatch
describeAlarmHistory
in interface AmazonCloudWatch
AmazonCloudWatch.describeAlarmHistory(DescribeAlarmHistoryRequest)
public 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.
describeAlarms
in interface AmazonCloudWatch
describeAlarmsRequest
- InvalidNextTokenException
- The next token specified is invalid.public DescribeAlarmsResult describeAlarms()
AmazonCloudWatch
describeAlarms
in interface AmazonCloudWatch
AmazonCloudWatch.describeAlarms(DescribeAlarmsRequest)
public DescribeAlarmsForMetricResult describeAlarmsForMetric(DescribeAlarmsForMetricRequest describeAlarmsForMetricRequest)
Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further.
describeAlarmsForMetric
in interface AmazonCloudWatch
describeAlarmsForMetricRequest
- public 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.
disableAlarmActions
in interface AmazonCloudWatch
disableAlarmActionsRequest
- public void enableAlarmActions(EnableAlarmActionsRequest enableAlarmActionsRequest)
Enables actions for the specified alarms.
enableAlarmActions
in interface AmazonCloudWatch
enableAlarmActionsRequest
- public GetMetricStatisticsResult getMetricStatistics(GetMetricStatisticsRequest getMetricStatisticsRequest)
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:
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
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.public 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. Statistics about the metric, however, are available sooner using
GetMetricStatistics. listMetrics
in interface AmazonCloudWatch
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.public ListMetricsResult listMetrics()
AmazonCloudWatch
listMetrics
in interface AmazonCloudWatch
AmazonCloudWatch.listMetrics(ListMetricsRequest)
public 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. 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
putMetricAlarmRequest
- LimitExceededException
- The quota for alarms for this customer has already been reached.public 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. 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.
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
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.public 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. 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 through DescribeAlarmHistory
.
setAlarmState
in interface AmazonCloudWatch
setAlarmStateRequest
- ResourceNotFoundException
- The named resource does not exist.InvalidFormatException
- Data was not syntactically valid JSON.public 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 the request.
getCachedResponseMetadata
in interface AmazonCloudWatch
request
- The originally executed requestCopyright © 2016. All rights reserved.