Skip to content
Proud to collaborate with Microsoft for Startups

aws.eks.describe_nodegroup ​

Describe an Amazon EKS managed nodegroup 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.
cluster_namestringYes—EKS cluster name.
nodegroup_namestringYes—EKS managed nodegroup name.

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo—CloudConnection UUID echoed from input.
regionstringNo—AWS region used.
cluster_namestringNo—EKS cluster name.
nodegroup_namestringNo—EKS nodegroup name.
nodegroup_arnstringNo—EKS nodegroup ARN.
statusstringNo—Provider nodegroup status.
capacity_typestringNo—Capacity type returned by EKS.
scaling_configjsonNo—Scaling config returned by EKS.
instance_typeslistNo—Instance types returned by EKS.
subnetslistNo—Nodegroup subnet IDs.
resourcesjsonNo—Nodegroup backing resources returned by EKS.
healthjsonNo—Nodegroup health block returned by EKS.
labelsjsonNo—Kubernetes labels on nodegroup nodes.
taintslistNo—Kubernetes taints on nodegroup nodes.
nodegroupjsonNo—Sanitized provider nodegroup object.
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.eks.describe_nodegroup",
  "initial_data": {
    "connection_uuid": "value",
    "cluster_name": "value",
    "nodegroup_name": "value"
  }
}