sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ CostExplorer/ GetCostForecast.ts

import type * as ce from "@distilled.cloud/aws/cost-explorer";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";

/**
 * Request for {@link GetCostForecast}.
 */
export interface GetCostForecastRequest extends ce.GetCostForecastRequest {}

/**
 * Runtime binding for `ce:GetCostForecast`.
 *
 * Forecast how much AWS predicts you will spend over a future time
 * period, with an optional prediction interval. Provide the implementation with
 * `Effect.provide(AWS.CostExplorer.GetCostForecastHttp)`.
 * ### Forecasting
 * **Example:** Forecast Next Month's Spend
 * ```typescript
 * // init — account-level binding takes no resource
 * const getCostForecast = yield* AWS.CostExplorer.GetCostForecast();
 *
 * // runtime
 * const result = yield* getCostForecast({
 *   TimePeriod: { Start: "2026-08-01", End: "2026-09-01" },
 *   Metric: "UNBLENDED_COST",
 *   Granularity: "MONTHLY",
 * });
 * const forecast = result.Total?.Amount;
 * ```
 *
 * @binding
 */
export interface GetCostForecast extends Binding.Service<
  GetCostForecast,
  "AWS.CostExplorer.GetCostForecast",
  () => Effect.Effect<
    (
      request: GetCostForecastRequest,
    ) => Effect.Effect<ce.GetCostForecastResponse, ce.GetCostForecastError>
  >
> {}

export const GetCostForecast = Binding.Service<GetCostForecast>("AWS.CostExplorer.GetCostForecast");