sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ Glacier/ DeleteArchive.ts

import type * as glacier from "@distilled.cloud/aws/glacier";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";
import type { Vault } from "./Vault.ts";

/**
 * `DeleteArchive` request with `accountId` and `vaultName` injected from the bound
 * {@link Vault}.
 */
export interface DeleteArchiveRequest extends Omit<
  glacier.DeleteArchiveInput,
  "accountId" | "vaultName"
> {}

/**
 * Runtime binding for the `DeleteArchive` operation (IAM action
 * `glacier:DeleteArchive` on the vault ARN).
 *
 * Deletes an archive from the bound {@link Vault}. The operation is
 * idempotent — deleting an already-deleted archive is not an error.
 * Provide the implementation with
 * `Effect.provide(AWS.Glacier.DeleteArchiveHttp)`.
 * ### Deleting Archives
 * **Example:** Delete an archive by ID
 * ```typescript
 * const deleteArchive = yield* AWS.Glacier.DeleteArchive(vault);
 *
 * yield* deleteArchive({ archiveId });
 * ```
 *
 * @binding
 */
export interface DeleteArchive extends Binding.Service<
  DeleteArchive,
  "AWS.Glacier.DeleteArchive",
  (
    vault: Vault,
  ) => Effect.Effect<
    (
      request: DeleteArchiveRequest,
    ) => Effect.Effect<glacier.DeleteArchiveResponse, glacier.DeleteArchiveError>
  >
> {}
export const DeleteArchive = Binding.Service<DeleteArchive>("AWS.Glacier.DeleteArchive");