com.amazonaws.services.cloudwatch.AmazonCloudWatch Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.cloudwatch;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.cloudwatch.model.*;
/**
* Interface for accessing AmazonCloudWatch.
* Amazon CloudWatch
* 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 :
*
*
*
* -
* Actions
* : An alphabetical list of all Amazon CloudWatch actions.
* -
* Data Types
* : An alphabetical list of all Amazon CloudWatch data types.
* -
* Common Parameters
* : Parameters that all Query actions can use.
* -
* Common Errors
* : Client and server errors that all actions can return.
* -
* Regions and Endpoints
* : Itemized regions and endpoints for all AWS products.
* -
* WSDL Location
* : http://monitoring.amazonaws.com/doc/2010-08-01/CloudWatch.wsdl
*
*
*/
public 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
* {@link 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.
*
* @param 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.
*
* @throws IllegalArgumentException
* If any problems are detected with the specified endpoint.
*/
public void setEndpoint(String endpoint) throws java.lang.IllegalArgumentException;
/**
* An alternative to {@link 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 {@link 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.
*
* @param region
* The region this client will communicate with. See
* {@link Region#getRegion(com.amazonaws.regions.Regions)} for
* accessing a given region.
* @throws java.lang.IllegalArgumentException
* If the given region is null, or if this service isn't
* available in the given region. See
* {@link Region#isServiceSupported(String)}
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
*/
public void setRegion(Region region) throws java.lang.IllegalArgumentException;
/**
*
* 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.
*
*
* NOTE: When updating an existing alarm, its StateValue is left
* unchanged.
*
*
* @param putMetricAlarmRequest Container for the necessary parameters to
* execute the PutMetricAlarm service method on AmazonCloudWatch.
*
*
* @throws LimitExceededException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonCloudWatch indicating
* either a problem with the data in the request, or a server side issue.
*/
public void putMetricAlarm(PutMetricAlarmRequest putMetricAlarmRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* 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.
*
*
* NOTE: 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.
*
*
* The size of a PutMetricData request is limited to 8 KB for HTTP GET
* requests and 40 KB for HTTP POST requests.
*
*
* IMPORTANT: Although the 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.
*
*
* @param putMetricDataRequest Container for the necessary parameters to
* execute the PutMetricData service method on AmazonCloudWatch.
*
*
* @throws InvalidParameterValueException
* @throws InternalServiceException
* @throws InvalidParameterCombinationException
* @throws MissingRequiredParameterException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonCloudWatch indicating
* either a problem with the data in the request, or a server side issue.
*/
public void putMetricData(PutMetricDataRequest putMetricDataRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* 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.
*
*
* NOTE: Up to 500 results are returned for any one call. To
* retrieve further results, use returned NextToken values with
* subsequent ListMetrics operations.
*
*
* NOTE: 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.
*
*
* @param listMetricsRequest Container for the necessary parameters to
* execute the ListMetrics service method on AmazonCloudWatch.
*
* @return The response from the ListMetrics service method, as returned
* by AmazonCloudWatch.
*
* @throws InternalServiceException
* @throws InvalidParameterValueException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonCloudWatch indicating
* either a problem with the data in the request, or a server side issue.
*/
public ListMetricsResult listMetrics(ListMetricsRequest listMetricsRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Gets statistics for the specified metric.
*
*
* NOTE: The maximum number of data points returned from a single
* 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.
*
*
* NOTE: The maximum number of data points that can be queried is
* 50,850; whereas the maximum number of data points returned is 1,440.
*
*
* 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
*
*
*
* @param getMetricStatisticsRequest Container for the necessary
* parameters to execute the GetMetricStatistics service method on
* AmazonCloudWatch.
*
* @return The response from the GetMetricStatistics service method, as
* returned by AmazonCloudWatch.
*
* @throws InvalidParameterValueException
* @throws InternalServiceException
* @throws InvalidParameterCombinationException
* @throws MissingRequiredParameterException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonCloudWatch indicating
* either a problem with the data in the request, or a server side issue.
*/
public GetMetricStatisticsResult getMetricStatistics(GetMetricStatisticsRequest getMetricStatisticsRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* 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.
*
*
* @param disableAlarmActionsRequest Container for the necessary
* parameters to execute the DisableAlarmActions service method on
* AmazonCloudWatch.
*
*
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonCloudWatch indicating
* either a problem with the data in the request, or a server side issue.
*/
public void disableAlarmActions(DisableAlarmActionsRequest disableAlarmActionsRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* 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.
*
*
* @param describeAlarmsRequest Container for the necessary parameters to
* execute the DescribeAlarms service method on AmazonCloudWatch.
*
* @return The response from the DescribeAlarms service method, as
* returned by AmazonCloudWatch.
*
* @throws InvalidNextTokenException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonCloudWatch indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeAlarmsResult describeAlarms(DescribeAlarmsRequest describeAlarmsRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Retrieves all alarms for a single metric. Specify a statistic,
* period, or unit to filter the set of alarms further.
*
*
* @param describeAlarmsForMetricRequest Container for the necessary
* parameters to execute the DescribeAlarmsForMetric service method on
* AmazonCloudWatch.
*
* @return The response from the DescribeAlarmsForMetric service method,
* as returned by AmazonCloudWatch.
*
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonCloudWatch indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeAlarmsForMetricResult describeAlarmsForMetric(DescribeAlarmsForMetricRequest describeAlarmsForMetricRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* 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.
*
*
* NOTE: Amazon CloudWatch retains the history of an alarm for two
* weeks, whether or not you delete the alarm.
*
*
* @param describeAlarmHistoryRequest Container for the necessary
* parameters to execute the DescribeAlarmHistory service method on
* AmazonCloudWatch.
*
* @return The response from the DescribeAlarmHistory service method, as
* returned by AmazonCloudWatch.
*
* @throws InvalidNextTokenException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonCloudWatch indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeAlarmHistoryResult describeAlarmHistory(DescribeAlarmHistoryRequest describeAlarmHistoryRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Enables actions for the specified alarms.
*
*
* @param enableAlarmActionsRequest Container for the necessary
* parameters to execute the EnableAlarmActions service method on
* AmazonCloudWatch.
*
*
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonCloudWatch indicating
* either a problem with the data in the request, or a server side issue.
*/
public void enableAlarmActions(EnableAlarmActionsRequest enableAlarmActionsRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Deletes all specified alarms. In the event of an error, no alarms are
* deleted.
*
*
* @param deleteAlarmsRequest Container for the necessary parameters to
* execute the DeleteAlarms service method on AmazonCloudWatch.
*
*
* @throws ResourceNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonCloudWatch indicating
* either a problem with the data in the request, or a server side issue.
*/
public void deleteAlarms(DeleteAlarmsRequest deleteAlarmsRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* 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.
*
*
* @param setAlarmStateRequest Container for the necessary parameters to
* execute the SetAlarmState service method on AmazonCloudWatch.
*
*
* @throws ResourceNotFoundException
* @throws InvalidFormatException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonCloudWatch indicating
* either a problem with the data in the request, or a server side issue.
*/
public void setAlarmState(SetAlarmStateRequest setAlarmStateRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* 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.
*
*
* NOTE: Up to 500 results are returned for any one call. To
* retrieve further results, use returned NextToken values with
* subsequent ListMetrics operations.
*
*
* NOTE: 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.
*
*
* @return The response from the ListMetrics service method, as returned
* by AmazonCloudWatch.
*
* @throws InternalServiceException
* @throws InvalidParameterValueException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonCloudWatch indicating
* either a problem with the data in the request, or a server side issue.
*/
public ListMetricsResult listMetrics() throws AmazonServiceException, AmazonClientException;
/**
*
* 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.
*
*
* @return The response from the DescribeAlarms service method, as
* returned by AmazonCloudWatch.
*
* @throws InvalidNextTokenException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonCloudWatch indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeAlarmsResult describeAlarms() throws AmazonServiceException, AmazonClientException;
/**
*
* 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.
*
*
* NOTE: Amazon CloudWatch retains the history of an alarm for two
* weeks, whether or not you delete the alarm.
*
*
* @return The response from the DescribeAlarmHistory service method, as
* returned by AmazonCloudWatch.
*
* @throws InvalidNextTokenException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonCloudWatch indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeAlarmHistoryResult describeAlarmHistory() throws AmazonServiceException, AmazonClientException;
/**
* 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.
*/
public void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none
* is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}