Skip to content
Proud to collaborate with Microsoft for Startups

aws.cost_explorer.get_usage_forecast ​

Call AWS cost explorer GetUsageForecast using a CloudConnection UUID.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryBase-aws
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Authenticated organization UUID used for field resolution and connection scoping.
connection_uuiduuidYes—AWS CloudConnection UUID for the target billing account or management account.
workflow_run_idstringNo—Engine DAG run ID stamped onto child steps.
regionstringNo—AWS API endpoint region override; omit to use the connection or SDK default.
start_datestringYes—Inclusive forecast start date in YYYY-MM-DD form.
end_datestringYes—Exclusive forecast end date in YYYY-MM-DD form.
metricstringYes—Forecast metric.
granularitystringYes—DAILY or MONTHLY.
filterjsonNo—Cost Explorer Expression filter.
prediction_interval_levelintegerNo—Forecast confidence interval percentage.
billing_view_arnstringNo—Optional Billing View ARN.
provider_native_requestjsonNo—Optional provider-native request overrides for AWS parameters not yet promoted to first-class fields.

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo—Organization UUID echoed from input.
connection_uuiduuidNo—AWS CloudConnection UUID echoed from input.
regionstringNo—AWS API endpoint region used.
servicestringNo—AWS boto3 service/client name.
operationstringNo—AWS API operation invoked.
request_idstringNo—AWS request ID when available.
responsejsonNo—Sanitized provider response object.
itemslistNo—Primary response item list when the API returns a collection.
result_countintegerNo—Count of primary response items.
next_page_tokenstringNo—Pagination token for the next page.
totaljsonNo—Forecast total value.
forecast_results_by_timelistNo—Forecast results by time.
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.cost_explorer.get_usage_forecast",
  "initial_data": {
    "organization_uuid": "value",
    "connection_uuid": "value",
    "start_date": "value",
    "end_date": "value"
  }
}