@aws-sdk/client-kafka 3.1098.0 → 3.1100.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.
- package/README.md +35 -0
- package/dist-cjs/index.js +535 -151
- package/dist-es/Kafka.js +10 -0
- package/dist-es/commands/CreateChannelCommand.js +4 -0
- package/dist-es/commands/DeleteChannelCommand.js +4 -0
- package/dist-es/commands/DescribeChannelCommand.js +4 -0
- package/dist-es/commands/ListChannelsCommand.js +4 -0
- package/dist-es/commands/UpdateChannelCommand.js +4 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/enums.js +36 -0
- package/dist-es/schemas/schemas_0.js +432 -150
- package/dist-types/Kafka.d.ts +35 -0
- package/dist-types/KafkaClient.d.ts +7 -2
- package/dist-types/commands/CreateChannelCommand.d.ts +181 -0
- package/dist-types/commands/DeleteChannelCommand.d.ts +94 -0
- package/dist-types/commands/DescribeChannelCommand.d.ts +186 -0
- package/dist-types/commands/ListChannelsCommand.d.ts +105 -0
- package/dist-types/commands/UpdateChannelCommand.d.ts +100 -0
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/enums.d.ts +92 -0
- package/dist-types/models/models_0.d.ts +632 -1
- package/dist-types/schemas/schemas_0.d.ts +34 -0
- package/dist-types/ts3.4/Kafka.d.ts +85 -0
- package/dist-types/ts3.4/KafkaClient.d.ts +30 -0
- package/dist-types/ts3.4/commands/CreateChannelCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteChannelCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DescribeChannelCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListChannelsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateChannelCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/enums.d.ts +45 -0
- package/dist-types/ts3.4/models/models_0.d.ts +157 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +34 -0
- package/package.json +3 -3
package/dist-types/Kafka.d.ts
CHANGED
|
@@ -1,18 +1,21 @@
|
|
|
1
1
|
import type { HttpHandlerOptions as __HttpHandlerOptions, PaginationConfiguration, Paginator } from "@smithy/types";
|
|
2
2
|
import { type BatchAssociateScramSecretCommandInput, type BatchAssociateScramSecretCommandOutput } from "./commands/BatchAssociateScramSecretCommand";
|
|
3
3
|
import { type BatchDisassociateScramSecretCommandInput, type BatchDisassociateScramSecretCommandOutput } from "./commands/BatchDisassociateScramSecretCommand";
|
|
4
|
+
import { type CreateChannelCommandInput, type CreateChannelCommandOutput } from "./commands/CreateChannelCommand";
|
|
4
5
|
import { type CreateClusterCommandInput, type CreateClusterCommandOutput } from "./commands/CreateClusterCommand";
|
|
5
6
|
import { type CreateClusterV2CommandInput, type CreateClusterV2CommandOutput } from "./commands/CreateClusterV2Command";
|
|
6
7
|
import { type CreateConfigurationCommandInput, type CreateConfigurationCommandOutput } from "./commands/CreateConfigurationCommand";
|
|
7
8
|
import { type CreateReplicatorCommandInput, type CreateReplicatorCommandOutput } from "./commands/CreateReplicatorCommand";
|
|
8
9
|
import { type CreateTopicCommandInput, type CreateTopicCommandOutput } from "./commands/CreateTopicCommand";
|
|
9
10
|
import { type CreateVpcConnectionCommandInput, type CreateVpcConnectionCommandOutput } from "./commands/CreateVpcConnectionCommand";
|
|
11
|
+
import { type DeleteChannelCommandInput, type DeleteChannelCommandOutput } from "./commands/DeleteChannelCommand";
|
|
10
12
|
import { type DeleteClusterCommandInput, type DeleteClusterCommandOutput } from "./commands/DeleteClusterCommand";
|
|
11
13
|
import { type DeleteClusterPolicyCommandInput, type DeleteClusterPolicyCommandOutput } from "./commands/DeleteClusterPolicyCommand";
|
|
12
14
|
import { type DeleteConfigurationCommandInput, type DeleteConfigurationCommandOutput } from "./commands/DeleteConfigurationCommand";
|
|
13
15
|
import { type DeleteReplicatorCommandInput, type DeleteReplicatorCommandOutput } from "./commands/DeleteReplicatorCommand";
|
|
14
16
|
import { type DeleteTopicCommandInput, type DeleteTopicCommandOutput } from "./commands/DeleteTopicCommand";
|
|
15
17
|
import { type DeleteVpcConnectionCommandInput, type DeleteVpcConnectionCommandOutput } from "./commands/DeleteVpcConnectionCommand";
|
|
18
|
+
import { type DescribeChannelCommandInput, type DescribeChannelCommandOutput } from "./commands/DescribeChannelCommand";
|
|
16
19
|
import { type DescribeClusterCommandInput, type DescribeClusterCommandOutput } from "./commands/DescribeClusterCommand";
|
|
17
20
|
import { type DescribeClusterOperationCommandInput, type DescribeClusterOperationCommandOutput } from "./commands/DescribeClusterOperationCommand";
|
|
18
21
|
import { type DescribeClusterOperationV2CommandInput, type DescribeClusterOperationV2CommandOutput } from "./commands/DescribeClusterOperationV2Command";
|
|
@@ -26,6 +29,7 @@ import { type DescribeVpcConnectionCommandInput, type DescribeVpcConnectionComma
|
|
|
26
29
|
import { type GetBootstrapBrokersCommandInput, type GetBootstrapBrokersCommandOutput } from "./commands/GetBootstrapBrokersCommand";
|
|
27
30
|
import { type GetClusterPolicyCommandInput, type GetClusterPolicyCommandOutput } from "./commands/GetClusterPolicyCommand";
|
|
28
31
|
import { type GetCompatibleKafkaVersionsCommandInput, type GetCompatibleKafkaVersionsCommandOutput } from "./commands/GetCompatibleKafkaVersionsCommand";
|
|
32
|
+
import { type ListChannelsCommandInput, type ListChannelsCommandOutput } from "./commands/ListChannelsCommand";
|
|
29
33
|
import { type ListClientVpcConnectionsCommandInput, type ListClientVpcConnectionsCommandOutput } from "./commands/ListClientVpcConnectionsCommand";
|
|
30
34
|
import { type ListClusterOperationsCommandInput, type ListClusterOperationsCommandOutput } from "./commands/ListClusterOperationsCommand";
|
|
31
35
|
import { type ListClusterOperationsV2CommandInput, type ListClusterOperationsV2CommandOutput } from "./commands/ListClusterOperationsV2Command";
|
|
@@ -48,6 +52,7 @@ import { type UntagResourceCommandInput, type UntagResourceCommandOutput } from
|
|
|
48
52
|
import { type UpdateBrokerCountCommandInput, type UpdateBrokerCountCommandOutput } from "./commands/UpdateBrokerCountCommand";
|
|
49
53
|
import { type UpdateBrokerStorageCommandInput, type UpdateBrokerStorageCommandOutput } from "./commands/UpdateBrokerStorageCommand";
|
|
50
54
|
import { type UpdateBrokerTypeCommandInput, type UpdateBrokerTypeCommandOutput } from "./commands/UpdateBrokerTypeCommand";
|
|
55
|
+
import { type UpdateChannelCommandInput, type UpdateChannelCommandOutput } from "./commands/UpdateChannelCommand";
|
|
51
56
|
import { type UpdateClusterConfigurationCommandInput, type UpdateClusterConfigurationCommandOutput } from "./commands/UpdateClusterConfigurationCommand";
|
|
52
57
|
import { type UpdateClusterKafkaVersionCommandInput, type UpdateClusterKafkaVersionCommandOutput } from "./commands/UpdateClusterKafkaVersionCommand";
|
|
53
58
|
import { type UpdateConfigurationCommandInput, type UpdateConfigurationCommandOutput } from "./commands/UpdateConfigurationCommand";
|
|
@@ -72,6 +77,12 @@ export interface Kafka {
|
|
|
72
77
|
batchDisassociateScramSecret(args: BatchDisassociateScramSecretCommandInput, options?: __HttpHandlerOptions): Promise<BatchDisassociateScramSecretCommandOutput>;
|
|
73
78
|
batchDisassociateScramSecret(args: BatchDisassociateScramSecretCommandInput, cb: (err: any, data?: BatchDisassociateScramSecretCommandOutput) => void): void;
|
|
74
79
|
batchDisassociateScramSecret(args: BatchDisassociateScramSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDisassociateScramSecretCommandOutput) => void): void;
|
|
80
|
+
/**
|
|
81
|
+
* @see {@link CreateChannelCommand}
|
|
82
|
+
*/
|
|
83
|
+
createChannel(args: CreateChannelCommandInput, options?: __HttpHandlerOptions): Promise<CreateChannelCommandOutput>;
|
|
84
|
+
createChannel(args: CreateChannelCommandInput, cb: (err: any, data?: CreateChannelCommandOutput) => void): void;
|
|
85
|
+
createChannel(args: CreateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelCommandOutput) => void): void;
|
|
75
86
|
/**
|
|
76
87
|
* @see {@link CreateClusterCommand}
|
|
77
88
|
*/
|
|
@@ -108,6 +119,12 @@ export interface Kafka {
|
|
|
108
119
|
createVpcConnection(args: CreateVpcConnectionCommandInput, options?: __HttpHandlerOptions): Promise<CreateVpcConnectionCommandOutput>;
|
|
109
120
|
createVpcConnection(args: CreateVpcConnectionCommandInput, cb: (err: any, data?: CreateVpcConnectionCommandOutput) => void): void;
|
|
110
121
|
createVpcConnection(args: CreateVpcConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVpcConnectionCommandOutput) => void): void;
|
|
122
|
+
/**
|
|
123
|
+
* @see {@link DeleteChannelCommand}
|
|
124
|
+
*/
|
|
125
|
+
deleteChannel(args: DeleteChannelCommandInput, options?: __HttpHandlerOptions): Promise<DeleteChannelCommandOutput>;
|
|
126
|
+
deleteChannel(args: DeleteChannelCommandInput, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void;
|
|
127
|
+
deleteChannel(args: DeleteChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void;
|
|
111
128
|
/**
|
|
112
129
|
* @see {@link DeleteClusterCommand}
|
|
113
130
|
*/
|
|
@@ -144,6 +161,12 @@ export interface Kafka {
|
|
|
144
161
|
deleteVpcConnection(args: DeleteVpcConnectionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteVpcConnectionCommandOutput>;
|
|
145
162
|
deleteVpcConnection(args: DeleteVpcConnectionCommandInput, cb: (err: any, data?: DeleteVpcConnectionCommandOutput) => void): void;
|
|
146
163
|
deleteVpcConnection(args: DeleteVpcConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVpcConnectionCommandOutput) => void): void;
|
|
164
|
+
/**
|
|
165
|
+
* @see {@link DescribeChannelCommand}
|
|
166
|
+
*/
|
|
167
|
+
describeChannel(args: DescribeChannelCommandInput, options?: __HttpHandlerOptions): Promise<DescribeChannelCommandOutput>;
|
|
168
|
+
describeChannel(args: DescribeChannelCommandInput, cb: (err: any, data?: DescribeChannelCommandOutput) => void): void;
|
|
169
|
+
describeChannel(args: DescribeChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelCommandOutput) => void): void;
|
|
147
170
|
/**
|
|
148
171
|
* @see {@link DescribeClusterCommand}
|
|
149
172
|
*/
|
|
@@ -223,6 +246,12 @@ export interface Kafka {
|
|
|
223
246
|
getCompatibleKafkaVersions(args: GetCompatibleKafkaVersionsCommandInput, options?: __HttpHandlerOptions): Promise<GetCompatibleKafkaVersionsCommandOutput>;
|
|
224
247
|
getCompatibleKafkaVersions(args: GetCompatibleKafkaVersionsCommandInput, cb: (err: any, data?: GetCompatibleKafkaVersionsCommandOutput) => void): void;
|
|
225
248
|
getCompatibleKafkaVersions(args: GetCompatibleKafkaVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCompatibleKafkaVersionsCommandOutput) => void): void;
|
|
249
|
+
/**
|
|
250
|
+
* @see {@link ListChannelsCommand}
|
|
251
|
+
*/
|
|
252
|
+
listChannels(args: ListChannelsCommandInput, options?: __HttpHandlerOptions): Promise<ListChannelsCommandOutput>;
|
|
253
|
+
listChannels(args: ListChannelsCommandInput, cb: (err: any, data?: ListChannelsCommandOutput) => void): void;
|
|
254
|
+
listChannels(args: ListChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsCommandOutput) => void): void;
|
|
226
255
|
/**
|
|
227
256
|
* @see {@link ListClientVpcConnectionsCommand}
|
|
228
257
|
*/
|
|
@@ -361,6 +390,12 @@ export interface Kafka {
|
|
|
361
390
|
updateBrokerType(args: UpdateBrokerTypeCommandInput, options?: __HttpHandlerOptions): Promise<UpdateBrokerTypeCommandOutput>;
|
|
362
391
|
updateBrokerType(args: UpdateBrokerTypeCommandInput, cb: (err: any, data?: UpdateBrokerTypeCommandOutput) => void): void;
|
|
363
392
|
updateBrokerType(args: UpdateBrokerTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBrokerTypeCommandOutput) => void): void;
|
|
393
|
+
/**
|
|
394
|
+
* @see {@link UpdateChannelCommand}
|
|
395
|
+
*/
|
|
396
|
+
updateChannel(args: UpdateChannelCommandInput, options?: __HttpHandlerOptions): Promise<UpdateChannelCommandOutput>;
|
|
397
|
+
updateChannel(args: UpdateChannelCommandInput, cb: (err: any, data?: UpdateChannelCommandOutput) => void): void;
|
|
398
|
+
updateChannel(args: UpdateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelCommandOutput) => void): void;
|
|
364
399
|
/**
|
|
365
400
|
* @see {@link UpdateClusterConfigurationCommand}
|
|
366
401
|
*/
|
|
@@ -8,18 +8,21 @@ import type { AwsCredentialIdentityProvider, BodyLengthCalculator as __BodyLengt
|
|
|
8
8
|
import { type HttpAuthSchemeInputConfig, type HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
|
|
9
9
|
import type { BatchAssociateScramSecretCommandInput, BatchAssociateScramSecretCommandOutput } from "./commands/BatchAssociateScramSecretCommand";
|
|
10
10
|
import type { BatchDisassociateScramSecretCommandInput, BatchDisassociateScramSecretCommandOutput } from "./commands/BatchDisassociateScramSecretCommand";
|
|
11
|
+
import type { CreateChannelCommandInput, CreateChannelCommandOutput } from "./commands/CreateChannelCommand";
|
|
11
12
|
import type { CreateClusterCommandInput, CreateClusterCommandOutput } from "./commands/CreateClusterCommand";
|
|
12
13
|
import type { CreateClusterV2CommandInput, CreateClusterV2CommandOutput } from "./commands/CreateClusterV2Command";
|
|
13
14
|
import type { CreateConfigurationCommandInput, CreateConfigurationCommandOutput } from "./commands/CreateConfigurationCommand";
|
|
14
15
|
import type { CreateReplicatorCommandInput, CreateReplicatorCommandOutput } from "./commands/CreateReplicatorCommand";
|
|
15
16
|
import type { CreateTopicCommandInput, CreateTopicCommandOutput } from "./commands/CreateTopicCommand";
|
|
16
17
|
import type { CreateVpcConnectionCommandInput, CreateVpcConnectionCommandOutput } from "./commands/CreateVpcConnectionCommand";
|
|
18
|
+
import type { DeleteChannelCommandInput, DeleteChannelCommandOutput } from "./commands/DeleteChannelCommand";
|
|
17
19
|
import type { DeleteClusterCommandInput, DeleteClusterCommandOutput } from "./commands/DeleteClusterCommand";
|
|
18
20
|
import type { DeleteClusterPolicyCommandInput, DeleteClusterPolicyCommandOutput } from "./commands/DeleteClusterPolicyCommand";
|
|
19
21
|
import type { DeleteConfigurationCommandInput, DeleteConfigurationCommandOutput } from "./commands/DeleteConfigurationCommand";
|
|
20
22
|
import type { DeleteReplicatorCommandInput, DeleteReplicatorCommandOutput } from "./commands/DeleteReplicatorCommand";
|
|
21
23
|
import type { DeleteTopicCommandInput, DeleteTopicCommandOutput } from "./commands/DeleteTopicCommand";
|
|
22
24
|
import type { DeleteVpcConnectionCommandInput, DeleteVpcConnectionCommandOutput } from "./commands/DeleteVpcConnectionCommand";
|
|
25
|
+
import type { DescribeChannelCommandInput, DescribeChannelCommandOutput } from "./commands/DescribeChannelCommand";
|
|
23
26
|
import type { DescribeClusterCommandInput, DescribeClusterCommandOutput } from "./commands/DescribeClusterCommand";
|
|
24
27
|
import type { DescribeClusterOperationCommandInput, DescribeClusterOperationCommandOutput } from "./commands/DescribeClusterOperationCommand";
|
|
25
28
|
import type { DescribeClusterOperationV2CommandInput, DescribeClusterOperationV2CommandOutput } from "./commands/DescribeClusterOperationV2Command";
|
|
@@ -33,6 +36,7 @@ import type { DescribeVpcConnectionCommandInput, DescribeVpcConnectionCommandOut
|
|
|
33
36
|
import type { GetBootstrapBrokersCommandInput, GetBootstrapBrokersCommandOutput } from "./commands/GetBootstrapBrokersCommand";
|
|
34
37
|
import type { GetClusterPolicyCommandInput, GetClusterPolicyCommandOutput } from "./commands/GetClusterPolicyCommand";
|
|
35
38
|
import type { GetCompatibleKafkaVersionsCommandInput, GetCompatibleKafkaVersionsCommandOutput } from "./commands/GetCompatibleKafkaVersionsCommand";
|
|
39
|
+
import type { ListChannelsCommandInput, ListChannelsCommandOutput } from "./commands/ListChannelsCommand";
|
|
36
40
|
import type { ListClientVpcConnectionsCommandInput, ListClientVpcConnectionsCommandOutput } from "./commands/ListClientVpcConnectionsCommand";
|
|
37
41
|
import type { ListClusterOperationsCommandInput, ListClusterOperationsCommandOutput } from "./commands/ListClusterOperationsCommand";
|
|
38
42
|
import type { ListClusterOperationsV2CommandInput, ListClusterOperationsV2CommandOutput } from "./commands/ListClusterOperationsV2Command";
|
|
@@ -55,6 +59,7 @@ import type { UntagResourceCommandInput, UntagResourceCommandOutput } from "./co
|
|
|
55
59
|
import type { UpdateBrokerCountCommandInput, UpdateBrokerCountCommandOutput } from "./commands/UpdateBrokerCountCommand";
|
|
56
60
|
import type { UpdateBrokerStorageCommandInput, UpdateBrokerStorageCommandOutput } from "./commands/UpdateBrokerStorageCommand";
|
|
57
61
|
import type { UpdateBrokerTypeCommandInput, UpdateBrokerTypeCommandOutput } from "./commands/UpdateBrokerTypeCommand";
|
|
62
|
+
import type { UpdateChannelCommandInput, UpdateChannelCommandOutput } from "./commands/UpdateChannelCommand";
|
|
58
63
|
import type { UpdateClusterConfigurationCommandInput, UpdateClusterConfigurationCommandOutput } from "./commands/UpdateClusterConfigurationCommand";
|
|
59
64
|
import type { UpdateClusterKafkaVersionCommandInput, UpdateClusterKafkaVersionCommandOutput } from "./commands/UpdateClusterKafkaVersionCommand";
|
|
60
65
|
import type { UpdateConfigurationCommandInput, UpdateConfigurationCommandOutput } from "./commands/UpdateConfigurationCommand";
|
|
@@ -71,11 +76,11 @@ export { __Client };
|
|
|
71
76
|
/**
|
|
72
77
|
* @public
|
|
73
78
|
*/
|
|
74
|
-
export type ServiceInputTypes = BatchAssociateScramSecretCommandInput | BatchDisassociateScramSecretCommandInput | CreateClusterCommandInput | CreateClusterV2CommandInput | CreateConfigurationCommandInput | CreateReplicatorCommandInput | CreateTopicCommandInput | CreateVpcConnectionCommandInput | DeleteClusterCommandInput | DeleteClusterPolicyCommandInput | DeleteConfigurationCommandInput | DeleteReplicatorCommandInput | DeleteTopicCommandInput | 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 | UpdateTopicCommandInput;
|
|
79
|
+
export type ServiceInputTypes = BatchAssociateScramSecretCommandInput | BatchDisassociateScramSecretCommandInput | CreateChannelCommandInput | CreateClusterCommandInput | CreateClusterV2CommandInput | CreateConfigurationCommandInput | CreateReplicatorCommandInput | CreateTopicCommandInput | CreateVpcConnectionCommandInput | DeleteChannelCommandInput | DeleteClusterCommandInput | DeleteClusterPolicyCommandInput | DeleteConfigurationCommandInput | DeleteReplicatorCommandInput | DeleteTopicCommandInput | DeleteVpcConnectionCommandInput | DescribeChannelCommandInput | DescribeClusterCommandInput | DescribeClusterOperationCommandInput | DescribeClusterOperationV2CommandInput | DescribeClusterV2CommandInput | DescribeConfigurationCommandInput | DescribeConfigurationRevisionCommandInput | DescribeReplicatorCommandInput | DescribeTopicCommandInput | DescribeTopicPartitionsCommandInput | DescribeVpcConnectionCommandInput | GetBootstrapBrokersCommandInput | GetClusterPolicyCommandInput | GetCompatibleKafkaVersionsCommandInput | ListChannelsCommandInput | ListClientVpcConnectionsCommandInput | ListClusterOperationsCommandInput | ListClusterOperationsV2CommandInput | ListClustersCommandInput | ListClustersV2CommandInput | ListConfigurationRevisionsCommandInput | ListConfigurationsCommandInput | ListKafkaVersionsCommandInput | ListNodesCommandInput | ListReplicatorsCommandInput | ListScramSecretsCommandInput | ListTagsForResourceCommandInput | ListTopicsCommandInput | ListVpcConnectionsCommandInput | PutClusterPolicyCommandInput | RebootBrokerCommandInput | RejectClientVpcConnectionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateBrokerCountCommandInput | UpdateBrokerStorageCommandInput | UpdateBrokerTypeCommandInput | UpdateChannelCommandInput | UpdateClusterConfigurationCommandInput | UpdateClusterKafkaVersionCommandInput | UpdateConfigurationCommandInput | UpdateConnectivityCommandInput | UpdateMonitoringCommandInput | UpdateRebalancingCommandInput | UpdateReplicationInfoCommandInput | UpdateSecurityCommandInput | UpdateStorageCommandInput | UpdateTopicCommandInput;
|
|
75
80
|
/**
|
|
76
81
|
* @public
|
|
77
82
|
*/
|
|
78
|
-
export type ServiceOutputTypes = BatchAssociateScramSecretCommandOutput | BatchDisassociateScramSecretCommandOutput | CreateClusterCommandOutput | CreateClusterV2CommandOutput | CreateConfigurationCommandOutput | CreateReplicatorCommandOutput | CreateTopicCommandOutput | CreateVpcConnectionCommandOutput | DeleteClusterCommandOutput | DeleteClusterPolicyCommandOutput | DeleteConfigurationCommandOutput | DeleteReplicatorCommandOutput | DeleteTopicCommandOutput | 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 | UpdateTopicCommandOutput;
|
|
83
|
+
export type ServiceOutputTypes = BatchAssociateScramSecretCommandOutput | BatchDisassociateScramSecretCommandOutput | CreateChannelCommandOutput | CreateClusterCommandOutput | CreateClusterV2CommandOutput | CreateConfigurationCommandOutput | CreateReplicatorCommandOutput | CreateTopicCommandOutput | CreateVpcConnectionCommandOutput | DeleteChannelCommandOutput | DeleteClusterCommandOutput | DeleteClusterPolicyCommandOutput | DeleteConfigurationCommandOutput | DeleteReplicatorCommandOutput | DeleteTopicCommandOutput | DeleteVpcConnectionCommandOutput | DescribeChannelCommandOutput | DescribeClusterCommandOutput | DescribeClusterOperationCommandOutput | DescribeClusterOperationV2CommandOutput | DescribeClusterV2CommandOutput | DescribeConfigurationCommandOutput | DescribeConfigurationRevisionCommandOutput | DescribeReplicatorCommandOutput | DescribeTopicCommandOutput | DescribeTopicPartitionsCommandOutput | DescribeVpcConnectionCommandOutput | GetBootstrapBrokersCommandOutput | GetClusterPolicyCommandOutput | GetCompatibleKafkaVersionsCommandOutput | ListChannelsCommandOutput | ListClientVpcConnectionsCommandOutput | ListClusterOperationsCommandOutput | ListClusterOperationsV2CommandOutput | ListClustersCommandOutput | ListClustersV2CommandOutput | ListConfigurationRevisionsCommandOutput | ListConfigurationsCommandOutput | ListKafkaVersionsCommandOutput | ListNodesCommandOutput | ListReplicatorsCommandOutput | ListScramSecretsCommandOutput | ListTagsForResourceCommandOutput | ListTopicsCommandOutput | ListVpcConnectionsCommandOutput | PutClusterPolicyCommandOutput | RebootBrokerCommandOutput | RejectClientVpcConnectionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateBrokerCountCommandOutput | UpdateBrokerStorageCommandOutput | UpdateBrokerTypeCommandOutput | UpdateChannelCommandOutput | UpdateClusterConfigurationCommandOutput | UpdateClusterKafkaVersionCommandOutput | UpdateConfigurationCommandOutput | UpdateConnectivityCommandOutput | UpdateMonitoringCommandOutput | UpdateRebalancingCommandOutput | UpdateReplicationInfoCommandOutput | UpdateSecurityCommandOutput | UpdateStorageCommandOutput | UpdateTopicCommandOutput;
|
|
79
84
|
/**
|
|
80
85
|
* @public
|
|
81
86
|
*/
|
|
@@ -0,0 +1,181 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { CreateChannelRequest, CreateChannelResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link CreateChannelCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface CreateChannelCommandInput extends CreateChannelRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link CreateChannelCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface CreateChannelCommandOutput extends CreateChannelResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const CreateChannelCommand_base: {
|
|
22
|
+
new (input: CreateChannelCommandInput): import("@smithy/core/client").CommandImpl<CreateChannelCommandInput, CreateChannelCommandOutput, import("..").KafkaClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: CreateChannelCommandInput): import("@smithy/core/client").CommandImpl<CreateChannelCommandInput, CreateChannelCommandOutput, import("..").KafkaClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Creates a Channel that streams records from an Amazon MSK Express cluster topic to Amazon S3 or Apache Iceberg.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { KafkaClient, CreateChannelCommand } from "@aws-sdk/client-kafka"; // ES Modules import
|
|
32
|
+
* // const { KafkaClient, CreateChannelCommand } = require("@aws-sdk/client-kafka"); // CommonJS import
|
|
33
|
+
* // import type { KafkaClientConfig } from "@aws-sdk/client-kafka";
|
|
34
|
+
* const config = {}; // type is KafkaClientConfig
|
|
35
|
+
* const client = new KafkaClient(config);
|
|
36
|
+
* const input = { // CreateChannelRequest
|
|
37
|
+
* ChannelName: "STRING_VALUE", // required
|
|
38
|
+
* ClusterArn: "STRING_VALUE", // required
|
|
39
|
+
* EncryptionConfiguration: { // EncryptionConfiguration
|
|
40
|
+
* KmsKeyArn: "STRING_VALUE", // required
|
|
41
|
+
* },
|
|
42
|
+
* IcebergDestinationConfiguration: { // IcebergDestinationConfiguration
|
|
43
|
+
* AppendOnly: true || false, // required
|
|
44
|
+
* Catalog: { // Catalog
|
|
45
|
+
* CatalogArn: "STRING_VALUE",
|
|
46
|
+
* WarehouseLocation: "STRING_VALUE",
|
|
47
|
+
* },
|
|
48
|
+
* DataFreshnessInSeconds: Number("int"),
|
|
49
|
+
* DeadLetterQueueS3: { // DeadLetterQueueS3
|
|
50
|
+
* BucketArn: "STRING_VALUE", // required
|
|
51
|
+
* ErrorOutputPrefix: "STRING_VALUE",
|
|
52
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
53
|
+
* },
|
|
54
|
+
* DestinationTableList: [ // __listOfDestinationTable // required
|
|
55
|
+
* { // DestinationTable
|
|
56
|
+
* DestinationDatabaseName: "STRING_VALUE",
|
|
57
|
+
* DestinationTableName: "STRING_VALUE",
|
|
58
|
+
* PartitionSpec: { // PartitionSpec
|
|
59
|
+
* PartitionStrategy: "TIME_HOUR", // required
|
|
60
|
+
* SourceList: [ // __listOfPartitionSource
|
|
61
|
+
* { // PartitionSource
|
|
62
|
+
* SourceName: "STRING_VALUE",
|
|
63
|
+
* },
|
|
64
|
+
* ],
|
|
65
|
+
* },
|
|
66
|
+
* },
|
|
67
|
+
* ],
|
|
68
|
+
* SchemaEvolution: { // SchemaEvolution
|
|
69
|
+
* EnableSchemaEvolution: true || false,
|
|
70
|
+
* },
|
|
71
|
+
* ServiceExecutionRoleArn: "STRING_VALUE", // required
|
|
72
|
+
* TableCreation: { // TableCreation
|
|
73
|
+
* EnableTableCreation: true || false,
|
|
74
|
+
* },
|
|
75
|
+
* CompressionType: "ZSTD" || "SNAPPY",
|
|
76
|
+
* },
|
|
77
|
+
* S3DestinationConfiguration: { // S3DestinationConfiguration
|
|
78
|
+
* DataFreshnessInSeconds: Number("int"),
|
|
79
|
+
* DeadLetterQueueS3: {
|
|
80
|
+
* BucketArn: "STRING_VALUE", // required
|
|
81
|
+
* ErrorOutputPrefix: "STRING_VALUE",
|
|
82
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
83
|
+
* },
|
|
84
|
+
* ServiceExecutionRoleArn: "STRING_VALUE", // required
|
|
85
|
+
* Storage: { // S3Storage
|
|
86
|
+
* BucketArn: "STRING_VALUE", // required
|
|
87
|
+
* CompressionType: "NONE" || "GZIP" || "ZSTD", // required
|
|
88
|
+
* OutputPrefix: "STRING_VALUE",
|
|
89
|
+
* OutputKeyTemplate: "STRING_VALUE",
|
|
90
|
+
* StorageClass: "STANDARD" || "INTELLIGENT_TIERING" || "GLACIER_IR", // required
|
|
91
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
92
|
+
* },
|
|
93
|
+
* },
|
|
94
|
+
* Tags: { // __mapOf__string
|
|
95
|
+
* "<keys>": "STRING_VALUE",
|
|
96
|
+
* },
|
|
97
|
+
* TopicConfigurationList: [ // __listOfTopicConfiguration // required
|
|
98
|
+
* { // TopicConfiguration
|
|
99
|
+
* RecordConverter: { // RecordConverter
|
|
100
|
+
* ValueConverter: "BYTE_ARRAY" || "JSON" || "JSON_SCHEMA_GSR" || "STRING", // required
|
|
101
|
+
* },
|
|
102
|
+
* RecordSchema: { // RecordSchema
|
|
103
|
+
* GsrArn: "STRING_VALUE", // required
|
|
104
|
+
* },
|
|
105
|
+
* TopicArn: "STRING_VALUE", // required
|
|
106
|
+
* },
|
|
107
|
+
* ],
|
|
108
|
+
* LoggingInfo: { // ChannelLoggingInfo
|
|
109
|
+
* CloudWatchLogs: { // CloudWatchLogs
|
|
110
|
+
* Enabled: true || false, // required
|
|
111
|
+
* LogGroup: "STRING_VALUE",
|
|
112
|
+
* },
|
|
113
|
+
* Firehose: { // Firehose
|
|
114
|
+
* DeliveryStream: "STRING_VALUE",
|
|
115
|
+
* Enabled: true || false, // required
|
|
116
|
+
* },
|
|
117
|
+
* S3: { // S3
|
|
118
|
+
* Bucket: "STRING_VALUE",
|
|
119
|
+
* Enabled: true || false, // required
|
|
120
|
+
* Prefix: "STRING_VALUE",
|
|
121
|
+
* },
|
|
122
|
+
* },
|
|
123
|
+
* };
|
|
124
|
+
* const command = new CreateChannelCommand(input);
|
|
125
|
+
* const response = await client.send(command);
|
|
126
|
+
* // { // CreateChannelResponse
|
|
127
|
+
* // ChannelArn: "STRING_VALUE", // required
|
|
128
|
+
* // ClusterOperationArn: "STRING_VALUE",
|
|
129
|
+
* // };
|
|
130
|
+
*
|
|
131
|
+
* ```
|
|
132
|
+
*
|
|
133
|
+
* @param CreateChannelCommandInput - {@link CreateChannelCommandInput}
|
|
134
|
+
* @returns {@link CreateChannelCommandOutput}
|
|
135
|
+
* @see {@link CreateChannelCommandInput} for command's `input` shape.
|
|
136
|
+
* @see {@link CreateChannelCommandOutput} for command's `response` shape.
|
|
137
|
+
* @see {@link KafkaClientResolvedConfig | config} for KafkaClient's `config` shape.
|
|
138
|
+
*
|
|
139
|
+
* @throws {@link BadRequestException} (client fault)
|
|
140
|
+
* <p>Returns information about an error.</p>
|
|
141
|
+
*
|
|
142
|
+
* @throws {@link ConflictException} (client fault)
|
|
143
|
+
* <p>Returns information about an error.</p>
|
|
144
|
+
*
|
|
145
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
146
|
+
* <p>Returns information about an error.</p>
|
|
147
|
+
*
|
|
148
|
+
* @throws {@link InternalServerErrorException} (server fault)
|
|
149
|
+
* <p>Returns information about an error.</p>
|
|
150
|
+
*
|
|
151
|
+
* @throws {@link NotFoundException} (client fault)
|
|
152
|
+
* <p>Returns information about an error.</p>
|
|
153
|
+
*
|
|
154
|
+
* @throws {@link ServiceUnavailableException} (server fault)
|
|
155
|
+
* <p>Returns information about an error.</p>
|
|
156
|
+
*
|
|
157
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
158
|
+
* <p>Returns information about an error.</p>
|
|
159
|
+
*
|
|
160
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
161
|
+
* <p>Returns information about an error.</p>
|
|
162
|
+
*
|
|
163
|
+
* @throws {@link KafkaServiceException}
|
|
164
|
+
* <p>Base exception class for all service exceptions from Kafka service.</p>
|
|
165
|
+
*
|
|
166
|
+
*
|
|
167
|
+
* @public
|
|
168
|
+
*/
|
|
169
|
+
export declare class CreateChannelCommand extends CreateChannelCommand_base {
|
|
170
|
+
/** @internal type navigation helper, not in runtime. */
|
|
171
|
+
protected static __types: {
|
|
172
|
+
api: {
|
|
173
|
+
input: CreateChannelRequest;
|
|
174
|
+
output: CreateChannelResponse;
|
|
175
|
+
};
|
|
176
|
+
sdk: {
|
|
177
|
+
input: CreateChannelCommandInput;
|
|
178
|
+
output: CreateChannelCommandOutput;
|
|
179
|
+
};
|
|
180
|
+
};
|
|
181
|
+
}
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { DeleteChannelRequest, DeleteChannelResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link DeleteChannelCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface DeleteChannelCommandInput extends DeleteChannelRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link DeleteChannelCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface DeleteChannelCommandOutput extends DeleteChannelResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const DeleteChannelCommand_base: {
|
|
22
|
+
new (input: DeleteChannelCommandInput): import("@smithy/core/client").CommandImpl<DeleteChannelCommandInput, DeleteChannelCommandOutput, import("..").KafkaClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: DeleteChannelCommandInput): import("@smithy/core/client").CommandImpl<DeleteChannelCommandInput, DeleteChannelCommandOutput, import("..").KafkaClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Deletes the channel specified by channelArn from the cluster specified by clusterArn. The channel transitions through DELETING and is removed when the asynchronous delete completes.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { KafkaClient, DeleteChannelCommand } from "@aws-sdk/client-kafka"; // ES Modules import
|
|
32
|
+
* // const { KafkaClient, DeleteChannelCommand } = require("@aws-sdk/client-kafka"); // CommonJS import
|
|
33
|
+
* // import type { KafkaClientConfig } from "@aws-sdk/client-kafka";
|
|
34
|
+
* const config = {}; // type is KafkaClientConfig
|
|
35
|
+
* const client = new KafkaClient(config);
|
|
36
|
+
* const input = { // DeleteChannelRequest
|
|
37
|
+
* ChannelArn: "STRING_VALUE", // required
|
|
38
|
+
* ClusterArn: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new DeleteChannelCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // DeleteChannelResponse
|
|
43
|
+
* // ChannelArn: "STRING_VALUE", // required
|
|
44
|
+
* // ClusterOperationArn: "STRING_VALUE",
|
|
45
|
+
* // };
|
|
46
|
+
*
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
49
|
+
* @param DeleteChannelCommandInput - {@link DeleteChannelCommandInput}
|
|
50
|
+
* @returns {@link DeleteChannelCommandOutput}
|
|
51
|
+
* @see {@link DeleteChannelCommandInput} for command's `input` shape.
|
|
52
|
+
* @see {@link DeleteChannelCommandOutput} for command's `response` shape.
|
|
53
|
+
* @see {@link KafkaClientResolvedConfig | config} for KafkaClient's `config` shape.
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link BadRequestException} (client fault)
|
|
56
|
+
* <p>Returns information about an error.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
59
|
+
* <p>Returns information about an error.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link InternalServerErrorException} (server fault)
|
|
62
|
+
* <p>Returns information about an error.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link NotFoundException} (client fault)
|
|
65
|
+
* <p>Returns information about an error.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ServiceUnavailableException} (server fault)
|
|
68
|
+
* <p>Returns information about an error.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
71
|
+
* <p>Returns information about an error.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
74
|
+
* <p>Returns information about an error.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link KafkaServiceException}
|
|
77
|
+
* <p>Base exception class for all service exceptions from Kafka service.</p>
|
|
78
|
+
*
|
|
79
|
+
*
|
|
80
|
+
* @public
|
|
81
|
+
*/
|
|
82
|
+
export declare class DeleteChannelCommand extends DeleteChannelCommand_base {
|
|
83
|
+
/** @internal type navigation helper, not in runtime. */
|
|
84
|
+
protected static __types: {
|
|
85
|
+
api: {
|
|
86
|
+
input: DeleteChannelRequest;
|
|
87
|
+
output: DeleteChannelResponse;
|
|
88
|
+
};
|
|
89
|
+
sdk: {
|
|
90
|
+
input: DeleteChannelCommandInput;
|
|
91
|
+
output: DeleteChannelCommandOutput;
|
|
92
|
+
};
|
|
93
|
+
};
|
|
94
|
+
}
|
|
@@ -0,0 +1,186 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { DescribeChannelRequest, DescribeChannelResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link DescribeChannelCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface DescribeChannelCommandInput extends DescribeChannelRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link DescribeChannelCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface DescribeChannelCommandOutput extends DescribeChannelResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const DescribeChannelCommand_base: {
|
|
22
|
+
new (input: DescribeChannelCommandInput): import("@smithy/core/client").CommandImpl<DescribeChannelCommandInput, DescribeChannelCommandOutput, import("..").KafkaClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: DescribeChannelCommandInput): import("@smithy/core/client").CommandImpl<DescribeChannelCommandInput, DescribeChannelCommandOutput, import("..").KafkaClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Returns the current configuration and state of a channel.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { KafkaClient, DescribeChannelCommand } from "@aws-sdk/client-kafka"; // ES Modules import
|
|
32
|
+
* // const { KafkaClient, DescribeChannelCommand } = require("@aws-sdk/client-kafka"); // CommonJS import
|
|
33
|
+
* // import type { KafkaClientConfig } from "@aws-sdk/client-kafka";
|
|
34
|
+
* const config = {}; // type is KafkaClientConfig
|
|
35
|
+
* const client = new KafkaClient(config);
|
|
36
|
+
* const input = { // DescribeChannelRequest
|
|
37
|
+
* ChannelArn: "STRING_VALUE", // required
|
|
38
|
+
* ClusterArn: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new DescribeChannelCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // DescribeChannelResponse
|
|
43
|
+
* // ChannelArn: "STRING_VALUE", // required
|
|
44
|
+
* // ChannelName: "STRING_VALUE", // required
|
|
45
|
+
* // EncryptionConfiguration: { // EncryptionConfiguration
|
|
46
|
+
* // KmsKeyArn: "STRING_VALUE", // required
|
|
47
|
+
* // },
|
|
48
|
+
* // IcebergDestinationConfiguration: { // IcebergDestinationConfiguration
|
|
49
|
+
* // AppendOnly: true || false, // required
|
|
50
|
+
* // Catalog: { // Catalog
|
|
51
|
+
* // CatalogArn: "STRING_VALUE",
|
|
52
|
+
* // WarehouseLocation: "STRING_VALUE",
|
|
53
|
+
* // },
|
|
54
|
+
* // DataFreshnessInSeconds: Number("int"),
|
|
55
|
+
* // DeadLetterQueueS3: { // DeadLetterQueueS3
|
|
56
|
+
* // BucketArn: "STRING_VALUE", // required
|
|
57
|
+
* // ErrorOutputPrefix: "STRING_VALUE",
|
|
58
|
+
* // ExpectedBucketOwner: "STRING_VALUE",
|
|
59
|
+
* // },
|
|
60
|
+
* // DestinationTableList: [ // __listOfDestinationTable // required
|
|
61
|
+
* // { // DestinationTable
|
|
62
|
+
* // DestinationDatabaseName: "STRING_VALUE",
|
|
63
|
+
* // DestinationTableName: "STRING_VALUE",
|
|
64
|
+
* // PartitionSpec: { // PartitionSpec
|
|
65
|
+
* // PartitionStrategy: "TIME_HOUR", // required
|
|
66
|
+
* // SourceList: [ // __listOfPartitionSource
|
|
67
|
+
* // { // PartitionSource
|
|
68
|
+
* // SourceName: "STRING_VALUE",
|
|
69
|
+
* // },
|
|
70
|
+
* // ],
|
|
71
|
+
* // },
|
|
72
|
+
* // },
|
|
73
|
+
* // ],
|
|
74
|
+
* // SchemaEvolution: { // SchemaEvolution
|
|
75
|
+
* // EnableSchemaEvolution: true || false,
|
|
76
|
+
* // },
|
|
77
|
+
* // ServiceExecutionRoleArn: "STRING_VALUE", // required
|
|
78
|
+
* // TableCreation: { // TableCreation
|
|
79
|
+
* // EnableTableCreation: true || false,
|
|
80
|
+
* // },
|
|
81
|
+
* // CompressionType: "ZSTD" || "SNAPPY",
|
|
82
|
+
* // },
|
|
83
|
+
* // S3DestinationConfiguration: { // S3DestinationConfiguration
|
|
84
|
+
* // DataFreshnessInSeconds: Number("int"),
|
|
85
|
+
* // DeadLetterQueueS3: {
|
|
86
|
+
* // BucketArn: "STRING_VALUE", // required
|
|
87
|
+
* // ErrorOutputPrefix: "STRING_VALUE",
|
|
88
|
+
* // ExpectedBucketOwner: "STRING_VALUE",
|
|
89
|
+
* // },
|
|
90
|
+
* // ServiceExecutionRoleArn: "STRING_VALUE", // required
|
|
91
|
+
* // Storage: { // S3Storage
|
|
92
|
+
* // BucketArn: "STRING_VALUE", // required
|
|
93
|
+
* // CompressionType: "NONE" || "GZIP" || "ZSTD", // required
|
|
94
|
+
* // OutputPrefix: "STRING_VALUE",
|
|
95
|
+
* // OutputKeyTemplate: "STRING_VALUE",
|
|
96
|
+
* // StorageClass: "STANDARD" || "INTELLIGENT_TIERING" || "GLACIER_IR", // required
|
|
97
|
+
* // ExpectedBucketOwner: "STRING_VALUE",
|
|
98
|
+
* // },
|
|
99
|
+
* // },
|
|
100
|
+
* // Status: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "FAILED" || "SUSPENDING" || "SUSPENDED", // required
|
|
101
|
+
* // DestinationType: "ICEBERG" || "S3", // required
|
|
102
|
+
* // CreationTime: new Date("TIMESTAMP"), // required
|
|
103
|
+
* // TopicConfigurationList: [ // __listOfTopicConfiguration // required
|
|
104
|
+
* // { // TopicConfiguration
|
|
105
|
+
* // RecordConverter: { // RecordConverter
|
|
106
|
+
* // ValueConverter: "BYTE_ARRAY" || "JSON" || "JSON_SCHEMA_GSR" || "STRING", // required
|
|
107
|
+
* // },
|
|
108
|
+
* // RecordSchema: { // RecordSchema
|
|
109
|
+
* // GsrArn: "STRING_VALUE", // required
|
|
110
|
+
* // },
|
|
111
|
+
* // TopicArn: "STRING_VALUE", // required
|
|
112
|
+
* // },
|
|
113
|
+
* // ],
|
|
114
|
+
* // LoggingInfo: { // ChannelLoggingInfo
|
|
115
|
+
* // CloudWatchLogs: { // CloudWatchLogs
|
|
116
|
+
* // Enabled: true || false, // required
|
|
117
|
+
* // LogGroup: "STRING_VALUE",
|
|
118
|
+
* // },
|
|
119
|
+
* // Firehose: { // Firehose
|
|
120
|
+
* // DeliveryStream: "STRING_VALUE",
|
|
121
|
+
* // Enabled: true || false, // required
|
|
122
|
+
* // },
|
|
123
|
+
* // S3: { // S3
|
|
124
|
+
* // Bucket: "STRING_VALUE",
|
|
125
|
+
* // Enabled: true || false, // required
|
|
126
|
+
* // Prefix: "STRING_VALUE",
|
|
127
|
+
* // },
|
|
128
|
+
* // },
|
|
129
|
+
* // StateInfo: { // ChannelStateInfo
|
|
130
|
+
* // Code: "STRING_VALUE",
|
|
131
|
+
* // Message: "STRING_VALUE",
|
|
132
|
+
* // },
|
|
133
|
+
* // ClusterOperationArn: "STRING_VALUE",
|
|
134
|
+
* // Tags: { // __mapOf__string
|
|
135
|
+
* // "<keys>": "STRING_VALUE",
|
|
136
|
+
* // },
|
|
137
|
+
* // };
|
|
138
|
+
*
|
|
139
|
+
* ```
|
|
140
|
+
*
|
|
141
|
+
* @param DescribeChannelCommandInput - {@link DescribeChannelCommandInput}
|
|
142
|
+
* @returns {@link DescribeChannelCommandOutput}
|
|
143
|
+
* @see {@link DescribeChannelCommandInput} for command's `input` shape.
|
|
144
|
+
* @see {@link DescribeChannelCommandOutput} for command's `response` shape.
|
|
145
|
+
* @see {@link KafkaClientResolvedConfig | config} for KafkaClient's `config` shape.
|
|
146
|
+
*
|
|
147
|
+
* @throws {@link BadRequestException} (client fault)
|
|
148
|
+
* <p>Returns information about an error.</p>
|
|
149
|
+
*
|
|
150
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
151
|
+
* <p>Returns information about an error.</p>
|
|
152
|
+
*
|
|
153
|
+
* @throws {@link InternalServerErrorException} (server fault)
|
|
154
|
+
* <p>Returns information about an error.</p>
|
|
155
|
+
*
|
|
156
|
+
* @throws {@link NotFoundException} (client fault)
|
|
157
|
+
* <p>Returns information about an error.</p>
|
|
158
|
+
*
|
|
159
|
+
* @throws {@link ServiceUnavailableException} (server fault)
|
|
160
|
+
* <p>Returns information about an error.</p>
|
|
161
|
+
*
|
|
162
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
163
|
+
* <p>Returns information about an error.</p>
|
|
164
|
+
*
|
|
165
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
166
|
+
* <p>Returns information about an error.</p>
|
|
167
|
+
*
|
|
168
|
+
* @throws {@link KafkaServiceException}
|
|
169
|
+
* <p>Base exception class for all service exceptions from Kafka service.</p>
|
|
170
|
+
*
|
|
171
|
+
*
|
|
172
|
+
* @public
|
|
173
|
+
*/
|
|
174
|
+
export declare class DescribeChannelCommand extends DescribeChannelCommand_base {
|
|
175
|
+
/** @internal type navigation helper, not in runtime. */
|
|
176
|
+
protected static __types: {
|
|
177
|
+
api: {
|
|
178
|
+
input: DescribeChannelRequest;
|
|
179
|
+
output: DescribeChannelResponse;
|
|
180
|
+
};
|
|
181
|
+
sdk: {
|
|
182
|
+
input: DescribeChannelCommandInput;
|
|
183
|
+
output: DescribeChannelCommandOutput;
|
|
184
|
+
};
|
|
185
|
+
};
|
|
186
|
+
}
|