Describe Alarms

cloudwatch_describe_alarms

R Documentation

Retrieves the specified alarms

Description

Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm name, the alarm state, or a prefix for any action.

To use this operation and return information about composite alarms, you must be signed on with the cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope.

Usage

cloudwatch_describe_alarms(AlarmNames, AlarmNamePrefix, AlarmTypes,
  ChildrenOfAlarmName, ParentsOfAlarmName, StateValue, ActionPrefix,
  MaxRecords, NextToken)

Arguments

AlarmNames

The names of the alarms to retrieve information about.

AlarmNamePrefix

An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix.

If this parameter is specified, you cannot specify AlarmNames.

AlarmTypes

Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned, even if composite alarms exist in the account.

For example, if you omit this parameter or specify MetricAlarms, the operation returns only a list of metric alarms. It does not return any composite alarms, even if composite alarms exist in the account.

If you specify CompositeAlarms, the operation returns only a list of composite alarms, and does not return any metric alarms.

ChildrenOfAlarmName

If you use this parameter and specify the name of a composite alarm, the operation returns information about the "children" alarms of the alarm you specify. These are the metric alarms and composite alarms referenced in the AlarmRule field of the composite alarm that you specify in ChildrenOfAlarmName. Information about the composite alarm that you name in ChildrenOfAlarmName is not returned.

If you specify ChildrenOfAlarmName, you cannot specify any other parameters in the request except for MaxRecords and NextToken. If you do so, you receive a validation error.

Only the ⁠Alarm Name⁠, ARN, StateValue (OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp information are returned by this operation when you use this parameter. To get complete information about these alarms, perform another describe_alarms operation and specify the parent alarm names in the AlarmNames parameter.

ParentsOfAlarmName

If you use this parameter and specify the name of a metric or composite alarm, the operation returns information about the "parent" alarms of the alarm you specify. These are the composite alarms that have AlarmRule parameters that reference the alarm named in ParentsOfAlarmName. Information about the alarm that you specify in ParentsOfAlarmName is not returned.

If you specify ParentsOfAlarmName, you cannot specify any other parameters in the request except for MaxRecords and NextToken. If you do so, you receive a validation error.

Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about these alarms, perform another describe_alarms operation and specify the parent alarm names in the AlarmNames parameter.

StateValue

Specify this parameter to receive information only about alarms that are currently in the state that you specify.

ActionPrefix

Use this parameter to filter the results of the operation to only those alarms that use a certain alarm action. For example, you could specify the ARN of an SNS topic to find all alarms that send notifications to that topic.

MaxRecords

The maximum number of alarm descriptions to retrieve.

NextToken

The token returned by a previous call to indicate that there is more data available.

Value

A list with the following syntax:

list(
  CompositeAlarms = list(
    list(
      ActionsEnabled = TRUE|FALSE,
      AlarmActions = list(
        "string"
      ),
      AlarmArn = "string",
      AlarmConfigurationUpdatedTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      AlarmDescription = "string",
      AlarmName = "string",
      AlarmRule = "string",
      InsufficientDataActions = list(
        "string"
      ),
      OKActions = list(
        "string"
      ),
      StateReason = "string",
      StateReasonData = "string",
      StateUpdatedTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      StateValue = "OK"|"ALARM"|"INSUFFICIENT_DATA",
      StateTransitionedTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      ActionsSuppressedBy = "WaitPeriod"|"ExtensionPeriod"|"Alarm",
      ActionsSuppressedReason = "string",
      ActionsSuppressor = "string",
      ActionsSuppressorWaitPeriod = 123,
      ActionsSuppressorExtensionPeriod = 123
    )
  ),
  MetricAlarms = list(
    list(
      AlarmName = "string",
      AlarmArn = "string",
      AlarmDescription = "string",
      AlarmConfigurationUpdatedTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      ActionsEnabled = TRUE|FALSE,
      OKActions = list(
        "string"
      ),
      AlarmActions = list(
        "string"
      ),
      InsufficientDataActions = list(
        "string"
      ),
      StateValue = "OK"|"ALARM"|"INSUFFICIENT_DATA",
      StateReason = "string",
      StateReasonData = "string",
      StateUpdatedTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      MetricName = "string",
      Namespace = "string",
      Statistic = "SampleCount"|"Average"|"Sum"|"Minimum"|"Maximum",
      ExtendedStatistic = "string",
      Dimensions = list(
        list(
          Name = "string",
          Value = "string"
        )
      ),
      Period = 123,
      Unit = "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",
      EvaluationPeriods = 123,
      DatapointsToAlarm = 123,
      Threshold = 123.0,
      ComparisonOperator = "GreaterThanOrEqualToThreshold"|"GreaterThanThreshold"|"LessThanThreshold"|"LessThanOrEqualToThreshold"|"LessThanLowerOrGreaterThanUpperThreshold"|"LessThanLowerThreshold"|"GreaterThanUpperThreshold",
      TreatMissingData = "string",
      EvaluateLowSampleCountPercentile = "string",
      Metrics = list(
        list(
          Id = "string",
          MetricStat = list(
            Metric = list(
              Namespace = "string",
              MetricName = "string",
              Dimensions = list(
                list(
                  Name = "string",
                  Value = "string"
                )
              )
            ),
            Period = 123,
            Stat = "string",
            Unit = "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"
          ),
          Expression = "string",
          Label = "string",
          ReturnData = TRUE|FALSE,
          Period = 123,
          AccountId = "string"
        )
      ),
      ThresholdMetricId = "string",
      EvaluationState = "PARTIAL_DATA",
      StateTransitionedTimestamp = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_alarms(
  AlarmNames = list(
    "string"
  ),
  AlarmNamePrefix = "string",
  AlarmTypes = list(
    "CompositeAlarm"|"MetricAlarm"
  ),
  ChildrenOfAlarmName = "string",
  ParentsOfAlarmName = "string",
  StateValue = "OK"|"ALARM"|"INSUFFICIENT_DATA",
  ActionPrefix = "string",
  MaxRecords = 123,
  NextToken = "string"
)