probeCloudWatch

get_alarm_state_value

Return the state value of an alarm

Try it in Reliably

Activity as code

Below are the details and signature of the activity Python module.

Typeprobe
Modulechaosaws.cloudwatch.probes
Nameget_alarm_state_value
Returnstring

The possible alarm state values are described in the documentation https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cloudwatch.html#CloudWatch.Client.describe_alarms

Usage

JSON

{
  "name": "get-alarm-state-value",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosaws.cloudwatch.probes",
    "func": "get_alarm_state_value",
    "arguments": {
      "alarm_name": ""
    }
  }
}

YAML

name: get-alarm-state-value
provider:
  arguments:
    alarm_name: ""
  func: get_alarm_state_value
  module: chaosaws.cloudwatch.probes
  type: python
type: probe

Arguments

NameTypeDefaultRequiredTitleDescription
alarm_namestringYesAlarma NameName of the alarm to retrieve the state for

Signature

def get_alarm_state_value(alarm_name: str,
                          configuration: Dict[str, Dict[str, str]] = None,
                          secrets: Dict[str, Dict[str, str]] = None) -> str:
    pass

Related activities

  • actionCloudWatch

    enable_rule

    Enables a CloudWatch rule
  • probeCloudWatch

    get_metric_data

    Gets metric data for a given metric in a given time period. This method allows for more data to be retrieved than get_metric_statistics
  • actionCloudWatch

    put_rule_targets

    Creates or updates CloudWatch event rule targets