sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ NeptuneGraph/ GetGraphSummary.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 `GetGraphSummary` operation (IAM action `neptune-graph:GetGraphSummary`),
 * scoped to one {@link Graph}.
 *
 * Reads the data summary of the bound graph — node/edge counts, labels, and (in `DETAILED` mode) per-label structure. Cheap way to sanity-check a load or drive dashboards without running a query. Provide the implementation with
 * `Effect.provide(AWS.NeptuneGraph.GetGraphSummaryHttp)`.
 * ### Inspecting a Graph
 * **Example:** Read node and edge counts
 * ```typescript
 * const getSummary = yield* NeptuneGraph.GetGraphSummary(graph);
 *
 * const summary = yield* getSummary({ mode: "BASIC" });
 * // summary.graphSummary?.numNodes, summary.graphSummary?.numEdges
 * ```
 *
 * @binding
 */
export interface GetGraphSummary extends Binding.Service<
  GetGraphSummary,
  "AWS.NeptuneGraph.GetGraphSummary",
  (
    graph: Graph,
  ) => Effect.Effect<
    (
      request?: Omit<neptunegraph.GetGraphSummaryInput, "graphIdentifier">,
    ) => Effect.Effect<neptunegraph.GetGraphSummaryOutput, neptunegraph.GetGraphSummaryError>
  >
> {}
export const GetGraphSummary = Binding.Service<GetGraphSummary>("AWS.NeptuneGraph.GetGraphSummary");