Skip to content

GetInstancesHealthStatus

Source: src/AWS/CloudMap/GetInstancesHealthStatus.ts

Runtime binding for servicediscovery:GetInstancesHealthStatus — reads the current health status (HEALTHY, UNHEALTHY, or UNKNOWN) of the bound 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).

Read Health of All Instances

const getInstancesHealthStatus =
yield* AWS.CloudMap.GetInstancesHealthStatus(service);
const { Status } = yield* getInstancesHealthStatus();
console.log(Status?.["worker-1"]); // "HEALTHY" | "UNHEALTHY" | "UNKNOWN"

Read Health of Specific Instances

const { Status } = yield* getInstancesHealthStatus({
Instances: ["worker-1", "worker-2"],
});