aws.ec2.describe_instances

Describe EC2 instances and their reservations using a CloudConnection UUID.

Overview

Property	Value
Workflow type	Atomic
Library	Base-aws
Version	1.0

Input Schema

Field	Type	Required	Default	Description
connection_uuid	uuid	Yes	—	CloudConnection UUID for the target AWS account.
workflow_run_id	string	No	—	Engine DAG run ID stamped onto child steps.
region	string	No	—	AWS region override.
instance_ids	list	No	—	EC2 instance IDs to describe.
filters	json	No	—	Provider-native DescribeInstances filters.
max_results	integer	No	—	Maximum number of results per page.
next_token	string	No	—	Pagination token from a prior call.

Output Schema

Field	Type	Required	Default	Description
connection_uuid	uuid	No	—	CloudConnection UUID echoed from input.
region	string	No	—	AWS region used.
reservations	json	No	—	Provider Reservations objects returned by EC2; empty list when none match.
instances	list	No	—	Flattened list of sanitized instance objects; empty list when none match.
instance_count	integer	No	—	Number of instances returned across all reservations.
next_token	string	No	—	Pagination token for the next page when present.
failure_reason	string	No	—	Human-readable failure reason.
failed_step	string	No	—	Failed logical step.
failed_layer	json	No	—	Failed DAG layer if engine supplies one.
failed_at_state	string	No	—	State where failure occurred.
error	string	No	—	Error message.
error_type	string	No	—	Error class.
failed_at	string	No	—	ISO failure timestamp.

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	—
completed	No	Yes	Yes	—	—
failed	No	Yes	No	—	—

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	—
* (any state)	fail	failed	—

API Usage

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

{
  "workflow_type": "aws.ec2.describe_instances",
  "initial_data": {
    "connection_uuid": "value"
  }
}