sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ ControlTower/ ListLandingZones.ts

import type * as controltower from "@distilled.cloud/aws/controltower";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";

/**
 * Runtime binding for `controltower:ListLandingZones`.
 *
 * An account-level operation that returns the organization's landing zone
 * ARN (a landing zone is a singleton — the list has at most one entry).
 * Useful for governance functions that discover the landing zone before
 * reading its drift status. Provide the implementation with
 * `Effect.provide(AWS.ControlTower.ListLandingZonesHttp)`.
 * ### Inspecting the Landing Zone
 * **Example:** Discover the Landing Zone ARN
 * ```typescript
 * // init — account-level binding takes no resource
 * const listLandingZones = yield* AWS.ControlTower.ListLandingZones();
 *
 * // runtime
 * const result = yield* listLandingZones();
 * const arn = result.landingZones[0]?.arn;
 * ```
 *
 * @binding
 */
export interface ListLandingZones extends Binding.Service<
  ListLandingZones,
  "AWS.ControlTower.ListLandingZones",
  () => Effect.Effect<
    (
      request?: controltower.ListLandingZonesInput,
    ) => Effect.Effect<controltower.ListLandingZonesOutput, controltower.ListLandingZonesError>
  >
> {}

export const ListLandingZones = Binding.Service<ListLandingZones>(
  "AWS.ControlTower.ListLandingZones",
);