@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
@@ -38,15 +38,24 @@ import { SubscribeToShardCommandInput, SubscribeToShardCommandOutput } from "./c
38
38
  import { UpdateShardCountCommandInput, UpdateShardCountCommandOutput } from "./commands/UpdateShardCountCommand";
39
39
  import { UpdateStreamModeCommandInput, UpdateStreamModeCommandOutput } from "./commands/UpdateStreamModeCommand";
40
40
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
41
+ /**
42
+ * @public
43
+ */
41
44
  export type ServiceInputTypes = AddTagsToStreamCommandInput | CreateStreamCommandInput | DecreaseStreamRetentionPeriodCommandInput | DeleteStreamCommandInput | DeregisterStreamConsumerCommandInput | DescribeLimitsCommandInput | DescribeStreamCommandInput | DescribeStreamConsumerCommandInput | DescribeStreamSummaryCommandInput | DisableEnhancedMonitoringCommandInput | EnableEnhancedMonitoringCommandInput | GetRecordsCommandInput | GetShardIteratorCommandInput | IncreaseStreamRetentionPeriodCommandInput | ListShardsCommandInput | ListStreamConsumersCommandInput | ListStreamsCommandInput | ListTagsForStreamCommandInput | MergeShardsCommandInput | PutRecordCommandInput | PutRecordsCommandInput | RegisterStreamConsumerCommandInput | RemoveTagsFromStreamCommandInput | SplitShardCommandInput | StartStreamEncryptionCommandInput | StopStreamEncryptionCommandInput | SubscribeToShardCommandInput | UpdateShardCountCommandInput | UpdateStreamModeCommandInput;
45
+ /**
46
+ * @public
47
+ */
42
48
  export type ServiceOutputTypes = AddTagsToStreamCommandOutput | CreateStreamCommandOutput | DecreaseStreamRetentionPeriodCommandOutput | DeleteStreamCommandOutput | DeregisterStreamConsumerCommandOutput | DescribeLimitsCommandOutput | DescribeStreamCommandOutput | DescribeStreamConsumerCommandOutput | DescribeStreamSummaryCommandOutput | DisableEnhancedMonitoringCommandOutput | EnableEnhancedMonitoringCommandOutput | GetRecordsCommandOutput | GetShardIteratorCommandOutput | IncreaseStreamRetentionPeriodCommandOutput | ListShardsCommandOutput | ListStreamConsumersCommandOutput | ListStreamsCommandOutput | ListTagsForStreamCommandOutput | MergeShardsCommandOutput | PutRecordCommandOutput | PutRecordsCommandOutput | RegisterStreamConsumerCommandOutput | RemoveTagsFromStreamCommandOutput | SplitShardCommandOutput | StartStreamEncryptionCommandOutput | StopStreamEncryptionCommandOutput | SubscribeToShardCommandOutput | UpdateShardCountCommandOutput | UpdateStreamModeCommandOutput;
49
+ /**
50
+ * @public
51
+ */
43
52
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
44
53
  /**
45
54
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
46
55
  */
47
56
  requestHandler?: __HttpHandler;
48
57
  /**
49
- * A constructor for a class implementing the {@link __Checksum} interface
58
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
50
59
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
51
60
  * @internal
52
61
  */
@@ -140,23 +149,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
140
149
  */
141
150
  eventStreamSerdeProvider?: __EventStreamSerdeProvider;
142
151
  /**
143
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
152
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
144
153
  */
145
154
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
146
155
  }
156
+ /**
157
+ * @public
158
+ */
147
159
  type KinesisClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & EventStreamSerdeInputConfig & ClientInputEndpointParameters;
148
160
  /**
149
- * The configuration interface of KinesisClient class constructor that set the region, credentials and other options.
161
+ * @public
162
+ *
163
+ * The configuration interface of KinesisClient class constructor that set the region, credentials and other options.
150
164
  */
151
165
  export interface KinesisClientConfig extends KinesisClientConfigType {
152
166
  }
167
+ /**
168
+ * @public
169
+ */
153
170
  type KinesisClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & EventStreamSerdeResolvedConfig & ClientResolvedEndpointParameters;
154
171
  /**
155
- * The resolved configuration interface of KinesisClient class. This is resolved and normalized from the {@link KinesisClientConfig | constructor configuration interface}.
172
+ * @public
173
+ *
174
+ * The resolved configuration interface of KinesisClient class. This is resolved and normalized from the {@link KinesisClientConfig | constructor configuration interface}.
156
175
  */
157
176
  export interface KinesisClientResolvedConfig extends KinesisClientResolvedConfigType {
158
177
  }
159
178
  /**
179
+ * @public
160
180
  * <fullname>Amazon Kinesis Data Streams Service API Reference</fullname>
161
181
  * <p>Amazon Kinesis Data Streams is a managed service that scales elastically for real-time
162
182
  * processing of streaming big data.</p>
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
5
5
  import { AddTagsToStreamInput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AddTagsToStreamCommand}.
8
10
  */
9
11
  export interface AddTagsToStreamCommandInput extends AddTagsToStreamInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AddTagsToStreamCommand}.
13
17
  */
14
18
  export interface AddTagsToStreamCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Adds or updates tags for the specified Kinesis data stream. You can assign up to 50
18
23
  * tags to a data stream.</p>
19
24
  * <note>
@@ -35,6 +40,8 @@ export interface AddTagsToStreamCommandOutput extends __MetadataBearer {
35
40
  * const response = await client.send(command);
36
41
  * ```
37
42
  *
43
+ * @param AddTagsToStreamCommandInput - {@link AddTagsToStreamCommandInput}
44
+ * @returns {@link AddTagsToStreamCommandOutput}
38
45
  * @see {@link AddTagsToStreamCommandInput} for command's `input` shape.
39
46
  * @see {@link AddTagsToStreamCommandOutput} for command's `response` shape.
40
47
  * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
@@ -64,11 +71,20 @@ export interface AddTagsToStreamCommandOutput extends __MetadataBearer {
64
71
  export declare class AddTagsToStreamCommand extends $Command<AddTagsToStreamCommandInput, AddTagsToStreamCommandOutput, KinesisClientResolvedConfig> {
65
72
  readonly input: AddTagsToStreamCommandInput;
66
73
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
74
+ /**
75
+ * @public
76
+ */
67
77
  constructor(input: AddTagsToStreamCommandInput);
68
78
  /**
69
79
  * @internal
70
80
  */
71
81
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AddTagsToStreamCommandInput, AddTagsToStreamCommandOutput>;
82
+ /**
83
+ * @internal
84
+ */
72
85
  private serialize;
86
+ /**
87
+ * @internal
88
+ */
73
89
  private deserialize;
74
90
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
5
5
  import { CreateStreamInput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateStreamCommand}.
8
10
  */
9
11
  export interface CreateStreamCommandInput extends CreateStreamInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateStreamCommand}.
13
17
  */
14
18
  export interface CreateStreamCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a Kinesis data stream. A stream captures and transports data records that are
18
23
  * continuously emitted from different data sources or <i>producers</i>.
19
24
  * Scale-out within a stream is explicitly supported by means of shards, which are uniquely
@@ -68,6 +73,8 @@ export interface CreateStreamCommandOutput extends __MetadataBearer {
68
73
  * const response = await client.send(command);
69
74
  * ```
70
75
  *
76
+ * @param CreateStreamCommandInput - {@link CreateStreamCommandInput}
77
+ * @returns {@link CreateStreamCommandOutput}
71
78
  * @see {@link CreateStreamCommandInput} for command's `input` shape.
72
79
  * @see {@link CreateStreamCommandOutput} for command's `response` shape.
73
80
  * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
@@ -89,11 +96,20 @@ export interface CreateStreamCommandOutput extends __MetadataBearer {
89
96
  export declare class CreateStreamCommand extends $Command<CreateStreamCommandInput, CreateStreamCommandOutput, KinesisClientResolvedConfig> {
90
97
  readonly input: CreateStreamCommandInput;
91
98
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
99
+ /**
100
+ * @public
101
+ */
92
102
  constructor(input: CreateStreamCommandInput);
93
103
  /**
94
104
  * @internal
95
105
  */
96
106
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateStreamCommandInput, CreateStreamCommandOutput>;
107
+ /**
108
+ * @internal
109
+ */
97
110
  private serialize;
111
+ /**
112
+ * @internal
113
+ */
98
114
  private deserialize;
99
115
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
5
5
  import { DecreaseStreamRetentionPeriodInput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DecreaseStreamRetentionPeriodCommand}.
8
10
  */
9
11
  export interface DecreaseStreamRetentionPeriodCommandInput extends DecreaseStreamRetentionPeriodInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DecreaseStreamRetentionPeriodCommand}.
13
17
  */
14
18
  export interface DecreaseStreamRetentionPeriodCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Decreases 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 minimum value of a
19
24
  * stream's retention period is 24 hours.</p>
@@ -34,6 +39,8 @@ export interface DecreaseStreamRetentionPeriodCommandOutput extends __MetadataBe
34
39
  * const response = await client.send(command);
35
40
  * ```
36
41
  *
42
+ * @param DecreaseStreamRetentionPeriodCommandInput - {@link DecreaseStreamRetentionPeriodCommandInput}
43
+ * @returns {@link DecreaseStreamRetentionPeriodCommandOutput}
37
44
  * @see {@link DecreaseStreamRetentionPeriodCommandInput} for command's `input` shape.
38
45
  * @see {@link DecreaseStreamRetentionPeriodCommandOutput} for command's `response` shape.
39
46
  * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
@@ -63,11 +70,20 @@ export interface DecreaseStreamRetentionPeriodCommandOutput extends __MetadataBe
63
70
  export declare class DecreaseStreamRetentionPeriodCommand extends $Command<DecreaseStreamRetentionPeriodCommandInput, DecreaseStreamRetentionPeriodCommandOutput, KinesisClientResolvedConfig> {
64
71
  readonly input: DecreaseStreamRetentionPeriodCommandInput;
65
72
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
66
76
  constructor(input: DecreaseStreamRetentionPeriodCommandInput);
67
77
  /**
68
78
  * @internal
69
79
  */
70
80
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DecreaseStreamRetentionPeriodCommandInput, DecreaseStreamRetentionPeriodCommandOutput>;
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 { DeleteStreamInput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteStreamCommand}.
8
10
  */
9
11
  export interface DeleteStreamCommandInput extends DeleteStreamInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteStreamCommand}.
13
17
  */
14
18
  export interface DeleteStreamCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a Kinesis data stream and all its shards and data. You must shut down any
18
23
  * applications that are operating on the stream before you delete the stream. If an
19
24
  * application attempts to operate on a deleted stream, it receives the exception
@@ -47,6 +52,8 @@ export interface DeleteStreamCommandOutput extends __MetadataBearer {
47
52
  * const response = await client.send(command);
48
53
  * ```
49
54
  *
55
+ * @param DeleteStreamCommandInput - {@link DeleteStreamCommandInput}
56
+ * @returns {@link DeleteStreamCommandOutput}
50
57
  * @see {@link DeleteStreamCommandInput} for command's `input` shape.
51
58
  * @see {@link DeleteStreamCommandOutput} for command's `response` shape.
52
59
  * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
@@ -76,11 +83,20 @@ export interface DeleteStreamCommandOutput extends __MetadataBearer {
76
83
  export declare class DeleteStreamCommand extends $Command<DeleteStreamCommandInput, DeleteStreamCommandOutput, KinesisClientResolvedConfig> {
77
84
  readonly input: DeleteStreamCommandInput;
78
85
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
86
+ /**
87
+ * @public
88
+ */
79
89
  constructor(input: DeleteStreamCommandInput);
80
90
  /**
81
91
  * @internal
82
92
  */
83
93
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteStreamCommandInput, DeleteStreamCommandOutput>;
94
+ /**
95
+ * @internal
96
+ */
84
97
  private serialize;
98
+ /**
99
+ * @internal
100
+ */
85
101
  private deserialize;
86
102
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
5
5
  import { DeregisterStreamConsumerInput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeregisterStreamConsumerCommand}.
8
10
  */
9
11
  export interface DeregisterStreamConsumerCommandInput extends DeregisterStreamConsumerInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeregisterStreamConsumerCommand}.
13
17
  */
14
18
  export interface DeregisterStreamConsumerCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>To deregister a consumer, provide its ARN. Alternatively, you can provide the ARN of
18
23
  * the data stream and the name you gave the consumer when you registered it. You may also
19
24
  * provide all three parameters, as long as they don't conflict with each other. If you
@@ -32,6 +37,8 @@ export interface DeregisterStreamConsumerCommandOutput extends __MetadataBearer
32
37
  * const response = await client.send(command);
33
38
  * ```
34
39
  *
40
+ * @param DeregisterStreamConsumerCommandInput - {@link DeregisterStreamConsumerCommandInput}
41
+ * @returns {@link DeregisterStreamConsumerCommandOutput}
35
42
  * @see {@link DeregisterStreamConsumerCommandInput} for command's `input` shape.
36
43
  * @see {@link DeregisterStreamConsumerCommandOutput} for command's `response` shape.
37
44
  * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
@@ -53,11 +60,20 @@ export interface DeregisterStreamConsumerCommandOutput extends __MetadataBearer
53
60
  export declare class DeregisterStreamConsumerCommand extends $Command<DeregisterStreamConsumerCommandInput, DeregisterStreamConsumerCommandOutput, KinesisClientResolvedConfig> {
54
61
  readonly input: DeregisterStreamConsumerCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: DeregisterStreamConsumerCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeregisterStreamConsumerCommandInput, DeregisterStreamConsumerCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
5
5
  import { DescribeLimitsInput, DescribeLimitsOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeLimitsCommand}.
8
10
  */
9
11
  export interface DescribeLimitsCommandInput extends DescribeLimitsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeLimitsCommand}.
13
17
  */
14
18
  export interface DescribeLimitsCommandOutput extends DescribeLimitsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the shard limits and usage for the account.</p>
18
23
  * <p>If you update your account limits, the old limits might be returned for a few
19
24
  * minutes.</p>
@@ -28,6 +33,8 @@ export interface DescribeLimitsCommandOutput extends DescribeLimitsOutput, __Met
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DescribeLimitsCommandInput - {@link DescribeLimitsCommandInput}
37
+ * @returns {@link DescribeLimitsCommandOutput}
31
38
  * @see {@link DescribeLimitsCommandInput} for command's `input` shape.
32
39
  * @see {@link DescribeLimitsCommandOutput} for command's `response` shape.
33
40
  * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
@@ -41,11 +48,20 @@ export interface DescribeLimitsCommandOutput extends DescribeLimitsOutput, __Met
41
48
  export declare class DescribeLimitsCommand extends $Command<DescribeLimitsCommandInput, DescribeLimitsCommandOutput, KinesisClientResolvedConfig> {
42
49
  readonly input: DescribeLimitsCommandInput;
43
50
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
51
+ /**
52
+ * @public
53
+ */
44
54
  constructor(input: DescribeLimitsCommandInput);
45
55
  /**
46
56
  * @internal
47
57
  */
48
58
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeLimitsCommandInput, DescribeLimitsCommandOutput>;
59
+ /**
60
+ * @internal
61
+ */
49
62
  private serialize;
63
+ /**
64
+ * @internal
65
+ */
50
66
  private deserialize;
51
67
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
5
5
  import { DescribeStreamInput, DescribeStreamOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeStreamCommand}.
8
10
  */
9
11
  export interface DescribeStreamCommandInput extends DescribeStreamInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeStreamCommand}.
13
17
  */
14
18
  export interface DescribeStreamCommandOutput extends DescribeStreamOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the specified Kinesis data stream.</p>
18
23
  * <note>
19
24
  * <p>This API has been revised. It's highly recommended that you use the <a>DescribeStreamSummary</a> API to get a summarized description of the
@@ -48,6 +53,8 @@ export interface DescribeStreamCommandOutput extends DescribeStreamOutput, __Met
48
53
  * const response = await client.send(command);
49
54
  * ```
50
55
  *
56
+ * @param DescribeStreamCommandInput - {@link DescribeStreamCommandInput}
57
+ * @returns {@link DescribeStreamCommandOutput}
51
58
  * @see {@link DescribeStreamCommandInput} for command's `input` shape.
52
59
  * @see {@link DescribeStreamCommandOutput} for command's `response` shape.
53
60
  * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
@@ -73,11 +80,20 @@ export interface DescribeStreamCommandOutput extends DescribeStreamOutput, __Met
73
80
  export declare class DescribeStreamCommand extends $Command<DescribeStreamCommandInput, DescribeStreamCommandOutput, KinesisClientResolvedConfig> {
74
81
  readonly input: DescribeStreamCommandInput;
75
82
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
83
+ /**
84
+ * @public
85
+ */
76
86
  constructor(input: DescribeStreamCommandInput);
77
87
  /**
78
88
  * @internal
79
89
  */
80
90
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeStreamCommandInput, DescribeStreamCommandOutput>;
91
+ /**
92
+ * @internal
93
+ */
81
94
  private serialize;
95
+ /**
96
+ * @internal
97
+ */
82
98
  private deserialize;
83
99
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
5
5
  import { DescribeStreamConsumerInput, DescribeStreamConsumerOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeStreamConsumerCommand}.
8
10
  */
9
11
  export interface DescribeStreamConsumerCommandInput extends DescribeStreamConsumerInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeStreamConsumerCommand}.
13
17
  */
14
18
  export interface DescribeStreamConsumerCommandOutput extends DescribeStreamConsumerOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>To get the description of a registered consumer, provide the ARN of the consumer.
18
23
  * Alternatively, you can provide the ARN of the data stream and the name you gave the
19
24
  * consumer when you registered it. You may also provide all three parameters, as long as
@@ -32,6 +37,8 @@ export interface DescribeStreamConsumerCommandOutput extends DescribeStreamConsu
32
37
  * const response = await client.send(command);
33
38
  * ```
34
39
  *
40
+ * @param DescribeStreamConsumerCommandInput - {@link DescribeStreamConsumerCommandInput}
41
+ * @returns {@link DescribeStreamConsumerCommandOutput}
35
42
  * @see {@link DescribeStreamConsumerCommandInput} for command's `input` shape.
36
43
  * @see {@link DescribeStreamConsumerCommandOutput} for command's `response` shape.
37
44
  * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
@@ -53,11 +60,20 @@ export interface DescribeStreamConsumerCommandOutput extends DescribeStreamConsu
53
60
  export declare class DescribeStreamConsumerCommand extends $Command<DescribeStreamConsumerCommandInput, DescribeStreamConsumerCommandOutput, KinesisClientResolvedConfig> {
54
61
  readonly input: DescribeStreamConsumerCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: DescribeStreamConsumerCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeStreamConsumerCommandInput, DescribeStreamConsumerCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
5
5
  import { DescribeStreamSummaryInput, DescribeStreamSummaryOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeStreamSummaryCommand}.
8
10
  */
9
11
  export interface DescribeStreamSummaryCommandInput extends DescribeStreamSummaryInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeStreamSummaryCommand}.
13
17
  */
14
18
  export interface DescribeStreamSummaryCommandOutput extends DescribeStreamSummaryOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Provides a summarized description of the specified Kinesis data stream without the
18
23
  * shard list.</p>
19
24
  * <note>
@@ -36,6 +41,8 @@ export interface DescribeStreamSummaryCommandOutput extends DescribeStreamSummar
36
41
  * const response = await client.send(command);
37
42
  * ```
38
43
  *
44
+ * @param DescribeStreamSummaryCommandInput - {@link DescribeStreamSummaryCommandInput}
45
+ * @returns {@link DescribeStreamSummaryCommandOutput}
39
46
  * @see {@link DescribeStreamSummaryCommandInput} for command's `input` shape.
40
47
  * @see {@link DescribeStreamSummaryCommandOutput} for command's `response` shape.
41
48
  * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
@@ -61,11 +68,20 @@ export interface DescribeStreamSummaryCommandOutput extends DescribeStreamSummar
61
68
  export declare class DescribeStreamSummaryCommand extends $Command<DescribeStreamSummaryCommandInput, DescribeStreamSummaryCommandOutput, KinesisClientResolvedConfig> {
62
69
  readonly input: DescribeStreamSummaryCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: DescribeStreamSummaryCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeStreamSummaryCommandInput, DescribeStreamSummaryCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
5
5
  import { DisableEnhancedMonitoringInput, EnhancedMonitoringOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DisableEnhancedMonitoringCommand}.
8
10
  */
9
11
  export interface DisableEnhancedMonitoringCommandInput extends DisableEnhancedMonitoringInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DisableEnhancedMonitoringCommand}.
13
17
  */
14
18
  export interface DisableEnhancedMonitoringCommandOutput extends EnhancedMonitoringOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Disables enhanced monitoring.</p>
18
23
  * <note>
19
24
  * <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input
@@ -29,6 +34,8 @@ export interface DisableEnhancedMonitoringCommandOutput extends EnhancedMonitori
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DisableEnhancedMonitoringCommandInput - {@link DisableEnhancedMonitoringCommandInput}
38
+ * @returns {@link DisableEnhancedMonitoringCommandOutput}
32
39
  * @see {@link DisableEnhancedMonitoringCommandInput} for command's `input` shape.
33
40
  * @see {@link DisableEnhancedMonitoringCommandOutput} for command's `response` shape.
34
41
  * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
@@ -58,11 +65,20 @@ export interface DisableEnhancedMonitoringCommandOutput extends EnhancedMonitori
58
65
  export declare class DisableEnhancedMonitoringCommand extends $Command<DisableEnhancedMonitoringCommandInput, DisableEnhancedMonitoringCommandOutput, KinesisClientResolvedConfig> {
59
66
  readonly input: DisableEnhancedMonitoringCommandInput;
60
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
61
71
  constructor(input: DisableEnhancedMonitoringCommandInput);
62
72
  /**
63
73
  * @internal
64
74
  */
65
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisableEnhancedMonitoringCommandInput, DisableEnhancedMonitoringCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
66
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
67
83
  private deserialize;
68
84
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
5
5
  import { EnableEnhancedMonitoringInput, EnhancedMonitoringOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link EnableEnhancedMonitoringCommand}.
8
10
  */
9
11
  export interface EnableEnhancedMonitoringCommandInput extends EnableEnhancedMonitoringInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link EnableEnhancedMonitoringCommand}.
13
17
  */
14
18
  export interface EnableEnhancedMonitoringCommandOutput extends EnhancedMonitoringOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Enables enhanced Kinesis data stream monitoring for shard-level metrics.</p>
18
23
  * <note>
19
24
  * <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input
@@ -29,6 +34,8 @@ export interface EnableEnhancedMonitoringCommandOutput extends EnhancedMonitorin
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param EnableEnhancedMonitoringCommandInput - {@link EnableEnhancedMonitoringCommandInput}
38
+ * @returns {@link EnableEnhancedMonitoringCommandOutput}
32
39
  * @see {@link EnableEnhancedMonitoringCommandInput} for command's `input` shape.
33
40
  * @see {@link EnableEnhancedMonitoringCommandOutput} for command's `response` shape.
34
41
  * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
@@ -58,11 +65,20 @@ export interface EnableEnhancedMonitoringCommandOutput extends EnhancedMonitorin
58
65
  export declare class EnableEnhancedMonitoringCommand extends $Command<EnableEnhancedMonitoringCommandInput, EnableEnhancedMonitoringCommandOutput, KinesisClientResolvedConfig> {
59
66
  readonly input: EnableEnhancedMonitoringCommandInput;
60
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
61
71
  constructor(input: EnableEnhancedMonitoringCommandInput);
62
72
  /**
63
73
  * @internal
64
74
  */
65
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisClientResolvedConfig, options?: __HttpHandlerOptions): Handler<EnableEnhancedMonitoringCommandInput, EnableEnhancedMonitoringCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
66
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
67
83
  private deserialize;
68
84
  }