sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ NeptuneGraph/ CreateGraphSnapshot.ts

import type * as neptunegraph from "@distilled.cloud/aws/neptune-graph";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";
import type { Graph } from "./Graph.ts";

/**
 * Runtime binding for the `CreateGraphSnapshot` operation (IAM actions `neptune-graph:CreateGraphSnapshot` + `neptune-graph:TagResource`),
 * scoped to one {@link Graph}.
 *
 * Takes an on-demand snapshot of the bound graph — e.g. a pre-import backup from an operational Lambda. Snapshot creation is asynchronous; poll it with {@link GetGraphSnapshot}. Provide the implementation with
 * `Effect.provide(AWS.NeptuneGraph.CreateGraphSnapshotHttp)`.
 * ### Managing Snapshots
 * **Example:** Take an on-demand snapshot
 * ```typescript
 * const createSnapshot = yield* NeptuneGraph.CreateGraphSnapshot(graph);
 *
 * const snapshot = yield* createSnapshot({ snapshotName: "pre-import" });
 * // snapshot.status → "CREATING"
 * ```
 *
 * @binding
 */
export interface CreateGraphSnapshot extends Binding.Service<
  CreateGraphSnapshot,
  "AWS.NeptuneGraph.CreateGraphSnapshot",
  (
    graph: Graph,
  ) => Effect.Effect<
    (
      request: Omit<neptunegraph.CreateGraphSnapshotInput, "graphIdentifier">,
    ) => Effect.Effect<
      neptunegraph.CreateGraphSnapshotOutput,
      neptunegraph.CreateGraphSnapshotError
    >
  >
> {}
export const CreateGraphSnapshot = Binding.Service<CreateGraphSnapshot>(
  "AWS.NeptuneGraph.CreateGraphSnapshot",
);