AbstractAmazonCloudWatch (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudwatch.AbstractAmazonCloudWatch

All Implemented Interfaces:

AmazonCloudWatch

Direct Known Subclasses:

AbstractAmazonCloudWatchAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonCloudWatch
extends Object
implements AmazonCloudWatch
```
Abstract implementation of AmazonCloudWatch. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.cloudwatch.AmazonCloudWatch
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DeleteAlarmsResult`	`deleteAlarms(DeleteAlarmsRequest request)` Deletes the specified alarms.
`DeleteDashboardsResult`	`deleteDashboards(DeleteDashboardsRequest request)` Deletes all dashboards that you specify.
`DescribeAlarmHistoryResult`	`describeAlarmHistory()` Simplified method form for invoking the DescribeAlarmHistory operation.
`DescribeAlarmHistoryResult`	`describeAlarmHistory(DescribeAlarmHistoryRequest request)` Retrieves the history for the specified alarm.
`DescribeAlarmsResult`	`describeAlarms()` Simplified method form for invoking the DescribeAlarms operation.
`DescribeAlarmsResult`	`describeAlarms(DescribeAlarmsRequest request)` Retrieves the specified alarms.
`DescribeAlarmsForMetricResult`	`describeAlarmsForMetric(DescribeAlarmsForMetricRequest request)` Retrieves the alarms for the specified metric.
`DisableAlarmActionsResult`	`disableAlarmActions(DisableAlarmActionsRequest request)` Disables the actions for the specified alarms.
`EnableAlarmActionsResult`	`enableAlarmActions(EnableAlarmActionsRequest request)` Enables the 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.
`GetDashboardResult`	`getDashboard(GetDashboardRequest request)` Displays the details of the dashboard that you specify.
`GetMetricStatisticsResult`	`getMetricStatistics(GetMetricStatisticsRequest request)` Gets statistics for the specified metric.
`ListDashboardsResult`	`listDashboards(ListDashboardsRequest request)` Returns a list of the dashboards for your account.
`ListMetricsResult`	`listMetrics()` Simplified method form for invoking the ListMetrics operation.
`ListMetricsResult`	`listMetrics(ListMetricsRequest request)` List the specified metrics.
`PutDashboardResult`	`putDashboard(PutDashboardRequest request)` Creates a dashboard if it does not already exist, or updates an existing dashboard.
`PutMetricAlarmResult`	`putMetricAlarm(PutMetricAlarmRequest request)` Creates or updates an alarm and associates it with the specified metric.
`PutMetricDataResult`	`putMetricData(PutMetricDataRequest request)` Publishes metric data points to Amazon CloudWatch.
`SetAlarmStateResult`	`setAlarmState(SetAlarmStateRequest request)` Temporarily sets the state of an alarm for testing purposes.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("https://monitoring.us-east-1.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `AmazonCloudWatch.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`AmazonCloudWatchWaiters`	`waiters()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from 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 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.
    
    Specified by:
    
    setEndpoint in interface AmazonCloudWatch
    
    Parameters:
    
    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.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AmazonCloudWatch
    
    An alternative to 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 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.
    
    Specified by:
    
    setRegion in interface AmazonCloudWatch
    
    Parameters:
    
    region - The region this client will communicate with. See 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 Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - deleteAlarms
```
public DeleteAlarmsResult deleteAlarms(DeleteAlarmsRequest request)
```
    Description copied from interface: AmazonCloudWatch
    
    Deletes the specified alarms. In the event of an error, no alarms are deleted.
    
    Specified by:
    
    deleteAlarms in interface AmazonCloudWatch
    
    Returns:
    
    Result of the DeleteAlarms operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDashboards
```
public DeleteDashboardsResult deleteDashboards(DeleteDashboardsRequest request)
```
    Description copied from interface: AmazonCloudWatch
    
    Deletes all dashboards that you specify. You may specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.
    
    Specified by:
    
    deleteDashboards in interface AmazonCloudWatch
    
    Returns:
    
    Result of the DeleteDashboards operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeAlarmHistory
```
public DescribeAlarmHistoryResult describeAlarmHistory(DescribeAlarmHistoryRequest request)
```
    Description copied from interface: AmazonCloudWatch
    
    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.
    
    CloudWatch retains the history of an alarm even if you delete the alarm.
    
    Specified by:
    
    describeAlarmHistory in interface AmazonCloudWatch
    
    Returns:
    
    Result of the DescribeAlarmHistory operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeAlarmHistory
```
public DescribeAlarmHistoryResult describeAlarmHistory()
```
    Description copied from interface: AmazonCloudWatch
    
    Simplified method form for invoking the DescribeAlarmHistory operation.
    
    Specified by:
    
    describeAlarmHistory in interface AmazonCloudWatch
    
    See Also:
    
    AmazonCloudWatch.describeAlarmHistory(DescribeAlarmHistoryRequest)
  - describeAlarms
```
public DescribeAlarmsResult describeAlarms(DescribeAlarmsRequest request)
```
    Description copied from interface: AmazonCloudWatch
    
    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.
    
    Specified by:
    
    describeAlarms in interface AmazonCloudWatch
    
    Returns:
    
    Result of the DescribeAlarms operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeAlarms
```
public DescribeAlarmsResult describeAlarms()
```
    Description copied from interface: AmazonCloudWatch
    
    Simplified method form for invoking the DescribeAlarms operation.
    
    Specified by:
    
    describeAlarms in interface AmazonCloudWatch
    
    See Also:
    
    AmazonCloudWatch.describeAlarms(DescribeAlarmsRequest)
  - describeAlarmsForMetric
```
public DescribeAlarmsForMetricResult describeAlarmsForMetric(DescribeAlarmsForMetricRequest request)
```
    Description copied from interface: AmazonCloudWatch
    
    Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.
    
    Specified by:
    
    describeAlarmsForMetric in interface AmazonCloudWatch
    
    Returns:
    
    Result of the DescribeAlarmsForMetric operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disableAlarmActions
```
public DisableAlarmActionsResult disableAlarmActions(DisableAlarmActionsRequest request)
```
    Description copied from interface: AmazonCloudWatch
    
    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.
    
    Specified by:
    
    disableAlarmActions in interface AmazonCloudWatch
    
    Returns:
    
    Result of the DisableAlarmActions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - enableAlarmActions
```
public EnableAlarmActionsResult enableAlarmActions(EnableAlarmActionsRequest request)
```
    Description copied from interface: AmazonCloudWatch
    
    Enables the actions for the specified alarms.
    
    Specified by:
    
    enableAlarmActions in interface AmazonCloudWatch
    
    Returns:
    
    Result of the EnableAlarmActions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDashboard
```
public GetDashboardResult getDashboard(GetDashboardRequest request)
```
    Description copied from interface: AmazonCloudWatch
    
    Displays the details of the dashboard that you specify.
    
    To copy an existing dashboard, use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create the copy.
    
    Specified by:
    
    getDashboard in interface AmazonCloudWatch
    
    Returns:
    
    Result of the GetDashboard operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getMetricStatistics
```
public GetMetricStatisticsResult getMetricStatistics(GetMetricStatisticsRequest request)
```
    Description copied from interface: AmazonCloudWatch
    Gets statistics for the specified metric.
    
    The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, 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. Data points are not returned in chronological order.
    
    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, 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.
    
    CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:
    - The SampleCount value of the statistic set is 1.
    - The Min and the Max values of the statistic set are equal.
    Amazon CloudWatch retains metric data as follows:
    - Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.
    - Data points with a period of 60 seconds (1-minute) are available for 15 days.
    - Data points with a period of 300 seconds (5-minute) are available for 63 days.
    - Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
    Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.
    
    CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.
    
    For information about metrics and dimensions supported by AWS services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.
    Specified by:
    
    getMetricStatistics in interface AmazonCloudWatch
    
    Returns:
    
    Result of the GetMetricStatistics operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDashboards
```
public ListDashboardsResult listDashboards(ListDashboardsRequest request)
```
    Description copied from interface: AmazonCloudWatch
    
    Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.
    
    Specified by:
    
    listDashboards in interface AmazonCloudWatch
    
    Returns:
    
    Result of the ListDashboards operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listMetrics
```
public ListMetricsResult listMetrics(ListMetricsRequest request)
```
    Description copied from interface: AmazonCloudWatch
    
    List the specified metrics. You can use the returned metrics with GetMetricStatistics to obtain statistical data.
    
    Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.
    
    After you create a metric, allow up to fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using GetMetricStatistics.
    
    Specified by:
    
    listMetrics in interface AmazonCloudWatch
    
    Returns:
    
    Result of the ListMetrics operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listMetrics
```
public ListMetricsResult listMetrics()
```
    Description copied from interface: AmazonCloudWatch
    
    Simplified method form for invoking the ListMetrics operation.
    
    Specified by:
    
    listMetrics in interface AmazonCloudWatch
    
    See Also:
    
    AmazonCloudWatch.listMetrics(ListMetricsRequest)
  - putDashboard
```
public PutDashboardResult putDashboard(PutDashboardRequest request)
```
    Description copied from interface: AmazonCloudWatch
    
    Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.
    
    You can have up to 500 dashboards per account. All dashboards in your account are global, not region-specific.
    
    A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard.
    
    When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard.
    
    Specified by:
    
    putDashboard in interface AmazonCloudWatch
    
    Returns:
    
    Result of the PutDashboard operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putMetricAlarm
```
public PutMetricAlarmResult putMetricAlarm(PutMetricAlarmRequest request)
```
    Description copied from interface: AmazonCloudWatch
    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.
    
    When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is evaluated and its state is set appropriately. Any actions associated with the state are then executed.
    
    When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
    
    If you are an IAM user, you must have Amazon EC2 permissions for some operations:
    - ec2:DescribeInstanceStatus and ec2:DescribeInstances for all alarms on 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 are not performed. However, if you are later granted the required permissions, the alarm actions that you created earlier are performed.
    
    If you are using an IAM role (for example, an 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 AWS STS, you cannot stop or terminate an EC2 instance using alarm actions.
    
    You must create at least one stop, terminate, or reboot alarm using either the Amazon EC2 or CloudWatch consoles to create the EC2ActionsAccess IAM role. After this IAM role is created, you can create stop, terminate, or reboot alarms using a command-line interface or API.
    Specified by:
    
    putMetricAlarm in interface AmazonCloudWatch
    
    Returns:
    
    Result of the PutMetricAlarm operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putMetricData
```
public PutMetricDataResult putMetricData(PutMetricDataRequest request)
```
    Description copied from interface: AmazonCloudWatch
    Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics.
    
    Each PutMetricData request is limited to 40 KB in size for HTTP POST requests.
    
    Although the Value parameter accepts numbers of type Double, 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 (for example, NaN, +Infinity, -Infinity) are not supported.
    
    You can use up to 10 dimensions per metric to further clarify what data the metric collects. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.
    
    Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricStatistics from the time they are submitted.
    
    CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:
    - The SampleCount value of the statistic set is 1
    - The Min and the Max values of the statistic set are equal
    Specified by:
    
    putMetricData in interface AmazonCloudWatch
    
    Returns:
    
    Result of the PutMetricData operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - setAlarmState
```
public SetAlarmStateResult setAlarmState(SetAlarmStateRequest request)
```
    Description copied from interface: AmazonCloudWatch
    
    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 ALARM sends an SNS message. The alarm returns to its actual state (often within seconds). Because the alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.
    
    Specified by:
    
    setAlarmState in interface AmazonCloudWatch
    
    Returns:
    
    Result of the SetAlarmState operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonCloudWatch
    
    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.
    
    Specified by:
    
    shutdown in interface AmazonCloudWatch
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonCloudWatch
    
    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.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonCloudWatch
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - waiters
```
public AmazonCloudWatchWaiters waiters()
```
    Specified by:
    
    waiters in interface AmazonCloudWatch

Did this page help you?

Class AbstractAmazonCloudWatch

Field Summary

Fields inherited from interface com.amazonaws.services.cloudwatch.AmazonCloudWatch

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

deleteAlarms

deleteDashboards

describeAlarmHistory

describeAlarmHistory

describeAlarms

describeAlarms

describeAlarmsForMetric

disableAlarmActions

enableAlarmActions

getDashboard

getMetricStatistics

listDashboards

listMetrics

listMetrics

putDashboard

putMetricAlarm

putMetricData

setAlarmState

shutdown

getCachedResponseMetadata

waiters