@aws-sdk/client-kafka 3.1097.0 → 3.1099.0

package/dist-types/commands/ListChannelsCommand.d.ts

@@ -0,0 +1,105 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { ListChannelsRequest, ListChannelsResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link ListChannelsCommand}.
+ */
+export interface ListChannelsCommandInput extends ListChannelsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListChannelsCommand}.
+ */
+export interface ListChannelsCommandOutput extends ListChannelsResponse, __MetadataBearer {
+}
+declare const ListChannelsCommand_base: {
+    new (input: ListChannelsCommandInput): import("@smithy/core/client").CommandImpl<ListChannelsCommandInput, ListChannelsCommandOutput, import("..").KafkaClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: ListChannelsCommandInput): import("@smithy/core/client").CommandImpl<ListChannelsCommandInput, ListChannelsCommandOutput, import("..").KafkaClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns the list of channels in a cluster.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { KafkaClient, ListChannelsCommand } from "@aws-sdk/client-kafka"; // ES Modules import
+ * // const { KafkaClient, ListChannelsCommand } = 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 = { // ListChannelsRequest
+ *   ClusterArn: "STRING_VALUE", // required
+ *   MaxResults: Number("int"),
+ *   NextToken: "STRING_VALUE",
+ *   TopicNameFilter: "STRING_VALUE",
+ * };
+ * const command = new ListChannelsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListChannelsResponse
+ * //   Channels: [ // __listOfChannelInfo
+ * //     { // ChannelInfo
+ * //       ChannelArn: "STRING_VALUE", // required
+ * //       ChannelName: "STRING_VALUE", // required
+ * //       Status: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "FAILED" || "SUSPENDING" || "SUSPENDED", // required
+ * //       CreationTime: new Date("TIMESTAMP"), // required
+ * //       DestinationType: "ICEBERG" || "S3", // required
+ * //       ClusterOperationArn: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListChannelsCommandInput - {@link ListChannelsCommandInput}
+ * @returns {@link ListChannelsCommandOutput}
+ * @see {@link ListChannelsCommandInput} for command's `input` shape.
+ * @see {@link ListChannelsCommandOutput} 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 ServiceUnavailableException} (server fault)
+ *  <p>Returns information about an error.</p>
+ *
+ * @throws {@link TooManyRequestsException} (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 declare class ListChannelsCommand extends ListChannelsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListChannelsRequest;
+            output: ListChannelsResponse;
+        };
+        sdk: {
+            input: ListChannelsCommandInput;
+            output: ListChannelsCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UpdateChannelCommand.d.ts

@@ -0,0 +1,100 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { UpdateChannelRequest, UpdateChannelResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link UpdateChannelCommand}.
+ */
+export interface UpdateChannelCommandInput extends UpdateChannelRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateChannelCommand}.
+ */
+export interface UpdateChannelCommandOutput extends UpdateChannelResponse, __MetadataBearer {
+}
+declare const UpdateChannelCommand_base: {
+    new (input: UpdateChannelCommandInput): import("@smithy/core/client").CommandImpl<UpdateChannelCommandInput, UpdateChannelCommandOutput, import("..").KafkaClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: UpdateChannelCommandInput): import("@smithy/core/client").CommandImpl<UpdateChannelCommandInput, UpdateChannelCommandOutput, import("..").KafkaClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates the destination configuration of an existing channel. Exactly one of icebergDestinationUpdate or s3DestinationUpdate must be supplied.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { KafkaClient, UpdateChannelCommand } from "@aws-sdk/client-kafka"; // ES Modules import
+ * // const { KafkaClient, UpdateChannelCommand } = 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 = { // UpdateChannelRequest
+ *   ChannelArn: "STRING_VALUE", // required
+ *   ClusterArn: "STRING_VALUE", // required
+ *   IcebergDestinationUpdate: { // IcebergDestinationUpdate
+ *     DataFreshnessInSeconds: Number("int"), // required
+ *   },
+ *   S3DestinationUpdate: { // S3DestinationUpdate
+ *     DataFreshnessInSeconds: Number("int"), // required
+ *   },
+ * };
+ * const command = new UpdateChannelCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateChannelResponse
+ * //   ChannelArn: "STRING_VALUE", // required
+ * //   ClusterOperationArn: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateChannelCommandInput - {@link UpdateChannelCommandInput}
+ * @returns {@link UpdateChannelCommandOutput}
+ * @see {@link UpdateChannelCommandInput} for command's `input` shape.
+ * @see {@link UpdateChannelCommandOutput} 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 ServiceUnavailableException} (server fault)
+ *  <p>Returns information about an error.</p>
+ *
+ * @throws {@link TooManyRequestsException} (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 declare class UpdateChannelCommand extends UpdateChannelCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateChannelRequest;
+            output: UpdateChannelResponse;
+        };
+        sdk: {
+            input: UpdateChannelCommandInput;
+            output: UpdateChannelCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -1,17 +1,20 @@
 export * from "./BatchAssociateScramSecretCommand";
 export * from "./BatchDisassociateScramSecretCommand";
+export * from "./CreateChannelCommand";
 export * from "./CreateClusterCommand";
 export * from "./CreateClusterV2Command";
 export * from "./CreateConfigurationCommand";
 export * from "./CreateReplicatorCommand";
 export * from "./CreateTopicCommand";
 export * from "./CreateVpcConnectionCommand";
+export * from "./DeleteChannelCommand";
 export * from "./DeleteClusterCommand";
 export * from "./DeleteClusterPolicyCommand";
 export * from "./DeleteConfigurationCommand";
 export * from "./DeleteReplicatorCommand";
 export * from "./DeleteTopicCommand";
 export * from "./DeleteVpcConnectionCommand";
+export * from "./DescribeChannelCommand";
 export * from "./DescribeClusterCommand";
 export * from "./DescribeClusterOperationCommand";
 export * from "./DescribeClusterOperationV2Command";
@@ -25,6 +28,7 @@ export * from "./DescribeVpcConnectionCommand";
 export * from "./GetBootstrapBrokersCommand";
 export * from "./GetClusterPolicyCommand";
 export * from "./GetCompatibleKafkaVersionsCommand";
+export * from "./ListChannelsCommand";
 export * from "./ListClientVpcConnectionsCommand";
 export * from "./ListClusterOperationsCommand";
 export * from "./ListClusterOperationsV2Command";
@@ -47,6 +51,7 @@ export * from "./UntagResourceCommand";
 export * from "./UpdateBrokerCountCommand";
 export * from "./UpdateBrokerStorageCommand";
 export * from "./UpdateBrokerTypeCommand";
+export * from "./UpdateChannelCommand";
 export * from "./UpdateClusterConfigurationCommand";
 export * from "./UpdateClusterKafkaVersionCommand";
 export * from "./UpdateConfigurationCommand";

package/dist-types/models/enums.d.ts

@@ -1,3 +1,32 @@
+/**
+ * @public
+ * @enum
+ */
+export declare const ChannelDestinationType: {
+    readonly ICEBERG: "ICEBERG";
+    readonly S3: "S3";
+};
+/**
+ * @public
+ */
+export type ChannelDestinationType = (typeof ChannelDestinationType)[keyof typeof ChannelDestinationType];
+/**
+ * @public
+ * @enum
+ */
+export declare const ChannelStatus: {
+    readonly ACTIVE: "ACTIVE";
+    readonly CREATING: "CREATING";
+    readonly DELETING: "DELETING";
+    readonly FAILED: "FAILED";
+    readonly SUSPENDED: "SUSPENDED";
+    readonly SUSPENDING: "SUSPENDING";
+    readonly UPDATING: "UPDATING";
+};
+/**
+ * @public
+ */
+export type ChannelStatus = (typeof ChannelStatus)[keyof typeof ChannelStatus];
 /**
  * @public
  * @enum
@@ -158,6 +187,17 @@ export declare const ConfigurationState: {
  * @public
  */
 export type ConfigurationState = (typeof ConfigurationState)[keyof typeof ConfigurationState];
+/**
+ * @public
+ * @enum
+ */
+export declare const PartitionStrategy: {
+    readonly TIME_HOUR: "TIME_HOUR";
+};
+/**
+ * @public
+ */
+export type PartitionStrategy = (typeof PartitionStrategy)[keyof typeof PartitionStrategy];
 /**
  * @public
  * @enum
@@ -270,6 +310,58 @@ export declare const ReplicatorState: {
  * @public
  */
 export type ReplicatorState = (typeof ReplicatorState)[keyof typeof ReplicatorState];
+/**
+ * @public
+ * @enum
+ */
+export declare const ValueConverter: {
+    readonly BYTE_ARRAY: "BYTE_ARRAY";
+    readonly JSON: "JSON";
+    readonly JSON_SCHEMA_GSR: "JSON_SCHEMA_GSR";
+    readonly STRING: "STRING";
+};
+/**
+ * @public
+ */
+export type ValueConverter = (typeof ValueConverter)[keyof typeof ValueConverter];
+/**
+ * @public
+ * @enum
+ */
+export declare const IcebergCompressionType: {
+    readonly SNAPPY: "SNAPPY";
+    readonly ZSTD: "ZSTD";
+};
+/**
+ * @public
+ */
+export type IcebergCompressionType = (typeof IcebergCompressionType)[keyof typeof IcebergCompressionType];
+/**
+ * @public
+ * @enum
+ */
+export declare const S3CompressionType: {
+    readonly GZIP: "GZIP";
+    readonly NONE: "NONE";
+    readonly ZSTD: "ZSTD";
+};
+/**
+ * @public
+ */
+export type S3CompressionType = (typeof S3CompressionType)[keyof typeof S3CompressionType];
+/**
+ * @public
+ * @enum
+ */
+export declare const S3StorageClass: {
+    readonly GLACIER_IR: "GLACIER_IR";
+    readonly INTELLIGENT_TIERING: "INTELLIGENT_TIERING";
+    readonly STANDARD: "STANDARD";
+};
+/**
+ * @public
+ */
+export type S3StorageClass = (typeof S3StorageClass)[keyof typeof S3StorageClass];
 /**
  * @public
  * @enum