sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ FSx/ DeleteSnapshot.ts

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

/**
 * Runtime binding for the `DeleteSnapshot` operation (IAM action
 * `fsx:DeleteSnapshot` on `*` — runtime-created snapshots have ARNs
 * unknowable at deploy time).
 *
 * Deletes an FSx for OpenZFS snapshot by id — the teardown half of a
 * runtime snapshot rotation built with {@link CreateSnapshot}. Deleting an
 * already-deleted snapshot surfaces the typed `SnapshotNotFound`. Provide
 * the implementation with `Effect.provide(AWS.FSx.DeleteSnapshotHttp)`.
 * ### Managing Snapshots at Runtime
 * **Example:** Rotate out an old snapshot
 * ```typescript
 * const deleteSnapshot = yield* AWS.FSx.DeleteSnapshot();
 *
 * yield* deleteSnapshot({ SnapshotId: old.SnapshotId! }).pipe(
 *   Effect.catchTag("SnapshotNotFound", () => Effect.void),
 * );
 * ```
 *
 * @binding
 */
export interface DeleteSnapshot extends Binding.Service<
  DeleteSnapshot,
  "AWS.FSx.DeleteSnapshot",
  () => Effect.Effect<
    (
      request: fsx.DeleteSnapshotRequest,
    ) => Effect.Effect<fsx.DeleteSnapshotResponse, fsx.DeleteSnapshotError>
  >
> {}
export const DeleteSnapshot = Binding.Service<DeleteSnapshot>("AWS.FSx.DeleteSnapshot");