sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ Grafana/ DescribeWorkspaceConfiguration.ts

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

/**
 * Runtime binding for the `DescribeWorkspaceConfiguration` operation (IAM
 * action `grafana:DescribeWorkspaceConfiguration`), scoped to one
 * {@link Workspace}.
 *
 * Reads the workspace's Grafana configuration JSON string (e.g. the
 * `unifiedAlerting` feature toggle) and the running Grafana version. Provide
 * the implementation with
 * `Effect.provide(AWS.Grafana.DescribeWorkspaceConfigurationHttp)`.
 * ### Managing Configuration
 * **Example:** Read the Configuration JSON
 * ```typescript
 * const describeConfig = yield* Grafana.DescribeWorkspaceConfiguration(workspace);
 *
 * const { configuration, grafanaVersion } = yield* describeConfig();
 * const parsed = JSON.parse(configuration);
 * ```
 *
 * @binding
 */
export interface DescribeWorkspaceConfiguration extends Binding.Service<
  DescribeWorkspaceConfiguration,
  "AWS.Grafana.DescribeWorkspaceConfiguration",
  (
    workspace: Workspace,
  ) => Effect.Effect<
    () => Effect.Effect<
      grafana.DescribeWorkspaceConfigurationResponse,
      grafana.DescribeWorkspaceConfigurationError
    >
  >
> {}
export const DescribeWorkspaceConfiguration = Binding.Service<DescribeWorkspaceConfiguration>(
  "AWS.Grafana.DescribeWorkspaceConfiguration",
);