actionSSM

send_command

Runs commands on one or more managed instances

Activity as code

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

Typeaction
Modulechaosaws.ssm.actions
Namesend_command
Returnmapping

Usage

JSON

{
  "name": "send-command",
  "type": "action",
  "provider": {
    "type": "python",
    "module": "chaosaws.ssm.actions",
    "func": "send_command",
    "arguments": {
      "document_name": ""
    }
  }
}

YAML

name: send-command
provider:
  arguments:
    document_name: ""
  func: send_command
  module: chaosaws.ssm.actions
  type: python
type: action

Arguments

NameTypeDefaultRequiredTitleDescription
document_namestringYesSSM DocumentName of the SSM document to apply
document_versionstringnullNoVersionDocument version
targetslistnullNoTargetsList of targets for this document
parametersmappingnullNoParametersDocument parameters to set
timeout_secondsintegernullNoTimeoutTimeout in seconds for the operation
max_concurrencystringnullNoConcurrencyMaximum concurrency
max_errorsstringnullNoTolerated ErrorsMaximum number of errors
regionstringnullNoRegionRegion where to apply this document to

An SSM document defines the actions that SSM performs on your managed instances.

More information about SSM documents:

Signature

def send_command(document_name: str,
                 targets: List[Dict[str, Any]] = None,
                 document_version: str = None,
                 parameters: Dict[str, Any] = None,
                 timeout_seconds: int = None,
                 max_concurrency: str = None,
                 max_errors: str = None,
                 region: str = None,
                 configuration: Dict[str, Dict[str, str]] = None,
                 secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass