Skip to content

DescribeServer

Source: src/AWS/Transfer/DescribeServer.ts

Runtime binding for transfer:DescribeServer.

Reads the bound Server’s live configuration and state — the ServerId is injected from the binding. Useful for checking whether the server is ONLINE/OFFLINE before a StartServer/StopServer call or surfacing endpoint details to an admin portal. Provide the implementation with Effect.provide(AWS.Transfer.DescribeServerHttp).

// init — bind the operation to the server
const describeServer = yield* AWS.Transfer.DescribeServer(server);
// runtime
const { Server } = yield* describeServer();
yield* Effect.log(`server is ${Server.State}`);