Skip to content

DescribeTopic

Source: src/AWS/Kafka/DescribeTopic.ts

Runtime binding for the DescribeTopic operation (IAM action kafka:DescribeTopic), scoped to one ServerlessCluster.

Reads a topic’s partition count, replication factor, configuration, and status through the MSK control plane. Provide the implementation with Effect.provide(AWS.Kafka.DescribeTopicHttp).

const describeTopic = yield* Kafka.DescribeTopic(cluster);
const topic = yield* describeTopic({ TopicName: "orders" });
// topic.PartitionCount, topic.Configs, topic.Status