sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ RDS/ DescribeDBClusterSnapshots.ts

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

/**
 * Runtime binding for the `DescribeDBClusterSnapshots` operation (IAM action
 * `rds:DescribeDBClusterSnapshots`).
 *
 * Lists the account's Aurora cluster snapshots — the discovery half of a
 * snapshot-rotation or verification function. Provide the implementation with
 * `Effect.provide(AWS.RDS.DescribeDBClusterSnapshotsHttp)`.
 * ### Managing Cluster Snapshots
 * **Example:** List a Cluster's Manual Snapshots
 * ```typescript
 * const describeDBClusterSnapshots =
 *   yield* AWS.RDS.DescribeDBClusterSnapshots();
 *
 * const page = yield* describeDBClusterSnapshots({
 *   DBClusterIdentifier: clusterId,
 *   SnapshotType: "manual",
 * });
 * ```
 *
 * @binding
 */
export interface DescribeDBClusterSnapshots extends Binding.Service<
  DescribeDBClusterSnapshots,
  "AWS.RDS.DescribeDBClusterSnapshots",
  () => Effect.Effect<
    (
      request?: rds.DescribeDBClusterSnapshotsMessage,
    ) => Effect.Effect<rds.DBClusterSnapshotMessage, rds.DescribeDBClusterSnapshotsError>
  >
> {}
export const DescribeDBClusterSnapshots = Binding.Service<DescribeDBClusterSnapshots>(
  "AWS.RDS.DescribeDBClusterSnapshots",
);