sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ Config/ StartConfigRulesEvaluation.ts

import type * as config from "@distilled.cloud/aws/config-service";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";
import type { ConfigRule } from "./ConfigRule.ts";

/**
 * Runtime binding for `config:StartConfigRulesEvaluation` — run an
 * on-demand evaluation of the bound {@link ConfigRule} against the last
 * known configuration state of your resources; the rule name is injected
 * automatically.
 *
 * Provide `Config.StartConfigRulesEvaluationHttp` on the hosting Lambda
 * Function to satisfy the requirement.
 * ### Rule Evaluation Status
 * **Example:** Re-Evaluate a Rule On Demand
 * ```typescript
 * // init — grants config:StartConfigRulesEvaluation
 * const startRulesEvaluation =
 *   yield* AWS.Config.StartConfigRulesEvaluation(rule);
 *
 * // runtime
 * yield* startRulesEvaluation();
 * ```
 *
 * @binding
 */
export interface StartConfigRulesEvaluation extends Binding.Service<
  StartConfigRulesEvaluation,
  "AWS.Config.StartConfigRulesEvaluation",
  (
    rule: ConfigRule,
  ) => Effect.Effect<
    () => Effect.Effect<
      config.StartConfigRulesEvaluationResponse,
      config.StartConfigRulesEvaluationError
    >
  >
> {}

export const StartConfigRulesEvaluation = Binding.Service<StartConfigRulesEvaluation>(
  "AWS.Config.StartConfigRulesEvaluation",
);