/*
* Copyright 2012-2017 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 javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.cloudwatch.model.*;
import com.amazonaws.services.cloudwatch.waiters.AmazonCloudWatchWaiters;
/**
* Interface for accessing CloudWatch.
* <p>
* <b>Note:</b> Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.cloudwatch.AbstractAmazonCloudWatch} instead.
* </p>
* <p>
* <p>
* 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.
* </p>
* <p>
* 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.
* </p>
* <p>
* 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.
* </p>
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonCloudWatch {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "monitoring";
/**
* 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.
* <p>
* 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.
* <p>
* 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: <a
* href="http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912">
* http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912</a>
* <p>
* <b>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.</b>
*
* @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.
* @deprecated use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for
* example:
* {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));}
*/
@Deprecated
void setEndpoint(String endpoint);
/**
* 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.
* <p>
* 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.
* <p>
* <b>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.</b>
*
* @param region
* The region this client will communicate with. See {@link 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.
*
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
* @deprecated use {@link AwsClientBuilder#setRegion(String)}
*/
@Deprecated
void setRegion(Region region);
/**
* <p>
* Deletes the specified alarms. In the event of an error, no alarms are deleted.
* </p>
*
* @param deleteAlarmsRequest
* @return Result of the DeleteAlarms operation returned by the service.
* @throws ResourceNotFoundException
* The named resource does not exist.
* @sample AmazonCloudWatch.DeleteAlarms
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteAlarms" target="_top">AWS API
* Documentation</a>
*/
DeleteAlarmsResult deleteAlarms(DeleteAlarmsRequest deleteAlarmsRequest);
/**
* <p>
* Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm
* name is not specified, the histories for all alarms are returned.
* </p>
* <p>
* Note that Amazon CloudWatch retains the history of an alarm even if you delete the alarm.
* </p>
*
* @param describeAlarmHistoryRequest
* @return Result of the DescribeAlarmHistory operation returned by the service.
* @throws InvalidNextTokenException
* The next token specified is invalid.
* @sample AmazonCloudWatch.DescribeAlarmHistory
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmHistory"
* target="_top">AWS API Documentation</a>
*/
DescribeAlarmHistoryResult describeAlarmHistory(DescribeAlarmHistoryRequest describeAlarmHistoryRequest);
/**
* Simplified method form for invoking the DescribeAlarmHistory operation.
*
* @see #describeAlarmHistory(DescribeAlarmHistoryRequest)
*/
DescribeAlarmHistoryResult describeAlarmHistory();
/**
* <p>
* Retrieves the specified alarms. If no alarms are specified, all alarms are returned. Alarms can be retrieved by
* using only a prefix for the alarm name, the alarm state, or a prefix for any action.
* </p>
*
* @param describeAlarmsRequest
* @return Result of the DescribeAlarms operation returned by the service.
* @throws InvalidNextTokenException
* The next token specified is invalid.
* @sample AmazonCloudWatch.DescribeAlarms
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarms" target="_top">AWS API
* Documentation</a>
*/
DescribeAlarmsResult describeAlarms(DescribeAlarmsRequest describeAlarmsRequest);
/**
* Simplified method form for invoking the DescribeAlarms operation.
*
* @see #describeAlarms(DescribeAlarmsRequest)
*/
DescribeAlarmsResult describeAlarms();
/**
* <p>
* Retrieves the alarms for the specified metric. Specify a statistic, period, or unit to filter the results.
* </p>
*
* @param describeAlarmsForMetricRequest
* @return Result of the DescribeAlarmsForMetric operation returned by the service.
* @sample AmazonCloudWatch.DescribeAlarmsForMetric
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmsForMetric"
* target="_top">AWS API Documentation</a>
*/
DescribeAlarmsForMetricResult describeAlarmsForMetric(DescribeAlarmsForMetricRequest describeAlarmsForMetricRequest);
/**
* <p>
* Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not
* execute when the alarm state changes.
* </p>
*
* @param disableAlarmActionsRequest
* @return Result of the DisableAlarmActions operation returned by the service.
* @sample AmazonCloudWatch.DisableAlarmActions
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DisableAlarmActions" target="_top">AWS
* API Documentation</a>
*/
DisableAlarmActionsResult disableAlarmActions(DisableAlarmActionsRequest disableAlarmActionsRequest);
/**
* <p>
* Enables the actions for the specified alarms.
* </p>
*
* @param enableAlarmActionsRequest
* @return Result of the EnableAlarmActions operation returned by the service.
* @sample AmazonCloudWatch.EnableAlarmActions
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/EnableAlarmActions" target="_top">AWS
* API Documentation</a>
*/
EnableAlarmActionsResult enableAlarmActions(EnableAlarmActionsRequest enableAlarmActionsRequest);
/**
* <p>
* Gets statistics for the specified metric.
* </p>
* <p>
* Amazon CloudWatch retains metric data as follows:
* </p>
* <ul>
* <li>
* <p>
* Data points with a period of 60 seconds (1 minute) are available for 15 days
* </p>
* </li>
* <li>
* <p>
* Data points with a period of 300 seconds (5 minute) are available for 63 days
* </p>
* </li>
* <li>
* <p>
* Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months)
* </p>
* </li>
* </ul>
* <p>
* Note that CloudWatch started retaining 5-minute and 1-hour metric data as of 9 July 2016.
* </p>
* <p>
* The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data
* points, Amazon CloudWatch returns an error. To reduce the number of data points, you can narrow the specified
* time range and make multiple requests across adjacent time ranges, or you can increase the specified period. A
* period can be as short as one minute (60 seconds). Note that data points are not returned in chronological order.
* </p>
* <p>
* Amazon CloudWatch aggregates data points based on the length of the period that you specify. For example, if you
* request statistics with a one-hour period, Amazon CloudWatch aggregates all data points with time stamps that
* fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the
* number of data points returned.
* </p>
* <p>
* CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set
* instead, you cannot retrieve percentile statistics for this data unless one of the following conditions is true:
* </p>
* <ul>
* <li>
* <p>
* The SampleCount of the statistic set is 1
* </p>
* </li>
* <li>
* <p>
* The Min and the Max of the statistic set are equal
* </p>
* </li>
* </ul>
* <p>
* For a list of metrics and dimensions supported by AWS services, see the <a
* href="http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CW_Support_For_AWS.html">Amazon CloudWatch
* Metrics and Dimensions Reference</a> in the <i>Amazon CloudWatch User Guide</i>.
* </p>
*
* @param getMetricStatisticsRequest
* @return Result of the GetMetricStatistics operation returned by the service.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws MissingRequiredParameterException
* An input parameter that is required is missing.
* @throws InvalidParameterCombinationException
* Parameters that cannot be used together were used together.
* @throws InternalServiceException
* Request processing has failed due to some unknown error, exception, or failure.
* @sample AmazonCloudWatch.GetMetricStatistics
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricStatistics" target="_top">AWS
* API Documentation</a>
*/
GetMetricStatisticsResult getMetricStatistics(GetMetricStatisticsRequest getMetricStatisticsRequest);
/**
* <p>
* List the specified metrics. You can use the returned metrics with <a>GetMetricStatistics</a> to obtain
* statistical data.
* </p>
* <p>
* Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with
* subsequent calls.
* </p>
* <p>
* After you create a metric, allow up to fifteen minutes before the metric appears. Statistics about the metric,
* however, are available sooner using <a>GetMetricStatistics</a>.
* </p>
*
* @param listMetricsRequest
* @return Result of the ListMetrics operation returned by the service.
* @throws InternalServiceException
* Request processing has failed due to some unknown error, exception, or failure.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @sample AmazonCloudWatch.ListMetrics
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListMetrics" target="_top">AWS API
* Documentation</a>
*/
ListMetricsResult listMetrics(ListMetricsRequest listMetricsRequest);
/**
* Simplified method form for invoking the ListMetrics operation.
*
* @see #listMetrics(ListMetricsRequest)
*/
ListMetricsResult listMetrics();
/**
* <p>
* Creates or updates an alarm and associates it with the specified metric. Optionally, this operation can associate
* one or more Amazon SNS resources with the alarm.
* </p>
* <p>
* When this operation creates an alarm, the alarm state is immediately set to <code>INSUFFICIENT_DATA</code>. The
* alarm is evaluated and its state is set appropriately. Any actions associated with the state are then executed.
* </p>
* <p>
* When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous
* configuration of the alarm.
* </p>
* <p>
* If you are an AWS Identity and Access Management (IAM) user, you must have Amazon EC2 permissions for some
* operations:
* </p>
* <ul>
* <li>
* <p>
* <code>ec2:DescribeInstanceStatus</code> and <code>ec2:DescribeInstances</code> for all alarms on EC2 instance
* status metrics
* </p>
* </li>
* <li>
* <p>
* <code>ec2:StopInstances</code> for alarms with stop actions
* </p>
* </li>
* <li>
* <p>
* <code>ec2:TerminateInstances</code> for alarms with terminate actions
* </p>
* </li>
* <li>
* <p>
* <code>ec2:DescribeInstanceRecoveryAttribute</code> and <code>ec2:RecoverInstances</code> for alarms with recover
* actions
* </p>
* </li>
* </ul>
* <p>
* 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. However, if you are later granted the required permissions,
* the alarm actions that you created earlier will be performed.
* </p>
* <p>
* If you are using an IAM role (for example, 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.
* </p>
* <p>
* 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.
* </p>
* <p>
* Note that you must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch
* console to create the <b>EC2ActionsAccess</b> IAM role. After this IAM role is created, you can create stop,
* terminate, or reboot alarms using a command-line interface or an API.
* </p>
*
* @param putMetricAlarmRequest
* @return Result of the PutMetricAlarm operation returned by the service.
* @throws LimitExceededException
* The quota for alarms for this customer has already been reached.
* @sample AmazonCloudWatch.PutMetricAlarm
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricAlarm" target="_top">AWS API
* Documentation</a>
*/
PutMetricAlarmResult putMetricAlarm(PutMetricAlarmRequest putMetricAlarmRequest);
/**
* <p>
* 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
* <a>ListMetrics</a>.
* </p>
* <p>
* Each <code>PutMetricData</code> request is limited to 40 KB in size for HTTP POST requests.
* </p>
* <p>
* Although the <code>Value</code> parameter accepts numbers of type <code>Double</code>, 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.
* </p>
* <p>
* You can use up to 10 dimensions per metric to further clarify what data the metric collects. For more information
* on specifying dimensions, see <a
* href="http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html">Publishing
* Metrics</a> in the <i>Amazon CloudWatch User Guide</i>.
* </p>
* <p>
* Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for
* <a>GetMetricStatistics</a> from the time they are submitted.
* </p>
* <p>
* CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set
* instead, you cannot retrieve percentile statistics for this data unless one of the following conditions is true:
* </p>
* <ul>
* <li>
* <p>
* The SampleCount of the statistic set is 1
* </p>
* </li>
* <li>
* <p>
* The Min and the Max of the statistic set are equal
* </p>
* </li>
* </ul>
*
* @param putMetricDataRequest
* @return Result of the PutMetricData operation returned by the service.
* @throws InvalidParameterValueException
* The value of an input parameter is bad or out-of-range.
* @throws MissingRequiredParameterException
* An input parameter that is required is missing.
* @throws InvalidParameterCombinationException
* Parameters that cannot be used together were used together.
* @throws InternalServiceException
* Request processing has failed due to some unknown error, exception, or failure.
* @sample AmazonCloudWatch.PutMetricData
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricData" target="_top">AWS API
* Documentation</a>
*/
PutMetricDataResult putMetricData(PutMetricDataRequest putMetricDataRequest);
/**
* <p>
* Temporarily sets the state of an alarm for testing purposes. When the updated state 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 state to <code>ALARM</code>
* 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 <b>History</b> tab in the Amazon
* CloudWatch console or through <a>DescribeAlarmHistory</a>.
* </p>
*
* @param setAlarmStateRequest
* @return Result of the SetAlarmState operation returned by the service.
* @throws ResourceNotFoundException
* The named resource does not exist.
* @throws InvalidFormatException
* Data was not syntactically valid JSON.
* @sample AmazonCloudWatch.SetAlarmState
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/SetAlarmState" target="_top">AWS API
* Documentation</a>
*/
SetAlarmStateResult setAlarmState(SetAlarmStateRequest setAlarmStateRequest);
/**
* 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.
*/
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.
* <p>
* 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.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
AmazonCloudWatchWaiters waiters();
}