@aws-sdk/client-kinesis 3.651.1 → 3.658.0

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

@@ -90,4 +90,15 @@ declare const AddTagsToStreamCommand_base: {
  * @public
  */
 export declare class AddTagsToStreamCommand extends AddTagsToStreamCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: AddTagsToStreamInput;
+            output: {};
+        };
+        sdk: {
+            input: AddTagsToStreamCommandInput;
+            output: AddTagsToStreamCommandOutput;
+        };
+    };
 }

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

@@ -71,6 +71,11 @@ declare const CreateStreamCommand_base: {
  *          <p>
  *             <a>CreateStream</a> has a limit of five transactions per second per
  *             account.</p>
+ *          <p>You can add tags to the stream when making a <code>CreateStream</code> request by
+ *             setting the <code>Tags</code> parameter. If you pass <code>Tags</code> parameter, in
+ *             addition to having <code>kinesis:createStream</code> permission, you must also have
+ *                 <code>kinesis:addTagsToStream</code> permission for the stream that will be created.
+ *             Tags will take effect from the <code>CREATING</code> status of the stream. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -83,6 +88,9 @@ declare const CreateStreamCommand_base: {
  *   StreamModeDetails: { // StreamModeDetails
  *     StreamMode: "PROVISIONED" || "ON_DEMAND", // required
  *   },
+ *   Tags: { // TagMap
+ *     "<keys>": "STRING_VALUE",
+ *   },
  * };
  * const command = new CreateStreamCommand(input);
  * const response = await client.send(command);
@@ -114,4 +122,15 @@ declare const CreateStreamCommand_base: {
  * @public
  */
 export declare class CreateStreamCommand extends CreateStreamCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: CreateStreamInput;
+            output: {};
+        };
+        sdk: {
+            input: CreateStreamCommandInput;
+            output: CreateStreamCommandOutput;
+        };
+    };
 }

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

@@ -87,4 +87,15 @@ declare const DecreaseStreamRetentionPeriodCommand_base: {
  * @public
  */
 export declare class DecreaseStreamRetentionPeriodCommand extends DecreaseStreamRetentionPeriodCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DecreaseStreamRetentionPeriodInput;
+            output: {};
+        };
+        sdk: {
+            input: DecreaseStreamRetentionPeriodCommandInput;
+            output: DecreaseStreamRetentionPeriodCommandOutput;
+        };
+    };
 }

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

@@ -85,4 +85,15 @@ declare const DeleteResourcePolicyCommand_base: {
  * @public
  */
 export declare class DeleteResourcePolicyCommand extends DeleteResourcePolicyCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DeleteResourcePolicyInput;
+            output: {};
+        };
+        sdk: {
+            input: DeleteResourcePolicyCommandInput;
+            output: DeleteResourcePolicyCommandOutput;
+        };
+    };
 }

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

@@ -100,4 +100,15 @@ declare const DeleteStreamCommand_base: {
  * @public
  */
 export declare class DeleteStreamCommand extends DeleteStreamCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DeleteStreamInput;
+            output: {};
+        };
+        sdk: {
+            input: DeleteStreamCommandInput;
+            output: DeleteStreamCommandOutput;
+        };
+    };
 }

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

@@ -76,4 +76,15 @@ declare const DeregisterStreamConsumerCommand_base: {
  * @public
  */
 export declare class DeregisterStreamConsumerCommand extends DeregisterStreamConsumerCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DeregisterStreamConsumerInput;
+            output: {};
+        };
+        sdk: {
+            input: DeregisterStreamConsumerCommandInput;
+            output: DeregisterStreamConsumerCommandOutput;
+        };
+    };
 }

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

@@ -65,4 +65,15 @@ declare const DescribeLimitsCommand_base: {
  * @public
  */
 export declare class DescribeLimitsCommand extends DescribeLimitsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: {};
+            output: DescribeLimitsOutput;
+        };
+        sdk: {
+            input: DescribeLimitsCommandInput;
+            output: DescribeLimitsCommandOutput;
+        };
+    };
 }

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

@@ -134,4 +134,15 @@ declare const DescribeStreamCommand_base: {
  * @public
  */
 export declare class DescribeStreamCommand extends DescribeStreamCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DescribeStreamInput;
+            output: DescribeStreamOutput;
+        };
+        sdk: {
+            input: DescribeStreamCommandInput;
+            output: DescribeStreamCommandOutput;
+        };
+    };
 }

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

@@ -87,4 +87,15 @@ declare const DescribeStreamConsumerCommand_base: {
  * @public
  */
 export declare class DescribeStreamConsumerCommand extends DescribeStreamConsumerCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DescribeStreamConsumerInput;
+            output: DescribeStreamConsumerOutput;
+        };
+        sdk: {
+            input: DescribeStreamConsumerCommandInput;
+            output: DescribeStreamConsumerCommandOutput;
+        };
+    };
 }

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

@@ -106,4 +106,15 @@ declare const DescribeStreamSummaryCommand_base: {
  * @public
  */
 export declare class DescribeStreamSummaryCommand extends DescribeStreamSummaryCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DescribeStreamSummaryInput;
+            output: DescribeStreamSummaryOutput;
+        };
+        sdk: {
+            input: DescribeStreamSummaryCommandInput;
+            output: DescribeStreamSummaryCommandOutput;
+        };
+    };
 }

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

@@ -93,4 +93,15 @@ declare const DisableEnhancedMonitoringCommand_base: {
  * @public
  */
 export declare class DisableEnhancedMonitoringCommand extends DisableEnhancedMonitoringCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DisableEnhancedMonitoringInput;
+            output: EnhancedMonitoringOutput;
+        };
+        sdk: {
+            input: DisableEnhancedMonitoringCommandInput;
+            output: DisableEnhancedMonitoringCommandOutput;
+        };
+    };
 }

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

@@ -93,4 +93,15 @@ declare const EnableEnhancedMonitoringCommand_base: {
  * @public
  */
 export declare class EnableEnhancedMonitoringCommand extends EnableEnhancedMonitoringCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: EnableEnhancedMonitoringInput;
+            output: EnhancedMonitoringOutput;
+        };
+        sdk: {
+            input: EnableEnhancedMonitoringCommandInput;
+            output: EnableEnhancedMonitoringCommandOutput;
+        };
+    };
 }

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

@@ -182,4 +182,15 @@ declare const GetRecordsCommand_base: {
  * @public
  */
 export declare class GetRecordsCommand extends GetRecordsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetRecordsInput;
+            output: GetRecordsOutput;
+        };
+        sdk: {
+            input: GetRecordsCommandInput;
+            output: GetRecordsCommandOutput;
+        };
+    };
 }

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

@@ -73,6 +73,10 @@ declare const GetResourcePolicyCommand_base: {
  *  <p>The requested resource exceeds the maximum number allowed, or the number of concurrent
  *             stream requests exceeds the maximum number allowed. </p>
  *
+ * @throws {@link ResourceInUseException} (client fault)
+ *  <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 ResourceNotFoundException} (client fault)
  *  <p>The requested resource could not be found. The stream might not be specified
  *             correctly.</p>
@@ -83,4 +87,15 @@ declare const GetResourcePolicyCommand_base: {
  * @public
  */
 export declare class GetResourcePolicyCommand extends GetResourcePolicyCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetResourcePolicyInput;
+            output: GetResourcePolicyOutput;
+        };
+        sdk: {
+            input: GetResourcePolicyCommandInput;
+            output: GetResourcePolicyCommandOutput;
+        };
+    };
 }

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

@@ -119,4 +119,15 @@ declare const GetShardIteratorCommand_base: {
  * @public
  */
 export declare class GetShardIteratorCommand extends GetShardIteratorCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetShardIteratorInput;
+            output: GetShardIteratorOutput;
+        };
+        sdk: {
+            input: GetShardIteratorCommandInput;
+            output: GetShardIteratorCommandOutput;
+        };
+    };
 }

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

@@ -90,4 +90,15 @@ declare const IncreaseStreamRetentionPeriodCommand_base: {
  * @public
  */
 export declare class IncreaseStreamRetentionPeriodCommand extends IncreaseStreamRetentionPeriodCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: IncreaseStreamRetentionPeriodInput;
+            output: {};
+        };
+        sdk: {
+            input: IncreaseStreamRetentionPeriodCommandInput;
+            output: IncreaseStreamRetentionPeriodCommandOutput;
+        };
+    };
 }

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

@@ -120,4 +120,15 @@ declare const ListShardsCommand_base: {
  * @public
  */
 export declare class ListShardsCommand extends ListShardsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListShardsInput;
+            output: ListShardsOutput;
+        };
+        sdk: {
+            input: ListShardsCommandInput;
+            output: ListShardsCommandOutput;
+        };
+    };
 }

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

@@ -89,4 +89,15 @@ declare const ListStreamConsumersCommand_base: {
  * @public
  */
 export declare class ListStreamConsumersCommand extends ListStreamConsumersCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListStreamConsumersInput;
+            output: ListStreamConsumersOutput;
+        };
+        sdk: {
+            input: ListStreamConsumersCommandInput;
+            output: ListStreamConsumersCommandOutput;
+        };
+    };
 }

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

@@ -100,4 +100,15 @@ declare const ListStreamsCommand_base: {
  * @public
  */
 export declare class ListStreamsCommand extends ListStreamsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListStreamsInput;
+            output: ListStreamsOutput;
+        };
+        sdk: {
+            input: ListStreamsCommandInput;
+            output: ListStreamsCommandOutput;
+        };
+    };
 }

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

@@ -88,4 +88,15 @@ declare const ListTagsForStreamCommand_base: {
  * @public
  */
 export declare class ListTagsForStreamCommand extends ListTagsForStreamCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListTagsForStreamInput;
+            output: ListTagsForStreamOutput;
+        };
+        sdk: {
+            input: ListTagsForStreamCommandInput;
+            output: ListTagsForStreamCommandOutput;
+        };
+    };
 }

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

@@ -124,4 +124,15 @@ declare const MergeShardsCommand_base: {
  * @public
  */
 export declare class MergeShardsCommand extends MergeShardsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: MergeShardsInput;
+            output: {};
+        };
+        sdk: {
+            input: MergeShardsCommandInput;
+            output: MergeShardsCommandOutput;
+        };
+    };
 }

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

@@ -150,4 +150,15 @@ declare const PutRecordCommand_base: {
  * @public
  */
 export declare class PutRecordCommand extends PutRecordCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: PutRecordInput;
+            output: PutRecordOutput;
+        };
+        sdk: {
+            input: PutRecordCommandInput;
+            output: PutRecordCommandOutput;
+        };
+    };
 }

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

@@ -180,4 +180,15 @@ declare const PutRecordsCommand_base: {
  * @public
  */
 export declare class PutRecordsCommand extends PutRecordsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: PutRecordsInput;
+            output: PutRecordsOutput;
+        };
+        sdk: {
+            input: PutRecordsCommandInput;
+            output: PutRecordsCommandOutput;
+        };
+    };
 }

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

@@ -93,4 +93,15 @@ declare const PutResourcePolicyCommand_base: {
  * @public
  */
 export declare class PutResourcePolicyCommand extends PutResourcePolicyCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: PutResourcePolicyInput;
+            output: {};
+        };
+        sdk: {
+            input: PutResourcePolicyCommandInput;
+            output: PutResourcePolicyCommandOutput;
+        };
+    };
 }

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

@@ -34,7 +34,7 @@ declare const RegisterStreamConsumerCommand_base: {
  *             read from the same stream.</p>
  *          <p>You can register up to 20 consumers per stream. A given consumer can only be
  *             registered with one stream at a time.</p>
- *          <p>For an example of how to use this operations, see <a href="/streams/latest/dev/building-enhanced-consumers-api.html">Enhanced Fan-Out
+ *          <p>For an example of how to use this operation, see <a href="https://docs.aws.amazon.com/streams/latest/dev/building-enhanced-consumers-api.html">Enhanced Fan-Out
  *                 Using the Kinesis Data Streams API</a>.</p>
  *          <p>The use of this operation has a limit of five transactions per second per account.
  *             Also, only 5 consumers can be created simultaneously. In other words, you cannot have
@@ -92,4 +92,15 @@ declare const RegisterStreamConsumerCommand_base: {
  * @public
  */
 export declare class RegisterStreamConsumerCommand extends RegisterStreamConsumerCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: RegisterStreamConsumerInput;
+            output: RegisterStreamConsumerOutput;
+        };
+        sdk: {
+            input: RegisterStreamConsumerCommandInput;
+            output: RegisterStreamConsumerCommandOutput;
+        };
+    };
 }

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

@@ -89,4 +89,15 @@ declare const RemoveTagsFromStreamCommand_base: {
  * @public
  */
 export declare class RemoveTagsFromStreamCommand extends RemoveTagsFromStreamCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: RemoveTagsFromStreamInput;
+            output: {};
+        };
+        sdk: {
+            input: RemoveTagsFromStreamCommandInput;
+            output: RemoveTagsFromStreamCommandOutput;
+        };
+    };
 }

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

@@ -128,4 +128,15 @@ declare const SplitShardCommand_base: {
  * @public
  */
 export declare class SplitShardCommand extends SplitShardCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: SplitShardInput;
+            output: {};
+        };
+        sdk: {
+            input: SplitShardCommandInput;
+            output: SplitShardCommandOutput;
+        };
+    };
 }

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

@@ -125,4 +125,15 @@ declare const StartStreamEncryptionCommand_base: {
  * @public
  */
 export declare class StartStreamEncryptionCommand extends StartStreamEncryptionCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: StartStreamEncryptionInput;
+            output: {};
+        };
+        sdk: {
+            input: StartStreamEncryptionCommandInput;
+            output: StartStreamEncryptionCommandOutput;
+        };
+    };
 }

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

@@ -97,4 +97,15 @@ declare const StopStreamEncryptionCommand_base: {
  * @public
  */
 export declare class StopStreamEncryptionCommand extends StopStreamEncryptionCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: StopStreamEncryptionInput;
+            output: {};
+        };
+        sdk: {
+            input: StopStreamEncryptionCommandInput;
+            output: StopStreamEncryptionCommandOutput;
+        };
+    };
 }

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

@@ -48,7 +48,7 @@ declare const SubscribeToShardCommand_base: {
  *             seconds or more after a successful call, the second call takes over the subscription and
  *             the previous connection expires or fails with a
  *             <code>ResourceInUseException</code>.</p>
- *          <p>For an example of how to use this operations, see <a href="/streams/latest/dev/building-enhanced-consumers-api.html">Enhanced Fan-Out
+ *          <p>For an example of how to use this operation, see <a href="https://docs.aws.amazon.com/streams/latest/dev/building-enhanced-consumers-api.html">Enhanced Fan-Out
  *                 Using the Kinesis Data Streams API</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -158,4 +158,15 @@ declare const SubscribeToShardCommand_base: {
  * @public
  */
 export declare class SubscribeToShardCommand extends SubscribeToShardCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: SubscribeToShardInput;
+            output: SubscribeToShardOutput;
+        };
+        sdk: {
+            input: SubscribeToShardCommandInput;
+            output: SubscribeToShardCommandOutput;
+        };
+    };
 }

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

@@ -139,4 +139,15 @@ declare const UpdateShardCountCommand_base: {
  * @public
  */
 export declare class UpdateShardCountCommand extends UpdateShardCountCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateShardCountInput;
+            output: UpdateShardCountOutput;
+        };
+        sdk: {
+            input: UpdateShardCountCommandInput;
+            output: UpdateShardCountCommandOutput;
+        };
+    };
 }

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

@@ -77,4 +77,15 @@ declare const UpdateStreamModeCommand_base: {
  * @public
  */
 export declare class UpdateStreamModeCommand extends UpdateStreamModeCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateStreamModeInput;
+            output: {};
+        };
+        sdk: {
+            input: UpdateStreamModeCommandInput;
+            output: UpdateStreamModeCommandOutput;
+        };
+    };
 }

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

@@ -263,6 +263,11 @@ export interface CreateStreamInput {
      * @public
      */
     StreamModeDetails?: StreamModeDetails;
+    /**
+     * <p>A set of up to 10 key-value pairs to use to create the tags.</p>
+     * @public
+     */
+    Tags?: Record<string, string>;
 }
 /**
  * <p>Represents the input for <a>DecreaseStreamRetentionPeriod</a>.</p>

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

@@ -31,4 +31,15 @@ declare const AddTagsToStreamCommand_base: {
   >;
   getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
-export declare class AddTagsToStreamCommand extends AddTagsToStreamCommand_base {}
+export declare class AddTagsToStreamCommand extends AddTagsToStreamCommand_base {
+  protected static __types: {
+    api: {
+      input: AddTagsToStreamInput;
+      output: {};
+    };
+    sdk: {
+      input: AddTagsToStreamCommandInput;
+      output: AddTagsToStreamCommandOutput;
+    };
+  };
+}

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

@@ -31,4 +31,15 @@ declare const CreateStreamCommand_base: {
   >;
   getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
-export declare class CreateStreamCommand extends CreateStreamCommand_base {}
+export declare class CreateStreamCommand extends CreateStreamCommand_base {
+  protected static __types: {
+    api: {
+      input: CreateStreamInput;
+      output: {};
+    };
+    sdk: {
+      input: CreateStreamCommandInput;
+      output: CreateStreamCommandOutput;
+    };
+  };
+}

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

@@ -33,4 +33,15 @@ declare const DecreaseStreamRetentionPeriodCommand_base: {
   >;
   getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
-export declare class DecreaseStreamRetentionPeriodCommand extends DecreaseStreamRetentionPeriodCommand_base {}
+export declare class DecreaseStreamRetentionPeriodCommand extends DecreaseStreamRetentionPeriodCommand_base {
+  protected static __types: {
+    api: {
+      input: DecreaseStreamRetentionPeriodInput;
+      output: {};
+    };
+    sdk: {
+      input: DecreaseStreamRetentionPeriodCommandInput;
+      output: DecreaseStreamRetentionPeriodCommandOutput;
+    };
+  };
+}