aws.ec2.describe_instance

Describe one EC2 instance by instance ID using a CloudConnection-backed AWS session.

Overview

Property	Value
Workflow type	Atomic
Library	Base-aws
Version	1.0

Input Schema

Field	Type	Required	Default	Description
connection_uuid	uuid	Yes	—	AWS CloudConnection UUID.
region	string	No	—	AWS region override.
instance_id	string	Yes	—	EC2 instance ID.
include_tags	boolean	No	—	Include tags in the sanitized instance payload.
include_terminated	boolean	No	—	Count a terminated instance as found; default false treats terminated as absent.

Output Schema

Field	Type	Required	Default	Description
connection_uuid	uuid	No	—	AWS CloudConnection UUID echoed from input.
region	string	No	—	AWS region used.
instance_id	string	No	—	EC2 instance ID.
found	boolean	No	—	True when the instance exists (and is not terminated unless include_terminated).
state	string	No	—	EC2 instance state name.
private_ip	string	No	—	Private IPv4 address.
public_ip	string	No	—	Public IPv4 address if assigned.
launch_time	string	No	—	Instance launch time as ISO string.
instance_type	string	No	—	EC2 instance type.
image_id	string	No	—	AMI ID.
subnet_id	string	No	—	Subnet ID.
vpc_id	string	No	—	VPC ID.
instance	json	No	—	Sanitized provider instance object.
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_instance",
  "initial_data": {
    "connection_uuid": "value",
    "instance_id": "value"
  }
}