Status
codedeploy.get_deployment
ActionAmazon Web Servicesconnection required
Calls the AWS codedeploy API (SigV4).
Read a deployment's status.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- AWS CodeDeploy
- Secret shape
- {"access_key_id", "secret_access_key"}
- Config it needs
- region
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
region AWS region (overrides the connection). | string | No | — | — | — |
deployment_id Id of the deployment to act on, from its Codedeploy URL or console — not its name. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
deployment_id | string | — |
status | string | — |
application_name | string | — |
error_message | string | — |
error_code Machine-readable form of error_message. | string | — |
complete_time When the deployment finished, epoch seconds. | number | — |
create_time When the deployment was created, epoch seconds. | number | — |
start_time When the rollout started, epoch seconds. | number | — |
deployment_group_name Deployment group — what a redeploy or rollback step targets. | string | — |
deployment_config_name Deployment configuration in force. | string | — |
external_id Caller-supplied id linking the deployment to a ticket. | string | — |
creator What started the deployment (user, autoscaling, …). | string | — |
description Deployment description. | string | — |
compute_platform Server, Lambda or ECS. | string | — |
deployment_type IN_PLACE or BLUE_GREEN. | string | — |
deployment_option Whether traffic control is used. | string | — |
instance_counts Per-state instance counts: pending, in_progress, succeeded, failed, skipped, ready. | object | — |
rollback_deployment_id Deployment that rolled this one back. | string | — |
rollback_message Why the rollback happened. | string | — |
status_messages Status messages the deployment recorded. | array | — |
additional_status_info Extra detail about the current status. | string | — |
{
"additional_status_info": "",
"application_name": "",
"complete_time": 0,
"compute_platform": "",
"create_time": 0,
"creator": "",
"deployment_config_name": "",
"deployment_group_name": "",
"deployment_id": "",
"deployment_option": "",
"deployment_type": "",
"description": "",
"error_code": "",
"error_message": "",
"external_id": "",
"instance_counts": {},
"rollback_deployment_id": "",
"rollback_message": "",
"start_time": 0,
"status": "",
"status_messages": []
}See Status run in a workflow.
In a technical demo we add the AWS CodeDeploy connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.