actionSSM

delete_document

Deletes a Systems Manager (SSM) document

Activity as code

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

Typeaction
Modulechaosaws.ssm.actions
Namedelete_document
Returnmapping

Usage

JSON

{
  "name": "delete-document",
  "type": "action",
  "provider": {
    "type": "python",
    "module": "chaosaws.ssm.actions",
    "func": "delete_document",
    "arguments": {
      "name": ""
    }
  }
}

YAML

name: delete-document
provider:
  arguments:
    name: ""
  func: delete_document
  module: chaosaws.ssm.actions
  type: python
type: action

Arguments

NameTypeDefaultRequiredTitleDescription
namestringYesDocument Name
version_namestringnullNoVersion Name
forcebooleantrueNoForce

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

More information about SSM documents:

Signature

def delete_document(
        name: str,
        version_name: str = None,
        force: bool = True,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass