sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ ObservabilityAdmin/ GetTelemetryEvaluationStatus.ts

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

/**
 * Runtime binding for `observabilityadmin:GetTelemetryEvaluationStatus` —
 * reads the account's telemetry config onboarding status (`RUNNING`,
 * `STOPPED`, `NOT_STARTED`, ...), e.g. for a compliance function that
 * verifies telemetry auditing stays enabled.
 *
 * Provide `AWS.ObservabilityAdmin.GetTelemetryEvaluationStatusHttp` on the
 * hosting Lambda Function to satisfy the requirement.
 * ### Reading Onboarding Status
 * **Example:** Verify telemetry auditing is enabled
 * ```typescript
 * // init — grants observabilityadmin:GetTelemetryEvaluationStatus
 * const getEvaluationStatus = yield* AWS.ObservabilityAdmin.GetTelemetryEvaluationStatus();
 *
 * // runtime
 * const { Status } = yield* getEvaluationStatus();
 * if (Status !== "RUNNING") {
 *   yield* Effect.logWarning("telemetry auditing is off");
 * }
 * ```
 *
 * @binding
 */
export interface GetTelemetryEvaluationStatus extends Binding.Service<
  GetTelemetryEvaluationStatus,
  "AWS.ObservabilityAdmin.GetTelemetryEvaluationStatus",
  () => Effect.Effect<
    (
      request?: obs.GetTelemetryEvaluationStatusRequest,
    ) => Effect.Effect<
      obs.GetTelemetryEvaluationStatusOutput,
      obs.GetTelemetryEvaluationStatusError
    >
  >
> {}

export const GetTelemetryEvaluationStatus = Binding.Service<GetTelemetryEvaluationStatus>(
  "AWS.ObservabilityAdmin.GetTelemetryEvaluationStatus",
);