sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ CostExplorer/ GetReservationCoverage.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 GetReservationCoverage}.
 */
export interface GetReservationCoverageRequest extends ce.GetReservationCoverageRequest {}

/**
 * Runtime binding for `ce:GetReservationCoverage`.
 *
 * Retrieve how much of your eligible usage (EC2, RDS, ElastiCache,
 * Redshift, OpenSearch, …) was covered by reservations over a time
 * period. Provide the implementation with
 * `Effect.provide(AWS.CostExplorer.GetReservationCoverageHttp)`.
 * ### Reservations
 * **Example:** Check Reservation Coverage
 * ```typescript
 * // init — account-level binding takes no resource
 * const getReservationCoverage = yield* AWS.CostExplorer.GetReservationCoverage();
 *
 * // runtime
 * const result = yield* getReservationCoverage({
 *   TimePeriod: { Start: "2026-06-01", End: "2026-07-01" },
 * });
 * const coverage = result.Total?.CoverageHours?.CoverageHoursPercentage;
 * ```
 *
 * @binding
 */
export interface GetReservationCoverage extends Binding.Service<
  GetReservationCoverage,
  "AWS.CostExplorer.GetReservationCoverage",
  () => Effect.Effect<
    (
      request: GetReservationCoverageRequest,
    ) => Effect.Effect<ce.GetReservationCoverageResponse, ce.GetReservationCoverageError>
  >
> {}

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