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

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

/**
 * Runtime binding for `config:GetResourceEvaluationSummary` — read the
 * status and compliance verdict of a proactive resource evaluation started
 * with `StartResourceEvaluation`.
 *
 * Provide `Config.GetResourceEvaluationSummaryHttp` on the hosting Lambda Function to
 * satisfy the requirement.
 * ### Proactive Resource Evaluation
 * **Example:** Read an Evaluation's Summary
 * ```typescript
 * // init — grants config:GetResourceEvaluationSummary
 * const getResourceEvaluationSummary = yield* AWS.Config.GetResourceEvaluationSummary();
 *
 * // runtime
 * const result = yield* getResourceEvaluationSummary({
 *   ResourceEvaluationId: evaluationId,
 * });
 * console.log(result.EvaluationStatus?.Status, result.Compliance);
 * ```
 *
 * @binding
 */
export interface GetResourceEvaluationSummary extends Binding.Service<
  GetResourceEvaluationSummary,
  "AWS.Config.GetResourceEvaluationSummary",
  () => Effect.Effect<
    (
      request: config.GetResourceEvaluationSummaryRequest,
    ) => Effect.Effect<
      config.GetResourceEvaluationSummaryResponse,
      config.GetResourceEvaluationSummaryError
    >
  >
> {}

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