sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ SecurityHub/ GetFindings.ts

import type * as securityhub from "@distilled.cloud/aws/securityhub";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";

/**
 * Runtime binding for `securityhub:GetFindings`.
 *
 * Returns findings that match the specified filter criteria. With cross-Region aggregation enabled, the home Region returns matching findings from all linked Regions.
 * Account-level operation — invoked with the caller's request as-is.
 * Provide the implementation with
 * `Effect.provide(AWS.SecurityHub.GetFindingsHttp)`.
 * ### Working with Findings
 * **Example:** Query High-Severity Findings
 * ```typescript
 * // init — account-level binding, no resource argument
 * const getFindings = yield* AWS.SecurityHub.GetFindings();
 *
 * // runtime
 * const { Findings } = yield* getFindings({
 *   Filters: { SeverityLabel: [{ Value: "HIGH", Comparison: "EQUALS" }] },
 *   MaxResults: 25,
 * });
 * ```
 *
 * @binding
 */
export interface GetFindings extends Binding.Service<
  GetFindings,
  "AWS.SecurityHub.GetFindings",
  () => Effect.Effect<
    (
      request?: securityhub.GetFindingsRequest,
    ) => Effect.Effect<securityhub.GetFindingsResponse, securityhub.GetFindingsError>
  >
> {}
export const GetFindings = Binding.Service<GetFindings>("AWS.SecurityHub.GetFindings");