AWS Systems Manager

App · 20 actions

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

Actions

ActionWhat it does
Delete parameterDelete a Parameter Store parameter by its name, along with its value and version history.
Describe automation executionsList Automation runbook executions, optionally filtered by status, runbook name or time, with each execution's ID, status and start time.
Describe documentGet the details of an SSM document by its name, such as its type, status, owner, parameters and latest version, without its content.
Describe instance informationList the managed nodes registered with Systems Manager, optionally filtered, with each node's ID, platform, agent version and ping status.
Describe instance patch statesGet the patch compliance summary of the managed nodes you list by ID, including counts of installed, missing and failed patches.
Describe instance patchesList the patches for one managed node by its ID, optionally filtered, with each patch's title, severity and install state.
Describe parametersList the Parameter Store parameters in your account, optionally filtered by name, path, type or tag.
Get automation executionGet one Automation runbook execution by its ID, including its status, parameters, outputs and the result of each step.
Get command invocationGet the result of a Run Command command on one managed node, by command ID and node ID, including its status, exit code and output.
Get documentGet the content of an SSM document by its name, optionally a specific version, in JSON, YAML or text.
Get inventoryQuery the inventory collected from your managed nodes, such as installed applications or network settings, with optional filters and aggregations.
Get parameterGet one Parameter Store parameter by its name, including its value and type.
Get parametersGet several Parameter Store parameters at once by their names, with each value and type, plus any names that were not found.
Get parameters by pathGet the Parameter Store parameters under a path, such as /app/prod, optionally including deeper levels, with each one's value.
List command invocationsList 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.
List commandsList 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.
List document versionsList the versions of an SSM document by its name, with each version's number, creation date and whether it is the default.
List documentsList the SSM documents you can use, optionally filtered by owner, type or tag, with each document's name, type and version.
List inventory entriesList one inventory type's entries for a managed node, such as its installed applications, by node ID and inventory type name.
Put parameterCreate a Parameter Store parameter with a name and value, or change an existing one's value when overwrite is on.

Delete parameter

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

Inputs

NamenametextRequired
Name.

Outputs

dataobject
AWS Systems Manager response data.
Example output
{
  "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

Filtersfilterslist
Filters.
Max resultsmax_resultsnumber
Max results.From 1 to 50.
Next tokennext_tokentext
Next token.

Outputs

dataobject
AWS Systems Manager response data.
Example output
{
  "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

NamenametextRequired
Name.
Document versiondocument_versiontext
Document version.
Version nameversion_nametext
Version name.

Outputs

dataobject
AWS Systems Manager response data.
Example output
{
  "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 listinstance_information_filter_listlist
Instance information filter list.
Filtersfilterslist
Filters.
Max resultsmax_resultsnumber
Max results.From 5 to 50.
Next tokennext_tokentext
Next token.

Outputs

dataobject
AWS Systems Manager response data.
Example output
{
  "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 idsinstance_idslistRequired
Instance ids.
Next tokennext_tokentext
Next token.
Max resultsmax_resultsnumber
Max results.From 10 to 100.

Outputs

dataobject
AWS Systems Manager response data.
Example output
{
  "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

Instanceinstance_idtextRequired
Instance id.
Filtersfilterslist
Filters.
Next tokennext_tokentext
Next token.
Max resultsmax_resultsnumber
Max results.From 10 to 100.

Outputs

dataobject
AWS Systems Manager response data.
Example output
{
  "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

Filtersfilterslist
Filters.
Parameter filtersparameter_filterslist
Parameter filters.
Max resultsmax_resultsnumber
Max results.From 1 to 50.
Next tokennext_tokentext
Next token.
Sharedsharedtrue/false
Shared.

Outputs

dataobject
AWS Systems Manager response data.
Example output
{
  "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 executionautomation_execution_idtextRequired
Automation execution id.

Outputs

dataobject
AWS Systems Manager response data.
Example output
{
  "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

Commandcommand_idtextRequired
Command id.
Instanceinstance_idtextRequired
Instance id.
Plugin nameplugin_nametext
Plugin name.

Outputs

dataobject
AWS Systems Manager response data.
Example output
{
  "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

NamenametextRequired
Name.
Version nameversion_nametext
Version name.
Document versiondocument_versiontext
Document version.
Document formatdocument_formattext
Document format.One of: YAML, JSON, TEXT.

Outputs

dataobject
AWS Systems Manager response data.
Example output
{
  "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

Filtersfilterslist
Filters.
Aggregatorsaggregatorslist
Aggregators.
Result attributesresult_attributeslist
Result attributes.
Next tokennext_tokentext
Next token.
Max resultsmax_resultsnumber
Max results.From 1 to 50.

Outputs

dataobject
AWS Systems Manager response data.
Example output
{
  "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

NamenametextRequired
Name.
With decryptionwith_decryptiontrue/false
With decryption.

Outputs

dataobject
AWS Systems Manager response data.
Example output
{
  "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

NamesnameslistRequired
Names.
With decryptionwith_decryptiontrue/false
With decryption.

Outputs

dataobject
AWS Systems Manager response data.
Example output
{
  "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

PathpathtextRequired
Path.
Recursiverecursivetrue/false
Recursive.
Parameter filtersparameter_filterslist
Parameter filters.
With decryptionwith_decryptiontrue/false
With decryption.
Max resultsmax_resultsnumber
Max results.From 1 to 10.
Next tokennext_tokentext
Next token.

Outputs

dataobject
AWS Systems Manager response data.
Example output
{
  "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

Commandcommand_idtext
Command id.
Instanceinstance_idtext
Instance id.
Max resultsmax_resultsnumber
Max results.From 1 to 50.
Next tokennext_tokentext
Next token.
Filtersfilterslist
Filters.
Detailsdetailstrue/false
Details.

Outputs

dataobject
AWS Systems Manager response data.
Example output
{
  "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

Commandcommand_idtext
Command id.
Instanceinstance_idtext
Instance id.
Max resultsmax_resultsnumber
Max results.From 1 to 50.
Next tokennext_tokentext
Next token.
Filtersfilterslist
Filters.

Outputs

dataobject
AWS Systems Manager response data.
Example output
{
  "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

NamenametextRequired
Name.
Max resultsmax_resultsnumber
Max results.From 1 to 50.
Next tokennext_tokentext
Next token.

Outputs

dataobject
AWS Systems Manager response data.
Example output
{
  "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 listdocument_filter_listlist
Document filter list.
Filtersfilterslist
Filters.
Max resultsmax_resultsnumber
Max results.From 1 to 50.
Next tokennext_tokentext
Next token.

Outputs

dataobject
AWS Systems Manager response data.
Example output
{
  "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

Instanceinstance_idtextRequired
Instance id.
Type nametype_nametextRequired
Type name.
Filtersfilterslist
Filters.
Next tokennext_tokentext
Next token.
Max resultsmax_resultsnumber
Max results.From 1 to 50.

Outputs

dataobject
AWS Systems Manager response data.
Example output
{
  "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

NamenametextRequired
Name.
Descriptiondescriptiontext
Description.
ValuevaluetextRequired
Value.
Typetypetext
Type.One of: String, StringList, SecureString.
Key idkey_idtext
Key id.
Overwriteoverwritetrue/false
Overwrite.
Allowed patternallowed_patterntext
Allowed pattern.
Tagstagslist
Tags.
Tiertiertext
Tier.One of: Standard, Advanced, Intelligent-Tiering.
Policiespoliciestext
Policies.
Data typedata_typetext
Data type.

Outputs

dataobject
AWS Systems Manager response data.
Example output
{
  "data": {
    "Tier": "Standard",
    "Version": 1
  }
}

On this page