sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ Backup/ DescribeRecoveryPoint.ts

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

/**
 * `DescribeRecoveryPoint` request with `BackupVaultName` injected from the
 * bound {@link BackupVault}.
 */
export interface DescribeRecoveryPointRequest extends Omit<
  backup.DescribeRecoveryPointInput,
  "BackupVaultName"
> {}

/**
 * Runtime binding for the `DescribeRecoveryPoint` operation (IAM action
 * `backup:DescribeRecoveryPoint`).
 *
 * Returns metadata for a recovery point stored in the bound
 * {@link BackupVault} — status, lifecycle, size, and restorability. Provide
 * the implementation with
 * `Effect.provide(AWS.Backup.DescribeRecoveryPointHttp)`.
 * ### Recovery Points
 * **Example:** Inspect A Recovery Point
 * ```typescript
 * const describeRecoveryPoint = yield* AWS.Backup.DescribeRecoveryPoint(vault);
 *
 * const point = yield* describeRecoveryPoint({
 *   RecoveryPointArn: recoveryPointArn,
 * });
 * yield* Effect.log(`status: ${point.Status}`);
 * ```
 *
 * @binding
 */
export interface DescribeRecoveryPoint extends Binding.Service<
  DescribeRecoveryPoint,
  "AWS.Backup.DescribeRecoveryPoint",
  (
    vault: BackupVault,
  ) => Effect.Effect<
    (
      request: DescribeRecoveryPointRequest,
    ) => Effect.Effect<backup.DescribeRecoveryPointOutput, backup.DescribeRecoveryPointError>
  >
> {}
export const DescribeRecoveryPoint = Binding.Service<DescribeRecoveryPoint>(
  "AWS.Backup.DescribeRecoveryPoint",
);