Package org.jclouds.cloudwatch.features

Interface AlarmApi

  • @Beta
public interface AlarmApi
    Provides access to Amazon CloudWatch via the Query API

    See Also:

    • Method Detail

      • delete

        @Named("DeleteAlarms")
@POST
@Path("/")
void delete​(Iterable<String> alarmNames)
        Deletes all specified alarms.

        Note

        In the event of an error, no alarms are deleted.
        Parameters:
        alarmNames - the list of alarms to delete

      • listHistory

        @Named("DescribeAlarmHistory")
@POST
@Path("/")
PagedIterable<AlarmHistoryItem> listHistory()
        Return all history for all alarms.
        Returns:
        the response object

      • listHistoryAt

        @Named("DescribeAlarmHistory")
@POST
@Path("/")
IterableWithMarker<AlarmHistoryItem> listHistoryAt​(@FormParam("NextToken")
                                                   String nextToken)
        Return a single page of history for the specified alarm.
        Parameters:
        nextToken - the token corresponding with the data you want to get
        Returns:
        the response object

      • list

        @Named("DescribeAlarms")
@POST
@Path("/")
PagedIterable<Alarm> list()
        Return all alarms.
        Returns:
        the response object

      • list

        @Named("DescribeAlarms")
@POST
@Path("/")
PagedIterable<Alarm> list​(ListAlarmsOptions options)
        Return all alarms based on the options query
        Parameters:
        options - the options describing the alarms query
        Returns:
        the response object

      • listAt

        @Named("DescribeAlarms")
@POST
@Path("/")
IterableWithMarker<Alarm> listAt​(@FormParam("NextToken")
                                 String nextToken)
        Return a single page of alarms based on the options query
        Parameters:
        nextToken - the token corresponding with the data you want to get
        Returns:
        the response object

      • listForMetric

        @Named("DescribeAlarmsForMetric")
@POST
@Path("/")
com.google.common.collect.FluentIterable<Alarm> listForMetric​(ListAlarmsForMetric options)
        Return alarms all alarms for a single metric.
        Parameters:
        options - the options describing the alarms for metric query
        Returns:
        the response object

      • disable

        @Named("DisableAlarmActions")
@POST
@Path("/")
void disable​(Iterable<String> alarmNames)
        Disables actions for the specified alarms.
        Parameters:
        alarmNames - the list of alarms to disable

      • enable

        @Named("EnableAlarmActions")
@POST
@Path("/")
void enable​(Iterable<String> alarmNames)
        Enables actions for the specified alarms.
        Parameters:
        alarmNames - the list of alarms to enable

      • save

        @Named("PutMetricAlarm")
@POST
@Path("/")
void save​(SaveAlarmOptions options)
        Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric.
        Parameters:
        options - the options describing the metric alarm to create/update

      • setState

        @Named("SetAlarmState")
@POST
@Path("/")
void setState​(@FormParam("AlarmName")
              String alarmName,
              @FormParam("StateReason")
              String stateReason,
              @FormParam("StateReasonData") @Nullable
              String stateReasonData,
              @FormParam("StateValue")
              Alarm.State state)
        Temporarily sets the state of an alarm.
        Parameters:
        alarmName - the descriptive name for the alarm
        stateReason - the reason that this alarm is set to this specific state (in human-readable text format)
        stateReasonData - the reason that this alarm is set to this specific state (in machine-readable JSON format)
        state - the value of the state