sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ AccessAnalyzer/ CreateAccessPreview.ts

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

/** `CreateAccessPreview` request with `analyzerArn` injected from the bound {@link Analyzer}. */
export interface CreateAccessPreviewRequest extends Omit<
  aa.CreateAccessPreviewRequest,
  "analyzerArn"
> {}

/**
 * Runtime binding for `access-analyzer:CreateAccessPreview`.
 *
 * Previews the findings a proposed resource policy would generate, before
 * deploying the policy. Provide the implementation with
 * `Effect.provide(AWS.AccessAnalyzer.CreateAccessPreviewHttp)`.
 * ### Access Previews
 * **Example:** Preview a Proposed Bucket Policy
 * ```typescript
 * const createPreview =
 *   yield* AWS.AccessAnalyzer.CreateAccessPreview(analyzer);
 * const preview = yield* createPreview({
 *   configurations: {
 *     [bucketArn]: { s3Bucket: { bucketPolicy: proposedPolicy } },
 *   },
 * });
 * ```
 *
 * @binding
 */
export interface CreateAccessPreview extends Binding.Service<
  CreateAccessPreview,
  "AWS.AccessAnalyzer.CreateAccessPreview",
  (
    analyzer: Analyzer,
  ) => Effect.Effect<
    (
      request: CreateAccessPreviewRequest,
    ) => Effect.Effect<aa.CreateAccessPreviewResponse, aa.CreateAccessPreviewError>
  >
> {}

export const CreateAccessPreview = Binding.Service<CreateAccessPreview>(
  "AWS.AccessAnalyzer.CreateAccessPreview",
);