aws.budgets.describe_budget_action ​
Call AWS budgets DescribeBudgetAction using a CloudConnection UUID.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | Base-aws |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | Authenticated organization UUID used for field resolution and connection scoping. |
connection_uuid | uuid | Yes | — | AWS CloudConnection UUID for the target billing account or management account. |
workflow_run_id | string | No | — | Engine DAG run ID stamped onto child steps. |
region | string | No | — | AWS API endpoint region override; omit to use the connection or SDK default. |
account_id | string | No | — | AWS account ID for AWS Budgets APIs; omitted values are derived at runtime with sts.get_caller_identity. |
budget_name | string | Yes | — | Budget name. |
action_id | string | Yes | — | Budget action ID. |
notification_type | string | No | — | Budget action notification type. |
action_type | string | No | — | Budget action type. |
action_threshold | json | No | — | Budget action threshold object. |
definition | json | No | — | Budget action definition object. |
execution_role_arn | string | No | — | IAM role ARN used to execute the action. |
approval_model | string | No | — | Budget action approval model. |
subscribers | list | No | — | Budget action subscriber list. |
action | json | No | — | Deprecated convenience AWS Budgets action object. |
execution_type | string | No | — | Budget action execution type. |
resource_tags | list | No | — | Resource tags to attach to the budget action. |
max_results | integer | No | — | Maximum results to return. |
next_token | string | No | — | Pagination token from a previous response. |
provider_native_request | json | No | — | Optional provider-native request overrides for AWS parameters not yet promoted to first-class fields. |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | No | — | Organization UUID echoed from input. |
connection_uuid | uuid | No | — | AWS CloudConnection UUID echoed from input. |
region | string | No | — | AWS API endpoint region used. |
service | string | No | — | AWS boto3 service/client name. |
operation | string | No | — | AWS API operation invoked. |
request_id | string | No | — | AWS request ID when available. |
response | json | No | — | Sanitized provider response object. |
items | list | No | — | Primary response item list when the API returns a collection. |
result_count | integer | No | — | Count of primary response items. |
next_page_token | string | No | — | Pagination token for the next page. |
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 ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "aws.budgets.describe_budget_action",
"initial_data": {
"organization_uuid": "value",
"connection_uuid": "value",
"budget_name": "value",
"action_id": "value"
}
}