sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ GuardDuty/ GetFindingsStatistics.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:GetFindingsStatistics`.
 *
 * Aggregates the detector's findings into statistics (grouped by severity, account, resource, or finding type) for dashboards and alert thresholds.
 * The detector id is injected from the bound {@link Detector}.
 * Provide the implementation with
 * `Effect.provide(AWS.GuardDuty.GetFindingsStatisticsHttp)`.
 * ### Working with Findings
 * **Example:** Count Findings by Severity
 * ```typescript
 * // init
 * const getFindingsStatistics = yield* AWS.GuardDuty.GetFindingsStatistics(detector);
 *
 * // runtime
 * const { FindingStatistics } = yield* getFindingsStatistics({
 *   GroupBy: "SEVERITY",
 * });
 * ```
 *
 * @binding
 */
export interface GetFindingsStatistics extends Binding.Service<
  GetFindingsStatistics,
  "AWS.GuardDuty.GetFindingsStatistics",
  (
    detector: Detector,
  ) => Effect.Effect<
    (
      request?: Omit<guardduty.GetFindingsStatisticsRequest, "DetectorId">,
    ) => Effect.Effect<
      guardduty.GetFindingsStatisticsResponse,
      guardduty.GetFindingsStatisticsError
    >
  >
> {}
export const GetFindingsStatistics = Binding.Service<GetFindingsStatistics>(
  "AWS.GuardDuty.GetFindingsStatistics",
);