feat(client-kinesis): Adds support for MinimumThroughputBillingCommitment with new UpdateAccountSettings API. Adds support to configure warm throughput for on-demand streams in new UpdateStreamWarmThroughput API and existing CreateStream API and UpdateStreamMode API.

Author: awstools

clients/client-kinesis/README.md

@@ -253,6 +253,14 @@ DeregisterStreamConsumer
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/kinesis/command/DeregisterStreamConsumerCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kinesis/Interface/DeregisterStreamConsumerCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kinesis/Interface/DeregisterStreamConsumerCommandOutput/)
 
+</details>
+<details>
+<summary>
+DescribeAccountSettings
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/kinesis/command/DescribeAccountSettingsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kinesis/Interface/DescribeAccountSettingsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kinesis/Interface/DescribeAccountSettingsCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -469,6 +477,14 @@ UntagResource
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/kinesis/command/UntagResourceCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kinesis/Interface/UntagResourceCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kinesis/Interface/UntagResourceCommandOutput/)
 
+</details>
+<details>
+<summary>
+UpdateAccountSettings
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/kinesis/command/UpdateAccountSettingsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kinesis/Interface/UpdateAccountSettingsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kinesis/Interface/UpdateAccountSettingsCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -494,3 +510,11 @@ UpdateStreamMode
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/kinesis/command/UpdateStreamModeCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kinesis/Interface/UpdateStreamModeCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kinesis/Interface/UpdateStreamModeCommandOutput/)
 
 </details>
+<details>
+<summary>
+UpdateStreamWarmThroughput
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/kinesis/command/UpdateStreamWarmThroughputCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kinesis/Interface/UpdateStreamWarmThroughputCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kinesis/Interface/UpdateStreamWarmThroughputCommandOutput/)
+
+</details>

clients/client-kinesis/src/Kinesis.ts

@@ -32,6 +32,11 @@ import {
   DeregisterStreamConsumerCommandInput,
   DeregisterStreamConsumerCommandOutput,
 } from "./commands/DeregisterStreamConsumerCommand";
+import {
+  DescribeAccountSettingsCommand,
+  DescribeAccountSettingsCommandInput,
+  DescribeAccountSettingsCommandOutput,
+} from "./commands/DescribeAccountSettingsCommand";
 import {
   DescribeLimitsCommand,
   DescribeLimitsCommandInput,
@@ -135,6 +140,11 @@ import {
   UntagResourceCommandInput,
   UntagResourceCommandOutput,
 } from "./commands/UntagResourceCommand";
+import {
+  UpdateAccountSettingsCommand,
+  UpdateAccountSettingsCommandInput,
+  UpdateAccountSettingsCommandOutput,
+} from "./commands/UpdateAccountSettingsCommand";
 import {
   UpdateMaxRecordSizeCommand,
   UpdateMaxRecordSizeCommandInput,
@@ -150,6 +160,11 @@ import {
   UpdateStreamModeCommandInput,
   UpdateStreamModeCommandOutput,
 } from "./commands/UpdateStreamModeCommand";
+import {
+  UpdateStreamWarmThroughputCommand,
+  UpdateStreamWarmThroughputCommandInput,
+  UpdateStreamWarmThroughputCommandOutput,
+} from "./commands/UpdateStreamWarmThroughputCommand";
 import { KinesisClient, KinesisClientConfig } from "./KinesisClient";
 
 const commands = {
@@ -159,6 +174,7 @@ const commands = {
   DeleteResourcePolicyCommand,
   DeleteStreamCommand,
   DeregisterStreamConsumerCommand,
+  DescribeAccountSettingsCommand,
   DescribeLimitsCommand,
   DescribeStreamCommand,
   DescribeStreamConsumerCommand,
@@ -186,9 +202,11 @@ const commands = {
   SubscribeToShardCommand,
   TagResourceCommand,
   UntagResourceCommand,
+  UpdateAccountSettingsCommand,
   UpdateMaxRecordSizeCommand,
   UpdateShardCountCommand,
   UpdateStreamModeCommand,
+  UpdateStreamWarmThroughputCommand,
 };
 
 export interface Kinesis {
@@ -281,6 +299,24 @@ export interface Kinesis {
     cb: (err: any, data?: DeregisterStreamConsumerCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link DescribeAccountSettingsCommand}
+   */
+  describeAccountSettings(): Promise<DescribeAccountSettingsCommandOutput>;
+  describeAccountSettings(
+    args: DescribeAccountSettingsCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<DescribeAccountSettingsCommandOutput>;
+  describeAccountSettings(
+    args: DescribeAccountSettingsCommandInput,
+    cb: (err: any, data?: DescribeAccountSettingsCommandOutput) => void
+  ): void;
+  describeAccountSettings(
+    args: DescribeAccountSettingsCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: DescribeAccountSettingsCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link DescribeLimitsCommand}
    */
@@ -687,6 +723,23 @@ export interface Kinesis {
     cb: (err: any, data?: UntagResourceCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link UpdateAccountSettingsCommand}
+   */
+  updateAccountSettings(
+    args: UpdateAccountSettingsCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<UpdateAccountSettingsCommandOutput>;
+  updateAccountSettings(
+    args: UpdateAccountSettingsCommandInput,
+    cb: (err: any, data?: UpdateAccountSettingsCommandOutput) => void
+  ): void;
+  updateAccountSettings(
+    args: UpdateAccountSettingsCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: UpdateAccountSettingsCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link UpdateMaxRecordSizeCommand}
    */
@@ -737,6 +790,23 @@ export interface Kinesis {
     options: __HttpHandlerOptions,
     cb: (err: any, data?: UpdateStreamModeCommandOutput) => void
   ): void;
+
+  /**
+   * @see {@link UpdateStreamWarmThroughputCommand}
+   */
+  updateStreamWarmThroughput(
+    args: UpdateStreamWarmThroughputCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<UpdateStreamWarmThroughputCommandOutput>;
+  updateStreamWarmThroughput(
+    args: UpdateStreamWarmThroughputCommandInput,
+    cb: (err: any, data?: UpdateStreamWarmThroughputCommandOutput) => void
+  ): void;
+  updateStreamWarmThroughput(
+    args: UpdateStreamWarmThroughputCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: UpdateStreamWarmThroughputCommandOutput) => void
+  ): void;
 }
 
 /**

clients/client-kinesis/src/KinesisClient.ts

@@ -74,6 +74,10 @@ import {
   DeregisterStreamConsumerCommandInput,
   DeregisterStreamConsumerCommandOutput,
 } from "./commands/DeregisterStreamConsumerCommand";
+import {
+  DescribeAccountSettingsCommandInput,
+  DescribeAccountSettingsCommandOutput,
+} from "./commands/DescribeAccountSettingsCommand";
 import { DescribeLimitsCommandInput, DescribeLimitsCommandOutput } from "./commands/DescribeLimitsCommand";
 import { DescribeStreamCommandInput, DescribeStreamCommandOutput } from "./commands/DescribeStreamCommand";
 import {
@@ -134,12 +138,20 @@ import {
 import { SubscribeToShardCommandInput, SubscribeToShardCommandOutput } from "./commands/SubscribeToShardCommand";
 import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
 import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
+import {
+  UpdateAccountSettingsCommandInput,
+  UpdateAccountSettingsCommandOutput,
+} from "./commands/UpdateAccountSettingsCommand";
 import {
   UpdateMaxRecordSizeCommandInput,
   UpdateMaxRecordSizeCommandOutput,
 } from "./commands/UpdateMaxRecordSizeCommand";
 import { UpdateShardCountCommandInput, UpdateShardCountCommandOutput } from "./commands/UpdateShardCountCommand";
 import { UpdateStreamModeCommandInput, UpdateStreamModeCommandOutput } from "./commands/UpdateStreamModeCommand";
+import {
+  UpdateStreamWarmThroughputCommandInput,
+  UpdateStreamWarmThroughputCommandOutput,
+} from "./commands/UpdateStreamWarmThroughputCommand";
 import {
   ClientInputEndpointParameters,
   ClientResolvedEndpointParameters,
@@ -161,6 +173,7 @@ export type ServiceInputTypes =
   | DeleteResourcePolicyCommandInput
   | DeleteStreamCommandInput
   | DeregisterStreamConsumerCommandInput
+  | DescribeAccountSettingsCommandInput
   | DescribeLimitsCommandInput
   | DescribeStreamCommandInput
   | DescribeStreamConsumerCommandInput
@@ -188,9 +201,11 @@ export type ServiceInputTypes =
   | SubscribeToShardCommandInput
   | TagResourceCommandInput
   | UntagResourceCommandInput
+  | UpdateAccountSettingsCommandInput
   | UpdateMaxRecordSizeCommandInput
   | UpdateShardCountCommandInput
-  | UpdateStreamModeCommandInput;
+  | UpdateStreamModeCommandInput
+  | UpdateStreamWarmThroughputCommandInput;
 
 /**
  * @public
@@ -202,6 +217,7 @@ export type ServiceOutputTypes =
   | DeleteResourcePolicyCommandOutput
   | DeleteStreamCommandOutput
   | DeregisterStreamConsumerCommandOutput
+  | DescribeAccountSettingsCommandOutput
   | DescribeLimitsCommandOutput
   | DescribeStreamCommandOutput
   | DescribeStreamConsumerCommandOutput
@@ -229,9 +245,11 @@ export type ServiceOutputTypes =
   | SubscribeToShardCommandOutput
   | TagResourceCommandOutput
   | UntagResourceCommandOutput
+  | UpdateAccountSettingsCommandOutput
   | UpdateMaxRecordSizeCommandOutput
   | UpdateShardCountCommandOutput
-  | UpdateStreamModeCommandOutput;
+  | UpdateStreamModeCommandOutput
+  | UpdateStreamWarmThroughputCommandOutput;
 
 /**
  * @public

clients/client-kinesis/src/commands/CreateStreamCommand.ts

@@ -32,16 +32,9 @@ export interface CreateStreamCommandOutput extends __MetadataBearer {}
  *             continuously emitted from different data sources or <i>producers</i>.
  *             Scale-out within a stream is explicitly supported by means of shards, which are uniquely
  *             identified groups of data records in a stream.</p>
- *          <p>You can create your data stream using either on-demand or provisioned capacity mode.
- *             Data streams with an on-demand mode require no capacity planning and automatically scale
- *             to handle gigabytes of write and read throughput per minute. With the on-demand mode,
- *             Kinesis Data Streams automatically manages the shards in order to provide the necessary
- *             throughput. For the data streams with a provisioned mode, you must specify the number of
- *             shards for the data stream. Each shard can support reads up to five transactions per
- *             second, up to a maximum data read total of 2 MiB per second. Each shard can support
- *             writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per
- *             second. If the amount of data input increases or decreases, you can add or remove
- *             shards.</p>
+ *          <p>You can create your data stream using either on-demand or provisioned capacity mode. Data streams with an on-demand mode require no capacity planning and automatically scale to handle gigabytes of write and read throughput per minute. With the on-demand mode, Kinesis Data Streams automatically manages the shards in order to provide the necessary throughput.</p>
+ *          <p>If you'd still like to proactively scale your on-demand data stream’s capacity, you can unlock the warm throughput feature for on-demand data streams by enabling <code>MinimumThroughputBillingCommitment</code> for your account. Once your account has <code>MinimumThroughputBillingCommitment</code> enabled, you can specify the warm throughput in MiB per second that your stream can support in writes.</p>
+ *          <p>For the data streams with a provisioned mode, you must specify the number of shards for the data stream. Each shard can support reads up to five transactions per second, up to a maximum data read total of 2 MiB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per second. If the amount of data input increases or decreases, you can add or remove shards.</p>
  *          <p>The stream name identifies the stream. The name is scoped to the Amazon Web Services
  *             account used by the application. It is also scoped by Amazon Web Services Region. That
  *             is, two streams in two different accounts can have the same name, and two streams in the
@@ -63,10 +56,7 @@ export interface CreateStreamCommandOutput extends __MetadataBearer {}
  *                <p>Create more shards than are authorized for your account.</p>
  *             </li>
  *          </ul>
- *          <p>For the default shard limit for an Amazon Web Services account, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html">Amazon
- *                 Kinesis Data Streams Limits</a> in the <i>Amazon Kinesis Data Streams
- *                 Developer Guide</i>. To increase this limit, <a href="https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">contact Amazon Web Services
- *                 Support</a>.</p>
+ *          <p>For the default shard or on-demand throughput limits for an Amazon Web Services account, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html">Amazon Kinesis Data Streams Limits</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>. To increase this limit, <a href="https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">contact Amazon Web Services Support</a>.</p>
  *          <p>You can use <a>DescribeStreamSummary</a> to check the stream status, which
  *             is returned in <code>StreamStatus</code>.</p>
  *          <p>
@@ -90,6 +80,7 @@ export interface CreateStreamCommandOutput extends __MetadataBearer {}
  *   Tags: { // TagMap
  *     "<keys>": "STRING_VALUE",
  *   },
+ *   WarmThroughputMiBps: Number("int"),
  *   MaxRecordSizeInKiB: Number("int"),
  * };
  * const command = new CreateStreamCommand(input);
@@ -116,6 +107,11 @@ export interface CreateStreamCommandOutput extends __MetadataBearer {}
  *  <p>The resource is not available for this operation. For successful operation, the
  *             resource must be in the <code>ACTIVE</code> state.</p>
  *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>Specifies that you tried to invoke this API for a data stream with the on-demand
+ *             capacity mode. This API is only supported for data streams with the provisioned capacity
+ *             mode. </p>
+ *
  * @throws {@link KinesisServiceException}
  * <p>Base exception class for all service exceptions from Kinesis service.</p>
  *