sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ CloudMap/ GetInstancesHealthStatus.ts

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

/**
 * `GetInstancesHealthStatus` request with `ServiceId` injected from the
 * bound {@link Service}.
 */
export interface GetInstancesHealthStatusRequest extends Omit<
  SD.GetInstancesHealthStatusRequest,
  "ServiceId"
> {}

/**
 * Runtime binding for `servicediscovery:GetInstancesHealthStatus` — reads
 * the current health status (`HEALTHY`, `UNHEALTHY`, or `UNKNOWN`) of the
 * bound {@link Service}'s instances. There is a brief delay between
 * registering an instance and its health status becoming available.
 * Provide the implementation with
 * `Effect.provide(AWS.CloudMap.GetInstancesHealthStatusHttp)`.
 * ### Instance Health
 * **Example:** Read Health of All Instances
 * ```typescript
 * const getInstancesHealthStatus =
 *   yield* AWS.CloudMap.GetInstancesHealthStatus(service);
 *
 * const { Status } = yield* getInstancesHealthStatus();
 * console.log(Status?.["worker-1"]); // "HEALTHY" | "UNHEALTHY" | "UNKNOWN"
 * ```
 *
 * **Example:** Read Health of Specific Instances
 * ```typescript
 * const { Status } = yield* getInstancesHealthStatus({
 *   Instances: ["worker-1", "worker-2"],
 * });
 * ```
 *
 * @binding
 */
export interface GetInstancesHealthStatus extends Binding.Service<
  GetInstancesHealthStatus,
  "AWS.CloudMap.GetInstancesHealthStatus",
  <S extends Service>(
    service: S,
  ) => Effect.Effect<
    (
      request?: GetInstancesHealthStatusRequest,
    ) => Effect.Effect<SD.GetInstancesHealthStatusResponse, SD.GetInstancesHealthStatusError>
  >
> {}
export const GetInstancesHealthStatus = Binding.Service<GetInstancesHealthStatus>(
  "AWS.CloudMap.GetInstancesHealthStatus",
);