Skip to content
Proud to collaborate with Microsoft for Startups

aws.ssm.describe_instance_information ​

Describe SSM managed instance information using a CloudConnection-backed AWS session.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryBase-aws
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidYes—AWS CloudConnection UUID.
regionstringNo—AWS region override.
instance_idslistNo—Managed instance IDs to filter on (InstanceIds filter).
max_resultsintegerNo—Maximum number of results per page.
next_tokenstringNo—Pagination token from a prior call.

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo—AWS CloudConnection UUID echoed from input.
regionstringNo—AWS region used.
managed_instance_idslistNo—Instance IDs of the SSM managed instances returned.
countintegerNo—Number of managed instances returned.
instance_informationlistNo—Sanitized SSM InstanceInformation objects.
next_tokenstringNo—Pagination token for the next page when present.
failure_reasonstringNo—Human-readable failure reason.
failed_stepstringNo—Failed logical step.
failed_layerjsonNo—Failed DAG layer if engine supplies one.
failed_at_statestringNo—State where failure occurred.
errorstringNo—Error message.
error_typestringNo—Error class.
failed_atstringNo—ISO failure timestamp.

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "aws.ssm.describe_instance_information",
  "initial_data": {
    "connection_uuid": "value"
  }
}