# AWS Systems Manager

> Read managed nodes, inventory, documents, command and automation status, and manage Parameter Store values.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/aws-systems-manager

## Actions

### Delete parameter

Delete a Parameter Store parameter by its name, along with its value and version history.

**Inputs**

- Name (`name`, text, required): Name.

**Outputs**

- `data` (object): AWS Systems Manager response data.

**Example output**

```json
{
  "data": {}
}
```

### Describe automation executions

List Automation runbook executions, optionally filtered by status, runbook name or time, with each execution's ID, status and start time.

**Inputs**

- Filters (`filters`, list): Filters.
- Max results (`max_results`, number): Max results. From 1 to 50.
- Next token (`next_token`, text): Next token.

**Outputs**

- `data` (object): AWS Systems Manager response data.

**Example output**

```json
{
  "data": {
    "AutomationExecutionMetadataList": [],
    "NextToken": "example"
  }
}
```

### Describe document

Get the details of an SSM document by its name, such as its type, status, owner, parameters and latest version, without its content.

**Inputs**

- Name (`name`, text, required): Name.
- Document version (`document_version`, text): Document version.
- Version name (`version_name`, text): Version name.

**Outputs**

- `data` (object): AWS Systems Manager response data.

**Example output**

```json
{
  "data": {
    "Document": {
      "ApprovedVersion": "example",
      "AttachmentsInformation": [],
      "Author": "example",
      "Category": [],
      "CategoryEnum": [],
      "CreatedDate": "example",
      "DefaultVersion": "example",
      "Description": "example",
      "DisplayName": "example",
      "DocumentFormat": "YAML",
      "DocumentType": "Command",
      "DocumentVersion": "example",
      "Hash": "example",
      "HashType": "Sha256",
      "LatestVersion": "example",
      "Name": "example",
      "Owner": "example",
      "Parameters": [],
      "PendingReviewVersion": "example",
      "PlatformTypes": [],
      "Requires": [],
      "ReviewInformation": [],
      "ReviewStatus": "APPROVED",
      "SchemaVersion": "example",
      "Sha1": "example",
      "Status": "Creating",
      "StatusInformation": "example",
      "Tags": [],
      "TargetType": "example",
      "VersionName": "example"
    }
  }
}
```

### Describe instance information

List the managed nodes registered with Systems Manager, optionally filtered, with each node's ID, platform, agent version and ping status.

**Inputs**

- Instance information filter list (`instance_information_filter_list`, list): Instance information filter list.
- Filters (`filters`, list): Filters.
- Max results (`max_results`, number): Max results. From 5 to 50.
- Next token (`next_token`, text): Next token.

**Outputs**

- `data` (object): AWS Systems Manager response data.

**Example output**

```json
{
  "data": {
    "InstanceInformationList": [],
    "NextToken": "example"
  }
}
```

### Describe instance patch states

Get the patch compliance summary of the managed nodes you list by ID, including counts of installed, missing and failed patches.

**Inputs**

- Instance ids (`instance_ids`, list, required): Instance ids.
- Next token (`next_token`, text): Next token.
- Max results (`max_results`, number): Max results. From 10 to 100.

**Outputs**

- `data` (object): AWS Systems Manager response data.

**Example output**

```json
{
  "data": {
    "InstancePatchStates": [],
    "NextToken": "example"
  }
}
```

### Describe instance patches

List the patches for one managed node by its ID, optionally filtered, with each patch's title, severity and install state.

**Inputs**

- Instance (`instance_id`, text, required): Instance id.
- Filters (`filters`, list): Filters.
- Next token (`next_token`, text): Next token.
- Max results (`max_results`, number): Max results. From 10 to 100.

**Outputs**

- `data` (object): AWS Systems Manager response data.

**Example output**

```json
{
  "data": {
    "NextToken": "example",
    "Patches": []
  }
}
```

### Describe parameters

List the Parameter Store parameters in your account, optionally filtered by name, path, type or tag. Returns each parameter's metadata but not its value.

**Inputs**

- Filters (`filters`, list): Filters.
- Parameter filters (`parameter_filters`, list): Parameter filters.
- Max results (`max_results`, number): Max results. From 1 to 50.
- Next token (`next_token`, text): Next token.
- Shared (`shared`, true/false): Shared.

**Outputs**

- `data` (object): AWS Systems Manager response data.

**Example output**

```json
{
  "data": {
    "NextToken": "example",
    "Parameters": []
  }
}
```

### Get automation execution

Get one Automation runbook execution by its ID, including its status, parameters, outputs and the result of each step.

**Inputs**

- Automation execution (`automation_execution_id`, text, required): Automation execution id.

**Outputs**

- `data` (object): AWS Systems Manager response data.

**Example output**

```json
{
  "data": {
    "AutomationExecution": {
      "AlarmConfiguration": {
        "Alarms": [],
        "IgnorePollAlarmFailure": false
      },
      "AssociationId": "example",
      "AutomationExecutionId": "example",
      "AutomationExecutionStatus": "Pending",
      "AutomationSubtype": "ChangeRequest",
      "ChangeRequestName": "example",
      "CurrentAction": "example",
      "CurrentStepName": "example",
      "DocumentName": "example",
      "DocumentVersion": "example",
      "ExecutedBy": "example",
      "ExecutionEndTime": "example",
      "ExecutionStartTime": "example",
      "FailureMessage": "example",
      "MaxConcurrency": "example",
      "MaxErrors": "example",
      "Mode": "Auto",
      "OpsItemId": "example",
      "Outputs": {},
      "Parameters": {},
      "ParentAutomationExecutionId": "example",
      "ProgressCounters": {
        "CancelledSteps": 1,
        "FailedSteps": 1,
        "SuccessSteps": 1,
        "TimedOutSteps": 1,
        "TotalSteps": 1
      },
      "ResolvedTargets": {
        "ParameterValues": [],
        "Truncated": false
      },
      "Runbooks": [],
      "ScheduledTime": "example",
      "StepExecutions": [],
      "StepExecutionsTruncated": false,
      "Target": "example",
      "TargetLocations": [],
      "TargetLocationsURL": "example",
      "TargetMaps": [],
      "TargetParameterName": "example",
      "Targets": [],
      "TriggeredAlarms": [],
      "Variables": {},
      "WarningMessage": "example"
    }
  }
}
```

### Get command invocation

Get the result of a Run Command command on one managed node, by command ID and node ID, including its status, exit code and output.

**Inputs**

- Command (`command_id`, text, required): Command id.
- Instance (`instance_id`, text, required): Instance id.
- Plugin name (`plugin_name`, text): Plugin name.

**Outputs**

- `data` (object): AWS Systems Manager response data.

**Example output**

```json
{
  "data": {
    "CloudWatchOutputConfig": {
      "CloudWatchLogGroupName": "example",
      "CloudWatchOutputEnabled": false
    },
    "CommandId": "example",
    "Comment": "example",
    "DocumentName": "example",
    "DocumentVersion": "example",
    "ExecutionElapsedTime": "example",
    "ExecutionEndDateTime": "example",
    "ExecutionStartDateTime": "example",
    "InstanceId": "example",
    "PluginName": "example",
    "ResponseCode": 1,
    "StandardErrorContent": "example",
    "StandardErrorUrl": "example",
    "StandardOutputContent": "example",
    "StandardOutputUrl": "example",
    "Status": "Pending",
    "StatusDetails": "example"
  }
}
```

### Get document

Get the content of an SSM document by its name, optionally a specific version, in JSON, YAML or text.

**Inputs**

- Name (`name`, text, required): Name.
- Version name (`version_name`, text): Version name.
- Document version (`document_version`, text): Document version.
- Document format (`document_format`, text): Document format. One of: `YAML`, `JSON`, `TEXT`.

**Outputs**

- `data` (object): AWS Systems Manager response data.

**Example output**

```json
{
  "data": {
    "AttachmentsContent": [],
    "Content": "example",
    "CreatedDate": "example",
    "DisplayName": "example",
    "DocumentFormat": "YAML",
    "DocumentType": "Command",
    "DocumentVersion": "example",
    "Name": "example",
    "Requires": [],
    "ReviewStatus": "APPROVED",
    "Status": "Creating",
    "StatusInformation": "example",
    "VersionName": "example"
  }
}
```

### Get inventory

Query the inventory collected from your managed nodes, such as installed applications or network settings, with optional filters and aggregations.

**Inputs**

- Filters (`filters`, list): Filters.
- Aggregators (`aggregators`, list): Aggregators.
- Result attributes (`result_attributes`, list): Result attributes.
- Next token (`next_token`, text): Next token.
- Max results (`max_results`, number): Max results. From 1 to 50.

**Outputs**

- `data` (object): AWS Systems Manager response data.

**Example output**

```json
{
  "data": {
    "Entities": [],
    "NextToken": "example"
  }
}
```

### Get parameter

Get one Parameter Store parameter by its name, including its value and type. Secure string values are decrypted when you ask for it.

**Inputs**

- Name (`name`, text, required): Name.
- With decryption (`with_decryption`, true/false): With decryption.

**Outputs**

- `data` (object): AWS Systems Manager response data.

**Example output**

```json
{
  "data": {
    "Parameter": {
      "ARN": "example",
      "DataType": "example",
      "LastModifiedDate": "example",
      "Name": "example",
      "Selector": "example",
      "SourceResult": "example",
      "Type": "String",
      "Value": "example",
      "Version": 1
    }
  }
}
```

### Get parameters

Get several Parameter Store parameters at once by their names, with each value and type, plus any names that were not found.

**Inputs**

- Names (`names`, list, required): Names.
- With decryption (`with_decryption`, true/false): With decryption.

**Outputs**

- `data` (object): AWS Systems Manager response data.

**Example output**

```json
{
  "data": {
    "InvalidParameters": [],
    "Parameters": []
  }
}
```

### Get parameters by path

Get the Parameter Store parameters under a path, such as /app/prod, optionally including deeper levels, with each one's value.

**Inputs**

- Path (`path`, text, required): Path.
- Recursive (`recursive`, true/false): Recursive.
- Parameter filters (`parameter_filters`, list): Parameter filters.
- With decryption (`with_decryption`, true/false): With decryption.
- Max results (`max_results`, number): Max results. From 1 to 10.
- Next token (`next_token`, text): Next token.

**Outputs**

- `data` (object): AWS Systems Manager response data.

**Example output**

```json
{
  "data": {
    "NextToken": "example",
    "Parameters": []
  }
}
```

### List command invocations

List the runs of Run Command commands on individual managed nodes, optionally for one command or node, with each run's status and, if asked, its output.

**Inputs**

- Command (`command_id`, text): Command id.
- Instance (`instance_id`, text): Instance id.
- Max results (`max_results`, number): Max results. From 1 to 50.
- Next token (`next_token`, text): Next token.
- Filters (`filters`, list): Filters.
- Details (`details`, true/false): Details.

**Outputs**

- `data` (object): AWS Systems Manager response data.

**Example output**

```json
{
  "data": {
    "CommandInvocations": [],
    "NextToken": "example"
  }
}
```

### List commands

List the Run Command commands sent to your managed nodes, optionally for one command ID or node, with each command's document, status and target counts.

**Inputs**

- Command (`command_id`, text): Command id.
- Instance (`instance_id`, text): Instance id.
- Max results (`max_results`, number): Max results. From 1 to 50.
- Next token (`next_token`, text): Next token.
- Filters (`filters`, list): Filters.

**Outputs**

- `data` (object): AWS Systems Manager response data.

**Example output**

```json
{
  "data": {
    "Commands": [],
    "NextToken": "example"
  }
}
```

### List document versions

List the versions of an SSM document by its name, with each version's number, creation date and whether it is the default.

**Inputs**

- Name (`name`, text, required): Name.
- Max results (`max_results`, number): Max results. From 1 to 50.
- Next token (`next_token`, text): Next token.

**Outputs**

- `data` (object): AWS Systems Manager response data.

**Example output**

```json
{
  "data": {
    "DocumentVersions": [],
    "NextToken": "example"
  }
}
```

### List documents

List the SSM documents you can use, optionally filtered by owner, type or tag, with each document's name, type and version.

**Inputs**

- Document filter list (`document_filter_list`, list): Document filter list.
- Filters (`filters`, list): Filters.
- Max results (`max_results`, number): Max results. From 1 to 50.
- Next token (`next_token`, text): Next token.

**Outputs**

- `data` (object): AWS Systems Manager response data.

**Example output**

```json
{
  "data": {
    "DocumentIdentifiers": [],
    "NextToken": "example"
  }
}
```

### List inventory entries

List one inventory type's entries for a managed node, such as its installed applications, by node ID and inventory type name.

**Inputs**

- Instance (`instance_id`, text, required): Instance id.
- Type name (`type_name`, text, required): Type name.
- Filters (`filters`, list): Filters.
- Next token (`next_token`, text): Next token.
- Max results (`max_results`, number): Max results. From 1 to 50.

**Outputs**

- `data` (object): AWS Systems Manager response data.

**Example output**

```json
{
  "data": {
    "CaptureTime": "example",
    "Entries": [],
    "InstanceId": "example",
    "NextToken": "example",
    "SchemaVersion": "example",
    "TypeName": "example"
  }
}
```

### Put parameter

Create a Parameter Store parameter with a name and value, or change an existing one's value when overwrite is on. Returns the parameter's new version number.

**Inputs**

- Name (`name`, text, required): Name.
- Description (`description`, text): Description.
- Value (`value`, text, required): Value.
- Type (`type`, text): Type. One of: `String`, `StringList`, `SecureString`.
- Key id (`key_id`, text): Key id.
- Overwrite (`overwrite`, true/false): Overwrite.
- Allowed pattern (`allowed_pattern`, text): Allowed pattern.
- Tags (`tags`, list): Tags.
- Tier (`tier`, text): Tier. One of: `Standard`, `Advanced`, `Intelligent-Tiering`.
- Policies (`policies`, text): Policies.
- Data type (`data_type`, text): Data type.

**Outputs**

- `data` (object): AWS Systems Manager response data.

**Example output**

```json
{
  "data": {
    "Tier": "Standard",
    "Version": 1
  }
}
```
