probeASG

describe_auto_scaling_groups

Returns AWS descriptions for provided ASG(s)

Activity as code

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

Typeprobe
Modulechaosaws.asg.probes
Namedescribe_auto_scaling_groups
Returnmapping

Usage

JSON

{
  "name": "describe-auto-scaling-groups",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosaws.asg.probes",
    "func": "describe_auto_scaling_groups"
  }
}

YAML

name: describe-auto-scaling-groups
provider:
  func: describe_auto_scaling_groups
  module: chaosaws.asg.probes
  type: python
type: probe

Arguments

NameTypeDefaultRequiredTitleDescription
asg_nameslistnullNoASG NamesOne or many ASG names as a JSON encoded list
tagslistnullNoASG TagsList of AWS tags for to identify ASG by tags instead of by names

One of *asg_names: a list of one or more asg names *tags: a list of key/value pair to identify asg(s) by

tags are expected as a list of dictionary objects:

[
  {'Key': 'TagKey1', 'Value': 'TagValue1'},
  {'Key': 'TagKey2', 'Value': 'TagValue2'},
  ...
]

Signature

def describe_auto_scaling_groups(
        asg_names: List[str] = None,
        tags: List[Dict[str, Any]] = None,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass