sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ GuardDuty/ ListFindings.ts

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

/**
 * Runtime binding for `guardduty:ListFindings`.
 *
 * Lists finding ids for the detector, with optional finding criteria and sort order — the entry point for a findings-triage automation.
 * The detector id is injected from the bound {@link Detector}.
 * Provide the implementation with
 * `Effect.provide(AWS.GuardDuty.ListFindingsHttp)`.
 * ### Working with Findings
 * **Example:** List Current Finding Ids
 * ```typescript
 * // init
 * const listFindings = yield* AWS.GuardDuty.ListFindings(detector);
 *
 * // runtime
 * const { FindingIds } = yield* listFindings();
 * ```
 *
 * @binding
 */
export interface ListFindings extends Binding.Service<
  ListFindings,
  "AWS.GuardDuty.ListFindings",
  (
    detector: Detector,
  ) => Effect.Effect<
    (
      request?: Omit<guardduty.ListFindingsRequest, "DetectorId">,
    ) => Effect.Effect<guardduty.ListFindingsResponse, guardduty.ListFindingsError>
  >
> {}
export const ListFindings = Binding.Service<ListFindings>("AWS.GuardDuty.ListFindings");