sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ ControlTower/ GetLandingZoneOperation.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:GetLandingZoneOperation`.
 *
 * An account-level operation that reads the status of an asynchronous
 * landing zone operation (`CREATE`, `UPDATE`, `DELETE`, `RESET`). Pair it
 * with {@link ResetLandingZone} to poll a drift-remediation run to
 * completion. Provide the implementation with
 * `Effect.provide(AWS.ControlTower.GetLandingZoneOperationHttp)`.
 * ### Polling Asynchronous Operations
 * **Example:** Poll a Landing Zone Operation
 * ```typescript
 * // init — account-level binding takes no resource
 * const getLandingZoneOperation =
 *   yield* AWS.ControlTower.GetLandingZoneOperation();
 *
 * // runtime
 * const { operationDetails } = yield* getLandingZoneOperation({
 *   operationIdentifier,
 * });
 * console.log(operationDetails.status);
 * ```
 *
 * @binding
 */
export interface GetLandingZoneOperation extends Binding.Service<
  GetLandingZoneOperation,
  "AWS.ControlTower.GetLandingZoneOperation",
  () => Effect.Effect<
    (
      request: controltower.GetLandingZoneOperationInput,
    ) => Effect.Effect<
      controltower.GetLandingZoneOperationOutput,
      controltower.GetLandingZoneOperationError
    >
  >
> {}

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