AWS Systems Manager
App · 20 actions
Read managed nodes, inventory, documents, command and automation status, and manage Parameter Store values.
Actions
| Action | What it does |
|---|---|
| Delete parameter | Delete a Parameter Store parameter by its name, along with its value and version history. |
| Describe automation executions | List Automation runbook executions, optionally filtered by status, runbook name or time, with each execution's ID, status and start time. |
| 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. |
| Describe instance information | List the managed nodes registered with Systems Manager, optionally filtered, with each node's ID, platform, agent version and ping status. |
| 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. |
| Describe instance patches | List the patches for one managed node by its ID, optionally filtered, with each patch's title, severity and install state. |
| Describe parameters | List the Parameter Store parameters in your account, optionally filtered by name, path, type or tag. |
| Get automation execution | Get one Automation runbook execution by its ID, including its status, parameters, outputs and the result of each step. |
| 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. |
| Get document | Get the content of an SSM document by its name, optionally a specific version, in JSON, YAML or text. |
| Get inventory | Query the inventory collected from your managed nodes, such as installed applications or network settings, with optional filters and aggregations. |
| Get parameter | Get one Parameter Store parameter by its name, including its value and type. |
| Get parameters | Get several Parameter Store parameters at once by their names, with each value and type, plus any names that were not found. |
| 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. |
| 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. |
| 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. |
| 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. |
| List documents | List the SSM documents you can use, optionally filtered by owner, type or tag, with each document's name, type and version. |
| 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. |
| Put parameter | Create 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
- Name
nametextRequired - 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
- Filters
filterslist - Filters.
- Max results
max_resultsnumber - Max results.From 1 to 50.
- Next token
next_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
- Name
nametextRequired - Name.
- Document version
document_versiontext - Document version.
- Version name
version_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 list
instance_information_filter_listlist - Instance information filter list.
- Filters
filterslist - Filters.
- Max results
max_resultsnumber - Max results.From 5 to 50.
- Next token
next_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 ids
instance_idslistRequired - Instance ids.
- Next token
next_tokentext - Next token.
- Max results
max_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
- Instance
instance_idtextRequired - Instance id.
- Filters
filterslist - Filters.
- Next token
next_tokentext - Next token.
- Max results
max_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
- Filters
filterslist - Filters.
- Parameter filters
parameter_filterslist - Parameter filters.
- Max results
max_resultsnumber - Max results.From 1 to 50.
- Next token
next_tokentext - Next token.
- Shared
sharedtrue/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 execution
automation_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
- Command
command_idtextRequired - Command id.
- Instance
instance_idtextRequired - Instance id.
- Plugin name
plugin_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
- Name
nametextRequired - Name.
- Version name
version_nametext - Version name.
- Document version
document_versiontext - Document version.
- Document format
document_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
- Filters
filterslist - Filters.
- Aggregators
aggregatorslist - Aggregators.
- Result attributes
result_attributeslist - Result attributes.
- Next token
next_tokentext - Next token.
- Max results
max_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
- Name
nametextRequired - Name.
- With decryption
with_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
- Names
nameslistRequired - Names.
- With decryption
with_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
- Path
pathtextRequired - Path.
- Recursive
recursivetrue/false - Recursive.
- Parameter filters
parameter_filterslist - Parameter filters.
- With decryption
with_decryptiontrue/false - With decryption.
- Max results
max_resultsnumber - Max results.From 1 to 10.
- Next token
next_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
- Command
command_idtext - Command id.
- Instance
instance_idtext - Instance id.
- Max results
max_resultsnumber - Max results.From 1 to 50.
- Next token
next_tokentext - Next token.
- Filters
filterslist - Filters.
- Details
detailstrue/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
- Command
command_idtext - Command id.
- Instance
instance_idtext - Instance id.
- Max results
max_resultsnumber - Max results.From 1 to 50.
- Next token
next_tokentext - Next token.
- Filters
filterslist - 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
- Name
nametextRequired - Name.
- Max results
max_resultsnumber - Max results.From 1 to 50.
- Next token
next_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 list
document_filter_listlist - Document filter list.
- Filters
filterslist - Filters.
- Max results
max_resultsnumber - Max results.From 1 to 50.
- Next token
next_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
- Instance
instance_idtextRequired - Instance id.
- Type name
type_nametextRequired - Type name.
- Filters
filterslist - Filters.
- Next token
next_tokentext - Next token.
- Max results
max_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
- Name
nametextRequired - Name.
- Description
descriptiontext - Description.
- Value
valuetextRequired - Value.
- Type
typetext - Type.One of:
String,StringList,SecureString. - Key id
key_idtext - Key id.
- Overwrite
overwritetrue/false - Overwrite.
- Allowed pattern
allowed_patterntext - Allowed pattern.
- Tags
tagslist - Tags.
- Tier
tiertext - Tier.One of:
Standard,Advanced,Intelligent-Tiering. - Policies
policiestext - Policies.
- Data type
data_typetext - Data type.
Outputs
dataobject- AWS Systems Manager response data.
Example output
{
"data": {
"Tier": "Standard",
"Version": 1
}
}