sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ CloudTrail/ DescribeQuery.ts

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

/**
 * Runtime binding for `cloudtrail:DescribeQuery`.
 *
 * Reads a CloudTrail Lake query's status, statistics, and error message by
 * `QueryId` — the polling half of the start/poll/results flow. Provide the
 * implementation with `Effect.provide(AWS.CloudTrail.DescribeQueryHttp)`.
 * ### Querying CloudTrail Lake
 * **Example:** Poll a Query to Completion
 * ```typescript
 * // init — bind the operation to the event data store
 * const describeQuery = yield* AWS.CloudTrail.DescribeQuery(store);
 *
 * // runtime
 * const status = yield* describeQuery({ QueryId: queryId });
 * console.log(status.QueryStatus); // QUEUED | RUNNING | FINISHED | ...
 * ```
 *
 * @binding
 */
export interface DescribeQuery extends Binding.Service<
  DescribeQuery,
  "AWS.CloudTrail.DescribeQuery",
  (
    store: EventDataStore,
  ) => Effect.Effect<
    (
      request: Omit<cloudtrail.DescribeQueryRequest, "EventDataStore">,
    ) => Effect.Effect<cloudtrail.DescribeQueryResponse, cloudtrail.DescribeQueryError>
  >
> {}
export const DescribeQuery = Binding.Service<DescribeQuery>("AWS.CloudTrail.DescribeQuery");