disable_alarm_actions ( $alarm_names, $opt )

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.

Access

public

Parameters

Parameter

Type

Required

Description

$alarm_names

string
array

Required

The names of the alarms to disable actions for. Pass a string for a single value, or an indexed array for multiple values.

$opt

array

Optional

An associative array of parameters that can have the following keys:

  • curlopts - array - Optional - A set of values to pass directly into curl_setopt(), where the key is a pre-defined CURLOPT_* constant.
  • returnCurlHandle - boolean - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.

Returns

Type

Description

CFResponse

A CFResponse object containing a parsed HTTP response.

Examples

Disable multiple alarm actions.

$cw = new AmazonCloudWatch();

$response = $cw->disable_alarm_actions(array(
	'my-alarm',
	'my-other-alarm'
));

// Success?
var_dump($response->isOK());
Result:
bool(true)

Related Methods

Source

Method defined in services/cloudwatch.class.php | Toggle source view (11 lines) | View on GitHub

public function disable_alarm_actions($alarm_names, $opt = null)
{
    if (!$opt) $opt = array();
            
    // Required list (non-map)
    $opt = array_merge($opt, CFComplexType::map(array(
        'AlarmNames' => (is_array($alarm_names) ? $alarm_names : array($alarm_names))
    ), 'member'));

    return $this->authenticate('DisableAlarmActions', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback