delete_alarms ( $alarm_names, $opt )

Deletes all specified alarms. In the event of an error, no alarms are deleted.

Access

public

Parameters

Parameter

Type

Required

Description

$alarm_names

string
array

Required

A list of alarms to be deleted. 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

Delete multiple alarms.

$cw = new AmazonCloudWatch();

$response = $cw->delete_alarms(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 delete_alarms($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('DeleteAlarms', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback