@aws-sdk/client-kafka 3.933.0 → 3.934.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. package/README.md +24 -0
  2. package/dist-cjs/index.js +351 -4
  3. package/dist-es/Kafka.js +6 -0
  4. package/dist-es/commands/DescribeTopicCommand.js +16 -0
  5. package/dist-es/commands/DescribeTopicPartitionsCommand.js +16 -0
  6. package/dist-es/commands/ListTopicsCommand.js +16 -0
  7. package/dist-es/commands/index.js +3 -0
  8. package/dist-es/models/models_0.js +6 -0
  9. package/dist-es/pagination/DescribeTopicPartitionsPaginator.js +4 -0
  10. package/dist-es/pagination/ListTopicsPaginator.js +4 -0
  11. package/dist-es/pagination/index.js +2 -0
  12. package/dist-es/schemas/schemas_0.js +297 -4
  13. package/dist-types/Kafka.d.ts +21 -0
  14. package/dist-types/KafkaClient.d.ts +5 -2
  15. package/dist-types/commands/DescribeTopicCommand.d.ts +95 -0
  16. package/dist-types/commands/DescribeTopicPartitionsCommand.d.ts +104 -0
  17. package/dist-types/commands/ListTopicsCommand.d.ts +101 -0
  18. package/dist-types/commands/index.d.ts +3 -0
  19. package/dist-types/models/models_0.d.ts +205 -0
  20. package/dist-types/pagination/DescribeTopicPartitionsPaginator.d.ts +7 -0
  21. package/dist-types/pagination/ListTopicsPaginator.d.ts +7 -0
  22. package/dist-types/pagination/index.d.ts +2 -0
  23. package/dist-types/schemas/schemas_0.d.ts +14 -0
  24. package/dist-types/ts3.4/Kafka.d.ts +51 -0
  25. package/dist-types/ts3.4/KafkaClient.d.ts +18 -0
  26. package/dist-types/ts3.4/commands/DescribeTopicCommand.d.ts +50 -0
  27. package/dist-types/ts3.4/commands/DescribeTopicPartitionsCommand.d.ts +51 -0
  28. package/dist-types/ts3.4/commands/ListTopicsCommand.d.ts +47 -0
  29. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  30. package/dist-types/ts3.4/models/models_0.d.ts +52 -0
  31. package/dist-types/ts3.4/pagination/DescribeTopicPartitionsPaginator.d.ts +11 -0
  32. package/dist-types/ts3.4/pagination/ListTopicsPaginator.d.ts +11 -0
  33. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  34. package/dist-types/ts3.4/schemas/schemas_0.d.ts +14 -0
  35. package/package.json +5 -5
@@ -18,6 +18,8 @@ import { DescribeClusterV2CommandInput, DescribeClusterV2CommandOutput } from ".
18
18
  import { DescribeConfigurationCommandInput, DescribeConfigurationCommandOutput } from "./commands/DescribeConfigurationCommand";
19
19
  import { DescribeConfigurationRevisionCommandInput, DescribeConfigurationRevisionCommandOutput } from "./commands/DescribeConfigurationRevisionCommand";
20
20
  import { DescribeReplicatorCommandInput, DescribeReplicatorCommandOutput } from "./commands/DescribeReplicatorCommand";
21
+ import { DescribeTopicCommandInput, DescribeTopicCommandOutput } from "./commands/DescribeTopicCommand";
22
+ import { DescribeTopicPartitionsCommandInput, DescribeTopicPartitionsCommandOutput } from "./commands/DescribeTopicPartitionsCommand";
21
23
  import { DescribeVpcConnectionCommandInput, DescribeVpcConnectionCommandOutput } from "./commands/DescribeVpcConnectionCommand";
22
24
  import { GetBootstrapBrokersCommandInput, GetBootstrapBrokersCommandOutput } from "./commands/GetBootstrapBrokersCommand";
23
25
  import { GetClusterPolicyCommandInput, GetClusterPolicyCommandOutput } from "./commands/GetClusterPolicyCommand";
@@ -34,6 +36,7 @@ import { ListNodesCommandInput, ListNodesCommandOutput } from "./commands/ListNo
34
36
  import { ListReplicatorsCommandInput, ListReplicatorsCommandOutput } from "./commands/ListReplicatorsCommand";
35
37
  import { ListScramSecretsCommandInput, ListScramSecretsCommandOutput } from "./commands/ListScramSecretsCommand";
36
38
  import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
39
+ import { ListTopicsCommandInput, ListTopicsCommandOutput } from "./commands/ListTopicsCommand";
37
40
  import { ListVpcConnectionsCommandInput, ListVpcConnectionsCommandOutput } from "./commands/ListVpcConnectionsCommand";
38
41
  import { PutClusterPolicyCommandInput, PutClusterPolicyCommandOutput } from "./commands/PutClusterPolicyCommand";
39
42
  import { RebootBrokerCommandInput, RebootBrokerCommandOutput } from "./commands/RebootBrokerCommand";
@@ -168,6 +171,18 @@ export interface Kafka {
168
171
  describeReplicator(args: DescribeReplicatorCommandInput, options?: __HttpHandlerOptions): Promise<DescribeReplicatorCommandOutput>;
169
172
  describeReplicator(args: DescribeReplicatorCommandInput, cb: (err: any, data?: DescribeReplicatorCommandOutput) => void): void;
170
173
  describeReplicator(args: DescribeReplicatorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReplicatorCommandOutput) => void): void;
174
+ /**
175
+ * @see {@link DescribeTopicCommand}
176
+ */
177
+ describeTopic(args: DescribeTopicCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTopicCommandOutput>;
178
+ describeTopic(args: DescribeTopicCommandInput, cb: (err: any, data?: DescribeTopicCommandOutput) => void): void;
179
+ describeTopic(args: DescribeTopicCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTopicCommandOutput) => void): void;
180
+ /**
181
+ * @see {@link DescribeTopicPartitionsCommand}
182
+ */
183
+ describeTopicPartitions(args: DescribeTopicPartitionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTopicPartitionsCommandOutput>;
184
+ describeTopicPartitions(args: DescribeTopicPartitionsCommandInput, cb: (err: any, data?: DescribeTopicPartitionsCommandOutput) => void): void;
185
+ describeTopicPartitions(args: DescribeTopicPartitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTopicPartitionsCommandOutput) => void): void;
171
186
  /**
172
187
  * @see {@link DescribeVpcConnectionCommand}
173
188
  */
@@ -270,6 +285,12 @@ export interface Kafka {
270
285
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
271
286
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
272
287
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
288
+ /**
289
+ * @see {@link ListTopicsCommand}
290
+ */
291
+ listTopics(args: ListTopicsCommandInput, options?: __HttpHandlerOptions): Promise<ListTopicsCommandOutput>;
292
+ listTopics(args: ListTopicsCommandInput, cb: (err: any, data?: ListTopicsCommandOutput) => void): void;
293
+ listTopics(args: ListTopicsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTopicsCommandOutput) => void): void;
273
294
  /**
274
295
  * @see {@link ListVpcConnectionsCommand}
275
296
  */
@@ -26,6 +26,8 @@ import { DescribeClusterV2CommandInput, DescribeClusterV2CommandOutput } from ".
26
26
  import { DescribeConfigurationCommandInput, DescribeConfigurationCommandOutput } from "./commands/DescribeConfigurationCommand";
27
27
  import { DescribeConfigurationRevisionCommandInput, DescribeConfigurationRevisionCommandOutput } from "./commands/DescribeConfigurationRevisionCommand";
28
28
  import { DescribeReplicatorCommandInput, DescribeReplicatorCommandOutput } from "./commands/DescribeReplicatorCommand";
29
+ import { DescribeTopicCommandInput, DescribeTopicCommandOutput } from "./commands/DescribeTopicCommand";
30
+ import { DescribeTopicPartitionsCommandInput, DescribeTopicPartitionsCommandOutput } from "./commands/DescribeTopicPartitionsCommand";
29
31
  import { DescribeVpcConnectionCommandInput, DescribeVpcConnectionCommandOutput } from "./commands/DescribeVpcConnectionCommand";
30
32
  import { GetBootstrapBrokersCommandInput, GetBootstrapBrokersCommandOutput } from "./commands/GetBootstrapBrokersCommand";
31
33
  import { GetClusterPolicyCommandInput, GetClusterPolicyCommandOutput } from "./commands/GetClusterPolicyCommand";
@@ -42,6 +44,7 @@ import { ListNodesCommandInput, ListNodesCommandOutput } from "./commands/ListNo
42
44
  import { ListReplicatorsCommandInput, ListReplicatorsCommandOutput } from "./commands/ListReplicatorsCommand";
43
45
  import { ListScramSecretsCommandInput, ListScramSecretsCommandOutput } from "./commands/ListScramSecretsCommand";
44
46
  import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
47
+ import { ListTopicsCommandInput, ListTopicsCommandOutput } from "./commands/ListTopicsCommand";
45
48
  import { ListVpcConnectionsCommandInput, ListVpcConnectionsCommandOutput } from "./commands/ListVpcConnectionsCommand";
46
49
  import { PutClusterPolicyCommandInput, PutClusterPolicyCommandOutput } from "./commands/PutClusterPolicyCommand";
47
50
  import { RebootBrokerCommandInput, RebootBrokerCommandOutput } from "./commands/RebootBrokerCommand";
@@ -66,11 +69,11 @@ export { __Client };
66
69
  /**
67
70
  * @public
68
71
  */
69
- export type ServiceInputTypes = BatchAssociateScramSecretCommandInput | BatchDisassociateScramSecretCommandInput | CreateClusterCommandInput | CreateClusterV2CommandInput | CreateConfigurationCommandInput | CreateReplicatorCommandInput | CreateVpcConnectionCommandInput | DeleteClusterCommandInput | DeleteClusterPolicyCommandInput | DeleteConfigurationCommandInput | DeleteReplicatorCommandInput | DeleteVpcConnectionCommandInput | DescribeClusterCommandInput | DescribeClusterOperationCommandInput | DescribeClusterOperationV2CommandInput | DescribeClusterV2CommandInput | DescribeConfigurationCommandInput | DescribeConfigurationRevisionCommandInput | DescribeReplicatorCommandInput | DescribeVpcConnectionCommandInput | GetBootstrapBrokersCommandInput | GetClusterPolicyCommandInput | GetCompatibleKafkaVersionsCommandInput | ListClientVpcConnectionsCommandInput | ListClusterOperationsCommandInput | ListClusterOperationsV2CommandInput | ListClustersCommandInput | ListClustersV2CommandInput | ListConfigurationRevisionsCommandInput | ListConfigurationsCommandInput | ListKafkaVersionsCommandInput | ListNodesCommandInput | ListReplicatorsCommandInput | ListScramSecretsCommandInput | ListTagsForResourceCommandInput | ListVpcConnectionsCommandInput | PutClusterPolicyCommandInput | RebootBrokerCommandInput | RejectClientVpcConnectionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateBrokerCountCommandInput | UpdateBrokerStorageCommandInput | UpdateBrokerTypeCommandInput | UpdateClusterConfigurationCommandInput | UpdateClusterKafkaVersionCommandInput | UpdateConfigurationCommandInput | UpdateConnectivityCommandInput | UpdateMonitoringCommandInput | UpdateRebalancingCommandInput | UpdateReplicationInfoCommandInput | UpdateSecurityCommandInput | UpdateStorageCommandInput;
72
+ export type ServiceInputTypes = BatchAssociateScramSecretCommandInput | BatchDisassociateScramSecretCommandInput | CreateClusterCommandInput | CreateClusterV2CommandInput | CreateConfigurationCommandInput | CreateReplicatorCommandInput | CreateVpcConnectionCommandInput | DeleteClusterCommandInput | DeleteClusterPolicyCommandInput | DeleteConfigurationCommandInput | DeleteReplicatorCommandInput | DeleteVpcConnectionCommandInput | DescribeClusterCommandInput | DescribeClusterOperationCommandInput | DescribeClusterOperationV2CommandInput | DescribeClusterV2CommandInput | DescribeConfigurationCommandInput | DescribeConfigurationRevisionCommandInput | DescribeReplicatorCommandInput | DescribeTopicCommandInput | DescribeTopicPartitionsCommandInput | DescribeVpcConnectionCommandInput | GetBootstrapBrokersCommandInput | GetClusterPolicyCommandInput | GetCompatibleKafkaVersionsCommandInput | ListClientVpcConnectionsCommandInput | ListClusterOperationsCommandInput | ListClusterOperationsV2CommandInput | ListClustersCommandInput | ListClustersV2CommandInput | ListConfigurationRevisionsCommandInput | ListConfigurationsCommandInput | ListKafkaVersionsCommandInput | ListNodesCommandInput | ListReplicatorsCommandInput | ListScramSecretsCommandInput | ListTagsForResourceCommandInput | ListTopicsCommandInput | ListVpcConnectionsCommandInput | PutClusterPolicyCommandInput | RebootBrokerCommandInput | RejectClientVpcConnectionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateBrokerCountCommandInput | UpdateBrokerStorageCommandInput | UpdateBrokerTypeCommandInput | UpdateClusterConfigurationCommandInput | UpdateClusterKafkaVersionCommandInput | UpdateConfigurationCommandInput | UpdateConnectivityCommandInput | UpdateMonitoringCommandInput | UpdateRebalancingCommandInput | UpdateReplicationInfoCommandInput | UpdateSecurityCommandInput | UpdateStorageCommandInput;
70
73
  /**
71
74
  * @public
72
75
  */
73
- export type ServiceOutputTypes = BatchAssociateScramSecretCommandOutput | BatchDisassociateScramSecretCommandOutput | CreateClusterCommandOutput | CreateClusterV2CommandOutput | CreateConfigurationCommandOutput | CreateReplicatorCommandOutput | CreateVpcConnectionCommandOutput | DeleteClusterCommandOutput | DeleteClusterPolicyCommandOutput | DeleteConfigurationCommandOutput | DeleteReplicatorCommandOutput | DeleteVpcConnectionCommandOutput | DescribeClusterCommandOutput | DescribeClusterOperationCommandOutput | DescribeClusterOperationV2CommandOutput | DescribeClusterV2CommandOutput | DescribeConfigurationCommandOutput | DescribeConfigurationRevisionCommandOutput | DescribeReplicatorCommandOutput | DescribeVpcConnectionCommandOutput | GetBootstrapBrokersCommandOutput | GetClusterPolicyCommandOutput | GetCompatibleKafkaVersionsCommandOutput | ListClientVpcConnectionsCommandOutput | ListClusterOperationsCommandOutput | ListClusterOperationsV2CommandOutput | ListClustersCommandOutput | ListClustersV2CommandOutput | ListConfigurationRevisionsCommandOutput | ListConfigurationsCommandOutput | ListKafkaVersionsCommandOutput | ListNodesCommandOutput | ListReplicatorsCommandOutput | ListScramSecretsCommandOutput | ListTagsForResourceCommandOutput | ListVpcConnectionsCommandOutput | PutClusterPolicyCommandOutput | RebootBrokerCommandOutput | RejectClientVpcConnectionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateBrokerCountCommandOutput | UpdateBrokerStorageCommandOutput | UpdateBrokerTypeCommandOutput | UpdateClusterConfigurationCommandOutput | UpdateClusterKafkaVersionCommandOutput | UpdateConfigurationCommandOutput | UpdateConnectivityCommandOutput | UpdateMonitoringCommandOutput | UpdateRebalancingCommandOutput | UpdateReplicationInfoCommandOutput | UpdateSecurityCommandOutput | UpdateStorageCommandOutput;
76
+ export type ServiceOutputTypes = BatchAssociateScramSecretCommandOutput | BatchDisassociateScramSecretCommandOutput | CreateClusterCommandOutput | CreateClusterV2CommandOutput | CreateConfigurationCommandOutput | CreateReplicatorCommandOutput | CreateVpcConnectionCommandOutput | DeleteClusterCommandOutput | DeleteClusterPolicyCommandOutput | DeleteConfigurationCommandOutput | DeleteReplicatorCommandOutput | DeleteVpcConnectionCommandOutput | DescribeClusterCommandOutput | DescribeClusterOperationCommandOutput | DescribeClusterOperationV2CommandOutput | DescribeClusterV2CommandOutput | DescribeConfigurationCommandOutput | DescribeConfigurationRevisionCommandOutput | DescribeReplicatorCommandOutput | DescribeTopicCommandOutput | DescribeTopicPartitionsCommandOutput | DescribeVpcConnectionCommandOutput | GetBootstrapBrokersCommandOutput | GetClusterPolicyCommandOutput | GetCompatibleKafkaVersionsCommandOutput | ListClientVpcConnectionsCommandOutput | ListClusterOperationsCommandOutput | ListClusterOperationsV2CommandOutput | ListClustersCommandOutput | ListClustersV2CommandOutput | ListConfigurationRevisionsCommandOutput | ListConfigurationsCommandOutput | ListKafkaVersionsCommandOutput | ListNodesCommandOutput | ListReplicatorsCommandOutput | ListScramSecretsCommandOutput | ListTagsForResourceCommandOutput | ListTopicsCommandOutput | ListVpcConnectionsCommandOutput | PutClusterPolicyCommandOutput | RebootBrokerCommandOutput | RejectClientVpcConnectionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateBrokerCountCommandOutput | UpdateBrokerStorageCommandOutput | UpdateBrokerTypeCommandOutput | UpdateClusterConfigurationCommandOutput | UpdateClusterKafkaVersionCommandOutput | UpdateConfigurationCommandOutput | UpdateConnectivityCommandOutput | UpdateMonitoringCommandOutput | UpdateRebalancingCommandOutput | UpdateReplicationInfoCommandOutput | UpdateSecurityCommandOutput | UpdateStorageCommandOutput;
74
77
  /**
75
78
  * @public
76
79
  */
@@ -0,0 +1,95 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { KafkaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KafkaClient";
4
+ import { DescribeTopicRequest, DescribeTopicResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DescribeTopicCommand}.
14
+ */
15
+ export interface DescribeTopicCommandInput extends DescribeTopicRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DescribeTopicCommand}.
21
+ */
22
+ export interface DescribeTopicCommandOutput extends DescribeTopicResponse, __MetadataBearer {
23
+ }
24
+ declare const DescribeTopicCommand_base: {
25
+ new (input: DescribeTopicCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeTopicCommandInput, DescribeTopicCommandOutput, KafkaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: DescribeTopicCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeTopicCommandInput, DescribeTopicCommandOutput, KafkaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Returns topic details of this topic on a MSK cluster.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { KafkaClient, DescribeTopicCommand } from "@aws-sdk/client-kafka"; // ES Modules import
35
+ * // const { KafkaClient, DescribeTopicCommand } = require("@aws-sdk/client-kafka"); // CommonJS import
36
+ * // import type { KafkaClientConfig } from "@aws-sdk/client-kafka";
37
+ * const config = {}; // type is KafkaClientConfig
38
+ * const client = new KafkaClient(config);
39
+ * const input = { // DescribeTopicRequest
40
+ * ClusterArn: "STRING_VALUE", // required
41
+ * TopicName: "STRING_VALUE", // required
42
+ * };
43
+ * const command = new DescribeTopicCommand(input);
44
+ * const response = await client.send(command);
45
+ * // { // DescribeTopicResponse
46
+ * // TopicArn: "STRING_VALUE",
47
+ * // TopicName: "STRING_VALUE",
48
+ * // ReplicationFactor: Number("int"),
49
+ * // PartitionCount: Number("int"),
50
+ * // Configs: "STRING_VALUE",
51
+ * // Status: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE",
52
+ * // };
53
+ *
54
+ * ```
55
+ *
56
+ * @param DescribeTopicCommandInput - {@link DescribeTopicCommandInput}
57
+ * @returns {@link DescribeTopicCommandOutput}
58
+ * @see {@link DescribeTopicCommandInput} for command's `input` shape.
59
+ * @see {@link DescribeTopicCommandOutput} for command's `response` shape.
60
+ * @see {@link KafkaClientResolvedConfig | config} for KafkaClient's `config` shape.
61
+ *
62
+ * @throws {@link BadRequestException} (client fault)
63
+ * <p>Returns information about an error.</p>
64
+ *
65
+ * @throws {@link ForbiddenException} (client fault)
66
+ * <p>Returns information about an error.</p>
67
+ *
68
+ * @throws {@link InternalServerErrorException} (server fault)
69
+ * <p>Returns information about an error.</p>
70
+ *
71
+ * @throws {@link NotFoundException} (client fault)
72
+ * <p>Returns information about an error.</p>
73
+ *
74
+ * @throws {@link UnauthorizedException} (client fault)
75
+ * <p>Returns information about an error.</p>
76
+ *
77
+ * @throws {@link KafkaServiceException}
78
+ * <p>Base exception class for all service exceptions from Kafka service.</p>
79
+ *
80
+ *
81
+ * @public
82
+ */
83
+ export declare class DescribeTopicCommand extends DescribeTopicCommand_base {
84
+ /** @internal type navigation helper, not in runtime. */
85
+ protected static __types: {
86
+ api: {
87
+ input: DescribeTopicRequest;
88
+ output: DescribeTopicResponse;
89
+ };
90
+ sdk: {
91
+ input: DescribeTopicCommandInput;
92
+ output: DescribeTopicCommandOutput;
93
+ };
94
+ };
95
+ }
@@ -0,0 +1,104 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { KafkaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KafkaClient";
4
+ import { DescribeTopicPartitionsRequest, DescribeTopicPartitionsResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DescribeTopicPartitionsCommand}.
14
+ */
15
+ export interface DescribeTopicPartitionsCommandInput extends DescribeTopicPartitionsRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DescribeTopicPartitionsCommand}.
21
+ */
22
+ export interface DescribeTopicPartitionsCommandOutput extends DescribeTopicPartitionsResponse, __MetadataBearer {
23
+ }
24
+ declare const DescribeTopicPartitionsCommand_base: {
25
+ new (input: DescribeTopicPartitionsCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeTopicPartitionsCommandInput, DescribeTopicPartitionsCommandOutput, KafkaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: DescribeTopicPartitionsCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeTopicPartitionsCommandInput, DescribeTopicPartitionsCommandOutput, KafkaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Returns partition details of this topic on a MSK cluster.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { KafkaClient, DescribeTopicPartitionsCommand } from "@aws-sdk/client-kafka"; // ES Modules import
35
+ * // const { KafkaClient, DescribeTopicPartitionsCommand } = require("@aws-sdk/client-kafka"); // CommonJS import
36
+ * // import type { KafkaClientConfig } from "@aws-sdk/client-kafka";
37
+ * const config = {}; // type is KafkaClientConfig
38
+ * const client = new KafkaClient(config);
39
+ * const input = { // DescribeTopicPartitionsRequest
40
+ * ClusterArn: "STRING_VALUE", // required
41
+ * TopicName: "STRING_VALUE", // required
42
+ * MaxResults: Number("int"),
43
+ * NextToken: "STRING_VALUE",
44
+ * };
45
+ * const command = new DescribeTopicPartitionsCommand(input);
46
+ * const response = await client.send(command);
47
+ * // { // DescribeTopicPartitionsResponse
48
+ * // Partitions: [ // __listOfTopicPartitionInfo
49
+ * // { // TopicPartitionInfo
50
+ * // Partition: Number("int"),
51
+ * // Leader: Number("int"),
52
+ * // Replicas: [ // __listOf__integer
53
+ * // Number("int"),
54
+ * // ],
55
+ * // Isr: [
56
+ * // Number("int"),
57
+ * // ],
58
+ * // },
59
+ * // ],
60
+ * // NextToken: "STRING_VALUE",
61
+ * // };
62
+ *
63
+ * ```
64
+ *
65
+ * @param DescribeTopicPartitionsCommandInput - {@link DescribeTopicPartitionsCommandInput}
66
+ * @returns {@link DescribeTopicPartitionsCommandOutput}
67
+ * @see {@link DescribeTopicPartitionsCommandInput} for command's `input` shape.
68
+ * @see {@link DescribeTopicPartitionsCommandOutput} for command's `response` shape.
69
+ * @see {@link KafkaClientResolvedConfig | config} for KafkaClient's `config` shape.
70
+ *
71
+ * @throws {@link BadRequestException} (client fault)
72
+ * <p>Returns information about an error.</p>
73
+ *
74
+ * @throws {@link ForbiddenException} (client fault)
75
+ * <p>Returns information about an error.</p>
76
+ *
77
+ * @throws {@link InternalServerErrorException} (server fault)
78
+ * <p>Returns information about an error.</p>
79
+ *
80
+ * @throws {@link NotFoundException} (client fault)
81
+ * <p>Returns information about an error.</p>
82
+ *
83
+ * @throws {@link UnauthorizedException} (client fault)
84
+ * <p>Returns information about an error.</p>
85
+ *
86
+ * @throws {@link KafkaServiceException}
87
+ * <p>Base exception class for all service exceptions from Kafka service.</p>
88
+ *
89
+ *
90
+ * @public
91
+ */
92
+ export declare class DescribeTopicPartitionsCommand extends DescribeTopicPartitionsCommand_base {
93
+ /** @internal type navigation helper, not in runtime. */
94
+ protected static __types: {
95
+ api: {
96
+ input: DescribeTopicPartitionsRequest;
97
+ output: DescribeTopicPartitionsResponse;
98
+ };
99
+ sdk: {
100
+ input: DescribeTopicPartitionsCommandInput;
101
+ output: DescribeTopicPartitionsCommandOutput;
102
+ };
103
+ };
104
+ }
@@ -0,0 +1,101 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { KafkaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KafkaClient";
4
+ import { ListTopicsRequest, ListTopicsResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListTopicsCommand}.
14
+ */
15
+ export interface ListTopicsCommandInput extends ListTopicsRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListTopicsCommand}.
21
+ */
22
+ export interface ListTopicsCommandOutput extends ListTopicsResponse, __MetadataBearer {
23
+ }
24
+ declare const ListTopicsCommand_base: {
25
+ new (input: ListTopicsCommandInput): import("@smithy/smithy-client").CommandImpl<ListTopicsCommandInput, ListTopicsCommandOutput, KafkaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: ListTopicsCommandInput): import("@smithy/smithy-client").CommandImpl<ListTopicsCommandInput, ListTopicsCommandOutput, KafkaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>List topics in a MSK cluster.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { KafkaClient, ListTopicsCommand } from "@aws-sdk/client-kafka"; // ES Modules import
35
+ * // const { KafkaClient, ListTopicsCommand } = require("@aws-sdk/client-kafka"); // CommonJS import
36
+ * // import type { KafkaClientConfig } from "@aws-sdk/client-kafka";
37
+ * const config = {}; // type is KafkaClientConfig
38
+ * const client = new KafkaClient(config);
39
+ * const input = { // ListTopicsRequest
40
+ * ClusterArn: "STRING_VALUE", // required
41
+ * MaxResults: Number("int"),
42
+ * NextToken: "STRING_VALUE",
43
+ * TopicNameFilter: "STRING_VALUE",
44
+ * };
45
+ * const command = new ListTopicsCommand(input);
46
+ * const response = await client.send(command);
47
+ * // { // ListTopicsResponse
48
+ * // Topics: [ // __listOfTopicInfo
49
+ * // { // TopicInfo
50
+ * // TopicArn: "STRING_VALUE",
51
+ * // TopicName: "STRING_VALUE",
52
+ * // ReplicationFactor: Number("int"),
53
+ * // PartitionCount: Number("int"),
54
+ * // OutOfSyncReplicaCount: Number("int"),
55
+ * // },
56
+ * // ],
57
+ * // NextToken: "STRING_VALUE",
58
+ * // };
59
+ *
60
+ * ```
61
+ *
62
+ * @param ListTopicsCommandInput - {@link ListTopicsCommandInput}
63
+ * @returns {@link ListTopicsCommandOutput}
64
+ * @see {@link ListTopicsCommandInput} for command's `input` shape.
65
+ * @see {@link ListTopicsCommandOutput} for command's `response` shape.
66
+ * @see {@link KafkaClientResolvedConfig | config} for KafkaClient's `config` shape.
67
+ *
68
+ * @throws {@link BadRequestException} (client fault)
69
+ * <p>Returns information about an error.</p>
70
+ *
71
+ * @throws {@link ForbiddenException} (client fault)
72
+ * <p>Returns information about an error.</p>
73
+ *
74
+ * @throws {@link InternalServerErrorException} (server fault)
75
+ * <p>Returns information about an error.</p>
76
+ *
77
+ * @throws {@link ServiceUnavailableException} (server fault)
78
+ * <p>Returns information about an error.</p>
79
+ *
80
+ * @throws {@link UnauthorizedException} (client fault)
81
+ * <p>Returns information about an error.</p>
82
+ *
83
+ * @throws {@link KafkaServiceException}
84
+ * <p>Base exception class for all service exceptions from Kafka service.</p>
85
+ *
86
+ *
87
+ * @public
88
+ */
89
+ export declare class ListTopicsCommand extends ListTopicsCommand_base {
90
+ /** @internal type navigation helper, not in runtime. */
91
+ protected static __types: {
92
+ api: {
93
+ input: ListTopicsRequest;
94
+ output: ListTopicsResponse;
95
+ };
96
+ sdk: {
97
+ input: ListTopicsCommandInput;
98
+ output: ListTopicsCommandOutput;
99
+ };
100
+ };
101
+ }
@@ -17,6 +17,8 @@ export * from "./DescribeClusterV2Command";
17
17
  export * from "./DescribeConfigurationCommand";
18
18
  export * from "./DescribeConfigurationRevisionCommand";
19
19
  export * from "./DescribeReplicatorCommand";
20
+ export * from "./DescribeTopicCommand";
21
+ export * from "./DescribeTopicPartitionsCommand";
20
22
  export * from "./DescribeVpcConnectionCommand";
21
23
  export * from "./GetBootstrapBrokersCommand";
22
24
  export * from "./GetClusterPolicyCommand";
@@ -33,6 +35,7 @@ export * from "./ListNodesCommand";
33
35
  export * from "./ListReplicatorsCommand";
34
36
  export * from "./ListScramSecretsCommand";
35
37
  export * from "./ListTagsForResourceCommand";
38
+ export * from "./ListTopicsCommand";
36
39
  export * from "./ListVpcConnectionsCommand";
37
40
  export * from "./PutClusterPolicyCommand";
38
41
  export * from "./RebootBrokerCommand";
@@ -1866,6 +1866,63 @@ export interface ReplicatorSummary {
1866
1866
  */
1867
1867
  ReplicatorState?: ReplicatorState | undefined;
1868
1868
  }
1869
+ /**
1870
+ * <p>Includes identification info about the topic.</p>
1871
+ * @public
1872
+ */
1873
+ export interface TopicInfo {
1874
+ /**
1875
+ * <p>The Amazon Resource Name (ARN) of the topic.</p>
1876
+ * @public
1877
+ */
1878
+ TopicArn?: string | undefined;
1879
+ /**
1880
+ * <p>Name for a topic.</p>
1881
+ * @public
1882
+ */
1883
+ TopicName?: string | undefined;
1884
+ /**
1885
+ * <p>Replication factor for a topic.</p>
1886
+ * @public
1887
+ */
1888
+ ReplicationFactor?: number | undefined;
1889
+ /**
1890
+ * <p>Partition count for a topic.</p>
1891
+ * @public
1892
+ */
1893
+ PartitionCount?: number | undefined;
1894
+ /**
1895
+ * <p>Number of out-of-sync replicas for a topic.</p>
1896
+ * @public
1897
+ */
1898
+ OutOfSyncReplicaCount?: number | undefined;
1899
+ }
1900
+ /**
1901
+ * <p>Contains information about a topic partition.</p>
1902
+ * @public
1903
+ */
1904
+ export interface TopicPartitionInfo {
1905
+ /**
1906
+ * <p>The partition ID.</p>
1907
+ * @public
1908
+ */
1909
+ Partition?: number | undefined;
1910
+ /**
1911
+ * <p>The leader broker ID for the partition.</p>
1912
+ * @public
1913
+ */
1914
+ Leader?: number | undefined;
1915
+ /**
1916
+ * <p>The list of replica broker IDs for the partition.</p>
1917
+ * @public
1918
+ */
1919
+ Replicas?: number[] | undefined;
1920
+ /**
1921
+ * <p>The list of in-sync replica broker IDs for the partition.</p>
1922
+ * @public
1923
+ */
1924
+ Isr?: number[] | undefined;
1925
+ }
1869
1926
  /**
1870
1927
  * <p>Error info for scram secret associate/disassociate failure.</p>
1871
1928
  * @public
@@ -3108,6 +3165,112 @@ export interface DescribeReplicatorResponse {
3108
3165
  */
3109
3166
  Tags?: Record<string, string> | undefined;
3110
3167
  }
3168
+ /**
3169
+ * @public
3170
+ */
3171
+ export interface DescribeTopicRequest {
3172
+ /**
3173
+ * <p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>
3174
+ * @public
3175
+ */
3176
+ ClusterArn: string | undefined;
3177
+ /**
3178
+ * <p>The Kafka topic name that uniquely identifies the topic.</p>
3179
+ * @public
3180
+ */
3181
+ TopicName: string | undefined;
3182
+ }
3183
+ /**
3184
+ * @public
3185
+ * @enum
3186
+ */
3187
+ export declare const TopicState: {
3188
+ readonly ACTIVE: "ACTIVE";
3189
+ readonly CREATING: "CREATING";
3190
+ readonly DELETING: "DELETING";
3191
+ readonly UPDATING: "UPDATING";
3192
+ };
3193
+ /**
3194
+ * @public
3195
+ */
3196
+ export type TopicState = (typeof TopicState)[keyof typeof TopicState];
3197
+ /**
3198
+ * @public
3199
+ */
3200
+ export interface DescribeTopicResponse {
3201
+ /**
3202
+ * <p>The Amazon Resource Name (ARN) of the topic.</p>
3203
+ * @public
3204
+ */
3205
+ TopicArn?: string | undefined;
3206
+ /**
3207
+ * <p>The Kafka topic name of the topic.</p>
3208
+ * @public
3209
+ */
3210
+ TopicName?: string | undefined;
3211
+ /**
3212
+ * <p>The replication factor of the topic.</p>
3213
+ * @public
3214
+ */
3215
+ ReplicationFactor?: number | undefined;
3216
+ /**
3217
+ * <p>The partition count of the topic.</p>
3218
+ * @public
3219
+ */
3220
+ PartitionCount?: number | undefined;
3221
+ /**
3222
+ * <p>Topic configurations encoded as a Base64 string.</p>
3223
+ * @public
3224
+ */
3225
+ Configs?: string | undefined;
3226
+ /**
3227
+ * <p>The status of the topic.</p>
3228
+ * @public
3229
+ */
3230
+ Status?: TopicState | undefined;
3231
+ }
3232
+ /**
3233
+ * @public
3234
+ */
3235
+ export interface DescribeTopicPartitionsRequest {
3236
+ /**
3237
+ * <p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>
3238
+ * @public
3239
+ */
3240
+ ClusterArn: string | undefined;
3241
+ /**
3242
+ * <p>The Kafka topic name that uniquely identifies the topic.</p>
3243
+ * @public
3244
+ */
3245
+ TopicName: string | undefined;
3246
+ /**
3247
+ * <p>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</p>
3248
+ * @public
3249
+ */
3250
+ MaxResults?: number | undefined;
3251
+ /**
3252
+ * <p>The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response.
3253
+ * To get the next batch, provide this token in your next request.</p>
3254
+ * @public
3255
+ */
3256
+ NextToken?: string | undefined;
3257
+ }
3258
+ /**
3259
+ * @public
3260
+ */
3261
+ export interface DescribeTopicPartitionsResponse {
3262
+ /**
3263
+ * <p>The list of partition information for the topic.</p>
3264
+ * @public
3265
+ */
3266
+ Partitions?: TopicPartitionInfo[] | undefined;
3267
+ /**
3268
+ * <p>The paginated results marker. When the result of a DescribeTopicPartitions operation is truncated, the call returns NextToken in the response.
3269
+ * To get another batch of configurations, provide this token in your next request.</p>
3270
+ * @public
3271
+ */
3272
+ NextToken?: string | undefined;
3273
+ }
3111
3274
  /**
3112
3275
  * @public
3113
3276
  */
@@ -3682,6 +3845,48 @@ export interface ListTagsForResourceResponse {
3682
3845
  */
3683
3846
  Tags?: Record<string, string> | undefined;
3684
3847
  }
3848
+ /**
3849
+ * @public
3850
+ */
3851
+ export interface ListTopicsRequest {
3852
+ /**
3853
+ * <p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>
3854
+ * @public
3855
+ */
3856
+ ClusterArn: string | undefined;
3857
+ /**
3858
+ * <p>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</p>
3859
+ * @public
3860
+ */
3861
+ MaxResults?: number | undefined;
3862
+ /**
3863
+ * <p>The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response.
3864
+ * To get the next batch, provide this token in your next request.</p>
3865
+ * @public
3866
+ */
3867
+ NextToken?: string | undefined;
3868
+ /**
3869
+ * <p>Returns topics starting with given name.</p>
3870
+ * @public
3871
+ */
3872
+ TopicNameFilter?: string | undefined;
3873
+ }
3874
+ /**
3875
+ * @public
3876
+ */
3877
+ export interface ListTopicsResponse {
3878
+ /**
3879
+ * <p>List containing topics info.</p>
3880
+ * @public
3881
+ */
3882
+ Topics?: TopicInfo[] | undefined;
3883
+ /**
3884
+ * <p>The paginated results marker. When the result of a ListTopics operation is truncated, the call returns NextToken in the response.
3885
+ * To get another batch of configurations, provide this token in your next request.</p>
3886
+ * @public
3887
+ */
3888
+ NextToken?: string | undefined;
3889
+ }
3685
3890
  /**
3686
3891
  * @public
3687
3892
  */
@@ -0,0 +1,7 @@
1
+ import { Paginator } from "@smithy/types";
2
+ import { DescribeTopicPartitionsCommandInput, DescribeTopicPartitionsCommandOutput } from "../commands/DescribeTopicPartitionsCommand";
3
+ import { KafkaPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
7
+ export declare const paginateDescribeTopicPartitions: (config: KafkaPaginationConfiguration, input: DescribeTopicPartitionsCommandInput, ...rest: any[]) => Paginator<DescribeTopicPartitionsCommandOutput>;
@@ -0,0 +1,7 @@
1
+ import { Paginator } from "@smithy/types";
2
+ import { ListTopicsCommandInput, ListTopicsCommandOutput } from "../commands/ListTopicsCommand";
3
+ import { KafkaPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
7
+ export declare const paginateListTopics: (config: KafkaPaginationConfiguration, input: ListTopicsCommandInput, ...rest: any[]) => Paginator<ListTopicsCommandOutput>;
@@ -1,3 +1,4 @@
1
+ export * from "./DescribeTopicPartitionsPaginator";
1
2
  export * from "./Interfaces";
2
3
  export * from "./ListClientVpcConnectionsPaginator";
3
4
  export * from "./ListClusterOperationsPaginator";
@@ -10,4 +11,5 @@ export * from "./ListKafkaVersionsPaginator";
10
11
  export * from "./ListNodesPaginator";
11
12
  export * from "./ListReplicatorsPaginator";
12
13
  export * from "./ListScramSecretsPaginator";
14
+ export * from "./ListTopicsPaginator";
13
15
  export * from "./ListVpcConnectionsPaginator";