@aws-sdk/client-kinesis 3.296.0 → 3.298.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (98) hide show
  1. package/dist-cjs/commands/AddTagsToStreamCommand.js +2 -3
  2. package/dist-cjs/commands/CreateStreamCommand.js +2 -3
  3. package/dist-cjs/commands/DecreaseStreamRetentionPeriodCommand.js +2 -3
  4. package/dist-cjs/commands/DeleteStreamCommand.js +2 -3
  5. package/dist-cjs/commands/DeregisterStreamConsumerCommand.js +2 -3
  6. package/dist-cjs/commands/DescribeLimitsCommand.js +2 -3
  7. package/dist-cjs/commands/DescribeStreamCommand.js +2 -3
  8. package/dist-cjs/commands/DescribeStreamConsumerCommand.js +2 -3
  9. package/dist-cjs/commands/DescribeStreamSummaryCommand.js +2 -3
  10. package/dist-cjs/commands/DisableEnhancedMonitoringCommand.js +2 -3
  11. package/dist-cjs/commands/EnableEnhancedMonitoringCommand.js +2 -3
  12. package/dist-cjs/commands/GetRecordsCommand.js +2 -3
  13. package/dist-cjs/commands/GetShardIteratorCommand.js +2 -3
  14. package/dist-cjs/commands/IncreaseStreamRetentionPeriodCommand.js +2 -3
  15. package/dist-cjs/commands/ListShardsCommand.js +2 -3
  16. package/dist-cjs/commands/ListStreamConsumersCommand.js +2 -3
  17. package/dist-cjs/commands/ListStreamsCommand.js +2 -3
  18. package/dist-cjs/commands/ListTagsForStreamCommand.js +2 -3
  19. package/dist-cjs/commands/MergeShardsCommand.js +2 -3
  20. package/dist-cjs/commands/PutRecordCommand.js +2 -3
  21. package/dist-cjs/commands/PutRecordsCommand.js +2 -3
  22. package/dist-cjs/commands/RegisterStreamConsumerCommand.js +2 -3
  23. package/dist-cjs/commands/RemoveTagsFromStreamCommand.js +2 -3
  24. package/dist-cjs/commands/SplitShardCommand.js +2 -3
  25. package/dist-cjs/commands/StartStreamEncryptionCommand.js +2 -3
  26. package/dist-cjs/commands/StopStreamEncryptionCommand.js +2 -3
  27. package/dist-cjs/commands/SubscribeToShardCommand.js +1 -1
  28. package/dist-cjs/commands/UpdateShardCountCommand.js +2 -3
  29. package/dist-cjs/commands/UpdateStreamModeCommand.js +2 -3
  30. package/dist-cjs/models/models_0.js +2 -251
  31. package/dist-es/commands/AddTagsToStreamCommand.js +2 -3
  32. package/dist-es/commands/CreateStreamCommand.js +2 -3
  33. package/dist-es/commands/DecreaseStreamRetentionPeriodCommand.js +2 -3
  34. package/dist-es/commands/DeleteStreamCommand.js +2 -3
  35. package/dist-es/commands/DeregisterStreamConsumerCommand.js +2 -3
  36. package/dist-es/commands/DescribeLimitsCommand.js +2 -3
  37. package/dist-es/commands/DescribeStreamCommand.js +2 -3
  38. package/dist-es/commands/DescribeStreamConsumerCommand.js +2 -3
  39. package/dist-es/commands/DescribeStreamSummaryCommand.js +2 -3
  40. package/dist-es/commands/DisableEnhancedMonitoringCommand.js +2 -3
  41. package/dist-es/commands/EnableEnhancedMonitoringCommand.js +2 -3
  42. package/dist-es/commands/GetRecordsCommand.js +2 -3
  43. package/dist-es/commands/GetShardIteratorCommand.js +2 -3
  44. package/dist-es/commands/IncreaseStreamRetentionPeriodCommand.js +2 -3
  45. package/dist-es/commands/ListShardsCommand.js +2 -3
  46. package/dist-es/commands/ListStreamConsumersCommand.js +2 -3
  47. package/dist-es/commands/ListStreamsCommand.js +2 -3
  48. package/dist-es/commands/ListTagsForStreamCommand.js +2 -3
  49. package/dist-es/commands/MergeShardsCommand.js +2 -3
  50. package/dist-es/commands/PutRecordCommand.js +2 -3
  51. package/dist-es/commands/PutRecordsCommand.js +2 -3
  52. package/dist-es/commands/RegisterStreamConsumerCommand.js +2 -3
  53. package/dist-es/commands/RemoveTagsFromStreamCommand.js +2 -3
  54. package/dist-es/commands/SplitShardCommand.js +2 -3
  55. package/dist-es/commands/StartStreamEncryptionCommand.js +2 -3
  56. package/dist-es/commands/StopStreamEncryptionCommand.js +2 -3
  57. package/dist-es/commands/SubscribeToShardCommand.js +2 -2
  58. package/dist-es/commands/UpdateShardCountCommand.js +2 -3
  59. package/dist-es/commands/UpdateStreamModeCommand.js +2 -3
  60. package/dist-es/models/models_0.js +1 -187
  61. package/dist-types/Kinesis.d.ts +30 -0
  62. package/dist-types/KinesisClient.d.ts +24 -4
  63. package/dist-types/commands/AddTagsToStreamCommand.d.ts +16 -0
  64. package/dist-types/commands/CreateStreamCommand.d.ts +16 -0
  65. package/dist-types/commands/DecreaseStreamRetentionPeriodCommand.d.ts +16 -0
  66. package/dist-types/commands/DeleteStreamCommand.d.ts +16 -0
  67. package/dist-types/commands/DeregisterStreamConsumerCommand.d.ts +16 -0
  68. package/dist-types/commands/DescribeLimitsCommand.d.ts +16 -0
  69. package/dist-types/commands/DescribeStreamCommand.d.ts +16 -0
  70. package/dist-types/commands/DescribeStreamConsumerCommand.d.ts +16 -0
  71. package/dist-types/commands/DescribeStreamSummaryCommand.d.ts +16 -0
  72. package/dist-types/commands/DisableEnhancedMonitoringCommand.d.ts +16 -0
  73. package/dist-types/commands/EnableEnhancedMonitoringCommand.d.ts +16 -0
  74. package/dist-types/commands/GetRecordsCommand.d.ts +16 -0
  75. package/dist-types/commands/GetShardIteratorCommand.d.ts +16 -0
  76. package/dist-types/commands/IncreaseStreamRetentionPeriodCommand.d.ts +16 -0
  77. package/dist-types/commands/ListShardsCommand.d.ts +16 -0
  78. package/dist-types/commands/ListStreamConsumersCommand.d.ts +16 -0
  79. package/dist-types/commands/ListStreamsCommand.d.ts +16 -0
  80. package/dist-types/commands/ListTagsForStreamCommand.d.ts +16 -0
  81. package/dist-types/commands/MergeShardsCommand.d.ts +16 -0
  82. package/dist-types/commands/PutRecordCommand.d.ts +16 -0
  83. package/dist-types/commands/PutRecordsCommand.d.ts +16 -0
  84. package/dist-types/commands/RegisterStreamConsumerCommand.d.ts +16 -0
  85. package/dist-types/commands/RemoveTagsFromStreamCommand.d.ts +16 -0
  86. package/dist-types/commands/SplitShardCommand.d.ts +16 -0
  87. package/dist-types/commands/StartStreamEncryptionCommand.d.ts +16 -0
  88. package/dist-types/commands/StopStreamEncryptionCommand.d.ts +16 -0
  89. package/dist-types/commands/SubscribeToShardCommand.d.ts +16 -0
  90. package/dist-types/commands/UpdateShardCountCommand.d.ts +16 -0
  91. package/dist-types/commands/UpdateStreamModeCommand.d.ts +16 -0
  92. package/dist-types/models/KinesisServiceException.d.ts +2 -0
  93. package/dist-types/models/models_0.d.ts +147 -248
  94. package/dist-types/pagination/Interfaces.d.ts +3 -0
  95. package/dist-types/pagination/ListStreamConsumersPaginator.d.ts +3 -0
  96. package/dist-types/pagination/ListStreamsPaginator.d.ts +3 -0
  97. package/dist-types/ts3.4/models/models_0.d.ts +0 -172
  98. package/package.json +4 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
5
5
  import { GetRecordsInput, GetRecordsOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetRecordsCommand}.
8
10
  */
9
11
  export interface GetRecordsCommandInput extends GetRecordsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetRecordsCommand}.
13
17
  */
14
18
  export interface GetRecordsCommandOutput extends GetRecordsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets data records from a Kinesis data stream's shard.</p>
18
23
  * <note>
19
24
  * <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input
@@ -76,6 +81,8 @@ export interface GetRecordsCommandOutput extends GetRecordsOutput, __MetadataBea
76
81
  * const response = await client.send(command);
77
82
  * ```
78
83
  *
84
+ * @param GetRecordsCommandInput - {@link GetRecordsCommandInput}
85
+ * @returns {@link GetRecordsCommandOutput}
79
86
  * @see {@link GetRecordsCommandInput} for command's `input` shape.
80
87
  * @see {@link GetRecordsCommandOutput} for command's `response` shape.
81
88
  * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
@@ -134,11 +141,20 @@ export interface GetRecordsCommandOutput extends GetRecordsOutput, __MetadataBea
134
141
  export declare class GetRecordsCommand extends $Command<GetRecordsCommandInput, GetRecordsCommandOutput, KinesisClientResolvedConfig> {
135
142
  readonly input: GetRecordsCommandInput;
136
143
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
144
+ /**
145
+ * @public
146
+ */
137
147
  constructor(input: GetRecordsCommandInput);
138
148
  /**
139
149
  * @internal
140
150
  */
141
151
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetRecordsCommandInput, GetRecordsCommandOutput>;
152
+ /**
153
+ * @internal
154
+ */
142
155
  private serialize;
156
+ /**
157
+ * @internal
158
+ */
143
159
  private deserialize;
144
160
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
5
5
  import { GetShardIteratorInput, GetShardIteratorOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetShardIteratorCommand}.
8
10
  */
9
11
  export interface GetShardIteratorCommandInput extends GetShardIteratorInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetShardIteratorCommand}.
13
17
  */
14
18
  export interface GetShardIteratorCommandOutput extends GetShardIteratorOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it is
18
23
  * returned to the requester.</p>
19
24
  * <note>
@@ -62,6 +67,8 @@ export interface GetShardIteratorCommandOutput extends GetShardIteratorOutput, _
62
67
  * const response = await client.send(command);
63
68
  * ```
64
69
  *
70
+ * @param GetShardIteratorCommandInput - {@link GetShardIteratorCommandInput}
71
+ * @returns {@link GetShardIteratorCommandOutput}
65
72
  * @see {@link GetShardIteratorCommandInput} for command's `input` shape.
66
73
  * @see {@link GetShardIteratorCommandOutput} for command's `response` shape.
67
74
  * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
@@ -90,11 +97,20 @@ export interface GetShardIteratorCommandOutput extends GetShardIteratorOutput, _
90
97
  export declare class GetShardIteratorCommand extends $Command<GetShardIteratorCommandInput, GetShardIteratorCommandOutput, KinesisClientResolvedConfig> {
91
98
  readonly input: GetShardIteratorCommandInput;
92
99
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
100
+ /**
101
+ * @public
102
+ */
93
103
  constructor(input: GetShardIteratorCommandInput);
94
104
  /**
95
105
  * @internal
96
106
  */
97
107
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetShardIteratorCommandInput, GetShardIteratorCommandOutput>;
108
+ /**
109
+ * @internal
110
+ */
98
111
  private serialize;
112
+ /**
113
+ * @internal
114
+ */
99
115
  private deserialize;
100
116
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
5
5
  import { IncreaseStreamRetentionPeriodInput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link IncreaseStreamRetentionPeriodCommand}.
8
10
  */
9
11
  export interface IncreaseStreamRetentionPeriodCommandInput extends IncreaseStreamRetentionPeriodInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link IncreaseStreamRetentionPeriodCommand}.
13
17
  */
14
18
  export interface IncreaseStreamRetentionPeriodCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Increases the Kinesis data stream's retention period, which is the length of time data
18
23
  * records are accessible after they are added to the stream. The maximum value of a
19
24
  * stream's retention period is 8760 hours (365 days).</p>
@@ -37,6 +42,8 @@ export interface IncreaseStreamRetentionPeriodCommandOutput extends __MetadataBe
37
42
  * const response = await client.send(command);
38
43
  * ```
39
44
  *
45
+ * @param IncreaseStreamRetentionPeriodCommandInput - {@link IncreaseStreamRetentionPeriodCommandInput}
46
+ * @returns {@link IncreaseStreamRetentionPeriodCommandOutput}
40
47
  * @see {@link IncreaseStreamRetentionPeriodCommandInput} for command's `input` shape.
41
48
  * @see {@link IncreaseStreamRetentionPeriodCommandOutput} for command's `response` shape.
42
49
  * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
@@ -66,11 +73,20 @@ export interface IncreaseStreamRetentionPeriodCommandOutput extends __MetadataBe
66
73
  export declare class IncreaseStreamRetentionPeriodCommand extends $Command<IncreaseStreamRetentionPeriodCommandInput, IncreaseStreamRetentionPeriodCommandOutput, KinesisClientResolvedConfig> {
67
74
  readonly input: IncreaseStreamRetentionPeriodCommandInput;
68
75
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
76
+ /**
77
+ * @public
78
+ */
69
79
  constructor(input: IncreaseStreamRetentionPeriodCommandInput);
70
80
  /**
71
81
  * @internal
72
82
  */
73
83
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisClientResolvedConfig, options?: __HttpHandlerOptions): Handler<IncreaseStreamRetentionPeriodCommandInput, IncreaseStreamRetentionPeriodCommandOutput>;
84
+ /**
85
+ * @internal
86
+ */
74
87
  private serialize;
88
+ /**
89
+ * @internal
90
+ */
75
91
  private deserialize;
76
92
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
5
5
  import { ListShardsInput, ListShardsOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListShardsCommand}.
8
10
  */
9
11
  export interface ListShardsCommandInput extends ListShardsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListShardsCommand}.
13
17
  */
14
18
  export interface ListShardsCommandOutput extends ListShardsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the shards in a stream and provides information about each shard. This operation
18
23
  * has a limit of 1000 transactions per second per data stream.</p>
19
24
  * <note>
@@ -39,6 +44,8 @@ export interface ListShardsCommandOutput extends ListShardsOutput, __MetadataBea
39
44
  * const response = await client.send(command);
40
45
  * ```
41
46
  *
47
+ * @param ListShardsCommandInput - {@link ListShardsCommandInput}
48
+ * @returns {@link ListShardsCommandOutput}
42
49
  * @see {@link ListShardsCommandInput} for command's `input` shape.
43
50
  * @see {@link ListShardsCommandOutput} for command's `response` shape.
44
51
  * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
@@ -71,11 +78,20 @@ export interface ListShardsCommandOutput extends ListShardsOutput, __MetadataBea
71
78
  export declare class ListShardsCommand extends $Command<ListShardsCommandInput, ListShardsCommandOutput, KinesisClientResolvedConfig> {
72
79
  readonly input: ListShardsCommandInput;
73
80
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
81
+ /**
82
+ * @public
83
+ */
74
84
  constructor(input: ListShardsCommandInput);
75
85
  /**
76
86
  * @internal
77
87
  */
78
88
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListShardsCommandInput, ListShardsCommandOutput>;
89
+ /**
90
+ * @internal
91
+ */
79
92
  private serialize;
93
+ /**
94
+ * @internal
95
+ */
80
96
  private deserialize;
81
97
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
5
5
  import { ListStreamConsumersInput, ListStreamConsumersOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListStreamConsumersCommand}.
8
10
  */
9
11
  export interface ListStreamConsumersCommandInput extends ListStreamConsumersInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListStreamConsumersCommand}.
13
17
  */
14
18
  export interface ListStreamConsumersCommandOutput extends ListStreamConsumersOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the consumers registered to receive data from a stream using enhanced fan-out,
18
23
  * and provides information about each consumer.</p>
19
24
  * <p>This operation has a limit of 5 transactions per second per stream.</p>
@@ -27,6 +32,8 @@ export interface ListStreamConsumersCommandOutput extends ListStreamConsumersOut
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param ListStreamConsumersCommandInput - {@link ListStreamConsumersCommandInput}
36
+ * @returns {@link ListStreamConsumersCommandOutput}
30
37
  * @see {@link ListStreamConsumersCommandInput} for command's `input` shape.
31
38
  * @see {@link ListStreamConsumersCommandOutput} for command's `response` shape.
32
39
  * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
@@ -55,11 +62,20 @@ export interface ListStreamConsumersCommandOutput extends ListStreamConsumersOut
55
62
  export declare class ListStreamConsumersCommand extends $Command<ListStreamConsumersCommandInput, ListStreamConsumersCommandOutput, KinesisClientResolvedConfig> {
56
63
  readonly input: ListStreamConsumersCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: ListStreamConsumersCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListStreamConsumersCommandInput, ListStreamConsumersCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
5
5
  import { ListStreamsInput, ListStreamsOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListStreamsCommand}.
8
10
  */
9
11
  export interface ListStreamsCommandInput extends ListStreamsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListStreamsCommand}.
13
17
  */
14
18
  export interface ListStreamsCommandOutput extends ListStreamsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists your Kinesis data streams.</p>
18
23
  * <p>The number of streams may be too large to return from a single call to
19
24
  * <code>ListStreams</code>. You can limit the number of returned streams using the
@@ -40,6 +45,8 @@ export interface ListStreamsCommandOutput extends ListStreamsOutput, __MetadataB
40
45
  * const response = await client.send(command);
41
46
  * ```
42
47
  *
48
+ * @param ListStreamsCommandInput - {@link ListStreamsCommandInput}
49
+ * @returns {@link ListStreamsCommandOutput}
43
50
  * @see {@link ListStreamsCommandInput} for command's `input` shape.
44
51
  * @see {@link ListStreamsCommandOutput} for command's `response` shape.
45
52
  * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
@@ -60,11 +67,20 @@ export interface ListStreamsCommandOutput extends ListStreamsOutput, __MetadataB
60
67
  export declare class ListStreamsCommand extends $Command<ListStreamsCommandInput, ListStreamsCommandOutput, KinesisClientResolvedConfig> {
61
68
  readonly input: ListStreamsCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: ListStreamsCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListStreamsCommandInput, ListStreamsCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
5
5
  import { ListTagsForStreamInput, ListTagsForStreamOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsForStreamCommand}.
8
10
  */
9
11
  export interface ListTagsForStreamCommandInput extends ListTagsForStreamInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsForStreamCommand}.
13
17
  */
14
18
  export interface ListTagsForStreamCommandOutput extends ListTagsForStreamOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the tags for the specified Kinesis data stream. This operation has a limit of
18
23
  * five transactions per second per account.</p>
19
24
  * <note>
@@ -30,6 +35,8 @@ export interface ListTagsForStreamCommandOutput extends ListTagsForStreamOutput,
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param ListTagsForStreamCommandInput - {@link ListTagsForStreamCommandInput}
39
+ * @returns {@link ListTagsForStreamCommandOutput}
33
40
  * @see {@link ListTagsForStreamCommandInput} for command's `input` shape.
34
41
  * @see {@link ListTagsForStreamCommandOutput} for command's `response` shape.
35
42
  * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
@@ -55,11 +62,20 @@ export interface ListTagsForStreamCommandOutput extends ListTagsForStreamOutput,
55
62
  export declare class ListTagsForStreamCommand extends $Command<ListTagsForStreamCommandInput, ListTagsForStreamCommandOutput, KinesisClientResolvedConfig> {
56
63
  readonly input: ListTagsForStreamCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: ListTagsForStreamCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForStreamCommandInput, ListTagsForStreamCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
5
5
  import { MergeShardsInput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link MergeShardsCommand}.
8
10
  */
9
11
  export interface MergeShardsCommandInput extends MergeShardsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link MergeShardsCommand}.
13
17
  */
14
18
  export interface MergeShardsCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Merges two adjacent shards in a Kinesis data stream and combines them into a single
18
23
  * shard to reduce the stream's capacity to ingest and transport data. This API is only
19
24
  * supported for the data streams with the provisioned capacity mode. Two shards are
@@ -65,6 +70,8 @@ export interface MergeShardsCommandOutput extends __MetadataBearer {
65
70
  * const response = await client.send(command);
66
71
  * ```
67
72
  *
73
+ * @param MergeShardsCommandInput - {@link MergeShardsCommandInput}
74
+ * @returns {@link MergeShardsCommandOutput}
68
75
  * @see {@link MergeShardsCommandInput} for command's `input` shape.
69
76
  * @see {@link MergeShardsCommandOutput} for command's `response` shape.
70
77
  * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
@@ -99,11 +106,20 @@ export interface MergeShardsCommandOutput extends __MetadataBearer {
99
106
  export declare class MergeShardsCommand extends $Command<MergeShardsCommandInput, MergeShardsCommandOutput, KinesisClientResolvedConfig> {
100
107
  readonly input: MergeShardsCommandInput;
101
108
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
109
+ /**
110
+ * @public
111
+ */
102
112
  constructor(input: MergeShardsCommandInput);
103
113
  /**
104
114
  * @internal
105
115
  */
106
116
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisClientResolvedConfig, options?: __HttpHandlerOptions): Handler<MergeShardsCommandInput, MergeShardsCommandOutput>;
117
+ /**
118
+ * @internal
119
+ */
107
120
  private serialize;
121
+ /**
122
+ * @internal
123
+ */
108
124
  private deserialize;
109
125
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
5
5
  import { PutRecordInput, PutRecordOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutRecordCommand}.
8
10
  */
9
11
  export interface PutRecordCommandInput extends PutRecordInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutRecordCommand}.
13
17
  */
14
18
  export interface PutRecordCommandOutput extends PutRecordOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Writes a single data record into an Amazon Kinesis data stream. Call
18
23
  * <code>PutRecord</code> to send data into the stream for real-time ingestion and
19
24
  * subsequent processing, one record at a time. Each shard can support writes up to 1,000
@@ -64,6 +69,8 @@ export interface PutRecordCommandOutput extends PutRecordOutput, __MetadataBeare
64
69
  * const response = await client.send(command);
65
70
  * ```
66
71
  *
72
+ * @param PutRecordCommandInput - {@link PutRecordCommandInput}
73
+ * @returns {@link PutRecordCommandOutput}
67
74
  * @see {@link PutRecordCommandInput} for command's `input` shape.
68
75
  * @see {@link PutRecordCommandOutput} for command's `response` shape.
69
76
  * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
@@ -119,11 +126,20 @@ export interface PutRecordCommandOutput extends PutRecordOutput, __MetadataBeare
119
126
  export declare class PutRecordCommand extends $Command<PutRecordCommandInput, PutRecordCommandOutput, KinesisClientResolvedConfig> {
120
127
  readonly input: PutRecordCommandInput;
121
128
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
129
+ /**
130
+ * @public
131
+ */
122
132
  constructor(input: PutRecordCommandInput);
123
133
  /**
124
134
  * @internal
125
135
  */
126
136
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutRecordCommandInput, PutRecordCommandOutput>;
137
+ /**
138
+ * @internal
139
+ */
127
140
  private serialize;
141
+ /**
142
+ * @internal
143
+ */
128
144
  private deserialize;
129
145
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
5
5
  import { PutRecordsInput, PutRecordsOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutRecordsCommand}.
8
10
  */
9
11
  export interface PutRecordsCommandInput extends PutRecordsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutRecordsCommand}.
13
17
  */
14
18
  export interface PutRecordsCommandOutput extends PutRecordsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Writes multiple data records into a Kinesis data stream in a single call (also
18
23
  * referred to as a <code>PutRecords</code> request). Use this operation to send data into
19
24
  * the stream for data ingestion and processing. </p>
@@ -84,6 +89,8 @@ export interface PutRecordsCommandOutput extends PutRecordsOutput, __MetadataBea
84
89
  * const response = await client.send(command);
85
90
  * ```
86
91
  *
92
+ * @param PutRecordsCommandInput - {@link PutRecordsCommandInput}
93
+ * @returns {@link PutRecordsCommandOutput}
87
94
  * @see {@link PutRecordsCommandInput} for command's `input` shape.
88
95
  * @see {@link PutRecordsCommandOutput} for command's `response` shape.
89
96
  * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
@@ -139,11 +146,20 @@ export interface PutRecordsCommandOutput extends PutRecordsOutput, __MetadataBea
139
146
  export declare class PutRecordsCommand extends $Command<PutRecordsCommandInput, PutRecordsCommandOutput, KinesisClientResolvedConfig> {
140
147
  readonly input: PutRecordsCommandInput;
141
148
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
149
+ /**
150
+ * @public
151
+ */
142
152
  constructor(input: PutRecordsCommandInput);
143
153
  /**
144
154
  * @internal
145
155
  */
146
156
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutRecordsCommandInput, PutRecordsCommandOutput>;
157
+ /**
158
+ * @internal
159
+ */
147
160
  private serialize;
161
+ /**
162
+ * @internal
163
+ */
148
164
  private deserialize;
149
165
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
5
5
  import { RegisterStreamConsumerInput, RegisterStreamConsumerOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RegisterStreamConsumerCommand}.
8
10
  */
9
11
  export interface RegisterStreamConsumerCommandInput extends RegisterStreamConsumerInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RegisterStreamConsumerCommand}.
13
17
  */
14
18
  export interface RegisterStreamConsumerCommandOutput extends RegisterStreamConsumerOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Registers a consumer with a Kinesis data stream. When you use this operation, the
18
23
  * consumer you register can then call <a>SubscribeToShard</a> to receive data
19
24
  * from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every
@@ -38,6 +43,8 @@ export interface RegisterStreamConsumerCommandOutput extends RegisterStreamConsu
38
43
  * const response = await client.send(command);
39
44
  * ```
40
45
  *
46
+ * @param RegisterStreamConsumerCommandInput - {@link RegisterStreamConsumerCommandInput}
47
+ * @returns {@link RegisterStreamConsumerCommandOutput}
41
48
  * @see {@link RegisterStreamConsumerCommandInput} for command's `input` shape.
42
49
  * @see {@link RegisterStreamConsumerCommandOutput} for command's `response` shape.
43
50
  * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
@@ -63,11 +70,20 @@ export interface RegisterStreamConsumerCommandOutput extends RegisterStreamConsu
63
70
  export declare class RegisterStreamConsumerCommand extends $Command<RegisterStreamConsumerCommandInput, RegisterStreamConsumerCommandOutput, KinesisClientResolvedConfig> {
64
71
  readonly input: RegisterStreamConsumerCommandInput;
65
72
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
66
76
  constructor(input: RegisterStreamConsumerCommandInput);
67
77
  /**
68
78
  * @internal
69
79
  */
70
80
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RegisterStreamConsumerCommandInput, RegisterStreamConsumerCommandOutput>;
81
+ /**
82
+ * @internal
83
+ */
71
84
  private serialize;
85
+ /**
86
+ * @internal
87
+ */
72
88
  private deserialize;
73
89
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
5
5
  import { RemoveTagsFromStreamInput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RemoveTagsFromStreamCommand}.
8
10
  */
9
11
  export interface RemoveTagsFromStreamCommandInput extends RemoveTagsFromStreamInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RemoveTagsFromStreamCommand}.
13
17
  */
14
18
  export interface RemoveTagsFromStreamCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes tags from the specified Kinesis data stream. Removed tags are deleted and
18
23
  * cannot be recovered after this operation successfully completes.</p>
19
24
  * <note>
@@ -34,6 +39,8 @@ export interface RemoveTagsFromStreamCommandOutput extends __MetadataBearer {
34
39
  * const response = await client.send(command);
35
40
  * ```
36
41
  *
42
+ * @param RemoveTagsFromStreamCommandInput - {@link RemoveTagsFromStreamCommandInput}
43
+ * @returns {@link RemoveTagsFromStreamCommandOutput}
37
44
  * @see {@link RemoveTagsFromStreamCommandInput} for command's `input` shape.
38
45
  * @see {@link RemoveTagsFromStreamCommandOutput} for command's `response` shape.
39
46
  * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
@@ -63,11 +70,20 @@ export interface RemoveTagsFromStreamCommandOutput extends __MetadataBearer {
63
70
  export declare class RemoveTagsFromStreamCommand extends $Command<RemoveTagsFromStreamCommandInput, RemoveTagsFromStreamCommandOutput, KinesisClientResolvedConfig> {
64
71
  readonly input: RemoveTagsFromStreamCommandInput;
65
72
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
66
76
  constructor(input: RemoveTagsFromStreamCommandInput);
67
77
  /**
68
78
  * @internal
69
79
  */
70
80
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RemoveTagsFromStreamCommandInput, RemoveTagsFromStreamCommandOutput>;
81
+ /**
82
+ * @internal
83
+ */
71
84
  private serialize;
85
+ /**
86
+ * @internal
87
+ */
72
88
  private deserialize;
73
89
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
5
5
  import { SplitShardInput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SplitShardCommand}.
8
10
  */
9
11
  export interface SplitShardCommandInput extends SplitShardInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SplitShardCommand}.
13
17
  */
14
18
  export interface SplitShardCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Splits a shard into two new shards in the Kinesis data stream, to increase the
18
23
  * stream's capacity to ingest and transport data. <code>SplitShard</code> is called when
19
24
  * there is a need to increase the overall capacity of a stream because of an expected
@@ -69,6 +74,8 @@ export interface SplitShardCommandOutput extends __MetadataBearer {
69
74
  * const response = await client.send(command);
70
75
  * ```
71
76
  *
77
+ * @param SplitShardCommandInput - {@link SplitShardCommandInput}
78
+ * @returns {@link SplitShardCommandOutput}
72
79
  * @see {@link SplitShardCommandInput} for command's `input` shape.
73
80
  * @see {@link SplitShardCommandOutput} for command's `response` shape.
74
81
  * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
@@ -103,11 +110,20 @@ export interface SplitShardCommandOutput extends __MetadataBearer {
103
110
  export declare class SplitShardCommand extends $Command<SplitShardCommandInput, SplitShardCommandOutput, KinesisClientResolvedConfig> {
104
111
  readonly input: SplitShardCommandInput;
105
112
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
113
+ /**
114
+ * @public
115
+ */
106
116
  constructor(input: SplitShardCommandInput);
107
117
  /**
108
118
  * @internal
109
119
  */
110
120
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SplitShardCommandInput, SplitShardCommandOutput>;
121
+ /**
122
+ * @internal
123
+ */
111
124
  private serialize;
125
+ /**
126
+ * @internal
127
+ */
112
128
  private deserialize;
113
129
  }