@aws-sdk/client-kinesis 3.321.1 → 3.326.0

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

@@ -45,6 +45,8 @@ export interface AddTagsToStreamCommandOutput extends __MetadataBearer {
  * };
  * const command = new AddTagsToStreamCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param AddTagsToStreamCommandInput - {@link AddTagsToStreamCommandInput}
@@ -73,6 +75,8 @@ export interface AddTagsToStreamCommandOutput extends __MetadataBearer {
  *  <p>The requested resource could not be found. The stream might not be specified
  *             correctly.</p>
  *
+ * @throws {@link KinesisServiceException}
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
  *
  */
 export declare class AddTagsToStreamCommand extends $Command<AddTagsToStreamCommandInput, AddTagsToStreamCommandOutput, KinesisClientResolvedConfig> {

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

@@ -78,6 +78,8 @@ export interface CreateStreamCommandOutput extends __MetadataBearer {
  * };
  * const command = new CreateStreamCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param CreateStreamCommandInput - {@link CreateStreamCommandInput}
@@ -98,6 +100,8 @@ 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 KinesisServiceException}
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
  *
  */
 export declare class CreateStreamCommand extends $Command<CreateStreamCommandInput, CreateStreamCommandOutput, KinesisClientResolvedConfig> {

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

@@ -42,6 +42,8 @@ export interface DecreaseStreamRetentionPeriodCommandOutput extends __MetadataBe
  * };
  * const command = new DecreaseStreamRetentionPeriodCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DecreaseStreamRetentionPeriodCommandInput - {@link DecreaseStreamRetentionPeriodCommandInput}
@@ -70,6 +72,8 @@ export interface DecreaseStreamRetentionPeriodCommandOutput extends __MetadataBe
  *  <p>The requested resource could not be found. The stream might not be specified
  *             correctly.</p>
  *
+ * @throws {@link KinesisServiceException}
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
  *
  */
 export declare class DecreaseStreamRetentionPeriodCommand extends $Command<DecreaseStreamRetentionPeriodCommandInput, DecreaseStreamRetentionPeriodCommandOutput, KinesisClientResolvedConfig> {

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

@@ -55,6 +55,8 @@ export interface DeleteStreamCommandOutput extends __MetadataBearer {
  * };
  * const command = new DeleteStreamCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeleteStreamCommandInput - {@link DeleteStreamCommandInput}
@@ -83,6 +85,8 @@ export interface DeleteStreamCommandOutput extends __MetadataBearer {
  *  <p>The requested resource could not be found. The stream might not be specified
  *             correctly.</p>
  *
+ * @throws {@link KinesisServiceException}
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
  *
  */
 export declare class DeleteStreamCommand extends $Command<DeleteStreamCommandInput, DeleteStreamCommandOutput, KinesisClientResolvedConfig> {

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

@@ -40,6 +40,8 @@ export interface DeregisterStreamConsumerCommandOutput extends __MetadataBearer
  * };
  * const command = new DeregisterStreamConsumerCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeregisterStreamConsumerCommandInput - {@link DeregisterStreamConsumerCommandInput}
@@ -60,6 +62,8 @@ export interface DeregisterStreamConsumerCommandOutput extends __MetadataBearer
  *  <p>The requested resource could not be found. The stream might not be specified
  *             correctly.</p>
  *
+ * @throws {@link KinesisServiceException}
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
  *
  */
 export declare class DeregisterStreamConsumerCommand extends $Command<DeregisterStreamConsumerCommandInput, DeregisterStreamConsumerCommandOutput, KinesisClientResolvedConfig> {

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

@@ -32,6 +32,13 @@ export interface DescribeLimitsCommandOutput extends DescribeLimitsOutput, __Met
  * const input = {};
  * const command = new DescribeLimitsCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeLimitsOutput
+ * //   ShardLimit: Number("int"), // required
+ * //   OpenShardCount: Number("int"), // required
+ * //   OnDemandStreamCount: Number("int"), // required
+ * //   OnDemandStreamCountLimit: Number("int"), // required
+ * // };
+ *
  * ```
  *
  * @param DescribeLimitsCommandInput - {@link DescribeLimitsCommandInput}
@@ -44,6 +51,8 @@ export interface DescribeLimitsCommandOutput extends DescribeLimitsOutput, __Met
  *  <p>The requested resource exceeds the maximum number allowed, or the number of concurrent
  *             stream requests exceeds the maximum number allowed. </p>
  *
+ * @throws {@link KinesisServiceException}
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
  *
  */
 export declare class DescribeLimitsCommand extends $Command<DescribeLimitsCommandInput, DescribeLimitsCommandOutput, KinesisClientResolvedConfig> {

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

@@ -57,6 +57,44 @@ export interface DescribeStreamCommandOutput extends DescribeStreamOutput, __Met
  * };
  * const command = new DescribeStreamCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeStreamOutput
+ * //   StreamDescription: { // StreamDescription
+ * //     StreamName: "STRING_VALUE", // required
+ * //     StreamARN: "STRING_VALUE", // required
+ * //     StreamStatus: "CREATING" || "DELETING" || "ACTIVE" || "UPDATING", // required
+ * //     StreamModeDetails: { // StreamModeDetails
+ * //       StreamMode: "PROVISIONED" || "ON_DEMAND", // required
+ * //     },
+ * //     Shards: [ // ShardList // required
+ * //       { // Shard
+ * //         ShardId: "STRING_VALUE", // required
+ * //         ParentShardId: "STRING_VALUE",
+ * //         AdjacentParentShardId: "STRING_VALUE",
+ * //         HashKeyRange: { // HashKeyRange
+ * //           StartingHashKey: "STRING_VALUE", // required
+ * //           EndingHashKey: "STRING_VALUE", // required
+ * //         },
+ * //         SequenceNumberRange: { // SequenceNumberRange
+ * //           StartingSequenceNumber: "STRING_VALUE", // required
+ * //           EndingSequenceNumber: "STRING_VALUE",
+ * //         },
+ * //       },
+ * //     ],
+ * //     HasMoreShards: true || false, // required
+ * //     RetentionPeriodHours: Number("int"), // required
+ * //     StreamCreationTimestamp: new Date("TIMESTAMP"), // required
+ * //     EnhancedMonitoring: [ // EnhancedMonitoringList // required
+ * //       { // EnhancedMetrics
+ * //         ShardLevelMetrics: [ // MetricsNameList
+ * //           "IncomingBytes" || "IncomingRecords" || "OutgoingBytes" || "OutgoingRecords" || "WriteProvisionedThroughputExceeded" || "ReadProvisionedThroughputExceeded" || "IteratorAgeMilliseconds" || "ALL",
+ * //         ],
+ * //       },
+ * //     ],
+ * //     EncryptionType: "NONE" || "KMS",
+ * //     KeyId: "STRING_VALUE",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeStreamCommandInput - {@link DescribeStreamCommandInput}
@@ -81,6 +119,8 @@ export interface DescribeStreamCommandOutput extends DescribeStreamOutput, __Met
  *  <p>The requested resource could not be found. The stream might not be specified
  *             correctly.</p>
  *
+ * @throws {@link KinesisServiceException}
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
  *
  */
 export declare class DescribeStreamCommand extends $Command<DescribeStreamCommandInput, DescribeStreamCommandOutput, KinesisClientResolvedConfig> {

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

@@ -40,6 +40,16 @@ export interface DescribeStreamConsumerCommandOutput extends DescribeStreamConsu
  * };
  * const command = new DescribeStreamConsumerCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeStreamConsumerOutput
+ * //   ConsumerDescription: { // ConsumerDescription
+ * //     ConsumerName: "STRING_VALUE", // required
+ * //     ConsumerARN: "STRING_VALUE", // required
+ * //     ConsumerStatus: "CREATING" || "DELETING" || "ACTIVE", // required
+ * //     ConsumerCreationTimestamp: new Date("TIMESTAMP"), // required
+ * //     StreamARN: "STRING_VALUE", // required
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeStreamConsumerCommandInput - {@link DescribeStreamConsumerCommandInput}
@@ -60,6 +70,8 @@ export interface DescribeStreamConsumerCommandOutput extends DescribeStreamConsu
  *  <p>The requested resource could not be found. The stream might not be specified
  *             correctly.</p>
  *
+ * @throws {@link KinesisServiceException}
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
  *
  */
 export declare class DescribeStreamConsumerCommand extends $Command<DescribeStreamConsumerCommandInput, DescribeStreamConsumerCommandOutput, KinesisClientResolvedConfig> {

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

@@ -43,6 +43,30 @@ export interface DescribeStreamSummaryCommandOutput extends DescribeStreamSummar
  * };
  * const command = new DescribeStreamSummaryCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeStreamSummaryOutput
+ * //   StreamDescriptionSummary: { // StreamDescriptionSummary
+ * //     StreamName: "STRING_VALUE", // required
+ * //     StreamARN: "STRING_VALUE", // required
+ * //     StreamStatus: "CREATING" || "DELETING" || "ACTIVE" || "UPDATING", // required
+ * //     StreamModeDetails: { // StreamModeDetails
+ * //       StreamMode: "PROVISIONED" || "ON_DEMAND", // required
+ * //     },
+ * //     RetentionPeriodHours: Number("int"), // required
+ * //     StreamCreationTimestamp: new Date("TIMESTAMP"), // required
+ * //     EnhancedMonitoring: [ // EnhancedMonitoringList // required
+ * //       { // EnhancedMetrics
+ * //         ShardLevelMetrics: [ // MetricsNameList
+ * //           "IncomingBytes" || "IncomingRecords" || "OutgoingBytes" || "OutgoingRecords" || "WriteProvisionedThroughputExceeded" || "ReadProvisionedThroughputExceeded" || "IteratorAgeMilliseconds" || "ALL",
+ * //         ],
+ * //       },
+ * //     ],
+ * //     EncryptionType: "NONE" || "KMS",
+ * //     KeyId: "STRING_VALUE",
+ * //     OpenShardCount: Number("int"), // required
+ * //     ConsumerCount: Number("int"),
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeStreamSummaryCommandInput - {@link DescribeStreamSummaryCommandInput}
@@ -67,6 +91,8 @@ export interface DescribeStreamSummaryCommandOutput extends DescribeStreamSummar
  *  <p>The requested resource could not be found. The stream might not be specified
  *             correctly.</p>
  *
+ * @throws {@link KinesisServiceException}
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
  *
  */
 export declare class DescribeStreamSummaryCommand extends $Command<DescribeStreamSummaryCommandInput, DescribeStreamSummaryCommandOutput, KinesisClientResolvedConfig> {

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

@@ -39,6 +39,17 @@ export interface DisableEnhancedMonitoringCommandOutput extends EnhancedMonitori
  * };
  * const command = new DisableEnhancedMonitoringCommand(input);
  * const response = await client.send(command);
+ * // { // EnhancedMonitoringOutput
+ * //   StreamName: "STRING_VALUE",
+ * //   CurrentShardLevelMetrics: [ // MetricsNameList
+ * //     "IncomingBytes" || "IncomingRecords" || "OutgoingBytes" || "OutgoingRecords" || "WriteProvisionedThroughputExceeded" || "ReadProvisionedThroughputExceeded" || "IteratorAgeMilliseconds" || "ALL",
+ * //   ],
+ * //   DesiredShardLevelMetrics: [
+ * //     "IncomingBytes" || "IncomingRecords" || "OutgoingBytes" || "OutgoingRecords" || "WriteProvisionedThroughputExceeded" || "ReadProvisionedThroughputExceeded" || "IteratorAgeMilliseconds" || "ALL",
+ * //   ],
+ * //   StreamARN: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param DisableEnhancedMonitoringCommandInput - {@link DisableEnhancedMonitoringCommandInput}
@@ -67,6 +78,8 @@ export interface DisableEnhancedMonitoringCommandOutput extends EnhancedMonitori
  *  <p>The requested resource could not be found. The stream might not be specified
  *             correctly.</p>
  *
+ * @throws {@link KinesisServiceException}
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
  *
  */
 export declare class DisableEnhancedMonitoringCommand extends $Command<DisableEnhancedMonitoringCommandInput, DisableEnhancedMonitoringCommandOutput, KinesisClientResolvedConfig> {

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

@@ -39,6 +39,17 @@ export interface EnableEnhancedMonitoringCommandOutput extends EnhancedMonitorin
  * };
  * const command = new EnableEnhancedMonitoringCommand(input);
  * const response = await client.send(command);
+ * // { // EnhancedMonitoringOutput
+ * //   StreamName: "STRING_VALUE",
+ * //   CurrentShardLevelMetrics: [ // MetricsNameList
+ * //     "IncomingBytes" || "IncomingRecords" || "OutgoingBytes" || "OutgoingRecords" || "WriteProvisionedThroughputExceeded" || "ReadProvisionedThroughputExceeded" || "IteratorAgeMilliseconds" || "ALL",
+ * //   ],
+ * //   DesiredShardLevelMetrics: [
+ * //     "IncomingBytes" || "IncomingRecords" || "OutgoingBytes" || "OutgoingRecords" || "WriteProvisionedThroughputExceeded" || "ReadProvisionedThroughputExceeded" || "IteratorAgeMilliseconds" || "ALL",
+ * //   ],
+ * //   StreamARN: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param EnableEnhancedMonitoringCommandInput - {@link EnableEnhancedMonitoringCommandInput}
@@ -67,6 +78,8 @@ export interface EnableEnhancedMonitoringCommandOutput extends EnhancedMonitorin
  *  <p>The requested resource could not be found. The stream might not be specified
  *             correctly.</p>
  *
+ * @throws {@link KinesisServiceException}
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
  *
  */
 export declare class EnableEnhancedMonitoringCommand extends $Command<EnableEnhancedMonitoringCommandInput, EnableEnhancedMonitoringCommandOutput, KinesisClientResolvedConfig> {

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

@@ -84,6 +84,32 @@ export interface GetRecordsCommandOutput extends GetRecordsOutput, __MetadataBea
  * };
  * const command = new GetRecordsCommand(input);
  * const response = await client.send(command);
+ * // { // GetRecordsOutput
+ * //   Records: [ // RecordList // required
+ * //     { // Record
+ * //       SequenceNumber: "STRING_VALUE", // required
+ * //       ApproximateArrivalTimestamp: new Date("TIMESTAMP"),
+ * //       Data: "BLOB_VALUE", // required
+ * //       PartitionKey: "STRING_VALUE", // required
+ * //       EncryptionType: "NONE" || "KMS",
+ * //     },
+ * //   ],
+ * //   NextShardIterator: "STRING_VALUE",
+ * //   MillisBehindLatest: Number("long"),
+ * //   ChildShards: [ // ChildShardList
+ * //     { // ChildShard
+ * //       ShardId: "STRING_VALUE", // required
+ * //       ParentShards: [ // ShardIdList // required
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       HashKeyRange: { // HashKeyRange
+ * //         StartingHashKey: "STRING_VALUE", // required
+ * //         EndingHashKey: "STRING_VALUE", // required
+ * //       },
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param GetRecordsCommandInput - {@link GetRecordsCommandInput}
@@ -141,6 +167,8 @@ export interface GetRecordsCommandOutput extends GetRecordsOutput, __MetadataBea
  *  <p>The requested resource could not be found. The stream might not be specified
  *             correctly.</p>
  *
+ * @throws {@link KinesisServiceException}
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
  *
  */
 export declare class GetRecordsCommand extends $Command<GetRecordsCommandInput, GetRecordsCommandOutput, KinesisClientResolvedConfig> {

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

@@ -73,6 +73,10 @@ export interface GetShardIteratorCommandOutput extends GetShardIteratorOutput, _
  * };
  * const command = new GetShardIteratorCommand(input);
  * const response = await client.send(command);
+ * // { // GetShardIteratorOutput
+ * //   ShardIterator: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param GetShardIteratorCommandInput - {@link GetShardIteratorCommandInput}
@@ -100,6 +104,8 @@ export interface GetShardIteratorCommandOutput extends GetShardIteratorOutput, _
  *  <p>The requested resource could not be found. The stream might not be specified
  *             correctly.</p>
  *
+ * @throws {@link KinesisServiceException}
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
  *
  */
 export declare class GetShardIteratorCommand extends $Command<GetShardIteratorCommandInput, GetShardIteratorCommandOutput, KinesisClientResolvedConfig> {

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

@@ -45,6 +45,8 @@ export interface IncreaseStreamRetentionPeriodCommandOutput extends __MetadataBe
  * };
  * const command = new IncreaseStreamRetentionPeriodCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param IncreaseStreamRetentionPeriodCommandInput - {@link IncreaseStreamRetentionPeriodCommandInput}
@@ -73,6 +75,8 @@ export interface IncreaseStreamRetentionPeriodCommandOutput extends __MetadataBe
  *  <p>The requested resource could not be found. The stream might not be specified
  *             correctly.</p>
  *
+ * @throws {@link KinesisServiceException}
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
  *
  */
 export declare class IncreaseStreamRetentionPeriodCommand extends $Command<IncreaseStreamRetentionPeriodCommandInput, IncreaseStreamRetentionPeriodCommandOutput, KinesisClientResolvedConfig> {

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

@@ -55,6 +55,25 @@ export interface ListShardsCommandOutput extends ListShardsOutput, __MetadataBea
  * };
  * const command = new ListShardsCommand(input);
  * const response = await client.send(command);
+ * // { // ListShardsOutput
+ * //   Shards: [ // ShardList
+ * //     { // Shard
+ * //       ShardId: "STRING_VALUE", // required
+ * //       ParentShardId: "STRING_VALUE",
+ * //       AdjacentParentShardId: "STRING_VALUE",
+ * //       HashKeyRange: { // HashKeyRange
+ * //         StartingHashKey: "STRING_VALUE", // required
+ * //         EndingHashKey: "STRING_VALUE", // required
+ * //       },
+ * //       SequenceNumberRange: { // SequenceNumberRange
+ * //         StartingSequenceNumber: "STRING_VALUE", // required
+ * //         EndingSequenceNumber: "STRING_VALUE",
+ * //       },
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param ListShardsCommandInput - {@link ListShardsCommandInput}
@@ -86,6 +105,8 @@ export interface ListShardsCommandOutput extends ListShardsOutput, __MetadataBea
  *  <p>The requested resource could not be found. The stream might not be specified
  *             correctly.</p>
  *
+ * @throws {@link KinesisServiceException}
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
  *
  */
 export declare class ListShardsCommand extends $Command<ListShardsCommandInput, ListShardsCommandOutput, KinesisClientResolvedConfig> {

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

@@ -36,6 +36,18 @@ export interface ListStreamConsumersCommandOutput extends ListStreamConsumersOut
  * };
  * const command = new ListStreamConsumersCommand(input);
  * const response = await client.send(command);
+ * // { // ListStreamConsumersOutput
+ * //   Consumers: [ // ConsumerList
+ * //     { // Consumer
+ * //       ConsumerName: "STRING_VALUE", // required
+ * //       ConsumerARN: "STRING_VALUE", // required
+ * //       ConsumerStatus: "CREATING" || "DELETING" || "ACTIVE", // required
+ * //       ConsumerCreationTimestamp: new Date("TIMESTAMP"), // required
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param ListStreamConsumersCommandInput - {@link ListStreamConsumersCommandInput}
@@ -63,6 +75,8 @@ export interface ListStreamConsumersCommandOutput extends ListStreamConsumersOut
  *  <p>The requested resource could not be found. The stream might not be specified
  *             correctly.</p>
  *
+ * @throws {@link KinesisServiceException}
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
  *
  */
 export declare class ListStreamConsumersCommand extends $Command<ListStreamConsumersCommandInput, ListStreamConsumersCommandOutput, KinesisClientResolvedConfig> {

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

@@ -48,6 +48,25 @@ export interface ListStreamsCommandOutput extends ListStreamsOutput, __MetadataB
  * };
  * const command = new ListStreamsCommand(input);
  * const response = await client.send(command);
+ * // { // ListStreamsOutput
+ * //   StreamNames: [ // StreamNameList // required
+ * //     "STRING_VALUE",
+ * //   ],
+ * //   HasMoreStreams: true || false, // required
+ * //   NextToken: "STRING_VALUE",
+ * //   StreamSummaries: [ // StreamSummaryList
+ * //     { // StreamSummary
+ * //       StreamName: "STRING_VALUE", // required
+ * //       StreamARN: "STRING_VALUE", // required
+ * //       StreamStatus: "CREATING" || "DELETING" || "ACTIVE" || "UPDATING", // required
+ * //       StreamModeDetails: { // StreamModeDetails
+ * //         StreamMode: "PROVISIONED" || "ON_DEMAND", // required
+ * //       },
+ * //       StreamCreationTimestamp: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param ListStreamsCommandInput - {@link ListStreamsCommandInput}
@@ -67,6 +86,8 @@ export interface ListStreamsCommandOutput extends ListStreamsOutput, __MetadataB
  *  <p>The requested resource exceeds the maximum number allowed, or the number of concurrent
  *             stream requests exceeds the maximum number allowed. </p>
  *
+ * @throws {@link KinesisServiceException}
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
  *
  */
 export declare class ListStreamsCommand extends $Command<ListStreamsCommandInput, ListStreamsCommandOutput, KinesisClientResolvedConfig> {

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

@@ -39,6 +39,16 @@ export interface ListTagsForStreamCommandOutput extends ListTagsForStreamOutput,
  * };
  * const command = new ListTagsForStreamCommand(input);
  * const response = await client.send(command);
+ * // { // ListTagsForStreamOutput
+ * //   Tags: [ // TagList // required
+ * //     { // Tag
+ * //       Key: "STRING_VALUE", // required
+ * //       Value: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   HasMoreTags: true || false, // required
+ * // };
+ *
  * ```
  *
  * @param ListTagsForStreamCommandInput - {@link ListTagsForStreamCommandInput}
@@ -63,6 +73,8 @@ export interface ListTagsForStreamCommandOutput extends ListTagsForStreamOutput,
  *  <p>The requested resource could not be found. The stream might not be specified
  *             correctly.</p>
  *
+ * @throws {@link KinesisServiceException}
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
  *
  */
 export declare class ListTagsForStreamCommand extends $Command<ListTagsForStreamCommandInput, ListTagsForStreamCommandOutput, KinesisClientResolvedConfig> {

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

@@ -74,6 +74,8 @@ export interface MergeShardsCommandOutput extends __MetadataBearer {
  * };
  * const command = new MergeShardsCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param MergeShardsCommandInput - {@link MergeShardsCommandInput}
@@ -107,6 +109,8 @@ export interface MergeShardsCommandOutput extends __MetadataBearer {
  *             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>
  *
  */
 export declare class MergeShardsCommand extends $Command<MergeShardsCommandInput, MergeShardsCommandOutput, KinesisClientResolvedConfig> {

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

@@ -75,6 +75,12 @@ export interface PutRecordCommandOutput extends PutRecordOutput, __MetadataBeare
  * };
  * const command = new PutRecordCommand(input);
  * const response = await client.send(command);
+ * // { // PutRecordOutput
+ * //   ShardId: "STRING_VALUE", // required
+ * //   SequenceNumber: "STRING_VALUE", // required
+ * //   EncryptionType: "NONE" || "KMS",
+ * // };
+ *
  * ```
  *
  * @param PutRecordCommandInput - {@link PutRecordCommandInput}
@@ -129,6 +135,8 @@ export interface PutRecordCommandOutput extends PutRecordOutput, __MetadataBeare
  *  <p>The requested resource could not be found. The stream might not be specified
  *             correctly.</p>
  *
+ * @throws {@link KinesisServiceException}
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
  *
  */
 export declare class PutRecordCommand extends $Command<PutRecordCommandInput, PutRecordCommandOutput, KinesisClientResolvedConfig> {

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

@@ -98,6 +98,19 @@ export interface PutRecordsCommandOutput extends PutRecordsOutput, __MetadataBea
  * };
  * const command = new PutRecordsCommand(input);
  * const response = await client.send(command);
+ * // { // PutRecordsOutput
+ * //   FailedRecordCount: Number("int"),
+ * //   Records: [ // PutRecordsResultEntryList // required
+ * //     { // PutRecordsResultEntry
+ * //       SequenceNumber: "STRING_VALUE",
+ * //       ShardId: "STRING_VALUE",
+ * //       ErrorCode: "STRING_VALUE",
+ * //       ErrorMessage: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   EncryptionType: "NONE" || "KMS",
+ * // };
+ *
  * ```
  *
  * @param PutRecordsCommandInput - {@link PutRecordsCommandInput}
@@ -152,6 +165,8 @@ export interface PutRecordsCommandOutput extends PutRecordsOutput, __MetadataBea
  *  <p>The requested resource could not be found. The stream might not be specified
  *             correctly.</p>
  *
+ * @throws {@link KinesisServiceException}
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
  *
  */
 export declare class PutRecordsCommand extends $Command<PutRecordsCommandInput, PutRecordsCommandOutput, KinesisClientResolvedConfig> {

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

@@ -45,6 +45,15 @@ export interface RegisterStreamConsumerCommandOutput extends RegisterStreamConsu
  * };
  * const command = new RegisterStreamConsumerCommand(input);
  * const response = await client.send(command);
+ * // { // RegisterStreamConsumerOutput
+ * //   Consumer: { // Consumer
+ * //     ConsumerName: "STRING_VALUE", // required
+ * //     ConsumerARN: "STRING_VALUE", // required
+ * //     ConsumerStatus: "CREATING" || "DELETING" || "ACTIVE", // required
+ * //     ConsumerCreationTimestamp: new Date("TIMESTAMP"), // required
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param RegisterStreamConsumerCommandInput - {@link RegisterStreamConsumerCommandInput}
@@ -69,6 +78,8 @@ export interface RegisterStreamConsumerCommandOutput extends RegisterStreamConsu
  *  <p>The requested resource could not be found. The stream might not be specified
  *             correctly.</p>
  *
+ * @throws {@link KinesisServiceException}
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
  *
  */
 export declare class RegisterStreamConsumerCommand extends $Command<RegisterStreamConsumerCommandInput, RegisterStreamConsumerCommandOutput, KinesisClientResolvedConfig> {

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

@@ -44,6 +44,8 @@ export interface RemoveTagsFromStreamCommandOutput extends __MetadataBearer {
  * };
  * const command = new RemoveTagsFromStreamCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param RemoveTagsFromStreamCommandInput - {@link RemoveTagsFromStreamCommandInput}
@@ -72,6 +74,8 @@ export interface RemoveTagsFromStreamCommandOutput extends __MetadataBearer {
  *  <p>The requested resource could not be found. The stream might not be specified
  *             correctly.</p>
  *
+ * @throws {@link KinesisServiceException}
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
  *
  */
 export declare class RemoveTagsFromStreamCommand extends $Command<RemoveTagsFromStreamCommandInput, RemoveTagsFromStreamCommandOutput, KinesisClientResolvedConfig> {

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

@@ -78,6 +78,8 @@ export interface SplitShardCommandOutput extends __MetadataBearer {
  * };
  * const command = new SplitShardCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param SplitShardCommandInput - {@link SplitShardCommandInput}
@@ -111,6 +113,8 @@ export interface SplitShardCommandOutput extends __MetadataBearer {
  *             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>
  *
  */
 export declare class SplitShardCommand extends $Command<SplitShardCommandInput, SplitShardCommandOutput, KinesisClientResolvedConfig> {

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

@@ -53,6 +53,8 @@ export interface StartStreamEncryptionCommandOutput extends __MetadataBearer {
  * };
  * const command = new StartStreamEncryptionCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param StartStreamEncryptionCommandInput - {@link StartStreamEncryptionCommandInput}
@@ -108,6 +110,8 @@ export interface StartStreamEncryptionCommandOutput extends __MetadataBearer {
  *  <p>The requested resource could not be found. The stream might not be specified
  *             correctly.</p>
  *
+ * @throws {@link KinesisServiceException}
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
  *
  */
 export declare class StartStreamEncryptionCommand extends $Command<StartStreamEncryptionCommandInput, StartStreamEncryptionCommandOutput, KinesisClientResolvedConfig> {

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

@@ -52,6 +52,8 @@ export interface StopStreamEncryptionCommandOutput extends __MetadataBearer {
  * };
  * const command = new StopStreamEncryptionCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param StopStreamEncryptionCommandInput - {@link StopStreamEncryptionCommandInput}
@@ -80,6 +82,8 @@ export interface StopStreamEncryptionCommandOutput extends __MetadataBearer {
  *  <p>The requested resource could not be found. The stream might not be specified
  *             correctly.</p>
  *
+ * @throws {@link KinesisServiceException}
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
  *
  */
 export declare class StopStreamEncryptionCommand extends $Command<StopStreamEncryptionCommandInput, StopStreamEncryptionCommandOutput, KinesisClientResolvedConfig> {

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

@@ -59,6 +59,63 @@ export interface SubscribeToShardCommandOutput extends SubscribeToShardOutput, _
  * };
  * const command = new SubscribeToShardCommand(input);
  * const response = await client.send(command);
+ * // { // SubscribeToShardOutput
+ * //   EventStream: { // SubscribeToShardEventStream Union: only one key present
+ * //     SubscribeToShardEvent: { // SubscribeToShardEvent
+ * //       Records: [ // RecordList // required
+ * //         { // Record
+ * //           SequenceNumber: "STRING_VALUE", // required
+ * //           ApproximateArrivalTimestamp: new Date("TIMESTAMP"),
+ * //           Data: "BLOB_VALUE", // required
+ * //           PartitionKey: "STRING_VALUE", // required
+ * //           EncryptionType: "NONE" || "KMS",
+ * //         },
+ * //       ],
+ * //       ContinuationSequenceNumber: "STRING_VALUE", // required
+ * //       MillisBehindLatest: Number("long"), // required
+ * //       ChildShards: [ // ChildShardList
+ * //         { // ChildShard
+ * //           ShardId: "STRING_VALUE", // required
+ * //           ParentShards: [ // ShardIdList // required
+ * //             "STRING_VALUE",
+ * //           ],
+ * //           HashKeyRange: { // HashKeyRange
+ * //             StartingHashKey: "STRING_VALUE", // required
+ * //             EndingHashKey: "STRING_VALUE", // required
+ * //           },
+ * //         },
+ * //       ],
+ * //     },
+ * //     ResourceNotFoundException: { // ResourceNotFoundException
+ * //       message: "STRING_VALUE",
+ * //     },
+ * //     ResourceInUseException: { // ResourceInUseException
+ * //       message: "STRING_VALUE",
+ * //     },
+ * //     KMSDisabledException: { // KMSDisabledException
+ * //       message: "STRING_VALUE",
+ * //     },
+ * //     KMSInvalidStateException: { // KMSInvalidStateException
+ * //       message: "STRING_VALUE",
+ * //     },
+ * //     KMSAccessDeniedException: { // KMSAccessDeniedException
+ * //       message: "STRING_VALUE",
+ * //     },
+ * //     KMSNotFoundException: { // KMSNotFoundException
+ * //       message: "STRING_VALUE",
+ * //     },
+ * //     KMSOptInRequired: { // KMSOptInRequired
+ * //       message: "STRING_VALUE",
+ * //     },
+ * //     KMSThrottlingException: { // KMSThrottlingException
+ * //       message: "STRING_VALUE",
+ * //     },
+ * //     InternalFailureException: { // InternalFailureException
+ * //       message: "STRING_VALUE",
+ * //     },
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param SubscribeToShardCommandInput - {@link SubscribeToShardCommandInput}
@@ -87,6 +144,8 @@ export interface SubscribeToShardCommandOutput extends SubscribeToShardOutput, _
  *  <p>The requested resource could not be found. The stream might not be specified
  *             correctly.</p>
  *
+ * @throws {@link KinesisServiceException}
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
  *
  */
 export declare class SubscribeToShardCommand extends $Command<SubscribeToShardCommandInput, SubscribeToShardCommandOutput, KinesisClientResolvedConfig> {

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

@@ -81,6 +81,13 @@ export interface UpdateShardCountCommandOutput extends UpdateShardCountOutput, _
  * };
  * const command = new UpdateShardCountCommand(input);
  * const response = await client.send(command);
+ * // { // UpdateShardCountOutput
+ * //   StreamName: "STRING_VALUE",
+ * //   CurrentShardCount: Number("int"),
+ * //   TargetShardCount: Number("int"),
+ * //   StreamARN: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param UpdateShardCountCommandInput - {@link UpdateShardCountCommandInput}
@@ -114,6 +121,8 @@ export interface UpdateShardCountCommandOutput extends UpdateShardCountOutput, _
  *             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>
  *
  */
 export declare class UpdateShardCountCommand extends $Command<UpdateShardCountCommandInput, UpdateShardCountCommandOutput, KinesisClientResolvedConfig> {

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

@@ -37,6 +37,8 @@ export interface UpdateStreamModeCommandOutput extends __MetadataBearer {
  * };
  * const command = new UpdateStreamModeCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param UpdateStreamModeCommandInput - {@link UpdateStreamModeCommandInput}
@@ -61,6 +63,8 @@ export interface UpdateStreamModeCommandOutput extends __MetadataBearer {
  *  <p>The requested resource could not be found. The stream might not be specified
  *             correctly.</p>
  *
+ * @throws {@link KinesisServiceException}
+ * <p>Base exception class for all service exceptions from Kinesis service.</p>
  *
  */
 export declare class UpdateStreamModeCommand extends $Command<UpdateStreamModeCommandInput, UpdateStreamModeCommandOutput, KinesisClientResolvedConfig> {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-kinesis",
   "description": "AWS SDK for JavaScript Kinesis Client for Node.js, Browser and React Native",
-  "version": "3.321.1",
+  "version": "3.326.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -22,36 +22,36 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.321.1",
+    "@aws-sdk/client-sts": "3.326.0",
     "@aws-sdk/config-resolver": "3.310.0",
-    "@aws-sdk/credential-provider-node": "3.321.1",
+    "@aws-sdk/credential-provider-node": "3.326.0",
     "@aws-sdk/eventstream-serde-browser": "3.310.0",
     "@aws-sdk/eventstream-serde-config-resolver": "3.310.0",
     "@aws-sdk/eventstream-serde-node": "3.310.0",
     "@aws-sdk/fetch-http-handler": "3.310.0",
     "@aws-sdk/hash-node": "3.310.0",
     "@aws-sdk/invalid-dependency": "3.310.0",
-    "@aws-sdk/middleware-content-length": "3.310.0",
-    "@aws-sdk/middleware-endpoint": "3.310.0",
-    "@aws-sdk/middleware-host-header": "3.310.0",
-    "@aws-sdk/middleware-logger": "3.310.0",
-    "@aws-sdk/middleware-recursion-detection": "3.310.0",
-    "@aws-sdk/middleware-retry": "3.310.0",
-    "@aws-sdk/middleware-serde": "3.310.0",
-    "@aws-sdk/middleware-signing": "3.310.0",
-    "@aws-sdk/middleware-stack": "3.310.0",
-    "@aws-sdk/middleware-user-agent": "3.319.0",
+    "@aws-sdk/middleware-content-length": "3.325.0",
+    "@aws-sdk/middleware-endpoint": "3.325.0",
+    "@aws-sdk/middleware-host-header": "3.325.0",
+    "@aws-sdk/middleware-logger": "3.325.0",
+    "@aws-sdk/middleware-recursion-detection": "3.325.0",
+    "@aws-sdk/middleware-retry": "3.325.0",
+    "@aws-sdk/middleware-serde": "3.325.0",
+    "@aws-sdk/middleware-signing": "3.325.0",
+    "@aws-sdk/middleware-stack": "3.325.0",
+    "@aws-sdk/middleware-user-agent": "3.325.0",
     "@aws-sdk/node-config-provider": "3.310.0",
     "@aws-sdk/node-http-handler": "3.321.1",
     "@aws-sdk/protocol-http": "3.310.0",
-    "@aws-sdk/smithy-client": "3.316.0",
+    "@aws-sdk/smithy-client": "3.325.0",
     "@aws-sdk/types": "3.310.0",
     "@aws-sdk/url-parser": "3.310.0",
     "@aws-sdk/util-base64": "3.310.0",
     "@aws-sdk/util-body-length-browser": "3.310.0",
     "@aws-sdk/util-body-length-node": "3.310.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.316.0",
-    "@aws-sdk/util-defaults-mode-node": "3.316.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.325.0",
+    "@aws-sdk/util-defaults-mode-node": "3.325.0",
     "@aws-sdk/util-endpoints": "3.319.0",
     "@aws-sdk/util-retry": "3.310.0",
     "@aws-sdk/util-user-agent-browser": "3.310.0",