sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ Kafka/ DescribeTopicPartitions.ts

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

/**
 * Runtime binding for the `DescribeTopicPartitions` operation (IAM action
 * `kafka:DescribeTopicPartitions`), scoped to one {@link ServerlessCluster}.
 *
 * Reads per-partition detail (leader, replicas, ISR) for a topic through the
 * MSK control plane. Pass `NextToken` from the previous page to paginate.
 * Provide the implementation with
 * `Effect.provide(AWS.Kafka.DescribeTopicPartitionsHttp)`.
 * ### Managing Topics
 * **Example:** Read a Topic's Partitions
 * ```typescript
 * const describeTopicPartitions = yield* Kafka.DescribeTopicPartitions(cluster);
 *
 * const page = yield* describeTopicPartitions({ TopicName: "orders" });
 * // page.Partitions → [{ Partition: 0, Leader: …, Isr: […] }, …]
 * ```
 *
 * @binding
 */
export interface DescribeTopicPartitions extends Binding.Service<
  DescribeTopicPartitions,
  "AWS.Kafka.DescribeTopicPartitions",
  (
    cluster: ServerlessCluster,
  ) => Effect.Effect<
    (
      request: Omit<kafka.DescribeTopicPartitionsRequest, "ClusterArn">,
    ) => Effect.Effect<kafka.DescribeTopicPartitionsResponse, kafka.DescribeTopicPartitionsError>
  >
> {}
export const DescribeTopicPartitions = Binding.Service<DescribeTopicPartitions>(
  "AWS.Kafka.DescribeTopicPartitions",
);