public class AmazonCloudWatchClient extends AmazonWebServiceClient implements 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:
LOGGING_AWS_REQUEST_METRIC| 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, configureRegion, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdownpublic AmazonCloudWatchClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChainpublic 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.).DefaultAWSCredentialsProviderChainpublic 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 AmazonCloudWatchdeleteAlarmsRequest - 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 AmazonCloudWatchdescribeAlarmHistoryRequest - InvalidNextTokenException - The next token specified is invalid.public DescribeAlarmHistoryResult describeAlarmHistory()
AmazonCloudWatchdescribeAlarmHistory in interface AmazonCloudWatchAmazonCloudWatch.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 AmazonCloudWatchdescribeAlarmsRequest - InvalidNextTokenException - The next token specified is invalid.public DescribeAlarmsResult describeAlarms()
AmazonCloudWatchdescribeAlarms in interface AmazonCloudWatchAmazonCloudWatch.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 AmazonCloudWatchdescribeAlarmsForMetricRequest - 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 AmazonCloudWatchdisableAlarmActionsRequest - public void enableAlarmActions(EnableAlarmActionsRequest enableAlarmActionsRequest)
Enables actions for the specified alarms.
enableAlarmActions in interface AmazonCloudWatchenableAlarmActionsRequest - public 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:
getMetricStatistics in interface AmazonCloudWatchgetMetricStatisticsRequest - 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. listMetrics in interface AmazonCloudWatchlistMetricsRequest - 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()
AmazonCloudWatchlistMetrics in interface AmazonCloudWatchAmazonCloudWatch.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. putMetricAlarm in interface AmazonCloudWatchputMetricAlarmRequest - 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.
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. putMetricData in interface AmazonCloudWatchputMetricDataRequest - 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. This is not a permanent
change. The next periodic alarm check (in about a minute) will set the
alarm to its actual state.
setAlarmState in interface AmazonCloudWatchsetAlarmStateRequest - 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 AmazonCloudWatchrequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.