Amazon CloudWatch API Reference. This guide provides detailed information about Amazon CloudWatch actions, data types,
* parameters, and errors. For detailed information about Amazon CloudWatch features and their associated API calls, go to the Amazon CloudWatch Developer Guide.
*
* Amazon CloudWatch is a web service that enables you to publish, monitor, and manage various metrics, as well as configure alarm actions
* based on data from metrics. For more information about this product go to http://aws.amazon.com/cloudwatch.
*
* Use the following links to get started using the Amazon CloudWatch API Reference:
*
* - Actions: An alphabetical
* list of all Amazon CloudWatch actions.
*
* - Data Types: An alphabetical list
* of all Amazon CloudWatch data types.
*
* - Common Parameters:
* Parameters that all Query actions can use.
*
* - Common Errors: Client and
* server errors that all actions can return.
*
* - Regions and Endpoints: Itemized regions and
* endpoints for all AWS products.
*
* - WSDL Location:
* http://monitoring.amazonaws.com/doc/2010-08-01/CloudWatch.wsdl
*
*
*
* @version Tue Aug 23 12:46:08 PDT 2011
* @license See the included NOTICE.md file for complete information.
* @copyright See the included NOTICE.md file for complete information.
* @link http://aws.amazon.com/cloudwatch/Amazon CloudWatch
* @link http://aws.amazon.com/documentation/cloudwatch/Amazon CloudWatch documentation
*/
class AmazonCloudWatch extends CFRuntime
{
/*%******************************************************************************************%*/
// CLASS CONSTANTS
/**
* Specify the default queue URL.
*/
const DEFAULT_URL = 'monitoring.amazonaws.com';
/**
* Specify the queue URL for the US-East (Northern Virginia) Region.
*/
const REGION_US_E1 = 'us-east-1';
/**
* Specify the queue URL for the US-West (Northern California) Region.
*/
const REGION_US_W1 = 'us-west-1';
/**
* Specify the queue URL for the EU (Ireland) Region.
*/
const REGION_EU_W1 = 'eu-west-1';
/**
* Specify the queue URL for the Asia Pacific (Singapore) Region.
*/
const REGION_APAC_SE1 = 'ap-southeast-1';
/**
* Specify the queue URL for the Asia Pacific (Japan) Region.
*/
const REGION_APAC_NE1 = 'ap-northeast-1';
/*%******************************************************************************************%*/
// SETTERS
/**
* This allows you to explicitly sets the region for the service to use.
*
* @param string $region (Required) The region to explicitly set. Available options are , , , or .
* @return $this A reference to the current instance.
*/
public function set_region($region)
{
$this->set_hostname('http://monitoring.'. $region .'.amazonaws.com');
return $this;
}
/*%******************************************************************************************%*/
// CONSTRUCTOR
/**
* Constructs a new instance of .
*
* @param string $key (Optional) Your Amazon API Key. If blank, it will look for the AWS_KEY constant.
* @param string $secret_key (Optional) Your Amazon API Secret Key. If blank, it will look for the AWS_SECRET_KEY constant.
* @return boolean false if no valid values are set, otherwise true.
*/
public function __construct($key = null, $secret_key = null)
{
$this->api_version = '2010-08-01';
$this->hostname = self::DEFAULT_URL;
if (!$key && !defined('AWS_KEY'))
{
// @codeCoverageIgnoreStart
throw new CW_Exception('No account key was passed into the constructor, nor was it set in the AWS_KEY constant.');
// @codeCoverageIgnoreEnd
}
if (!$secret_key && !defined('AWS_SECRET_KEY'))
{
// @codeCoverageIgnoreStart
throw new CW_Exception('No account secret was passed into the constructor, nor was it set in the AWS_SECRET_KEY constant.');
// @codeCoverageIgnoreEnd
}
return parent::__construct($key, $secret_key);
}
/*%******************************************************************************************%*/
// SERVICE METHODS
/**
*
* Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric. Optionally, this operation can associate one or
* more Amazon Simple Notification Service 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
* StateValue is set appropriately. Any actions associated with the StateValue is then executed.
*
* When updating an existing alarm, its StateValue is left unchanged.
*
* @param string $alarm_name (Required) The descriptive name for the alarm. This name must be unique within the user's AWS account
* @param string $metric_name (Required) The name for the alarm's associated metric.
* @param string $namespace (Required) The namespace for the alarm's associated metric.
* @param string $statistic (Required) The statistic to apply to the alarm's associated metric. [Allowed values: SampleCount, Average, Sum, Minimum, Maximum]
* @param integer $period (Required) The period in seconds over which the specified statistic is applied.
* @param integer $evaluation_periods (Required) The number of periods over which data is compared to the specified threshold.
* @param double $threshold (Required) The value against which the specified statistic is compared.
* @param string $comparison_operator (Required) The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand. [Allowed values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold]
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* AlarmDescription - string - Optional - The description for the alarm. ActionsEnabled - boolean - Optional - Indicates whether or not actions should be executed during any changes to the alarm's state. OKActions - string|array - Optional - The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy. Pass a string for a single value, or an indexed array for multiple values. AlarmActions - string|array - Optional - The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy. Pass a string for a single value, or an indexed array for multiple values. InsufficientDataActions - string|array - Optional - The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy. Pass a string for a single value, or an indexed array for multiple values. Dimensions - array - Optional - The dimensions for the alarm's associated metric.
* x - array - This represents a simple array index.
* Name - string - Required - The name of the dimension. Value - string - Required - The value representing the dimension measurement
Unit - string - Optional - The unit for the alarm's associated metric. [Allowed values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None]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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function put_metric_alarm($alarm_name, $metric_name, $namespace, $statistic, $period, $evaluation_periods, $threshold, $comparison_operator, $opt = null)
{
if (!$opt) $opt = array();
$opt['AlarmName'] = $alarm_name;
// Optional parameter
if (isset($opt['OKActions']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'OKActions' => (is_array($opt['OKActions']) ? $opt['OKActions'] : array($opt['OKActions']))
), 'member'));
unset($opt['OKActions']);
}
// Optional parameter
if (isset($opt['AlarmActions']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'AlarmActions' => (is_array($opt['AlarmActions']) ? $opt['AlarmActions'] : array($opt['AlarmActions']))
), 'member'));
unset($opt['AlarmActions']);
}
// Optional parameter
if (isset($opt['InsufficientDataActions']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'InsufficientDataActions' => (is_array($opt['InsufficientDataActions']) ? $opt['InsufficientDataActions'] : array($opt['InsufficientDataActions']))
), 'member'));
unset($opt['InsufficientDataActions']);
}
$opt['MetricName'] = $metric_name;
$opt['Namespace'] = $namespace;
$opt['Statistic'] = $statistic;
// Optional parameter
if (isset($opt['Dimensions']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'Dimensions' => $opt['Dimensions']
), 'member'));
unset($opt['Dimensions']);
}
$opt['Period'] = $period;
$opt['EvaluationPeriods'] = $evaluation_periods;
$opt['Threshold'] = $threshold;
$opt['ComparisonOperator'] = $comparison_operator;
return $this->authenticate('PutMetricAlarm', $opt, $this->hostname);
}
/**
* 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. If you create a metric with the PutMetricData action, allow up to
* fifteen minutes for the metric to appear in calls to the ListMetrics action.
*
* The size of a PutMetricData request is limited to 8 KB for HTTP GET requests and 40 KB for HTTP POST requests.
*
* Amazon CloudWatch truncates values with very large exponents. Values with base-10 exponents greater than 126 (1 x 10^126) are truncated.
* Likewise, values with base-10 exponents less than -130 (1 x 10^-130) are also truncated.
*
* @param string $namespace (Required) The namespace for the metric data. You cannot specify a namespace that begins with AWS/. Namespaces that begin with AWS/ are reserved for other Amazon Web Services products that send metrics to Amazon CloudWatch.
* @param array $metric_data (Required) A list of data describing the metric.
* x - array - This represents a simple array index.
* MetricName - string - Required - The name of the metric. Dimensions - array - Optional - A list of dimensions associated with the metric.
* x - array - This represents a simple array index.
* Name - string - Required - The name of the dimension. Value - string - Required - The value representing the dimension measurement
Timestamp - string - Optional - The time stamp used for the metric. If not specified, the default value is set to the time the metric data was received. May be passed as a number of seconds since UNIX Epoch, or any string compatible with .Value - integer - Optional - The value for the metric. Amazon CloudWatch truncates values with very large exponents. Values with base-10 exponents greater than 126 (1 x 10^126) are truncated. Likewise, values with base-10 exponents less than -130 (1 x 10^-130) are also truncated. StatisticValues - array - Optional - A set of statistical values describing the metric. Takes an associative array of parameters that can have the following keys:
* SampleCount - double - Required - The number of samples used for the statistic set. Sum - double - Required - The sum of values for the sample set. Minimum - double - Required - The minimum value of the sample set. Maximum - double - Required - The maximum value of the sample set.
Unit - string - Optional - The unit of the metric. [Allowed values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None]
* @param array $opt (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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function put_metric_data($namespace, $metric_data, $opt = null)
{
if (!$opt) $opt = array();
$opt['Namespace'] = $namespace;
// Handle Timestamps
for ($i = 0, $max = count($metric_data); $i < $max; $i++)
{
if (isset($metric_data[$i]['Timestamp']))
{
$metric_data[$i]['Timestamp'] = $this->util->convert_date_to_iso8601($metric_data[$i]['Timestamp']);
}
}
// Required parameter
$opt = array_merge($opt, CFComplexType::map(array(
'MetricData' => (is_array($metric_data) ? $metric_data : array($metric_data))
), 'member'));
return $this->authenticate('PutMetricData', $opt, $this->hostname);
}
/**
*
* Returns a list of valid metrics stored for the AWS account owner. Returned metrics can be used with GetMetricStatistics to obtain
* statistical data for a given metric.
*
* Up to 500 results are returned for any one call. To retrieve further results, use returned NextToken values with subsequent
* ListMetrics operations.
*
* If you create a metric with the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the
* ListMetrics action. Statistics about the metric, however, are available sooner using GetMetricStatistics.
*
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* Namespace - string - Optional - The namespace to filter against. MetricName - string - Optional - The name of the metric to filter against. Dimensions - array - Optional - A list of dimensions to filter against.
* x - array - This represents a simple array index.
* Name - string - Required - The dimension name to be matched. Value - string - Optional - The value of the dimension to be matched. Specifying a Name without specifying a Value returns all values associated with that Name.
NextToken - string - Optional - The token returned by a previous call to indicate that there is more data available. 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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function list_metrics($opt = null)
{
if (!$opt) $opt = array();
// Optional parameter
if (isset($opt['Dimensions']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'Dimensions' => $opt['Dimensions']
), 'member'));
unset($opt['Dimensions']);
}
return $this->authenticate('ListMetrics', $opt, $this->hostname);
}
/**
*
* Gets statistics for the specified metric.
*
* The maximum number of data points returned from a single GetMetricStatistics request is 1,440. If a request is made that
* generates more than 1,440 data points, Amazon CloudWatch returns an error. In such a case, alter the request by narrowing the specified time
* range or increasing the specified period. Alternatively, make multiple requests across adjacent time ranges.
*
* Amazon CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request
* statistics with a one-minute granularity, Amazon CloudWatch aggregates data points with time stamps that fall within the same one-minute
* period. In such a case, the data points queried can greatly outnumber the data points returned.
*
* The maximum number of data points that can be queried is 50,850; whereas the maximum number of data points returned is 1,440.
*
* The following examples show various statistics allowed by the data point query maximum of 50,850 when you call
* GetMetricStatistics on Amazon EC2 instances with detailed (one-minute) monitoring enabled:
*
* - Statistics for up to 400 instances for a span of one hour
*
* - Statistics for up to 35 instances over a span of 24 hours
*
* - Statistics for up to 2 instances over a span of 2 weeks
*
*
*
* @param string $namespace (Required) The namespace of the metric.
* @param string $metric_name (Required) The name of the metric.
* @param string $start_time (Required) The time stamp to use for determining the first datapoint to return. The value specified is inclusive; results include datapoints with the time stamp specified. The specified start time is rounded down to the nearest value. Datapoints are returned for start times up to two weeks in the past. Specified start times that are more than two weeks in the past will not return datapoints for metrics that are older than two weeks. Accepts any value that understands.
* @param string $end_time (Required) The time stamp to use for determining the last datapoint to return. The value specified is exclusive; results will include datapoints up to the time stamp specified. Accepts any value that understands.
* @param integer $period (Required) The granularity, in seconds, of the returned datapoints. Period must be at least 60 seconds and must be a multiple of 60. The default value is 60.
* @param string|array $statistics (Required) The metric statistics to return. Pass a string for a single value, or an indexed array for multiple values.
* @param string $unit (Required) The unit for the metric. [Allowed values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None]
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* Dimensions - array - Optional - A list of dimensions describing qualities of the metric.
* x - array - This represents a simple array index.
* Name - string - Required - The name of the dimension. Value - string - Required - The value representing the dimension measurement
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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function get_metric_statistics($namespace, $metric_name, $start_time, $end_time, $period, $statistics, $unit, $opt = null)
{
if (!$opt) $opt = array();
$opt['Namespace'] = $namespace;
$opt['MetricName'] = $metric_name;
// Optional parameter
if (isset($opt['Dimensions']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'Dimensions' => $opt['Dimensions']
), 'member'));
unset($opt['Dimensions']);
}
$opt['StartTime'] = $this->util->convert_date_to_iso8601($start_time);
$opt['EndTime'] = $this->util->convert_date_to_iso8601($end_time);
$opt['Period'] = $period;
// Required parameter
$opt = array_merge($opt, CFComplexType::map(array(
'Statistics' => (is_array($statistics) ? $statistics : array($statistics))
), 'member'));
$opt['Unit'] = $unit;
return $this->authenticate('GetMetricStatistics', $opt, $this->hostname);
}
/**
*
* 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.
*
* @param string|array $alarm_names (Required) The names of the alarms to disable actions for. Pass a string for a single value, or an indexed array for multiple values.
* @param array $opt (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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function disable_alarm_actions($alarm_names, $opt = null)
{
if (!$opt) $opt = array();
// Required parameter
$opt = array_merge($opt, CFComplexType::map(array(
'AlarmNames' => (is_array($alarm_names) ? $alarm_names : array($alarm_names))
), 'member'));
return $this->authenticate('DisableAlarmActions', $opt, $this->hostname);
}
/**
*
* Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using
* only a prefix for the alarm name, the alarm state, or a prefix for any action.
*
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* AlarmNames - string|array - Optional - A list of alarm names to retrieve information for. Pass a string for a single value, or an indexed array for multiple values. AlarmNamePrefix - string - Optional - The alarm name prefix. AlarmNames cannot be specified if this parameter is specified. StateValue - string - Optional - The state value to be used in matching alarms. [Allowed values: OK, ALARM, INSUFFICIENT_DATA]ActionPrefix - string - Optional - The action name prefix. MaxRecords - integer - Optional - The maximum number of alarm descriptions to retrieve. NextToken - string - Optional - The token returned by a previous call to indicate that there is more data available. 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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function describe_alarms($opt = null)
{
if (!$opt) $opt = array();
// Optional parameter
if (isset($opt['AlarmNames']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'AlarmNames' => (is_array($opt['AlarmNames']) ? $opt['AlarmNames'] : array($opt['AlarmNames']))
), 'member'));
unset($opt['AlarmNames']);
}
return $this->authenticate('DescribeAlarms', $opt, $this->hostname);
}
/**
*
* Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further.
*
* @param string $metric_name (Required) The name of the metric.
* @param string $namespace (Required) The namespace of the metric.
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* Statistic - string - Optional - The statistic for the metric. [Allowed values: SampleCount, Average, Sum, Minimum, Maximum]Dimensions - array - Optional - The list of dimensions associated with the metric.
* x - array - This represents a simple array index.
* Name - string - Required - The name of the dimension. Value - string - Required - The value representing the dimension measurement
Period - integer - Optional - The period in seconds over which the statistic is applied. Unit - string - Optional - The unit for the metric. [Allowed values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None]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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function describe_alarms_for_metric($metric_name, $namespace, $opt = null)
{
if (!$opt) $opt = array();
$opt['MetricName'] = $metric_name;
$opt['Namespace'] = $namespace;
// Optional parameter
if (isset($opt['Dimensions']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'Dimensions' => $opt['Dimensions']
), 'member'));
unset($opt['Dimensions']);
}
return $this->authenticate('DescribeAlarmsForMetric', $opt, $this->hostname);
}
/**
*
* Retrieves history for the specified alarm. Filter alarms by date range or item type. If an alarm name is not specified, Amazon CloudWatch
* returns histories for all of the owner's alarms.
*
* Amazon CloudWatch retains the history of an alarm for two weeks, whether or not you delete the alarm.
*
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* AlarmName - string - Optional - The name of the alarm. HistoryItemType - string - Optional - The type of alarm histories to retrieve. [Allowed values: ConfigurationUpdate, StateUpdate, Action]StartDate - string - Optional - The starting date to retrieve alarm history. May be passed as a number of seconds since UNIX Epoch, or any string compatible with .EndDate - string - Optional - The ending date to retrieve alarm history. May be passed as a number of seconds since UNIX Epoch, or any string compatible with .MaxRecords - integer - Optional - The maximum number of alarm history records to retrieve. NextToken - string - Optional - The token returned by a previous call to indicate that there is more data available. 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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function describe_alarm_history($opt = null)
{
if (!$opt) $opt = array();
// Optional parameter
if (isset($opt['StartDate']))
{
$opt['StartDate'] = $this->util->convert_date_to_iso8601($opt['StartDate']);
}
// Optional parameter
if (isset($opt['EndDate']))
{
$opt['EndDate'] = $this->util->convert_date_to_iso8601($opt['EndDate']);
}
return $this->authenticate('DescribeAlarmHistory', $opt, $this->hostname);
}
/**
*
* Enables actions for the specified alarms.
*
* @param string|array $alarm_names (Required) The names of the alarms to enable actions for. Pass a string for a single value, or an indexed array for multiple values.
* @param array $opt (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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function enable_alarm_actions($alarm_names, $opt = null)
{
if (!$opt) $opt = array();
// Required parameter
$opt = array_merge($opt, CFComplexType::map(array(
'AlarmNames' => (is_array($alarm_names) ? $alarm_names : array($alarm_names))
), 'member'));
return $this->authenticate('EnableAlarmActions', $opt, $this->hostname);
}
/**
*
* Deletes all specified alarms. In the event of an error, no alarms are deleted.
*
* @param string|array $alarm_names (Required) A list of alarms to be deleted. Pass a string for a single value, or an indexed array for multiple values.
* @param array $opt (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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function delete_alarms($alarm_names, $opt = null)
{
if (!$opt) $opt = array();
// Required parameter
$opt = array_merge($opt, CFComplexType::map(array(
'AlarmNames' => (is_array($alarm_names) ? $alarm_names : array($alarm_names))
), 'member'));
return $this->authenticate('DeleteAlarms', $opt, $this->hostname);
}
/**
*
* Temporarily sets the state of an alarm. When the updated StateValue differs from the previous value, the action configured for
* the appropriate state is invoked. This is not a permanent change. The next periodic alarm check (in about a minute) will set the alarm to
* its actual state.
*
* @param string $alarm_name (Required) The descriptive name for the alarm. This name must be unique within the user's AWS account. The maximum length is 255 characters.
* @param string $state_value (Required) The value of the state. [Allowed values: OK, ALARM, INSUFFICIENT_DATA]
* @param string $state_reason (Required) The reason that this alarm is set to this specific state (in human-readable text format)
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* StateReasonData - string - Optional - The reason that this alarm is set to this specific state (in machine-readable JSON format) 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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function set_alarm_state($alarm_name, $state_value, $state_reason, $opt = null)
{
if (!$opt) $opt = array();
$opt['AlarmName'] = $alarm_name;
$opt['StateValue'] = $state_value;
$opt['StateReason'] = $state_reason;
return $this->authenticate('SetAlarmState', $opt, $this->hostname);
}
}
/*%******************************************************************************************%*/
// EXCEPTIONS
/**
* Default CloudWatch Exception.
*/
class CloudWatch_Exception extends Exception {}