AWS Systems Manager

AWS Systems Manager is the operations hub for AWS. It gives you a single place to run commands across fleets of managed nodes, store configuration and secrets, track patch and compliance state, and execute runbooks — without opening SSH, managing bastion hosts, or distributing long-lived credentials.

With AWS Systems Manager, you can:

  • Run commands remotely: Execute shell or PowerShell across a fleet by instance ID or tag-based targets, with concurrency and error thresholds you control
  • Store configuration and secrets: Keep parameters in Parameter Store as plain strings, string lists, or KMS-encrypted SecureStrings
  • Inspect your fleet: List managed nodes with their platform, agent version, and last ping time
  • Track patch state: Read per-instance patch installations and summary compliance counts
  • Audit compliance: Query compliance items and summaries across your managed nodes
  • Automate runbooks: Start, monitor, and stop Automation executions built on SSM documents

In Sim, the Systems Manager integration is what lets an agent act on infrastructure rather than only report on it. Paired with CloudWatch or CloudTrail for detection, a workflow can investigate an alert, run a diagnostic command against the affected nodes, read the configuration behind the failure from Parameter Store, and kick off an Automation runbook to remediate — end to end, with every step logged in your run history.

Parameter Store decryption is opt-in: Get Parameter, Get Parameters, and Get Parameters By Path leave WithDecryption off unless you explicitly enable it, so a SecureString stays encrypted by default.

Be precise about what that protects, because it is narrower than it looks. The value you supply to Put Parameter is masked in the editor and is never echoed back in the operation's result, and Sim never puts a parameter value into an error message. It is not kept out of the run log: block inputs are recorded, and a value typed directly into the field is recorded verbatim. Referencing an environment variable instead — {{MY_SECRET}} — keeps the literal out of the log, because references are restored to their placeholder before the log is written.

Reads are exposed the same way. Once you enable decryption the plaintext is ordinary block output: it flows to downstream blocks as intended, and it is written to the run log and the execution trace like any other output.

So enable decryption only on the steps that genuinely need the plaintext, prefer environment-variable references over typed literals when writing, and treat the run logs of any workflow that touches SecureString values as secret material.

Usage Instructions

Integrate AWS Systems Manager into your workflow. Run commands on managed nodes, read and write Parameter Store values, inspect node inventory and patch compliance, and drive Automation runbooks.

Actions

SSM Send Command

Run an SSM document on managed nodes with AWS Systems Manager Run Command

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
documentNamestringYesName of the SSM document to run (e.g., AWS-RunShellScript)
instanceIdsjsonNoManaged node IDs to target, as an array of strings (e.g., ["i-0123456789abcdef0"]). Provide instanceIds or targets
targetsjsonNoTag or resource-group targets, as an array of {Key, Values} objects. Provide instanceIds or targets
documentVersionstringNoDocument version to run ($LATEST, $DEFAULT, or a version number)
parametersjsonNoDocument parameters, as an object mapping each parameter name to an array of string values
commentstringNoComment describing the command, at most 100 characters
executionTimeoutSecondsnumberNoSeconds to wait for a node to acknowledge the command before it times out (30-2592000)
maxConcurrencystringNoNumber or percentage of nodes to run the command on at once (e.g., 10 or 50%)
maxErrorsstringNoNumber or percentage of errors allowed before the command stops (e.g., 0 or 10%)
outputS3BucketNamestringNoS3 bucket to store command output in
outputS3KeyPrefixstringNoS3 key prefix for stored command output
serviceRoleArnstringNoARN of the IAM service role Systems Manager uses to publish notifications

Output

ParameterTypeDescription
commandIdstringID of the command; pass it to ssm_get_command_invocation or ssm_list_command_invocations to read per-node results
documentNamestringName of the document that was run
documentVersionstringDocument version that was run
commentstringComment supplied with the command
statusstringCommand status (Pending, InProgress, Success, Cancelled, Failed, TimedOut, Cancelling)
statusDetailsstringDetailed status of the command
requestedDateTimestringWhen the command was requested
expiresAfterstringWhen the command stops being dispatched to nodes that have not run it
instanceIdsarrayManaged node IDs the command targets
targetsjsonTag or resource-group targets the command was sent to, as an array of {key, values}
maxConcurrencystringConcurrency setting the command ran with
maxErrorsstringError threshold the command ran with
targetCountnumberNumber of targets the command was sent to
completedCountnumberNumber of targets that have completed the command
errorCountnumberNumber of targets whose command execution failed
deliveryTimedOutCountnumberNumber of targets the command could not be delivered to in time
executionTimeoutSecondsnumberAcknowledgement timeout the command ran with
outputS3BucketNamestringS3 bucket command output is written to
outputS3KeyPrefixstringS3 key prefix command output is written under
outputS3RegionstringS3 region reported for command output
serviceRolestringIAM service role used for notifications

SSM List Commands

List Run Command executions in an AWS account

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
commandIdstringNoReturn only the command with this ID
instanceIdstringNoReturn only commands sent to this managed node
filtersjsonNoFilters, as an array of {key, value} objects. Valid keys: InvokedAfter, InvokedBefore, Status, ExecutionStage, DocumentName
maxResultsnumberNoMaximum number of commands to return (1-50)
nextTokenstringNoPagination token from a previous request

Output

ParameterTypeDescription
commandsjsonCommands, each with commandId, documentName, status, statusDetails, requestedDateTime, instanceIds, targets, targetCount, completedCount, and errorCount
nextTokenstringPagination token for the next page of results
countnumberNumber of commands returned

SSM List Command Invocations

List the per-node invocations of Run Command executions

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
commandIdstringNoReturn only invocations of this command
instanceIdstringNoReturn only invocations on this managed node
filtersjsonNoFilters, as an array of {key, value} objects. Valid keys: InvokedAfter, InvokedBefore, Status, DocumentName
detailsbooleanNoInclude per-plugin detail (command plugins and their output) for each invocation
maxResultsnumberNoMaximum number of invocations to return (1-50)
nextTokenstringNoPagination token from a previous request

Output

ParameterTypeDescription
commandInvocationsjsonInvocations, each with commandId, instanceId, instanceName, status, statusDetails, requestedDateTime, standardOutputUrl, standardErrorUrl, and commandPlugins
nextTokenstringPagination token for the next page of results
countnumberNumber of invocations returned

SSM Get Command Invocation

Read the output and status of a Run Command execution on one managed node

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
commandIdstringYesID of the command, as returned by ssm_send_command
instanceIdstringYesManaged node the command ran on (e.g., i-0123456789abcdef0)
pluginNamestringNoName of the document plugin to read output for; required for documents with more than one plugin

Output

ParameterTypeDescription
commandIdstringID of the command
instanceIdstringManaged node the command ran on
commentstringComment supplied with the command
documentNamestringDocument that was run
documentVersionstringDocument version that was run
pluginNamestringPlugin the output belongs to
responseCodenumberExit code of the command, or -1 if it has not started
executionStartDateTimestringWhen the command started running on the node
executionElapsedTimestringHow long the command ran, as an ISO 8601 duration
executionEndDateTimestringWhen the command finished running on the node
statusstringInvocation status (Pending, InProgress, Delayed, Success, Cancelled, TimedOut, Failed, Cancelling)
statusDetailsstringDetailed status of the invocation
standardOutputContentstringFirst 24000 characters of stdout; longer output is available at standardOutputUrl
standardOutputUrlstringS3 URL of the full stdout, if S3 output was configured
standardErrorContentstringFirst 8000 characters of stderr; longer output is available at standardErrorUrl
standardErrorUrlstringS3 URL of the full stderr, if S3 output was configured

SSM Cancel Command

Cancel an in-flight Run Command execution

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
commandIdstringYesID of the command to cancel, as returned by ssm_send_command
instanceIdsarrayNoManaged node IDs to cancel on (e.g., ["i-0123456789abcdef0"]); omit to cancel on every targeted node

Output

ParameterTypeDescription
messagestringOperation status message
commandIdstringID of the command that was cancelled

SSM Get Parameter

Read one parameter from AWS Systems Manager Parameter Store

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
namestringYesName of the parameter, optionally with a :version or :label suffix
withDecryptionbooleanNoReturn the decrypted value of a SecureString parameter; ignored for String and StringList parameters

Output

ParameterTypeDescription
namestringName of the parameter
typestringParameter type (String, StringList, or SecureString)
valuestringParameter value; encrypted unless withDecryption was set for a SecureString
versionnumberVersion of the parameter
selectorstringVersion or label selector used to read the parameter
sourceResultstringRaw result from the source for a parameter served by another service
lastModifiedDatestringWhen the parameter was last changed
arnstringARN of the parameter
dataTypestringData type of the parameter (text, aws:ec2:image, or aws:ssm:integration)

SSM Get Parameters

Read up to ten parameters from AWS Systems Manager Parameter Store by name

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
namesjsonYesParameter names to read, as an array of at most 10 strings
withDecryptionbooleanNoReturn decrypted values for SecureString parameters; ignored for String and StringList parameters

Output

ParameterTypeDescription
parametersjsonParameters that were found, each with name, type, value, version, arn, dataType, and lastModifiedDate
invalidParametersarrayNames that could not be read because they do not exist or are malformed
countnumberNumber of parameters returned

SSM Get Parameters By Path

Read parameters under a Parameter Store hierarchy path

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
pathstringYesHierarchy path to read, starting with a slash (e.g., /prod/app)
recursivebooleanNoInclude parameters in nested paths below the given path
withDecryptionbooleanNoReturn decrypted values for SecureString parameters; ignored for String and StringList parameters
parameterFiltersjsonNoFilters, as an array of {Key, Option, Values} objects. Valid keys here: Type, KeyId, Label
maxResultsnumberNoMaximum number of parameters to return (1-10)
nextTokenstringNoPagination token from a previous request

Output

ParameterTypeDescription
parametersjsonParameters under the path, each with name, type, value, version, arn, dataType, and lastModifiedDate
nextTokenstringPagination token for the next page of results
countnumberNumber of parameters returned

SSM Put Parameter

Create or update a parameter in AWS Systems Manager Parameter Store

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
namestringYesName of the parameter, optionally using a slash-separated hierarchy
valuestringYesValue to store
typestringNoParameter type (String, StringList, or SecureString); required when creating a new parameter
descriptionstringNoDescription of the parameter
keyIdstringNoKMS key ID or ARN used to encrypt a SecureString parameter; defaults to the account key
overwritebooleanNoOverwrite the parameter if it already exists
allowedPatternstringNoRegular expression the value must match
tierstringNoParameter tier (Standard, Advanced, or Intelligent-Tiering)
dataTypestringNoData type of the parameter (text, aws:ec2:image, or aws:ssm:integration)
policiesstringNoParameter policies as a JSON array string; Advanced tier only

Output

ParameterTypeDescription
messagestringOperation status message
namestringName of the parameter that was written
versionnumberVersion number the write produced
tierstringTier the parameter was stored in

SSM Delete Parameter

Delete a parameter from AWS Systems Manager Parameter Store

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
namestringYesName of the parameter to delete

Output

ParameterTypeDescription
messagestringOperation status message
namestringName of the parameter that was deleted

SSM Describe Parameters

List Parameter Store parameter metadata without reading any values

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
parameterFiltersjsonNoFilters, as an array of {Key, Option, Values} objects. Valid keys: Name, Type, KeyId, Path, Tier, DataType, or tag:<key>
sharedbooleanNoReturn parameters shared with this account instead of parameters it owns
maxResultsnumberNoMaximum number of parameters to return (1-50)
nextTokenstringNoPagination token from a previous request

Output

ParameterTypeDescription
parametersjsonParameter metadata, each with name, arn, type, keyId, description, tier, version, dataType, allowedPattern, lastModifiedDate, lastModifiedUser, and policies. Values are never included
nextTokenstringPagination token for the next page of results
countnumberNumber of parameters returned

SSM Describe Instance Information

List managed nodes registered with AWS Systems Manager and their agent status

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
filtersjsonNoFilters, as an array of {Key, Values} objects. Valid keys: InstanceIds, AgentVersion, PingStatus, PlatformTypes, ActivationIds, IamRole, ResourceType, AssociationStatus, SourceIds, SourceTypes, tag-key, or tag:<key>
maxResultsnumberNoMaximum number of nodes to return (5-50)
nextTokenstringNoPagination token from a previous request

Output

ParameterTypeDescription
instancesjsonManaged nodes, each with instanceId, pingStatus, lastPingDateTime, agentVersion, isLatestVersion, platformType, platformName, platformVersion, computerName, ipAddress, iamRole, resourceType, and associationStatus
nextTokenstringPagination token for the next page of results
countnumberNumber of managed nodes returned

SSM Describe Instance Patches

List the patches reported for one managed node

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
instanceIdstringYesManaged node to report patches for (e.g., i-0123456789abcdef0)
filtersjsonNoFilters, as an array of {Key, Values} objects. Valid keys: Classification, KBId, Severity, State
maxResultsnumberNoMaximum number of patches to return (10-100)
nextTokenstringNoPagination token from a previous request

Output

ParameterTypeDescription
patchesjsonPatches, each with title, kbId, classification, severity, state, installedTime, and cveIds
nextTokenstringPagination token for the next page of results
countnumberNumber of patches returned

SSM Describe Instance Patch States

Read patch compliance summaries for a set of managed nodes

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
instanceIdsjsonYesManaged node IDs to summarize, as an array of at most 50 strings
maxResultsnumberNoMaximum number of patch states to return (10-100)
nextTokenstringNoPagination token from a previous request

Output

ParameterTypeDescription
instancePatchStatesjsonPatch states, each with instanceId, patchGroup, baselineId, operation, operationStartTime, operationEndTime, installedCount, missingCount, failedCount, notApplicableCount, criticalNonCompliantCount, and securityNonCompliantCount
nextTokenstringPagination token for the next page of results
countnumberNumber of patch states returned

SSM List Compliance Items

List individual compliance findings reported to AWS Systems Manager

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
resourceIdsjsonNoResource to report on, as an array holding a single managed node ID
resourceTypesjsonNoResource type to report on, as an array holding a single value; currently only ManagedInstance is supported
filtersjsonNoFilters, as an array of {Key, Values, Type} objects. Type is one of EQUAL, NOT_EQUAL, BEGIN_WITH, LESS_THAN, GREATER_THAN
maxResultsnumberNoMaximum number of compliance items to return (1-50)
nextTokenstringNoPagination token from a previous request

Output

ParameterTypeDescription
complianceItemsjsonCompliance items, each with complianceType, resourceType, resourceId, id, title, status, severity, executionTime, executionId, executionType, and details
nextTokenstringPagination token for the next page of results
countnumberNumber of compliance items returned

SSM List Compliance Summaries

Read compliant and non-compliant counts per compliance type

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
filtersjsonNoFilters, as an array of {Key, Values, Type} objects. Type is one of EQUAL, NOT_EQUAL, BEGIN_WITH, LESS_THAN, GREATER_THAN
maxResultsnumberNoMaximum number of summaries to return (1-50)
nextTokenstringNoPagination token from a previous request

Output

ParameterTypeDescription
complianceSummaryItemsjsonSummaries, each with complianceType, compliantCount, compliantSeveritySummary, nonCompliantCount, and nonCompliantSeveritySummary
nextTokenstringPagination token for the next page of results
countnumberNumber of summaries returned

SSM Start Automation Execution

Start an AWS Systems Manager Automation runbook execution

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
documentNamestringYesName of the Automation runbook to run (e.g., AWS-RestartEC2Instance)
documentVersionstringNoRunbook version to run ($LATEST, $DEFAULT, or a version number)
parametersjsonNoRunbook parameters, as an object mapping each parameter name to an array of string values
modestringNoExecution mode, Auto or Interactive
targetParameterNamestringNoRunbook parameter that receives each resolved target; required when targets is set
targetsjsonNoRate-control target, as an array holding a single {Key, Values} object; requires targetParameterName
maxConcurrencystringNoNumber or percentage of targets to run against at once (e.g., 10 or 50%)
maxErrorsstringNoNumber or percentage of errors allowed before the execution stops (e.g., 0 or 10%)
clientTokenstringNoIdempotency token, exactly 36 characters

Output

ParameterTypeDescription
automationExecutionIdstringID of the execution; pass it to ssm_get_automation_execution or ssm_stop_automation_execution

SSM Describe Automation Executions

List Automation runbook executions in an AWS account

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
filtersjsonNoFilters, as an array of {Key, Values} objects. Valid keys: DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter, AutomationType, TagKey, TargetResourceGroup, AutomationSubtype, OpsItemId
maxResultsnumberNoMaximum number of executions to return (1-50)
nextTokenstringNoPagination token from a previous request

Output

ParameterTypeDescription
automationExecutionsjsonExecutions, each with automationExecutionId, documentName, documentVersion, automationExecutionStatus, executionStartTime, executionEndTime, executedBy, currentStepName, currentAction, failureMessage, and outputs
nextTokenstringPagination token for the next page of results
countnumberNumber of executions returned

SSM Get Automation Execution

Read the status, outputs, and step results of one Automation execution

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
automationExecutionIdstringYesID of the execution, as returned by ssm_start_automation_execution

Output

ParameterTypeDescription
automationExecutionIdstringID of the execution
documentNamestringRunbook that was run
documentVersionstringRunbook version that was run
automationExecutionStatusstringExecution status (Pending, InProgress, Waiting, Success, TimedOut, Cancelling, Cancelled, Failed, and related values)
executionStartTimestringWhen the execution started
executionEndTimestringWhen the execution finished
executedBystringIAM identity that started the execution
modestringExecution mode, Auto or Interactive
parentAutomationExecutionIdstringID of the parent execution, for a child execution
currentStepNamestringStep the execution is currently running
currentActionstringAction the execution is currently running
failureMessagestringReason the execution failed
targetParameterNamestringRunbook parameter that received each resolved target
targetstringResource the execution targeted
maxConcurrencystringConcurrency setting the execution ran with
maxErrorsstringError threshold the execution ran with
parametersjsonParameter values the execution was started with
outputsjsonOutputs the execution produced
stepExecutionsjsonSteps, each with stepName, action, stepStatus, stepExecutionId, executionStartTime, executionEndTime, failureMessage, response, isEnd, and nextStep
stepExecutionsTruncatedbooleanWhether the returned step list was truncated

SSM Stop Automation Execution

Stop a running AWS Systems Manager Automation execution

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
automationExecutionIdstringYesID of the execution to stop, as returned by ssm_start_automation_execution
stopTypestringNoHow to stop the execution: Cancel to stop it immediately, or Complete to let the current step finish

Output

ParameterTypeDescription
messagestringOperation status message
automationExecutionIdstringID of the execution that was stopped

SSM List Documents

List SSM documents and runbooks available to an AWS account

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
filtersjsonNoFilters, as an array of {Key, Values} objects. Valid keys: Name, Owner, DocumentType, PlatformTypes, TargetType, or tag:<key>
maxResultsnumberNoMaximum number of documents to return (1-50)
nextTokenstringNoPagination token from a previous request

Output

ParameterTypeDescription
documentsjsonDocuments, each with name, displayName, owner, documentType, documentFormat, documentVersion, schemaVersion, platformTypes, targetType, createdDate, reviewStatus, author, and tags
nextTokenstringPagination token for the next page of results
countnumberNumber of documents returned

SSM Get Document

Read the content of an SSM document or Automation runbook

Input

ParameterTypeRequiredDescription
regionstringYesAWS region (e.g., us-east-1)
accessKeyIdstringYesAWS access key ID
secretAccessKeystringYesAWS secret access key
namestringYesName of the document to read, as returned by ssm_list_documents
documentVersionstringNoDocument version to read ($LATEST, $DEFAULT, or a version number)
versionNamestringNoUser-defined version name to read
documentFormatstringNoFormat to return the content in: JSON, YAML, or TEXT

Output

ParameterTypeDescription
namestringName of the document
displayNamestringFriendly name of the document
createdDatestringWhen the document was created
versionNamestringUser-defined version name
documentVersionstringDocument version that was returned
statusstringDocument status (Creating, Active, Updating, Deleting, Failed)
statusInformationstringDetail about the document status
contentstringContent of the document in the requested format
documentTypestringType of the document (Command, Automation, Policy, Session, and related values)
documentFormatstringFormat the content is returned in
reviewStatusstringReview status of the document (APPROVED, NOT_REVIEWED, PENDING, REJECTED)

On this page