Skip to content
Proud to collaborate with Microsoft for Startups

aws.autoscaling.detach_instances ​

Detach EC2 instances from an Auto Scaling group using a CloudConnection UUID.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryBase-aws
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidYes—CloudConnection UUID for the target AWS account.
workflow_run_idstringNo—Engine DAG run ID stamped onto child steps.
regionstringNo—AWS region override.
auto_scaling_group_namestringYes—Name of the Auto Scaling group.
instance_idslistYes—EC2 instance IDs to detach from the group.
should_decrement_desired_capacitybooleanYes—Whether to decrement the group desired capacity on detach.

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo—CloudConnection UUID echoed from input.
regionstringNo—AWS region used.
auto_scaling_group_namestringNo—Name of the Auto Scaling group.
activitiesjsonNo—Scaling activities returned for the detach operation.
detachedbooleanNo—Whether the instances were detached.
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.autoscaling.detach_instances",
  "initial_data": {
    "connection_uuid": "value",
    "auto_scaling_group_name": "value",
    "instance_ids": "value",
    "should_decrement_desired_capacity": true
  }
}