Skip to content

DescribeBroker

Source: src/AWS/MQ/DescribeBroker.ts

Runtime binding for the DescribeBroker operation (IAM action mq:DescribeBroker), scoped to one Broker.

Resolves the broker’s live state at runtime — engine version, instance endpoints (the wire-protocol URIs clients connect to), pending changes, and maintenance information. Provide the implementation with Effect.provide(AWS.MQ.DescribeBrokerHttp).

const describeBroker = yield* MQ.DescribeBroker(broker);
const info = yield* describeBroker();
// info.BrokerState → "RUNNING"
// info.BrokerInstances?.[0]?.Endpoints → ["ssl://b-….mq.us-west-2.amazonaws.com:61617", …]