sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ Signer/ RevokeSigningProfile.ts

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

/**
 * Runtime binding for `signer:RevokeSigningProfile`.
 *
 * Revokes a version of the bound {@link SigningProfile}, permanently
 * invalidating every signature that version produced on or after
 * `effectiveTime` — the incident-response lever when signing material is
 * compromised. Revocation is irreversible. The profile name is injected from
 * the binding; pass the `profileVersion` to revoke. Provide the
 * implementation with `Effect.provide(AWS.Signer.RevokeSigningProfileHttp)`.
 * ### Revoking Signatures
 * **Example:** Revoke a Compromised Profile Version
 * ```typescript
 * // init — bind the operation to the profile
 * const revokeSigningProfile = yield* AWS.Signer.RevokeSigningProfile(profile);
 *
 * // runtime — invalidate everything the version signed from now on
 * yield* revokeSigningProfile({
 *   profileVersion,
 *   reason: "signing key compromised",
 *   effectiveTime: new Date(),
 * });
 * ```
 *
 * @binding
 */
export interface RevokeSigningProfile extends Binding.Service<
  RevokeSigningProfile,
  "AWS.Signer.RevokeSigningProfile",
  (
    profile: SigningProfile,
  ) => Effect.Effect<
    (
      request: Omit<signer.RevokeSigningProfileRequest, "profileName">,
    ) => Effect.Effect<signer.RevokeSigningProfileResponse, signer.RevokeSigningProfileError>
  >
> {}
export const RevokeSigningProfile = Binding.Service<RevokeSigningProfile>(
  "AWS.Signer.RevokeSigningProfile",
);