sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ Route53Domains/ CheckDomainTransferability.ts

import type * as route53domains from "@distilled.cloud/aws/route-53-domains";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";

export interface CheckDomainTransferabilityRequest
  extends route53domains.CheckDomainTransferabilityRequest {}

/**
 * Runtime binding for `route53domains:CheckDomainTransferability` — check
 * whether a domain can be transferred to Amazon Route 53 from another
 * registrar.
 *
 * Route 53 Domains is a global registration API with no resource-level IAM:
 * the binding takes no arguments and grants the function
 * `route53domains:CheckDomainTransferability` on `*`. Calls are pinned to
 * `us-east-1`, the only region that serves the Route 53 Domains API,
 * regardless of where the function runs.
 *
 * Provide the implementation with
 * `Effect.provide(AWS.Route53Domains.CheckDomainTransferabilityHttp)`.
 *
 * ### Checking Domain Transferability
 * **Example:** Check Whether a Domain Can Be Transferred In
 * ```typescript
 * // init
 * const checkDomainTransferability =
 *   yield* AWS.Route53Domains.CheckDomainTransferability();
 *
 * // runtime
 * const result = yield* checkDomainTransferability({
 *   DomainName: "example.com",
 * });
 * if (result.Transferability?.Transferable === "TRANSFERABLE") {
 *   // domain can be transferred to Route 53
 * }
 * ```
 *
 * @binding
 */
export interface CheckDomainTransferability extends Binding.Service<
  CheckDomainTransferability,
  "AWS.Route53Domains.CheckDomainTransferability",
  () => Effect.Effect<
    (
      request: CheckDomainTransferabilityRequest,
    ) => Effect.Effect<
      route53domains.CheckDomainTransferabilityResponse,
      route53domains.CheckDomainTransferabilityError
    >
  >
> {}
export const CheckDomainTransferability = Binding.Service<CheckDomainTransferability>(
  "AWS.Route53Domains.CheckDomainTransferability",
);