Class AmazonCloudWatchClient
- All Implemented Interfaces:
AmazonCloudWatch
- Direct Known Subclasses:
AmazonCloudWatchAsyncClient
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final ClientConfigurationFactory
Client configuration factory providing ClientConfigurations tailored to this clientprotected final List
<com.amazonaws.transform.Unmarshaller<AmazonServiceException, Node>> List of exception unmarshallers for all modeled exceptionsFields inherited from class com.amazonaws.AmazonWebServiceClient
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs 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
(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
(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
(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on CloudWatch. -
Method Summary
Modifier and TypeMethodDescriptiondeleteAlarms
(DeleteAlarmsRequest deleteAlarmsRequest) Deletes all specified alarms.Simplified method form for invoking the DescribeAlarmHistory operation.describeAlarmHistory
(DescribeAlarmHistoryRequest describeAlarmHistoryRequest) Retrieves history for the specified alarm.Simplified method form for invoking the DescribeAlarms operation.describeAlarms
(DescribeAlarmsRequest describeAlarmsRequest) Retrieves alarms with the specified names.describeAlarmsForMetric
(DescribeAlarmsForMetricRequest describeAlarmsForMetricRequest) Retrieves all alarms for a single metric.disableAlarmActions
(DisableAlarmActionsRequest disableAlarmActionsRequest) Disables actions for the specified alarms.enableAlarmActions
(EnableAlarmActionsRequest enableAlarmActionsRequest) 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.getMetricStatistics
(GetMetricStatisticsRequest getMetricStatisticsRequest) Gets statistics for the specified metric.Simplified method form for invoking the ListMetrics operation.listMetrics
(ListMetricsRequest listMetricsRequest) Returns a list of valid metrics stored for the AWS account owner.putMetricAlarm
(PutMetricAlarmRequest putMetricAlarmRequest) Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric.putMetricData
(PutMetricDataRequest putMetricDataRequest) Publishes metric data points to Amazon CloudWatch.setAlarmState
(SetAlarmStateRequest setAlarmStateRequest) Temporarily sets the state of an alarm.Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeMarshalling, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.amazonaws.services.cloudwatch.AmazonCloudWatch
setEndpoint, setRegion, shutdown
-
Field Details
-
configFactory
Client configuration factory providing ClientConfigurations tailored to this client -
exceptionUnmarshallers
protected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallersList of exception unmarshallers for all modeled exceptions
-
-
Constructor Details
-
AmazonCloudWatchClient
public AmazonCloudWatchClient()Constructs a new client to invoke service methods on CloudWatch. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Instance profile credentials delivered through the Amazon EC2 metadata service
All service calls made using this new client object are blocking, and will not return until the service call completes.
- See Also:
-
AmazonCloudWatchClient
Constructs a new client to invoke service methods on CloudWatch. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Instance profile credentials delivered through the Amazon EC2 metadata service
All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
clientConfiguration
- The client configuration options controlling how this client connects to CloudWatch (ex: proxy settings, retry counts, etc.).- See Also:
-
AmazonCloudWatchClient
Constructs a new client to invoke service methods on CloudWatch using the specified AWS account credentials.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
-
AmazonCloudWatchClient
public 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.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
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.).
-
AmazonCloudWatchClient
Constructs a new client to invoke service methods on CloudWatch using the specified AWS account credentials provider.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
-
AmazonCloudWatchClient
public 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.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
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.).
-
AmazonCloudWatchClient
public 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.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
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 collector
-
-
Method Details
-
deleteAlarms
Deletes all specified alarms. In the event of an error, no alarms are deleted.
- Specified by:
deleteAlarms
in interfaceAmazonCloudWatch
- Parameters:
deleteAlarmsRequest
-- Returns:
- Result of the DeleteAlarms operation returned by the service.
- Throws:
ResourceNotFoundException
- The named resource does not exist.
-
describeAlarmHistory
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.
Amazon CloudWatch retains the history of an alarm for two weeks, whether or not you delete the alarm. - Specified by:
describeAlarmHistory
in interfaceAmazonCloudWatch
- Parameters:
describeAlarmHistoryRequest
-- Returns:
- Result of the DescribeAlarmHistory operation returned by the service.
- Throws:
InvalidNextTokenException
- The next token specified is invalid.
-
describeAlarmHistory
Description copied from interface:AmazonCloudWatch
Simplified method form for invoking the DescribeAlarmHistory operation.- Specified by:
describeAlarmHistory
in interfaceAmazonCloudWatch
- See Also:
-
describeAlarms
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
- Parameters:
describeAlarmsRequest
-- Returns:
- Result of the DescribeAlarms operation returned by the service.
- Throws:
InvalidNextTokenException
- The next token specified is invalid.
-
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 describeAlarmsForMetricRequest) 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
- Parameters:
describeAlarmsForMetricRequest
-- Returns:
- Result of the DescribeAlarmsForMetric operation returned by the service.
-
disableAlarmActions
public DisableAlarmActionsResult 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.
- Specified by:
disableAlarmActions
in interfaceAmazonCloudWatch
- Parameters:
disableAlarmActionsRequest
-- Returns:
- Result of the DisableAlarmActions operation returned by the service.
-
enableAlarmActions
public EnableAlarmActionsResult enableAlarmActions(EnableAlarmActionsRequest enableAlarmActionsRequest) Enables actions for the specified alarms.
- Specified by:
enableAlarmActions
in interfaceAmazonCloudWatch
- Parameters:
enableAlarmActionsRequest
-- Returns:
- Result of the EnableAlarmActions operation returned by the service.
-
getMetricStatistics
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:- 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
- Parameters:
getMetricStatisticsRequest
-- Returns:
- Result of the GetMetricStatistics operation returned by the service.
- Throws:
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.
-
listMetrics
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
- Parameters:
listMetricsRequest
-- Returns:
- Result of the ListMetrics operation returned by the service.
- Throws:
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.
-
listMetrics
Description copied from interface:AmazonCloudWatch
Simplified method form for invoking the ListMetrics operation.- Specified by:
listMetrics
in interfaceAmazonCloudWatch
- See Also:
-
putMetricAlarm
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
- Parameters:
putMetricAlarmRequest
-- Returns:
- Result of the PutMetricAlarm operation returned by the service.
- Throws:
LimitExceededException
- The quota for alarms for this customer has already been reached.
-
putMetricData
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
- Parameters:
putMetricDataRequest
-- Returns:
- Result of the PutMetricData operation returned by the service.
- Throws:
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.
-
setAlarmState
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
- Parameters:
setAlarmStateRequest
-- Returns:
- Result of the SetAlarmState operation returned by the service.
- Throws:
ResourceNotFoundException
- The named resource does not exist.InvalidFormatException
- Data was not syntactically valid JSON.
-
getCachedResponseMetadata
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 the 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.
-