CloudWatch / Client / describe_alarms

describe_alarms

CloudWatch.Client.describe_alarms(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_alarms(
    AlarmNames=[
        'string',
    ],
    AlarmNamePrefix='string',
    AlarmTypes=[
        'CompositeAlarm'|'MetricAlarm',
    ],
    ChildrenOfAlarmName='string',
    ParentsOfAlarmName='string',
    StateValue='OK'|'ALARM'|'INSUFFICIENT_DATA',
    ActionPrefix='string',
    MaxRecords=123,
    NextToken='string'
)

Parameters:

• AlarmNames (list) –

  The names of the alarms to retrieve information about.

  • (string) –

• AlarmNamePrefix (string) –

  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 (list) –

  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.

  • (string) –

• ChildrenOfAlarmName (string) –

  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.

  Note

  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 DescribeAlarms operation and specify the parent alarm names in the AlarmNames parameter.

• ParentsOfAlarmName (string) –

  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.

  Note

  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 DescribeAlarms operation and specify the parent alarm names in the AlarmNames parameter.

• StateValue (string) – Specify this parameter to receive information only about alarms that are currently in the state that you specify.

• ActionPrefix (string) – 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 (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.

Return type:

dict

Returns:

Response Syntax

{
    'CompositeAlarms': [
        {
            'ActionsEnabled': True|False,
            'AlarmActions': [
                'string',
            ],
            'AlarmArn': 'string',
            'AlarmConfigurationUpdatedTimestamp': datetime(2015, 1, 1),
            'AlarmDescription': 'string',
            'AlarmName': 'string',
            'AlarmRule': 'string',
            'InsufficientDataActions': [
                'string',
            ],
            'OKActions': [
                'string',
            ],
            'StateReason': 'string',
            'StateReasonData': 'string',
            'StateUpdatedTimestamp': datetime(2015, 1, 1),
            'StateValue': 'OK'|'ALARM'|'INSUFFICIENT_DATA',
            'StateTransitionedTimestamp': datetime(2015, 1, 1),
            'ActionsSuppressedBy': 'WaitPeriod'|'ExtensionPeriod'|'Alarm',
            'ActionsSuppressedReason': 'string',
            'ActionsSuppressor': 'string',
            'ActionsSuppressorWaitPeriod': 123,
            'ActionsSuppressorExtensionPeriod': 123
        },
    ],
    'MetricAlarms': [
        {
            'AlarmName': 'string',
            'AlarmArn': 'string',
            'AlarmDescription': 'string',
            'AlarmConfigurationUpdatedTimestamp': datetime(2015, 1, 1),
            'ActionsEnabled': True|False,
            'OKActions': [
                'string',
            ],
            'AlarmActions': [
                'string',
            ],
            'InsufficientDataActions': [
                'string',
            ],
            'StateValue': 'OK'|'ALARM'|'INSUFFICIENT_DATA',
            'StateReason': 'string',
            'StateReasonData': 'string',
            'StateUpdatedTimestamp': datetime(2015, 1, 1),
            'MetricName': 'string',
            'Namespace': 'string',
            'Statistic': 'SampleCount'|'Average'|'Sum'|'Minimum'|'Maximum',
            'ExtendedStatistic': 'string',
            'Dimensions': [
                {
                    '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': [
                {
                    'Id': 'string',
                    'MetricStat': {
                        'Metric': {
                            'Namespace': 'string',
                            'MetricName': 'string',
                            'Dimensions': [
                                {
                                    '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': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • CompositeAlarms (list) –

    The information about any composite alarms returned by the operation.

    • (dict) –

      The details about a composite alarm.

      • ActionsEnabled (boolean) –

        Indicates whether actions should be executed during any changes to the alarm state.

      • AlarmActions (list) –

        The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

        • (string) –

      • AlarmArn (string) –

        The Amazon Resource Name (ARN) of the alarm.

      • AlarmConfigurationUpdatedTimestamp (datetime) –

        The time stamp of the last update to the alarm configuration.

      • AlarmDescription (string) –

        The description of the alarm.

      • AlarmName (string) –

        The name of the alarm.

      • AlarmRule (string) –

        The rule that this alarm uses to evaluate its alarm state.

      • InsufficientDataActions (list) –

        The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

        • (string) –

      • OKActions (list) –

        The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

        • (string) –

      • StateReason (string) –

        An explanation for the alarm state, in text format.

      • StateReasonData (string) –

        An explanation for the alarm state, in JSON format.

      • StateUpdatedTimestamp (datetime) –

        Tracks the timestamp of any state update, even if StateValue doesn’t change.

      • StateValue (string) –

        The state value for the alarm.

      • StateTransitionedTimestamp (datetime) –

        The timestamp of the last change to the alarm’s StateValue.

      • ActionsSuppressedBy (string) –

        When the value is ALARM, it means that the actions are suppressed because the suppressor alarm is in ALARM When the value is WaitPeriod, it means that the actions are suppressed because the composite alarm is waiting for the suppressor alarm to go into into the ALARM state. The maximum waiting time is as specified in ActionsSuppressorWaitPeriod. After this time, the composite alarm performs its actions. When the value is ExtensionPeriod, it means that the actions are suppressed because the composite alarm is waiting after the suppressor alarm went out of the ALARM state. The maximum waiting time is as specified in ActionsSuppressorExtensionPeriod. After this time, the composite alarm performs its actions.

      • ActionsSuppressedReason (string) –

        Captures the reason for action suppression.

      • ActionsSuppressor (string) –

        Actions will be suppressed if the suppressor alarm is in the ALARM state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.

      • ActionsSuppressorWaitPeriod (integer) –

        The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the ALARM state. After this time, the composite alarm performs its actions.

        Warning

        WaitPeriod is required only when ActionsSuppressor is specified.

      • ActionsSuppressorExtensionPeriod (integer) –

        The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the ALARM state. After this time, the composite alarm performs its actions.

        Warning

        ExtensionPeriod is required only when ActionsSuppressor is specified.

  • MetricAlarms (list) –

    The information about any metric alarms returned by the operation.

    • (dict) –

      The details about a metric alarm.

      • AlarmName (string) –

        The name of the alarm.

      • AlarmArn (string) –

        The Amazon Resource Name (ARN) of the alarm.

      • AlarmDescription (string) –

        The description of the alarm.

      • AlarmConfigurationUpdatedTimestamp (datetime) –

        The time stamp of the last update to the alarm configuration.

      • ActionsEnabled (boolean) –

        Indicates whether actions should be executed during any changes to the alarm state.

      • OKActions (list) –

        The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

        • (string) –

      • AlarmActions (list) –

        The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

        • (string) –

      • InsufficientDataActions (list) –

        The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

        • (string) –

      • StateValue (string) –

        The state value for the alarm.

      • StateReason (string) –

        An explanation for the alarm state, in text format.

      • StateReasonData (string) –

        An explanation for the alarm state, in JSON format.

      • StateUpdatedTimestamp (datetime) –

        The time stamp of the last update to the value of either the StateValue or EvaluationState parameters.

      • MetricName (string) –

        The name of the metric associated with the alarm, if this is an alarm based on a single metric.

      • Namespace (string) –

        The namespace of the metric associated with the alarm.

      • Statistic (string) –

        The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.

      • ExtendedStatistic (string) –

        The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.

      • Dimensions (list) –

        The dimensions for the metric associated with the alarm.

        • (dict) –

          A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.

          You can assign up to 30 dimensions to a metric.

          • Name (string) –

            The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon ( :). ASCII control characters are not supported as part of dimension names.

          • Value (string) –

            The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.

      • Period (integer) –

        The period, in seconds, over which the statistic is applied.

      • Unit (string) –

        The unit of the metric associated with the alarm.

      • EvaluationPeriods (integer) –

        The number of periods over which data is compared to the specified threshold.

      • DatapointsToAlarm (integer) –

        The number of data points that must be breaching to trigger the alarm.

      • Threshold (float) –

        The value to compare with the specified statistic.

      • ComparisonOperator (string) –

        The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

      • TreatMissingData (string) –

        Sets how this alarm is to handle missing data points. The valid values are breaching, notBreaching, ignore, and missing. For more information, see Configuring how CloudWatch alarms treat missing data.

        If this parameter is omitted, the default behavior of missing is used.

      • EvaluateLowSampleCountPercentile (string) –

        Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.

      • Metrics (list) –

        An array of MetricDataQuery structures, used in an alarm based on a metric math expression. Each structure either retrieves a metric or performs a math expression. One item in the Metrics array is the math expression that the alarm watches. This expression by designated by having ReturnData set to true.

        • (dict) –

          This structure is used in both GetMetricData and PutMetricAlarm. The supported use of this structure is different for those two operations.

          When used in GetMetricData, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A single GetMetricData call can include up to 500 MetricDataQuery structures.

          When used in PutMetricAlarm, it enables you to create an alarm based on a metric math expression. Each MetricDataQuery in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single PutMetricAlarm call can include up to 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, one must have true as the value for ReturnData. The result of this expression is the value the alarm watches.

          Any expression used in a PutMetricAlarm operation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

          Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData operation or a PutMetricAlarm operation. These differences are explained in the following parameter list.

          • Id (string) –

            A short name used to tie this object to the results in the response. This name must be unique within a single call to GetMetricData. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.

          • MetricStat (dict) –

            The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.

            Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.

            • Metric (dict) –

              The metric to return, including the metric name, namespace, and dimensions.

              • Namespace (string) –

                The namespace of the metric.

              • MetricName (string) –

                The name of the metric. This is a required field.

              • Dimensions (list) –

                The dimensions for the metric.

                • (dict) –

                  A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.

                  You can assign up to 30 dimensions to a metric.

                  • Name (string) –

                    The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon ( :). ASCII control characters are not supported as part of dimension names.

                  • Value (string) –

                    The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.

            • Period (integer) –

              The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

              If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

              • Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

              • Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

              • Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

            • Stat (string) –

              The statistic to return. It can include any CloudWatch statistic or extended statistic.

            • Unit (string) –

              When you are using a Put operation, this defines what unit you want to use when storing the metric.

              In a Get operation, if you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

          • Expression (string) –

            This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data. For more information about Metrics Insights queries, see Metrics Insights query components and syntax in the Amazon CloudWatch User Guide.

            A math expression can use the Id of the other metrics or queries to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

            Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.

          • Label (string) –

            A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.

            You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.

          • ReturnData (boolean) –

            When used in GetMetricData, this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify false. If you omit this, the default of true is used.

            When used in PutMetricAlarm, specify true for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm operation, specify ReturnData as False.

          • Period (integer) –

            The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData operation that includes a StorageResolution of 1 second.

          • AccountId (string) –

            The ID of the account where the metrics are located.

            If you are performing a GetMetricData operation in a monitoring account, use this to specify which account to retrieve this metric from.

            If you are performing a PutMetricAlarm operation, use this to specify which account contains the metric that the alarm is watching.

      • ThresholdMetricId (string) –

        In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.

      • EvaluationState (string) –

        If the value of this field is PARTIAL_DATA, the alarm is being evaluated based on only partial data. This happens if the query used for the alarm returns more than 10,000 metrics. For more information, see Create alarms on Metrics Insights queries.

      • StateTransitionedTimestamp (datetime) –

        The date and time that the alarm’s StateValue most recently changed.

  • NextToken (string) –

    The token that marks the start of the next batch of returned results.

Exceptions

• CloudWatch.Client.exceptions.InvalidNextToken