feat(client-kafka): Amazon MSK adds three new APIs, ListTopics, DescribeTopic, and DescribeTopicPartitions for viewing Kafka topics in your MSK clusters.

Author: awstools

clients/client-kafka/README.md

@@ -354,6 +354,22 @@ DescribeReplicator
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/kafka/command/DescribeReplicatorCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kafka/Interface/DescribeReplicatorCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kafka/Interface/DescribeReplicatorCommandOutput/)
 
+</details>
+<details>
+<summary>
+DescribeTopic
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/kafka/command/DescribeTopicCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kafka/Interface/DescribeTopicCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kafka/Interface/DescribeTopicCommandOutput/)
+
+</details>
+<details>
+<summary>
+DescribeTopicPartitions
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/kafka/command/DescribeTopicPartitionsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kafka/Interface/DescribeTopicPartitionsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kafka/Interface/DescribeTopicPartitionsCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -482,6 +498,14 @@ ListTagsForResource
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/kafka/command/ListTagsForResourceCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kafka/Interface/ListTagsForResourceCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kafka/Interface/ListTagsForResourceCommandOutput/)
 
+</details>
+<details>
+<summary>
+ListTopics
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/kafka/command/ListTopicsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kafka/Interface/ListTopicsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kafka/Interface/ListTopicsCommandOutput/)
+
 </details>
 <details>
 <summary>

clients/client-kafka/src/Kafka.ts

@@ -97,6 +97,16 @@ import {
   DescribeReplicatorCommandInput,
   DescribeReplicatorCommandOutput,
 } from "./commands/DescribeReplicatorCommand";
+import {
+  DescribeTopicCommand,
+  DescribeTopicCommandInput,
+  DescribeTopicCommandOutput,
+} from "./commands/DescribeTopicCommand";
+import {
+  DescribeTopicPartitionsCommand,
+  DescribeTopicPartitionsCommandInput,
+  DescribeTopicPartitionsCommandOutput,
+} from "./commands/DescribeTopicPartitionsCommand";
 import {
   DescribeVpcConnectionCommand,
   DescribeVpcConnectionCommandInput,
@@ -173,6 +183,7 @@ import {
   ListTagsForResourceCommandInput,
   ListTagsForResourceCommandOutput,
 } from "./commands/ListTagsForResourceCommand";
+import { ListTopicsCommand, ListTopicsCommandInput, ListTopicsCommandOutput } from "./commands/ListTopicsCommand";
 import {
   ListVpcConnectionsCommand,
   ListVpcConnectionsCommandInput,
@@ -281,6 +292,8 @@ const commands = {
   DescribeConfigurationCommand,
   DescribeConfigurationRevisionCommand,
   DescribeReplicatorCommand,
+  DescribeTopicCommand,
+  DescribeTopicPartitionsCommand,
   DescribeVpcConnectionCommand,
   GetBootstrapBrokersCommand,
   GetClusterPolicyCommand,
@@ -297,6 +310,7 @@ const commands = {
   ListReplicatorsCommand,
   ListScramSecretsCommand,
   ListTagsForResourceCommand,
+  ListTopicsCommand,
   ListVpcConnectionsCommand,
   PutClusterPolicyCommand,
   RebootBrokerCommand,
@@ -623,6 +637,34 @@ export interface Kafka {
     cb: (err: any, data?: DescribeReplicatorCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link DescribeTopicCommand}
+   */
+  describeTopic(args: DescribeTopicCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTopicCommandOutput>;
+  describeTopic(args: DescribeTopicCommandInput, cb: (err: any, data?: DescribeTopicCommandOutput) => void): void;
+  describeTopic(
+    args: DescribeTopicCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: DescribeTopicCommandOutput) => void
+  ): void;
+
+  /**
+   * @see {@link DescribeTopicPartitionsCommand}
+   */
+  describeTopicPartitions(
+    args: DescribeTopicPartitionsCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<DescribeTopicPartitionsCommandOutput>;
+  describeTopicPartitions(
+    args: DescribeTopicPartitionsCommandInput,
+    cb: (err: any, data?: DescribeTopicPartitionsCommandOutput) => void
+  ): void;
+  describeTopicPartitions(
+    args: DescribeTopicPartitionsCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: DescribeTopicPartitionsCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link DescribeVpcConnectionCommand}
    */
@@ -883,6 +925,17 @@ export interface Kafka {
     cb: (err: any, data?: ListTagsForResourceCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link ListTopicsCommand}
+   */
+  listTopics(args: ListTopicsCommandInput, options?: __HttpHandlerOptions): Promise<ListTopicsCommandOutput>;
+  listTopics(args: ListTopicsCommandInput, cb: (err: any, data?: ListTopicsCommandOutput) => void): void;
+  listTopics(
+    args: ListTopicsCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: ListTopicsCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link ListVpcConnectionsCommand}
    */

clients/client-kafka/src/KafkaClient.ts

@@ -109,6 +109,11 @@ import {
   DescribeConfigurationRevisionCommandOutput,
 } from "./commands/DescribeConfigurationRevisionCommand";
 import { DescribeReplicatorCommandInput, DescribeReplicatorCommandOutput } from "./commands/DescribeReplicatorCommand";
+import { DescribeTopicCommandInput, DescribeTopicCommandOutput } from "./commands/DescribeTopicCommand";
+import {
+  DescribeTopicPartitionsCommandInput,
+  DescribeTopicPartitionsCommandOutput,
+} from "./commands/DescribeTopicPartitionsCommand";
 import {
   DescribeVpcConnectionCommandInput,
   DescribeVpcConnectionCommandOutput,
@@ -149,6 +154,7 @@ import {
   ListTagsForResourceCommandInput,
   ListTagsForResourceCommandOutput,
 } from "./commands/ListTagsForResourceCommand";
+import { ListTopicsCommandInput, ListTopicsCommandOutput } from "./commands/ListTopicsCommand";
 import { ListVpcConnectionsCommandInput, ListVpcConnectionsCommandOutput } from "./commands/ListVpcConnectionsCommand";
 import { PutClusterPolicyCommandInput, PutClusterPolicyCommandOutput } from "./commands/PutClusterPolicyCommand";
 import { RebootBrokerCommandInput, RebootBrokerCommandOutput } from "./commands/RebootBrokerCommand";
@@ -219,6 +225,8 @@ export type ServiceInputTypes =
   | DescribeConfigurationCommandInput
   | DescribeConfigurationRevisionCommandInput
   | DescribeReplicatorCommandInput
+  | DescribeTopicCommandInput
+  | DescribeTopicPartitionsCommandInput
   | DescribeVpcConnectionCommandInput
   | GetBootstrapBrokersCommandInput
   | GetClusterPolicyCommandInput
@@ -235,6 +243,7 @@ export type ServiceInputTypes =
   | ListReplicatorsCommandInput
   | ListScramSecretsCommandInput
   | ListTagsForResourceCommandInput
+  | ListTopicsCommandInput
   | ListVpcConnectionsCommandInput
   | PutClusterPolicyCommandInput
   | RebootBrokerCommandInput
@@ -277,6 +286,8 @@ export type ServiceOutputTypes =
   | DescribeConfigurationCommandOutput
   | DescribeConfigurationRevisionCommandOutput
   | DescribeReplicatorCommandOutput
+  | DescribeTopicCommandOutput
+  | DescribeTopicPartitionsCommandOutput
   | DescribeVpcConnectionCommandOutput
   | GetBootstrapBrokersCommandOutput
   | GetClusterPolicyCommandOutput
@@ -293,6 +304,7 @@ export type ServiceOutputTypes =
   | ListReplicatorsCommandOutput
   | ListScramSecretsCommandOutput
   | ListTagsForResourceCommandOutput
+  | ListTopicsCommandOutput
   | ListVpcConnectionsCommandOutput
   | PutClusterPolicyCommandOutput
   | RebootBrokerCommandOutput

clients/client-kafka/src/commands/DescribeTopicCommand.ts

@@ -0,0 +1,110 @@
+// smithy-typescript generated code
+import { getEndpointPlugin } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+
+import { commonParams } from "../endpoint/EndpointParameters";
+import { KafkaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KafkaClient";
+import { DescribeTopicRequest, DescribeTopicResponse } from "../models/models_0";
+import { DescribeTopic } from "../schemas/schemas_0";
+
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link DescribeTopicCommand}.
+ */
+export interface DescribeTopicCommandInput extends DescribeTopicRequest {}
+/**
+ * @public
+ *
+ * The output of {@link DescribeTopicCommand}.
+ */
+export interface DescribeTopicCommandOutput extends DescribeTopicResponse, __MetadataBearer {}
+
+/**
+ * <p>Returns topic details of this topic on a MSK cluster.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { KafkaClient, DescribeTopicCommand } from "@aws-sdk/client-kafka"; // ES Modules import
+ * // const { KafkaClient, DescribeTopicCommand } = require("@aws-sdk/client-kafka"); // CommonJS import
+ * // import type { KafkaClientConfig } from "@aws-sdk/client-kafka";
+ * const config = {}; // type is KafkaClientConfig
+ * const client = new KafkaClient(config);
+ * const input = { // DescribeTopicRequest
+ *   ClusterArn: "STRING_VALUE", // required
+ *   TopicName: "STRING_VALUE", // required
+ * };
+ * const command = new DescribeTopicCommand(input);
+ * const response = await client.send(command);
+ * // { // DescribeTopicResponse
+ * //   TopicArn: "STRING_VALUE",
+ * //   TopicName: "STRING_VALUE",
+ * //   ReplicationFactor: Number("int"),
+ * //   PartitionCount: Number("int"),
+ * //   Configs: "STRING_VALUE",
+ * //   Status: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE",
+ * // };
+ *
+ * ```
+ *
+ * @param DescribeTopicCommandInput - {@link DescribeTopicCommandInput}
+ * @returns {@link DescribeTopicCommandOutput}
+ * @see {@link DescribeTopicCommandInput} for command's `input` shape.
+ * @see {@link DescribeTopicCommandOutput} for command's `response` shape.
+ * @see {@link KafkaClientResolvedConfig | config} for KafkaClient's `config` shape.
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>Returns information about an error.</p>
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *  <p>Returns information about an error.</p>
+ *
+ * @throws {@link InternalServerErrorException} (server fault)
+ *  <p>Returns information about an error.</p>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>Returns information about an error.</p>
+ *
+ * @throws {@link UnauthorizedException} (client fault)
+ *  <p>Returns information about an error.</p>
+ *
+ * @throws {@link KafkaServiceException}
+ * <p>Base exception class for all service exceptions from Kafka service.</p>
+ *
+ *
+ * @public
+ */
+export class DescribeTopicCommand extends $Command
+  .classBuilder<
+    DescribeTopicCommandInput,
+    DescribeTopicCommandOutput,
+    KafkaClientResolvedConfig,
+    ServiceInputTypes,
+    ServiceOutputTypes
+  >()
+  .ep(commonParams)
+  .m(function (this: any, Command: any, cs: any, config: KafkaClientResolvedConfig, o: any) {
+    return [getEndpointPlugin(config, Command.getEndpointParameterInstructions())];
+  })
+  .s("Kafka", "DescribeTopic", {})
+  .n("KafkaClient", "DescribeTopicCommand")
+  .sc(DescribeTopic)
+  .build() {
+  /** @internal type navigation helper, not in runtime. */
+  protected declare static __types: {
+    api: {
+      input: DescribeTopicRequest;
+      output: DescribeTopicResponse;
+    };
+    sdk: {
+      input: DescribeTopicCommandInput;
+      output: DescribeTopicCommandOutput;
+    };
+  };
+}