@aws-sdk/client-kinesis 3.922.0 → 3.923.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.
- package/README.md +24 -0
- package/dist-cjs/index.js +163 -15
- package/dist-es/Kinesis.js +6 -0
- package/dist-es/commands/DescribeAccountSettingsCommand.js +22 -0
- package/dist-es/commands/UpdateAccountSettingsCommand.js +22 -0
- package/dist-es/commands/UpdateStreamWarmThroughputCommand.js +26 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/models_0.js +21 -12
- package/dist-es/protocols/Aws_json1_1.js +79 -3
- package/dist-types/Kinesis.d.ts +22 -0
- package/dist-types/KinesisClient.d.ts +5 -2
- package/dist-types/commands/CreateStreamCommand.d.ts +10 -14
- package/dist-types/commands/DescribeAccountSettingsCommand.d.ts +82 -0
- package/dist-types/commands/DescribeStreamSummaryCommand.d.ts +4 -0
- package/dist-types/commands/UpdateAccountSettingsCommand.d.ts +106 -0
- package/dist-types/commands/UpdateStreamModeCommand.d.ts +7 -0
- package/dist-types/commands/UpdateStreamWarmThroughputCommand.d.ts +122 -0
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +198 -14
- package/dist-types/protocols/Aws_json1_1.d.ts +27 -0
- package/dist-types/ts3.4/Kinesis.d.ts +52 -0
- package/dist-types/ts3.4/KinesisClient.d.ts +20 -2
- package/dist-types/ts3.4/commands/DescribeAccountSettingsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateAccountSettingsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateStreamWarmThroughputCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +62 -7
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +36 -0
- package/package.json +1 -1
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient";
|
|
4
|
+
import { UpdateStreamWarmThroughputInput, UpdateStreamWarmThroughputOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link UpdateStreamWarmThroughputCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateStreamWarmThroughputCommandInput extends UpdateStreamWarmThroughputInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateStreamWarmThroughputCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateStreamWarmThroughputCommandOutput extends UpdateStreamWarmThroughputOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateStreamWarmThroughputCommand_base: {
|
|
25
|
+
new (input: UpdateStreamWarmThroughputCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateStreamWarmThroughputCommandInput, UpdateStreamWarmThroughputCommandOutput, KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: UpdateStreamWarmThroughputCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateStreamWarmThroughputCommandInput, UpdateStreamWarmThroughputCommandOutput, KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Updates the warm throughput configuration for the specified Amazon Kinesis Data Streams on-demand data stream. This operation allows you to proactively scale your on-demand data stream to a specified throughput level, enabling better performance for sudden traffic spikes. </p>
|
|
31
|
+
* <note>
|
|
32
|
+
* <p>When invoking this API, you must use either the <code>StreamARN</code> or the <code>StreamName</code> parameter, or both. It is recommended that you use the <code>StreamARN</code> input parameter when you invoke this API.</p>
|
|
33
|
+
* </note>
|
|
34
|
+
* <p>Updating the warm throughput is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to <code>UPDATING</code>. After the update is complete, Kinesis Data Streams sets the status of the stream back to <code>ACTIVE</code>. Depending on the size of the stream, the scaling action could take a few minutes to complete. You can continue to read and write data to your stream while its status is <code>UPDATING</code>.</p>
|
|
35
|
+
* <p>This operation is only supported for data streams with the on-demand capacity mode in accounts that have <code>MinimumThroughputBillingCommitment</code> enabled. Provisioned capacity mode streams do not support warm throughput configuration.</p>
|
|
36
|
+
* <p>This operation has the following default limits. By default, you cannot do the following:</p>
|
|
37
|
+
* <ul>
|
|
38
|
+
* <li>
|
|
39
|
+
* <p>Scale to more than 10 GiBps for an on-demand stream.</p>
|
|
40
|
+
* </li>
|
|
41
|
+
* <li>
|
|
42
|
+
* <p>This API has a call limit of 5 transactions per second (TPS) for each Amazon Web Services account. TPS over 5 will initiate the <code>LimitExceededException</code>.</p>
|
|
43
|
+
* </li>
|
|
44
|
+
* </ul>
|
|
45
|
+
* <p>For the default limits for an Amazon Web Services account, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html">Streams Limits</a> in the <i>Amazon Kinesis Data Streams Developer
|
|
46
|
+
* Guide</i>. To request an increase in the call rate limit, the shard limit for this API, or your overall shard limit, use the <a href="https://console.aws.amazon.com/support/v1#/case/create?issueType=service-limit-increase&limitType=service-code-kinesis">limits form</a>.</p>
|
|
47
|
+
* @example
|
|
48
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
49
|
+
* ```javascript
|
|
50
|
+
* import { KinesisClient, UpdateStreamWarmThroughputCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
51
|
+
* // const { KinesisClient, UpdateStreamWarmThroughputCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
52
|
+
* // import type { KinesisClientConfig } from "@aws-sdk/client-kinesis";
|
|
53
|
+
* const config = {}; // type is KinesisClientConfig
|
|
54
|
+
* const client = new KinesisClient(config);
|
|
55
|
+
* const input = { // UpdateStreamWarmThroughputInput
|
|
56
|
+
* StreamARN: "STRING_VALUE",
|
|
57
|
+
* StreamName: "STRING_VALUE",
|
|
58
|
+
* WarmThroughputMiBps: Number("int"), // required
|
|
59
|
+
* };
|
|
60
|
+
* const command = new UpdateStreamWarmThroughputCommand(input);
|
|
61
|
+
* const response = await client.send(command);
|
|
62
|
+
* // { // UpdateStreamWarmThroughputOutput
|
|
63
|
+
* // StreamARN: "STRING_VALUE",
|
|
64
|
+
* // StreamName: "STRING_VALUE",
|
|
65
|
+
* // WarmThroughput: { // WarmThroughputObject
|
|
66
|
+
* // TargetMiBps: Number("int"),
|
|
67
|
+
* // CurrentMiBps: Number("int"),
|
|
68
|
+
* // },
|
|
69
|
+
* // };
|
|
70
|
+
*
|
|
71
|
+
* ```
|
|
72
|
+
*
|
|
73
|
+
* @param UpdateStreamWarmThroughputCommandInput - {@link UpdateStreamWarmThroughputCommandInput}
|
|
74
|
+
* @returns {@link UpdateStreamWarmThroughputCommandOutput}
|
|
75
|
+
* @see {@link UpdateStreamWarmThroughputCommandInput} for command's `input` shape.
|
|
76
|
+
* @see {@link UpdateStreamWarmThroughputCommandOutput} for command's `response` shape.
|
|
77
|
+
* @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
80
|
+
* <p>Specifies that you do not have the permissions required to perform this
|
|
81
|
+
* operation.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link InvalidArgumentException} (client fault)
|
|
84
|
+
* <p>A specified parameter exceeds its restrictions, is not supported, or can't be used.
|
|
85
|
+
* For more information, see the returned message.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
88
|
+
* <p>The requested resource exceeds the maximum number allowed, or the number of concurrent
|
|
89
|
+
* stream requests exceeds the maximum number allowed. </p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link ResourceInUseException} (client fault)
|
|
92
|
+
* <p>The resource is not available for this operation. For successful operation, the
|
|
93
|
+
* resource must be in the <code>ACTIVE</code> state.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
96
|
+
* <p>The requested resource could not be found. The stream might not be specified
|
|
97
|
+
* correctly.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link ValidationException} (client fault)
|
|
100
|
+
* <p>Specifies that you tried to invoke this API for a data stream with the on-demand
|
|
101
|
+
* capacity mode. This API is only supported for data streams with the provisioned capacity
|
|
102
|
+
* mode. </p>
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link KinesisServiceException}
|
|
105
|
+
* <p>Base exception class for all service exceptions from Kinesis service.</p>
|
|
106
|
+
*
|
|
107
|
+
*
|
|
108
|
+
* @public
|
|
109
|
+
*/
|
|
110
|
+
export declare class UpdateStreamWarmThroughputCommand extends UpdateStreamWarmThroughputCommand_base {
|
|
111
|
+
/** @internal type navigation helper, not in runtime. */
|
|
112
|
+
protected static __types: {
|
|
113
|
+
api: {
|
|
114
|
+
input: UpdateStreamWarmThroughputInput;
|
|
115
|
+
output: UpdateStreamWarmThroughputOutput;
|
|
116
|
+
};
|
|
117
|
+
sdk: {
|
|
118
|
+
input: UpdateStreamWarmThroughputCommandInput;
|
|
119
|
+
output: UpdateStreamWarmThroughputCommandOutput;
|
|
120
|
+
};
|
|
121
|
+
};
|
|
122
|
+
}
|
|
@@ -4,6 +4,7 @@ export * from "./DecreaseStreamRetentionPeriodCommand";
|
|
|
4
4
|
export * from "./DeleteResourcePolicyCommand";
|
|
5
5
|
export * from "./DeleteStreamCommand";
|
|
6
6
|
export * from "./DeregisterStreamConsumerCommand";
|
|
7
|
+
export * from "./DescribeAccountSettingsCommand";
|
|
7
8
|
export * from "./DescribeLimitsCommand";
|
|
8
9
|
export * from "./DescribeStreamCommand";
|
|
9
10
|
export * from "./DescribeStreamConsumerCommand";
|
|
@@ -31,6 +32,8 @@ export * from "./StopStreamEncryptionCommand";
|
|
|
31
32
|
export * from "./SubscribeToShardCommand";
|
|
32
33
|
export * from "./TagResourceCommand";
|
|
33
34
|
export * from "./UntagResourceCommand";
|
|
35
|
+
export * from "./UpdateAccountSettingsCommand";
|
|
34
36
|
export * from "./UpdateMaxRecordSizeCommand";
|
|
35
37
|
export * from "./UpdateShardCountCommand";
|
|
36
38
|
export * from "./UpdateStreamModeCommand";
|
|
39
|
+
export * from "./UpdateStreamWarmThroughputCommand";
|
|
@@ -268,12 +268,31 @@ export interface CreateStreamInput {
|
|
|
268
268
|
* @public
|
|
269
269
|
*/
|
|
270
270
|
Tags?: Record<string, string> | undefined;
|
|
271
|
+
/**
|
|
272
|
+
* <p>The target warm throughput in MB/s that the stream should be scaled to handle. This represents the throughput capacity that will be immediately available for write operations.</p>
|
|
273
|
+
* @public
|
|
274
|
+
*/
|
|
275
|
+
WarmThroughputMiBps?: number | undefined;
|
|
271
276
|
/**
|
|
272
277
|
* <p>The maximum record size of a single record in kibibyte (KiB) that you can write to, and read from a stream.</p>
|
|
273
278
|
* @public
|
|
274
279
|
*/
|
|
275
280
|
MaxRecordSizeInKiB?: number | undefined;
|
|
276
281
|
}
|
|
282
|
+
/**
|
|
283
|
+
* <p>Specifies that you tried to invoke this API for a data stream with the on-demand
|
|
284
|
+
* capacity mode. This API is only supported for data streams with the provisioned capacity
|
|
285
|
+
* mode. </p>
|
|
286
|
+
* @public
|
|
287
|
+
*/
|
|
288
|
+
export declare class ValidationException extends __BaseException {
|
|
289
|
+
readonly name: "ValidationException";
|
|
290
|
+
readonly $fault: "client";
|
|
291
|
+
/**
|
|
292
|
+
* @internal
|
|
293
|
+
*/
|
|
294
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
295
|
+
}
|
|
277
296
|
/**
|
|
278
297
|
* <p>Represents the input for <a>DecreaseStreamRetentionPeriod</a>.</p>
|
|
279
298
|
* @public
|
|
@@ -355,6 +374,60 @@ export interface DeregisterStreamConsumerInput {
|
|
|
355
374
|
*/
|
|
356
375
|
ConsumerARN?: string | undefined;
|
|
357
376
|
}
|
|
377
|
+
/**
|
|
378
|
+
* @public
|
|
379
|
+
*/
|
|
380
|
+
export interface DescribeAccountSettingsInput {
|
|
381
|
+
}
|
|
382
|
+
/**
|
|
383
|
+
* @public
|
|
384
|
+
* @enum
|
|
385
|
+
*/
|
|
386
|
+
export declare const MinimumThroughputBillingCommitmentOutputStatus: {
|
|
387
|
+
readonly DISABLED: "DISABLED";
|
|
388
|
+
readonly ENABLED: "ENABLED";
|
|
389
|
+
readonly ENABLED_UNTIL_EARLIEST_ALLOWED_END: "ENABLED_UNTIL_EARLIEST_ALLOWED_END";
|
|
390
|
+
};
|
|
391
|
+
/**
|
|
392
|
+
* @public
|
|
393
|
+
*/
|
|
394
|
+
export type MinimumThroughputBillingCommitmentOutputStatus = (typeof MinimumThroughputBillingCommitmentOutputStatus)[keyof typeof MinimumThroughputBillingCommitmentOutputStatus];
|
|
395
|
+
/**
|
|
396
|
+
* <p>Represents the current status of minimum throughput billing commitment for an account.</p>
|
|
397
|
+
* @public
|
|
398
|
+
*/
|
|
399
|
+
export interface MinimumThroughputBillingCommitmentOutput {
|
|
400
|
+
/**
|
|
401
|
+
* <p>The current status of the minimum throughput billing commitment.</p>
|
|
402
|
+
* @public
|
|
403
|
+
*/
|
|
404
|
+
Status: MinimumThroughputBillingCommitmentOutputStatus | undefined;
|
|
405
|
+
/**
|
|
406
|
+
* <p>The timestamp when the commitment was started.</p>
|
|
407
|
+
* @public
|
|
408
|
+
*/
|
|
409
|
+
StartedAt?: Date | undefined;
|
|
410
|
+
/**
|
|
411
|
+
* <p>The timestamp when the commitment was ended.</p>
|
|
412
|
+
* @public
|
|
413
|
+
*/
|
|
414
|
+
EndedAt?: Date | undefined;
|
|
415
|
+
/**
|
|
416
|
+
* <p>The earliest timestamp when the commitment can be ended.</p>
|
|
417
|
+
* @public
|
|
418
|
+
*/
|
|
419
|
+
EarliestAllowedEndAt?: Date | undefined;
|
|
420
|
+
}
|
|
421
|
+
/**
|
|
422
|
+
* @public
|
|
423
|
+
*/
|
|
424
|
+
export interface DescribeAccountSettingsOutput {
|
|
425
|
+
/**
|
|
426
|
+
* <p>The current configuration of the minimum throughput billing commitment for your Amazon Web Services account.</p>
|
|
427
|
+
* @public
|
|
428
|
+
*/
|
|
429
|
+
MinimumThroughputBillingCommitment?: MinimumThroughputBillingCommitmentOutput | undefined;
|
|
430
|
+
}
|
|
358
431
|
/**
|
|
359
432
|
* @public
|
|
360
433
|
*/
|
|
@@ -760,6 +833,22 @@ export interface DescribeStreamSummaryInput {
|
|
|
760
833
|
*/
|
|
761
834
|
StreamARN?: string | undefined;
|
|
762
835
|
}
|
|
836
|
+
/**
|
|
837
|
+
* <p>Represents the warm throughput configuration on the stream. This is only present for On-Demand Kinesis Data Streams in accounts that have <code>MinimumThroughputBillingCommitment</code> enabled.</p>
|
|
838
|
+
* @public
|
|
839
|
+
*/
|
|
840
|
+
export interface WarmThroughputObject {
|
|
841
|
+
/**
|
|
842
|
+
* <p>The target warm throughput value on the stream. This indicates that the stream is currently scaling towards this target value.</p>
|
|
843
|
+
* @public
|
|
844
|
+
*/
|
|
845
|
+
TargetMiBps?: number | undefined;
|
|
846
|
+
/**
|
|
847
|
+
* <p>The current warm throughput value on the stream. This is the write throughput in MiBps that the stream is currently scaled to handle.</p>
|
|
848
|
+
* @public
|
|
849
|
+
*/
|
|
850
|
+
CurrentMiBps?: number | undefined;
|
|
851
|
+
}
|
|
763
852
|
/**
|
|
764
853
|
* <p>Represents the output for <a>DescribeStreamSummary</a>
|
|
765
854
|
* </p>
|
|
@@ -890,6 +979,11 @@ export interface StreamDescriptionSummary {
|
|
|
890
979
|
* @public
|
|
891
980
|
*/
|
|
892
981
|
ConsumerCount?: number | undefined;
|
|
982
|
+
/**
|
|
983
|
+
* <p>The warm throughput in MB/s for the stream. This represents the throughput capacity that will be immediately available for write operations.</p>
|
|
984
|
+
* @public
|
|
985
|
+
*/
|
|
986
|
+
WarmThroughput?: WarmThroughputObject | undefined;
|
|
893
987
|
/**
|
|
894
988
|
* <p>The maximum record size of a single record in kibibyte (KiB) that you can write to, and read from a stream.</p>
|
|
895
989
|
* @public
|
|
@@ -1936,20 +2030,6 @@ export interface MergeShardsInput {
|
|
|
1936
2030
|
*/
|
|
1937
2031
|
StreamARN?: string | undefined;
|
|
1938
2032
|
}
|
|
1939
|
-
/**
|
|
1940
|
-
* <p>Specifies that you tried to invoke this API for a data stream with the on-demand
|
|
1941
|
-
* capacity mode. This API is only supported for data streams with the provisioned capacity
|
|
1942
|
-
* mode. </p>
|
|
1943
|
-
* @public
|
|
1944
|
-
*/
|
|
1945
|
-
export declare class ValidationException extends __BaseException {
|
|
1946
|
-
readonly name: "ValidationException";
|
|
1947
|
-
readonly $fault: "client";
|
|
1948
|
-
/**
|
|
1949
|
-
* @internal
|
|
1950
|
-
*/
|
|
1951
|
-
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
1952
|
-
}
|
|
1953
2033
|
/**
|
|
1954
2034
|
* <p>Represents the input for <code>PutRecord</code>.</p>
|
|
1955
2035
|
* @public
|
|
@@ -2736,6 +2816,65 @@ export interface UntagResourceInput {
|
|
|
2736
2816
|
*/
|
|
2737
2817
|
ResourceARN: string | undefined;
|
|
2738
2818
|
}
|
|
2819
|
+
/**
|
|
2820
|
+
* @public
|
|
2821
|
+
* @enum
|
|
2822
|
+
*/
|
|
2823
|
+
export declare const MinimumThroughputBillingCommitmentInputStatus: {
|
|
2824
|
+
readonly DISABLED: "DISABLED";
|
|
2825
|
+
readonly ENABLED: "ENABLED";
|
|
2826
|
+
};
|
|
2827
|
+
/**
|
|
2828
|
+
* @public
|
|
2829
|
+
*/
|
|
2830
|
+
export type MinimumThroughputBillingCommitmentInputStatus = (typeof MinimumThroughputBillingCommitmentInputStatus)[keyof typeof MinimumThroughputBillingCommitmentInputStatus];
|
|
2831
|
+
/**
|
|
2832
|
+
* <p>Represents the request parameters for configuring minimum throughput billing commitment.</p>
|
|
2833
|
+
* <note>
|
|
2834
|
+
* <ul>
|
|
2835
|
+
* <li>
|
|
2836
|
+
* <p>Minimum throughput billing commitments provide cost savings on on-demand data streams in exchange for committing to a minimum level of throughput usage.</p>
|
|
2837
|
+
* </li>
|
|
2838
|
+
* <li>
|
|
2839
|
+
* <p>Commitments have a minimum duration of 24 hours that must be honored before they can be disabled.</p>
|
|
2840
|
+
* </li>
|
|
2841
|
+
* <li>
|
|
2842
|
+
* <p>If you attempt to disable a commitment before the minimum commitment period ends, the commitment will be scheduled for automatic disable at the earliest allowed end time.</p>
|
|
2843
|
+
* </li>
|
|
2844
|
+
* <li>
|
|
2845
|
+
* <p>You can cancel a pending disable by enabling the commitment again before the earliest allowed end time.</p>
|
|
2846
|
+
* </li>
|
|
2847
|
+
* </ul>
|
|
2848
|
+
* </note>
|
|
2849
|
+
* @public
|
|
2850
|
+
*/
|
|
2851
|
+
export interface MinimumThroughputBillingCommitmentInput {
|
|
2852
|
+
/**
|
|
2853
|
+
* <p>The desired status of the minimum throughput billing commitment.</p>
|
|
2854
|
+
* @public
|
|
2855
|
+
*/
|
|
2856
|
+
Status: MinimumThroughputBillingCommitmentInputStatus | undefined;
|
|
2857
|
+
}
|
|
2858
|
+
/**
|
|
2859
|
+
* @public
|
|
2860
|
+
*/
|
|
2861
|
+
export interface UpdateAccountSettingsInput {
|
|
2862
|
+
/**
|
|
2863
|
+
* <p>Specifies the minimum throughput billing commitment configuration for your account.</p>
|
|
2864
|
+
* @public
|
|
2865
|
+
*/
|
|
2866
|
+
MinimumThroughputBillingCommitment: MinimumThroughputBillingCommitmentInput | undefined;
|
|
2867
|
+
}
|
|
2868
|
+
/**
|
|
2869
|
+
* @public
|
|
2870
|
+
*/
|
|
2871
|
+
export interface UpdateAccountSettingsOutput {
|
|
2872
|
+
/**
|
|
2873
|
+
* <p>The updated configuration of the minimum throughput billing commitment for your account.</p>
|
|
2874
|
+
* @public
|
|
2875
|
+
*/
|
|
2876
|
+
MinimumThroughputBillingCommitment?: MinimumThroughputBillingCommitmentOutput | undefined;
|
|
2877
|
+
}
|
|
2739
2878
|
/**
|
|
2740
2879
|
* @public
|
|
2741
2880
|
*/
|
|
@@ -2846,6 +2985,51 @@ export interface UpdateStreamModeInput {
|
|
|
2846
2985
|
* @public
|
|
2847
2986
|
*/
|
|
2848
2987
|
StreamModeDetails: StreamModeDetails | undefined;
|
|
2988
|
+
/**
|
|
2989
|
+
* <p>The target warm throughput in MB/s that the stream should be scaled to handle. This represents the throughput capacity that will be immediately available for write operations. This field is only valid when the stream mode is being updated to on-demand.</p>
|
|
2990
|
+
* @public
|
|
2991
|
+
*/
|
|
2992
|
+
WarmThroughputMiBps?: number | undefined;
|
|
2993
|
+
}
|
|
2994
|
+
/**
|
|
2995
|
+
* @public
|
|
2996
|
+
*/
|
|
2997
|
+
export interface UpdateStreamWarmThroughputInput {
|
|
2998
|
+
/**
|
|
2999
|
+
* <p>The ARN of the stream to be updated.</p>
|
|
3000
|
+
* @public
|
|
3001
|
+
*/
|
|
3002
|
+
StreamARN?: string | undefined;
|
|
3003
|
+
/**
|
|
3004
|
+
* <p>The name of the stream to be updated.</p>
|
|
3005
|
+
* @public
|
|
3006
|
+
*/
|
|
3007
|
+
StreamName?: string | undefined;
|
|
3008
|
+
/**
|
|
3009
|
+
* <p>The target warm throughput in MB/s that the stream should be scaled to handle. This represents the throughput capacity that will be immediately available for write operations.</p>
|
|
3010
|
+
* @public
|
|
3011
|
+
*/
|
|
3012
|
+
WarmThroughputMiBps: number | undefined;
|
|
3013
|
+
}
|
|
3014
|
+
/**
|
|
3015
|
+
* @public
|
|
3016
|
+
*/
|
|
3017
|
+
export interface UpdateStreamWarmThroughputOutput {
|
|
3018
|
+
/**
|
|
3019
|
+
* <p>The ARN of the stream that was updated.</p>
|
|
3020
|
+
* @public
|
|
3021
|
+
*/
|
|
3022
|
+
StreamARN?: string | undefined;
|
|
3023
|
+
/**
|
|
3024
|
+
* <p>The name of the stream that was updated.</p>
|
|
3025
|
+
* @public
|
|
3026
|
+
*/
|
|
3027
|
+
StreamName?: string | undefined;
|
|
3028
|
+
/**
|
|
3029
|
+
* <p>Specifies the updated warm throughput configuration for your data stream.</p>
|
|
3030
|
+
* @public
|
|
3031
|
+
*/
|
|
3032
|
+
WarmThroughput?: WarmThroughputObject | undefined;
|
|
2849
3033
|
}
|
|
2850
3034
|
/**
|
|
2851
3035
|
* @internal
|
|
@@ -6,6 +6,7 @@ import { DecreaseStreamRetentionPeriodCommandInput, DecreaseStreamRetentionPerio
|
|
|
6
6
|
import { DeleteResourcePolicyCommandInput, DeleteResourcePolicyCommandOutput } from "../commands/DeleteResourcePolicyCommand";
|
|
7
7
|
import { DeleteStreamCommandInput, DeleteStreamCommandOutput } from "../commands/DeleteStreamCommand";
|
|
8
8
|
import { DeregisterStreamConsumerCommandInput, DeregisterStreamConsumerCommandOutput } from "../commands/DeregisterStreamConsumerCommand";
|
|
9
|
+
import { DescribeAccountSettingsCommandInput, DescribeAccountSettingsCommandOutput } from "../commands/DescribeAccountSettingsCommand";
|
|
9
10
|
import { DescribeLimitsCommandInput, DescribeLimitsCommandOutput } from "../commands/DescribeLimitsCommand";
|
|
10
11
|
import { DescribeStreamCommandInput, DescribeStreamCommandOutput } from "../commands/DescribeStreamCommand";
|
|
11
12
|
import { DescribeStreamConsumerCommandInput, DescribeStreamConsumerCommandOutput } from "../commands/DescribeStreamConsumerCommand";
|
|
@@ -33,9 +34,11 @@ import { StopStreamEncryptionCommandInput, StopStreamEncryptionCommandOutput } f
|
|
|
33
34
|
import { SubscribeToShardCommandInput, SubscribeToShardCommandOutput } from "../commands/SubscribeToShardCommand";
|
|
34
35
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "../commands/TagResourceCommand";
|
|
35
36
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "../commands/UntagResourceCommand";
|
|
37
|
+
import { UpdateAccountSettingsCommandInput, UpdateAccountSettingsCommandOutput } from "../commands/UpdateAccountSettingsCommand";
|
|
36
38
|
import { UpdateMaxRecordSizeCommandInput, UpdateMaxRecordSizeCommandOutput } from "../commands/UpdateMaxRecordSizeCommand";
|
|
37
39
|
import { UpdateShardCountCommandInput, UpdateShardCountCommandOutput } from "../commands/UpdateShardCountCommand";
|
|
38
40
|
import { UpdateStreamModeCommandInput, UpdateStreamModeCommandOutput } from "../commands/UpdateStreamModeCommand";
|
|
41
|
+
import { UpdateStreamWarmThroughputCommandInput, UpdateStreamWarmThroughputCommandOutput } from "../commands/UpdateStreamWarmThroughputCommand";
|
|
39
42
|
/**
|
|
40
43
|
* serializeAws_json1_1AddTagsToStreamCommand
|
|
41
44
|
*/
|
|
@@ -60,6 +63,10 @@ export declare const se_DeleteStreamCommand: (input: DeleteStreamCommandInput, c
|
|
|
60
63
|
* serializeAws_json1_1DeregisterStreamConsumerCommand
|
|
61
64
|
*/
|
|
62
65
|
export declare const se_DeregisterStreamConsumerCommand: (input: DeregisterStreamConsumerCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
66
|
+
/**
|
|
67
|
+
* serializeAws_json1_1DescribeAccountSettingsCommand
|
|
68
|
+
*/
|
|
69
|
+
export declare const se_DescribeAccountSettingsCommand: (input: DescribeAccountSettingsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
63
70
|
/**
|
|
64
71
|
* serializeAws_json1_1DescribeLimitsCommand
|
|
65
72
|
*/
|
|
@@ -168,6 +175,10 @@ export declare const se_TagResourceCommand: (input: TagResourceCommandInput, con
|
|
|
168
175
|
* serializeAws_json1_1UntagResourceCommand
|
|
169
176
|
*/
|
|
170
177
|
export declare const se_UntagResourceCommand: (input: UntagResourceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
178
|
+
/**
|
|
179
|
+
* serializeAws_json1_1UpdateAccountSettingsCommand
|
|
180
|
+
*/
|
|
181
|
+
export declare const se_UpdateAccountSettingsCommand: (input: UpdateAccountSettingsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
171
182
|
/**
|
|
172
183
|
* serializeAws_json1_1UpdateMaxRecordSizeCommand
|
|
173
184
|
*/
|
|
@@ -180,6 +191,10 @@ export declare const se_UpdateShardCountCommand: (input: UpdateShardCountCommand
|
|
|
180
191
|
* serializeAws_json1_1UpdateStreamModeCommand
|
|
181
192
|
*/
|
|
182
193
|
export declare const se_UpdateStreamModeCommand: (input: UpdateStreamModeCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
194
|
+
/**
|
|
195
|
+
* serializeAws_json1_1UpdateStreamWarmThroughputCommand
|
|
196
|
+
*/
|
|
197
|
+
export declare const se_UpdateStreamWarmThroughputCommand: (input: UpdateStreamWarmThroughputCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
183
198
|
/**
|
|
184
199
|
* deserializeAws_json1_1AddTagsToStreamCommand
|
|
185
200
|
*/
|
|
@@ -204,6 +219,10 @@ export declare const de_DeleteStreamCommand: (output: __HttpResponse, context: _
|
|
|
204
219
|
* deserializeAws_json1_1DeregisterStreamConsumerCommand
|
|
205
220
|
*/
|
|
206
221
|
export declare const de_DeregisterStreamConsumerCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeregisterStreamConsumerCommandOutput>;
|
|
222
|
+
/**
|
|
223
|
+
* deserializeAws_json1_1DescribeAccountSettingsCommand
|
|
224
|
+
*/
|
|
225
|
+
export declare const de_DescribeAccountSettingsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DescribeAccountSettingsCommandOutput>;
|
|
207
226
|
/**
|
|
208
227
|
* deserializeAws_json1_1DescribeLimitsCommand
|
|
209
228
|
*/
|
|
@@ -312,6 +331,10 @@ export declare const de_TagResourceCommand: (output: __HttpResponse, context: __
|
|
|
312
331
|
* deserializeAws_json1_1UntagResourceCommand
|
|
313
332
|
*/
|
|
314
333
|
export declare const de_UntagResourceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UntagResourceCommandOutput>;
|
|
334
|
+
/**
|
|
335
|
+
* deserializeAws_json1_1UpdateAccountSettingsCommand
|
|
336
|
+
*/
|
|
337
|
+
export declare const de_UpdateAccountSettingsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateAccountSettingsCommandOutput>;
|
|
315
338
|
/**
|
|
316
339
|
* deserializeAws_json1_1UpdateMaxRecordSizeCommand
|
|
317
340
|
*/
|
|
@@ -324,3 +347,7 @@ export declare const de_UpdateShardCountCommand: (output: __HttpResponse, contex
|
|
|
324
347
|
* deserializeAws_json1_1UpdateStreamModeCommand
|
|
325
348
|
*/
|
|
326
349
|
export declare const de_UpdateStreamModeCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateStreamModeCommandOutput>;
|
|
350
|
+
/**
|
|
351
|
+
* deserializeAws_json1_1UpdateStreamWarmThroughputCommand
|
|
352
|
+
*/
|
|
353
|
+
export declare const de_UpdateStreamWarmThroughputCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateStreamWarmThroughputCommandOutput>;
|
|
@@ -23,6 +23,10 @@ import {
|
|
|
23
23
|
DeregisterStreamConsumerCommandInput,
|
|
24
24
|
DeregisterStreamConsumerCommandOutput,
|
|
25
25
|
} from "./commands/DeregisterStreamConsumerCommand";
|
|
26
|
+
import {
|
|
27
|
+
DescribeAccountSettingsCommandInput,
|
|
28
|
+
DescribeAccountSettingsCommandOutput,
|
|
29
|
+
} from "./commands/DescribeAccountSettingsCommand";
|
|
26
30
|
import {
|
|
27
31
|
DescribeLimitsCommandInput,
|
|
28
32
|
DescribeLimitsCommandOutput,
|
|
@@ -131,6 +135,10 @@ import {
|
|
|
131
135
|
UntagResourceCommandInput,
|
|
132
136
|
UntagResourceCommandOutput,
|
|
133
137
|
} from "./commands/UntagResourceCommand";
|
|
138
|
+
import {
|
|
139
|
+
UpdateAccountSettingsCommandInput,
|
|
140
|
+
UpdateAccountSettingsCommandOutput,
|
|
141
|
+
} from "./commands/UpdateAccountSettingsCommand";
|
|
134
142
|
import {
|
|
135
143
|
UpdateMaxRecordSizeCommandInput,
|
|
136
144
|
UpdateMaxRecordSizeCommandOutput,
|
|
@@ -143,6 +151,10 @@ import {
|
|
|
143
151
|
UpdateStreamModeCommandInput,
|
|
144
152
|
UpdateStreamModeCommandOutput,
|
|
145
153
|
} from "./commands/UpdateStreamModeCommand";
|
|
154
|
+
import {
|
|
155
|
+
UpdateStreamWarmThroughputCommandInput,
|
|
156
|
+
UpdateStreamWarmThroughputCommandOutput,
|
|
157
|
+
} from "./commands/UpdateStreamWarmThroughputCommand";
|
|
146
158
|
import { KinesisClient } from "./KinesisClient";
|
|
147
159
|
export interface Kinesis {
|
|
148
160
|
addTagsToStream(
|
|
@@ -225,6 +237,20 @@ export interface Kinesis {
|
|
|
225
237
|
options: __HttpHandlerOptions,
|
|
226
238
|
cb: (err: any, data?: DeregisterStreamConsumerCommandOutput) => void
|
|
227
239
|
): void;
|
|
240
|
+
describeAccountSettings(): Promise<DescribeAccountSettingsCommandOutput>;
|
|
241
|
+
describeAccountSettings(
|
|
242
|
+
args: DescribeAccountSettingsCommandInput,
|
|
243
|
+
options?: __HttpHandlerOptions
|
|
244
|
+
): Promise<DescribeAccountSettingsCommandOutput>;
|
|
245
|
+
describeAccountSettings(
|
|
246
|
+
args: DescribeAccountSettingsCommandInput,
|
|
247
|
+
cb: (err: any, data?: DescribeAccountSettingsCommandOutput) => void
|
|
248
|
+
): void;
|
|
249
|
+
describeAccountSettings(
|
|
250
|
+
args: DescribeAccountSettingsCommandInput,
|
|
251
|
+
options: __HttpHandlerOptions,
|
|
252
|
+
cb: (err: any, data?: DescribeAccountSettingsCommandOutput) => void
|
|
253
|
+
): void;
|
|
228
254
|
describeLimits(): Promise<DescribeLimitsCommandOutput>;
|
|
229
255
|
describeLimits(
|
|
230
256
|
args: DescribeLimitsCommandInput,
|
|
@@ -583,6 +609,19 @@ export interface Kinesis {
|
|
|
583
609
|
options: __HttpHandlerOptions,
|
|
584
610
|
cb: (err: any, data?: UntagResourceCommandOutput) => void
|
|
585
611
|
): void;
|
|
612
|
+
updateAccountSettings(
|
|
613
|
+
args: UpdateAccountSettingsCommandInput,
|
|
614
|
+
options?: __HttpHandlerOptions
|
|
615
|
+
): Promise<UpdateAccountSettingsCommandOutput>;
|
|
616
|
+
updateAccountSettings(
|
|
617
|
+
args: UpdateAccountSettingsCommandInput,
|
|
618
|
+
cb: (err: any, data?: UpdateAccountSettingsCommandOutput) => void
|
|
619
|
+
): void;
|
|
620
|
+
updateAccountSettings(
|
|
621
|
+
args: UpdateAccountSettingsCommandInput,
|
|
622
|
+
options: __HttpHandlerOptions,
|
|
623
|
+
cb: (err: any, data?: UpdateAccountSettingsCommandOutput) => void
|
|
624
|
+
): void;
|
|
586
625
|
updateMaxRecordSize(
|
|
587
626
|
args: UpdateMaxRecordSizeCommandInput,
|
|
588
627
|
options?: __HttpHandlerOptions
|
|
@@ -622,5 +661,18 @@ export interface Kinesis {
|
|
|
622
661
|
options: __HttpHandlerOptions,
|
|
623
662
|
cb: (err: any, data?: UpdateStreamModeCommandOutput) => void
|
|
624
663
|
): void;
|
|
664
|
+
updateStreamWarmThroughput(
|
|
665
|
+
args: UpdateStreamWarmThroughputCommandInput,
|
|
666
|
+
options?: __HttpHandlerOptions
|
|
667
|
+
): Promise<UpdateStreamWarmThroughputCommandOutput>;
|
|
668
|
+
updateStreamWarmThroughput(
|
|
669
|
+
args: UpdateStreamWarmThroughputCommandInput,
|
|
670
|
+
cb: (err: any, data?: UpdateStreamWarmThroughputCommandOutput) => void
|
|
671
|
+
): void;
|
|
672
|
+
updateStreamWarmThroughput(
|
|
673
|
+
args: UpdateStreamWarmThroughputCommandInput,
|
|
674
|
+
options: __HttpHandlerOptions,
|
|
675
|
+
cb: (err: any, data?: UpdateStreamWarmThroughputCommandOutput) => void
|
|
676
|
+
): void;
|
|
625
677
|
}
|
|
626
678
|
export declare class Kinesis extends KinesisClient implements Kinesis {}
|
|
@@ -74,6 +74,10 @@ import {
|
|
|
74
74
|
DeregisterStreamConsumerCommandInput,
|
|
75
75
|
DeregisterStreamConsumerCommandOutput,
|
|
76
76
|
} from "./commands/DeregisterStreamConsumerCommand";
|
|
77
|
+
import {
|
|
78
|
+
DescribeAccountSettingsCommandInput,
|
|
79
|
+
DescribeAccountSettingsCommandOutput,
|
|
80
|
+
} from "./commands/DescribeAccountSettingsCommand";
|
|
77
81
|
import {
|
|
78
82
|
DescribeLimitsCommandInput,
|
|
79
83
|
DescribeLimitsCommandOutput,
|
|
@@ -182,6 +186,10 @@ import {
|
|
|
182
186
|
UntagResourceCommandInput,
|
|
183
187
|
UntagResourceCommandOutput,
|
|
184
188
|
} from "./commands/UntagResourceCommand";
|
|
189
|
+
import {
|
|
190
|
+
UpdateAccountSettingsCommandInput,
|
|
191
|
+
UpdateAccountSettingsCommandOutput,
|
|
192
|
+
} from "./commands/UpdateAccountSettingsCommand";
|
|
185
193
|
import {
|
|
186
194
|
UpdateMaxRecordSizeCommandInput,
|
|
187
195
|
UpdateMaxRecordSizeCommandOutput,
|
|
@@ -194,6 +202,10 @@ import {
|
|
|
194
202
|
UpdateStreamModeCommandInput,
|
|
195
203
|
UpdateStreamModeCommandOutput,
|
|
196
204
|
} from "./commands/UpdateStreamModeCommand";
|
|
205
|
+
import {
|
|
206
|
+
UpdateStreamWarmThroughputCommandInput,
|
|
207
|
+
UpdateStreamWarmThroughputCommandOutput,
|
|
208
|
+
} from "./commands/UpdateStreamWarmThroughputCommand";
|
|
197
209
|
import {
|
|
198
210
|
ClientInputEndpointParameters,
|
|
199
211
|
ClientResolvedEndpointParameters,
|
|
@@ -208,6 +220,7 @@ export type ServiceInputTypes =
|
|
|
208
220
|
| DeleteResourcePolicyCommandInput
|
|
209
221
|
| DeleteStreamCommandInput
|
|
210
222
|
| DeregisterStreamConsumerCommandInput
|
|
223
|
+
| DescribeAccountSettingsCommandInput
|
|
211
224
|
| DescribeLimitsCommandInput
|
|
212
225
|
| DescribeStreamCommandInput
|
|
213
226
|
| DescribeStreamConsumerCommandInput
|
|
@@ -235,9 +248,11 @@ export type ServiceInputTypes =
|
|
|
235
248
|
| SubscribeToShardCommandInput
|
|
236
249
|
| TagResourceCommandInput
|
|
237
250
|
| UntagResourceCommandInput
|
|
251
|
+
| UpdateAccountSettingsCommandInput
|
|
238
252
|
| UpdateMaxRecordSizeCommandInput
|
|
239
253
|
| UpdateShardCountCommandInput
|
|
240
|
-
| UpdateStreamModeCommandInput
|
|
254
|
+
| UpdateStreamModeCommandInput
|
|
255
|
+
| UpdateStreamWarmThroughputCommandInput;
|
|
241
256
|
export type ServiceOutputTypes =
|
|
242
257
|
| AddTagsToStreamCommandOutput
|
|
243
258
|
| CreateStreamCommandOutput
|
|
@@ -245,6 +260,7 @@ export type ServiceOutputTypes =
|
|
|
245
260
|
| DeleteResourcePolicyCommandOutput
|
|
246
261
|
| DeleteStreamCommandOutput
|
|
247
262
|
| DeregisterStreamConsumerCommandOutput
|
|
263
|
+
| DescribeAccountSettingsCommandOutput
|
|
248
264
|
| DescribeLimitsCommandOutput
|
|
249
265
|
| DescribeStreamCommandOutput
|
|
250
266
|
| DescribeStreamConsumerCommandOutput
|
|
@@ -272,9 +288,11 @@ export type ServiceOutputTypes =
|
|
|
272
288
|
| SubscribeToShardCommandOutput
|
|
273
289
|
| TagResourceCommandOutput
|
|
274
290
|
| UntagResourceCommandOutput
|
|
291
|
+
| UpdateAccountSettingsCommandOutput
|
|
275
292
|
| UpdateMaxRecordSizeCommandOutput
|
|
276
293
|
| UpdateShardCountCommandOutput
|
|
277
|
-
| UpdateStreamModeCommandOutput
|
|
294
|
+
| UpdateStreamModeCommandOutput
|
|
295
|
+
| UpdateStreamWarmThroughputCommandOutput;
|
|
278
296
|
export interface ClientDefaults
|
|
279
297
|
extends Partial<__SmithyConfiguration<__HttpHandlerOptions>> {
|
|
280
298
|
requestHandler?: __HttpHandlerUserInput;
|