sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ Athena/ StopQueryExecution.ts

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

/**
 * Runtime binding for `athena:StopQueryExecution`.
 *
 * Cancels a running query in the bound workgroup. Stopping an already
 * finished query is a no-op, so the call is safely idempotent. Provide the
 * implementation with `Effect.provide(AWS.Athena.StopQueryExecutionHttp)`.
 * ### Cancelling Queries
 * **Example:** Cancel a Runaway Query
 * ```typescript
 * // init — bind the operation to the workgroup
 * const stopQueryExecution = yield* AWS.Athena.StopQueryExecution(workGroup);
 *
 * // runtime
 * yield* stopQueryExecution({ QueryExecutionId: id });
 * ```
 *
 * @binding
 */
export interface StopQueryExecution extends Binding.Service<
  StopQueryExecution,
  "AWS.Athena.StopQueryExecution",
  (
    workGroup: WorkGroup,
  ) => Effect.Effect<
    (
      request: athena.StopQueryExecutionInput,
    ) => Effect.Effect<athena.StopQueryExecutionOutput, athena.StopQueryExecutionError>
  >
> {}

export const StopQueryExecution = Binding.Service<StopQueryExecution>(
  "AWS.Athena.StopQueryExecution",
);