Method: Fog::AWS::CloudWatch::Real#describe_alarms
- Defined in:
- lib/fog/aws/requests/cloud_watch/describe_alarms.rb
#describe_alarms(options = {}) ⇒ Object
Retrieves alarms with the specified names
Options
-
ActionPrefix<~String>: The action name prefix
-
AlarmNamePrefix<~String>: The alarm name prefix.
AlarmNames cannot be specified if this parameter is specified
-
AlarmNames<~Array>: A list of alarm names to retrieve information for.
-
MaxRecords<~Integer>: The maximum number of alarm descriptions to retrieve
-
NextToken<~String>: The token returned by a previous call to indicate that there is more data available
-
NextToken<~String> The token returned by a previous call to indicate that there is more data available
-
StateValue<~String>: The state value to be used in matching alarms
Returns
-
response<~Excon::Response>:
See Also
docs.amazonwebservices.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html
26 27 28 29 30 31 32 33 34 |
# File 'lib/fog/aws/requests/cloud_watch/describe_alarms.rb', line 26 def describe_alarms(={}) if alarm_names = .delete('AlarmNames') .merge!(AWS.indexed_param('AlarmNames.member.%d', [*alarm_names])) end request({ 'Action' => 'DescribeAlarms', :parser => Fog::Parsers::AWS::CloudWatch::DescribeAlarms.new }.merge()) end |