@aws-sdk/client-kinesis 3.299.0 → 3.300.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/dist-types/commands/AddTagsToStreamCommand.d.ts +7 -0
- package/dist-types/commands/CreateStreamCommand.d.ts +7 -0
- package/dist-types/commands/DecreaseStreamRetentionPeriodCommand.d.ts +5 -0
- package/dist-types/commands/DeleteStreamCommand.d.ts +5 -0
- package/dist-types/commands/DeregisterStreamConsumerCommand.d.ts +5 -0
- package/dist-types/commands/DescribeLimitsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeStreamCommand.d.ts +6 -0
- package/dist-types/commands/DescribeStreamConsumerCommand.d.ts +5 -0
- package/dist-types/commands/DescribeStreamSummaryCommand.d.ts +4 -0
- package/dist-types/commands/DisableEnhancedMonitoringCommand.d.ts +7 -0
- package/dist-types/commands/EnableEnhancedMonitoringCommand.d.ts +7 -0
- package/dist-types/commands/GetRecordsCommand.d.ts +5 -0
- package/dist-types/commands/GetShardIteratorCommand.d.ts +8 -0
- package/dist-types/commands/IncreaseStreamRetentionPeriodCommand.d.ts +5 -0
- package/dist-types/commands/ListShardsCommand.d.ts +13 -0
- package/dist-types/commands/ListStreamConsumersCommand.d.ts +6 -0
- package/dist-types/commands/ListStreamsCommand.d.ts +5 -0
- package/dist-types/commands/ListTagsForStreamCommand.d.ts +6 -0
- package/dist-types/commands/MergeShardsCommand.d.ts +6 -0
- package/dist-types/commands/PutRecordCommand.d.ts +8 -0
- package/dist-types/commands/PutRecordsCommand.d.ts +11 -0
- package/dist-types/commands/RegisterStreamConsumerCommand.d.ts +4 -0
- package/dist-types/commands/RemoveTagsFromStreamCommand.d.ts +7 -0
- package/dist-types/commands/SplitShardCommand.d.ts +6 -0
- package/dist-types/commands/StartStreamEncryptionCommand.d.ts +6 -0
- package/dist-types/commands/StopStreamEncryptionCommand.d.ts +6 -0
- package/dist-types/commands/SubscribeToShardCommand.d.ts +9 -0
- package/dist-types/commands/UpdateShardCountCommand.d.ts +6 -0
- package/dist-types/commands/UpdateStreamModeCommand.d.ts +6 -0
- package/package.json +8 -8
|
@@ -36,6 +36,13 @@ export interface AddTagsToStreamCommandOutput extends __MetadataBearer {
|
|
|
36
36
|
* import { KinesisClient, AddTagsToStreamCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
37
37
|
* // const { KinesisClient, AddTagsToStreamCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
38
38
|
* const client = new KinesisClient(config);
|
|
39
|
+
* const input = {
|
|
40
|
+
* StreamName: "STRING_VALUE",
|
|
41
|
+
* Tags: { // required
|
|
42
|
+
* "<keys>": "STRING_VALUE",
|
|
43
|
+
* },
|
|
44
|
+
* StreamARN: "STRING_VALUE",
|
|
45
|
+
* };
|
|
39
46
|
* const command = new AddTagsToStreamCommand(input);
|
|
40
47
|
* const response = await client.send(command);
|
|
41
48
|
* ```
|
|
@@ -69,6 +69,13 @@ export interface CreateStreamCommandOutput extends __MetadataBearer {
|
|
|
69
69
|
* import { KinesisClient, CreateStreamCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
70
70
|
* // const { KinesisClient, CreateStreamCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
71
71
|
* const client = new KinesisClient(config);
|
|
72
|
+
* const input = {
|
|
73
|
+
* StreamName: "STRING_VALUE", // required
|
|
74
|
+
* ShardCount: Number("int"),
|
|
75
|
+
* StreamModeDetails: {
|
|
76
|
+
* StreamMode: "PROVISIONED" || "ON_DEMAND", // required
|
|
77
|
+
* },
|
|
78
|
+
* };
|
|
72
79
|
* const command = new CreateStreamCommand(input);
|
|
73
80
|
* const response = await client.send(command);
|
|
74
81
|
* ```
|
|
@@ -35,6 +35,11 @@ export interface DecreaseStreamRetentionPeriodCommandOutput extends __MetadataBe
|
|
|
35
35
|
* import { KinesisClient, DecreaseStreamRetentionPeriodCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
36
36
|
* // const { KinesisClient, DecreaseStreamRetentionPeriodCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
37
37
|
* const client = new KinesisClient(config);
|
|
38
|
+
* const input = {
|
|
39
|
+
* StreamName: "STRING_VALUE",
|
|
40
|
+
* RetentionPeriodHours: Number("int"), // required
|
|
41
|
+
* StreamARN: "STRING_VALUE",
|
|
42
|
+
* };
|
|
38
43
|
* const command = new DecreaseStreamRetentionPeriodCommand(input);
|
|
39
44
|
* const response = await client.send(command);
|
|
40
45
|
* ```
|
|
@@ -48,6 +48,11 @@ export interface DeleteStreamCommandOutput extends __MetadataBearer {
|
|
|
48
48
|
* import { KinesisClient, DeleteStreamCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
49
49
|
* // const { KinesisClient, DeleteStreamCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
50
50
|
* const client = new KinesisClient(config);
|
|
51
|
+
* const input = {
|
|
52
|
+
* StreamName: "STRING_VALUE",
|
|
53
|
+
* EnforceConsumerDeletion: true || false,
|
|
54
|
+
* StreamARN: "STRING_VALUE",
|
|
55
|
+
* };
|
|
51
56
|
* const command = new DeleteStreamCommand(input);
|
|
52
57
|
* const response = await client.send(command);
|
|
53
58
|
* ```
|
|
@@ -33,6 +33,11 @@ export interface DeregisterStreamConsumerCommandOutput extends __MetadataBearer
|
|
|
33
33
|
* import { KinesisClient, DeregisterStreamConsumerCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
34
34
|
* // const { KinesisClient, DeregisterStreamConsumerCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
35
35
|
* const client = new KinesisClient(config);
|
|
36
|
+
* const input = {
|
|
37
|
+
* StreamARN: "STRING_VALUE",
|
|
38
|
+
* ConsumerName: "STRING_VALUE",
|
|
39
|
+
* ConsumerARN: "STRING_VALUE",
|
|
40
|
+
* };
|
|
36
41
|
* const command = new DeregisterStreamConsumerCommand(input);
|
|
37
42
|
* const response = await client.send(command);
|
|
38
43
|
* ```
|
|
@@ -29,6 +29,7 @@ export interface DescribeLimitsCommandOutput extends DescribeLimitsOutput, __Met
|
|
|
29
29
|
* import { KinesisClient, DescribeLimitsCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
30
30
|
* // const { KinesisClient, DescribeLimitsCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
31
31
|
* const client = new KinesisClient(config);
|
|
32
|
+
* const input = {};
|
|
32
33
|
* const command = new DescribeLimitsCommand(input);
|
|
33
34
|
* const response = await client.send(command);
|
|
34
35
|
* ```
|
|
@@ -49,6 +49,12 @@ export interface DescribeStreamCommandOutput extends DescribeStreamOutput, __Met
|
|
|
49
49
|
* import { KinesisClient, DescribeStreamCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
50
50
|
* // const { KinesisClient, DescribeStreamCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
51
51
|
* const client = new KinesisClient(config);
|
|
52
|
+
* const input = {
|
|
53
|
+
* StreamName: "STRING_VALUE",
|
|
54
|
+
* Limit: Number("int"),
|
|
55
|
+
* ExclusiveStartShardId: "STRING_VALUE",
|
|
56
|
+
* StreamARN: "STRING_VALUE",
|
|
57
|
+
* };
|
|
52
58
|
* const command = new DescribeStreamCommand(input);
|
|
53
59
|
* const response = await client.send(command);
|
|
54
60
|
* ```
|
|
@@ -33,6 +33,11 @@ export interface DescribeStreamConsumerCommandOutput extends DescribeStreamConsu
|
|
|
33
33
|
* import { KinesisClient, DescribeStreamConsumerCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
34
34
|
* // const { KinesisClient, DescribeStreamConsumerCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
35
35
|
* const client = new KinesisClient(config);
|
|
36
|
+
* const input = {
|
|
37
|
+
* StreamARN: "STRING_VALUE",
|
|
38
|
+
* ConsumerName: "STRING_VALUE",
|
|
39
|
+
* ConsumerARN: "STRING_VALUE",
|
|
40
|
+
* };
|
|
36
41
|
* const command = new DescribeStreamConsumerCommand(input);
|
|
37
42
|
* const response = await client.send(command);
|
|
38
43
|
* ```
|
|
@@ -37,6 +37,10 @@ export interface DescribeStreamSummaryCommandOutput extends DescribeStreamSummar
|
|
|
37
37
|
* import { KinesisClient, DescribeStreamSummaryCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
38
38
|
* // const { KinesisClient, DescribeStreamSummaryCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
39
39
|
* const client = new KinesisClient(config);
|
|
40
|
+
* const input = {
|
|
41
|
+
* StreamName: "STRING_VALUE",
|
|
42
|
+
* StreamARN: "STRING_VALUE",
|
|
43
|
+
* };
|
|
40
44
|
* const command = new DescribeStreamSummaryCommand(input);
|
|
41
45
|
* const response = await client.send(command);
|
|
42
46
|
* ```
|
|
@@ -30,6 +30,13 @@ export interface DisableEnhancedMonitoringCommandOutput extends EnhancedMonitori
|
|
|
30
30
|
* import { KinesisClient, DisableEnhancedMonitoringCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
31
31
|
* // const { KinesisClient, DisableEnhancedMonitoringCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
32
32
|
* const client = new KinesisClient(config);
|
|
33
|
+
* const input = {
|
|
34
|
+
* StreamName: "STRING_VALUE",
|
|
35
|
+
* ShardLevelMetrics: [ // required
|
|
36
|
+
* "IncomingBytes" || "IncomingRecords" || "OutgoingBytes" || "OutgoingRecords" || "WriteProvisionedThroughputExceeded" || "ReadProvisionedThroughputExceeded" || "IteratorAgeMilliseconds" || "ALL",
|
|
37
|
+
* ],
|
|
38
|
+
* StreamARN: "STRING_VALUE",
|
|
39
|
+
* };
|
|
33
40
|
* const command = new DisableEnhancedMonitoringCommand(input);
|
|
34
41
|
* const response = await client.send(command);
|
|
35
42
|
* ```
|
|
@@ -30,6 +30,13 @@ export interface EnableEnhancedMonitoringCommandOutput extends EnhancedMonitorin
|
|
|
30
30
|
* import { KinesisClient, EnableEnhancedMonitoringCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
31
31
|
* // const { KinesisClient, EnableEnhancedMonitoringCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
32
32
|
* const client = new KinesisClient(config);
|
|
33
|
+
* const input = {
|
|
34
|
+
* StreamName: "STRING_VALUE",
|
|
35
|
+
* ShardLevelMetrics: [ // required
|
|
36
|
+
* "IncomingBytes" || "IncomingRecords" || "OutgoingBytes" || "OutgoingRecords" || "WriteProvisionedThroughputExceeded" || "ReadProvisionedThroughputExceeded" || "IteratorAgeMilliseconds" || "ALL",
|
|
37
|
+
* ],
|
|
38
|
+
* StreamARN: "STRING_VALUE",
|
|
39
|
+
* };
|
|
33
40
|
* const command = new EnableEnhancedMonitoringCommand(input);
|
|
34
41
|
* const response = await client.send(command);
|
|
35
42
|
* ```
|
|
@@ -77,6 +77,11 @@ export interface GetRecordsCommandOutput extends GetRecordsOutput, __MetadataBea
|
|
|
77
77
|
* import { KinesisClient, GetRecordsCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
78
78
|
* // const { KinesisClient, GetRecordsCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
79
79
|
* const client = new KinesisClient(config);
|
|
80
|
+
* const input = {
|
|
81
|
+
* ShardIterator: "STRING_VALUE", // required
|
|
82
|
+
* Limit: Number("int"),
|
|
83
|
+
* StreamARN: "STRING_VALUE",
|
|
84
|
+
* };
|
|
80
85
|
* const command = new GetRecordsCommand(input);
|
|
81
86
|
* const response = await client.send(command);
|
|
82
87
|
* ```
|
|
@@ -63,6 +63,14 @@ export interface GetShardIteratorCommandOutput extends GetShardIteratorOutput, _
|
|
|
63
63
|
* import { KinesisClient, GetShardIteratorCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
64
64
|
* // const { KinesisClient, GetShardIteratorCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
65
65
|
* const client = new KinesisClient(config);
|
|
66
|
+
* const input = {
|
|
67
|
+
* StreamName: "STRING_VALUE",
|
|
68
|
+
* ShardId: "STRING_VALUE", // required
|
|
69
|
+
* ShardIteratorType: "AT_SEQUENCE_NUMBER" || "AFTER_SEQUENCE_NUMBER" || "TRIM_HORIZON" || "LATEST" || "AT_TIMESTAMP", // required
|
|
70
|
+
* StartingSequenceNumber: "STRING_VALUE",
|
|
71
|
+
* Timestamp: new Date("TIMESTAMP"),
|
|
72
|
+
* StreamARN: "STRING_VALUE",
|
|
73
|
+
* };
|
|
66
74
|
* const command = new GetShardIteratorCommand(input);
|
|
67
75
|
* const response = await client.send(command);
|
|
68
76
|
* ```
|
|
@@ -38,6 +38,11 @@ export interface IncreaseStreamRetentionPeriodCommandOutput extends __MetadataBe
|
|
|
38
38
|
* import { KinesisClient, IncreaseStreamRetentionPeriodCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
39
39
|
* // const { KinesisClient, IncreaseStreamRetentionPeriodCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
40
40
|
* const client = new KinesisClient(config);
|
|
41
|
+
* const input = {
|
|
42
|
+
* StreamName: "STRING_VALUE",
|
|
43
|
+
* RetentionPeriodHours: Number("int"), // required
|
|
44
|
+
* StreamARN: "STRING_VALUE",
|
|
45
|
+
* };
|
|
41
46
|
* const command = new IncreaseStreamRetentionPeriodCommand(input);
|
|
42
47
|
* const response = await client.send(command);
|
|
43
48
|
* ```
|
|
@@ -40,6 +40,19 @@ export interface ListShardsCommandOutput extends ListShardsOutput, __MetadataBea
|
|
|
40
40
|
* import { KinesisClient, ListShardsCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
41
41
|
* // const { KinesisClient, ListShardsCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
42
42
|
* const client = new KinesisClient(config);
|
|
43
|
+
* const input = {
|
|
44
|
+
* StreamName: "STRING_VALUE",
|
|
45
|
+
* NextToken: "STRING_VALUE",
|
|
46
|
+
* ExclusiveStartShardId: "STRING_VALUE",
|
|
47
|
+
* MaxResults: Number("int"),
|
|
48
|
+
* StreamCreationTimestamp: new Date("TIMESTAMP"),
|
|
49
|
+
* ShardFilter: {
|
|
50
|
+
* Type: "AFTER_SHARD_ID" || "AT_TRIM_HORIZON" || "FROM_TRIM_HORIZON" || "AT_LATEST" || "AT_TIMESTAMP" || "FROM_TIMESTAMP", // required
|
|
51
|
+
* ShardId: "STRING_VALUE",
|
|
52
|
+
* Timestamp: new Date("TIMESTAMP"),
|
|
53
|
+
* },
|
|
54
|
+
* StreamARN: "STRING_VALUE",
|
|
55
|
+
* };
|
|
43
56
|
* const command = new ListShardsCommand(input);
|
|
44
57
|
* const response = await client.send(command);
|
|
45
58
|
* ```
|
|
@@ -28,6 +28,12 @@ export interface ListStreamConsumersCommandOutput extends ListStreamConsumersOut
|
|
|
28
28
|
* import { KinesisClient, ListStreamConsumersCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
29
29
|
* // const { KinesisClient, ListStreamConsumersCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
30
30
|
* const client = new KinesisClient(config);
|
|
31
|
+
* const input = {
|
|
32
|
+
* StreamARN: "STRING_VALUE", // required
|
|
33
|
+
* NextToken: "STRING_VALUE",
|
|
34
|
+
* MaxResults: Number("int"),
|
|
35
|
+
* StreamCreationTimestamp: new Date("TIMESTAMP"),
|
|
36
|
+
* };
|
|
31
37
|
* const command = new ListStreamConsumersCommand(input);
|
|
32
38
|
* const response = await client.send(command);
|
|
33
39
|
* ```
|
|
@@ -41,6 +41,11 @@ export interface ListStreamsCommandOutput extends ListStreamsOutput, __MetadataB
|
|
|
41
41
|
* import { KinesisClient, ListStreamsCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
42
42
|
* // const { KinesisClient, ListStreamsCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
43
43
|
* const client = new KinesisClient(config);
|
|
44
|
+
* const input = {
|
|
45
|
+
* Limit: Number("int"),
|
|
46
|
+
* ExclusiveStartStreamName: "STRING_VALUE",
|
|
47
|
+
* NextToken: "STRING_VALUE",
|
|
48
|
+
* };
|
|
44
49
|
* const command = new ListStreamsCommand(input);
|
|
45
50
|
* const response = await client.send(command);
|
|
46
51
|
* ```
|
|
@@ -31,6 +31,12 @@ export interface ListTagsForStreamCommandOutput extends ListTagsForStreamOutput,
|
|
|
31
31
|
* import { KinesisClient, ListTagsForStreamCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
32
32
|
* // const { KinesisClient, ListTagsForStreamCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
33
33
|
* const client = new KinesisClient(config);
|
|
34
|
+
* const input = {
|
|
35
|
+
* StreamName: "STRING_VALUE",
|
|
36
|
+
* ExclusiveStartTagKey: "STRING_VALUE",
|
|
37
|
+
* Limit: Number("int"),
|
|
38
|
+
* StreamARN: "STRING_VALUE",
|
|
39
|
+
* };
|
|
34
40
|
* const command = new ListTagsForStreamCommand(input);
|
|
35
41
|
* const response = await client.send(command);
|
|
36
42
|
* ```
|
|
@@ -66,6 +66,12 @@ export interface MergeShardsCommandOutput extends __MetadataBearer {
|
|
|
66
66
|
* import { KinesisClient, MergeShardsCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
67
67
|
* // const { KinesisClient, MergeShardsCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
68
68
|
* const client = new KinesisClient(config);
|
|
69
|
+
* const input = {
|
|
70
|
+
* StreamName: "STRING_VALUE",
|
|
71
|
+
* ShardToMerge: "STRING_VALUE", // required
|
|
72
|
+
* AdjacentShardToMerge: "STRING_VALUE", // required
|
|
73
|
+
* StreamARN: "STRING_VALUE",
|
|
74
|
+
* };
|
|
69
75
|
* const command = new MergeShardsCommand(input);
|
|
70
76
|
* const response = await client.send(command);
|
|
71
77
|
* ```
|
|
@@ -65,6 +65,14 @@ export interface PutRecordCommandOutput extends PutRecordOutput, __MetadataBeare
|
|
|
65
65
|
* import { KinesisClient, PutRecordCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
66
66
|
* // const { KinesisClient, PutRecordCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
67
67
|
* const client = new KinesisClient(config);
|
|
68
|
+
* const input = {
|
|
69
|
+
* StreamName: "STRING_VALUE",
|
|
70
|
+
* Data: "BLOB_VALUE", // required
|
|
71
|
+
* PartitionKey: "STRING_VALUE", // required
|
|
72
|
+
* ExplicitHashKey: "STRING_VALUE",
|
|
73
|
+
* SequenceNumberForOrdering: "STRING_VALUE",
|
|
74
|
+
* StreamARN: "STRING_VALUE",
|
|
75
|
+
* };
|
|
68
76
|
* const command = new PutRecordCommand(input);
|
|
69
77
|
* const response = await client.send(command);
|
|
70
78
|
* ```
|
|
@@ -85,6 +85,17 @@ export interface PutRecordsCommandOutput extends PutRecordsOutput, __MetadataBea
|
|
|
85
85
|
* import { KinesisClient, PutRecordsCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
86
86
|
* // const { KinesisClient, PutRecordsCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
87
87
|
* const client = new KinesisClient(config);
|
|
88
|
+
* const input = {
|
|
89
|
+
* Records: [ // required
|
|
90
|
+
* {
|
|
91
|
+
* Data: "BLOB_VALUE", // required
|
|
92
|
+
* ExplicitHashKey: "STRING_VALUE",
|
|
93
|
+
* PartitionKey: "STRING_VALUE", // required
|
|
94
|
+
* },
|
|
95
|
+
* ],
|
|
96
|
+
* StreamName: "STRING_VALUE",
|
|
97
|
+
* StreamARN: "STRING_VALUE",
|
|
98
|
+
* };
|
|
88
99
|
* const command = new PutRecordsCommand(input);
|
|
89
100
|
* const response = await client.send(command);
|
|
90
101
|
* ```
|
|
@@ -39,6 +39,10 @@ export interface RegisterStreamConsumerCommandOutput extends RegisterStreamConsu
|
|
|
39
39
|
* import { KinesisClient, RegisterStreamConsumerCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
40
40
|
* // const { KinesisClient, RegisterStreamConsumerCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
41
41
|
* const client = new KinesisClient(config);
|
|
42
|
+
* const input = {
|
|
43
|
+
* StreamARN: "STRING_VALUE", // required
|
|
44
|
+
* ConsumerName: "STRING_VALUE", // required
|
|
45
|
+
* };
|
|
42
46
|
* const command = new RegisterStreamConsumerCommand(input);
|
|
43
47
|
* const response = await client.send(command);
|
|
44
48
|
* ```
|
|
@@ -35,6 +35,13 @@ export interface RemoveTagsFromStreamCommandOutput extends __MetadataBearer {
|
|
|
35
35
|
* import { KinesisClient, RemoveTagsFromStreamCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
36
36
|
* // const { KinesisClient, RemoveTagsFromStreamCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
37
37
|
* const client = new KinesisClient(config);
|
|
38
|
+
* const input = {
|
|
39
|
+
* StreamName: "STRING_VALUE",
|
|
40
|
+
* TagKeys: [ // required
|
|
41
|
+
* "STRING_VALUE",
|
|
42
|
+
* ],
|
|
43
|
+
* StreamARN: "STRING_VALUE",
|
|
44
|
+
* };
|
|
38
45
|
* const command = new RemoveTagsFromStreamCommand(input);
|
|
39
46
|
* const response = await client.send(command);
|
|
40
47
|
* ```
|
|
@@ -70,6 +70,12 @@ export interface SplitShardCommandOutput extends __MetadataBearer {
|
|
|
70
70
|
* import { KinesisClient, SplitShardCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
71
71
|
* // const { KinesisClient, SplitShardCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
72
72
|
* const client = new KinesisClient(config);
|
|
73
|
+
* const input = {
|
|
74
|
+
* StreamName: "STRING_VALUE",
|
|
75
|
+
* ShardToSplit: "STRING_VALUE", // required
|
|
76
|
+
* NewStartingHashKey: "STRING_VALUE", // required
|
|
77
|
+
* StreamARN: "STRING_VALUE",
|
|
78
|
+
* };
|
|
73
79
|
* const command = new SplitShardCommand(input);
|
|
74
80
|
* const response = await client.send(command);
|
|
75
81
|
* ```
|
|
@@ -45,6 +45,12 @@ export interface StartStreamEncryptionCommandOutput extends __MetadataBearer {
|
|
|
45
45
|
* import { KinesisClient, StartStreamEncryptionCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
46
46
|
* // const { KinesisClient, StartStreamEncryptionCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
47
47
|
* const client = new KinesisClient(config);
|
|
48
|
+
* const input = {
|
|
49
|
+
* StreamName: "STRING_VALUE",
|
|
50
|
+
* EncryptionType: "NONE" || "KMS", // required
|
|
51
|
+
* KeyId: "STRING_VALUE", // required
|
|
52
|
+
* StreamARN: "STRING_VALUE",
|
|
53
|
+
* };
|
|
48
54
|
* const command = new StartStreamEncryptionCommand(input);
|
|
49
55
|
* const response = await client.send(command);
|
|
50
56
|
* ```
|
|
@@ -44,6 +44,12 @@ export interface StopStreamEncryptionCommandOutput extends __MetadataBearer {
|
|
|
44
44
|
* import { KinesisClient, StopStreamEncryptionCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
45
45
|
* // const { KinesisClient, StopStreamEncryptionCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
46
46
|
* const client = new KinesisClient(config);
|
|
47
|
+
* const input = {
|
|
48
|
+
* StreamName: "STRING_VALUE",
|
|
49
|
+
* EncryptionType: "NONE" || "KMS", // required
|
|
50
|
+
* KeyId: "STRING_VALUE", // required
|
|
51
|
+
* StreamARN: "STRING_VALUE",
|
|
52
|
+
* };
|
|
47
53
|
* const command = new StopStreamEncryptionCommand(input);
|
|
48
54
|
* const response = await client.send(command);
|
|
49
55
|
* ```
|
|
@@ -48,6 +48,15 @@ export interface SubscribeToShardCommandOutput extends SubscribeToShardOutput, _
|
|
|
48
48
|
* import { KinesisClient, SubscribeToShardCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
49
49
|
* // const { KinesisClient, SubscribeToShardCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
50
50
|
* const client = new KinesisClient(config);
|
|
51
|
+
* const input = {
|
|
52
|
+
* ConsumerARN: "STRING_VALUE", // required
|
|
53
|
+
* ShardId: "STRING_VALUE", // required
|
|
54
|
+
* StartingPosition: {
|
|
55
|
+
* Type: "AT_SEQUENCE_NUMBER" || "AFTER_SEQUENCE_NUMBER" || "TRIM_HORIZON" || "LATEST" || "AT_TIMESTAMP", // required
|
|
56
|
+
* SequenceNumber: "STRING_VALUE",
|
|
57
|
+
* Timestamp: new Date("TIMESTAMP"),
|
|
58
|
+
* },
|
|
59
|
+
* };
|
|
51
60
|
* const command = new SubscribeToShardCommand(input);
|
|
52
61
|
* const response = await client.send(command);
|
|
53
62
|
* ```
|
|
@@ -73,6 +73,12 @@ export interface UpdateShardCountCommandOutput extends UpdateShardCountOutput, _
|
|
|
73
73
|
* import { KinesisClient, UpdateShardCountCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
74
74
|
* // const { KinesisClient, UpdateShardCountCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
75
75
|
* const client = new KinesisClient(config);
|
|
76
|
+
* const input = {
|
|
77
|
+
* StreamName: "STRING_VALUE",
|
|
78
|
+
* TargetShardCount: Number("int"), // required
|
|
79
|
+
* ScalingType: "UNIFORM_SCALING", // required
|
|
80
|
+
* StreamARN: "STRING_VALUE",
|
|
81
|
+
* };
|
|
76
82
|
* const command = new UpdateShardCountCommand(input);
|
|
77
83
|
* const response = await client.send(command);
|
|
78
84
|
* ```
|
|
@@ -29,6 +29,12 @@ export interface UpdateStreamModeCommandOutput extends __MetadataBearer {
|
|
|
29
29
|
* import { KinesisClient, UpdateStreamModeCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
|
|
30
30
|
* // const { KinesisClient, UpdateStreamModeCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
|
|
31
31
|
* const client = new KinesisClient(config);
|
|
32
|
+
* const input = {
|
|
33
|
+
* StreamARN: "STRING_VALUE", // required
|
|
34
|
+
* StreamModeDetails: {
|
|
35
|
+
* StreamMode: "PROVISIONED" || "ON_DEMAND", // required
|
|
36
|
+
* },
|
|
37
|
+
* };
|
|
32
38
|
* const command = new UpdateStreamModeCommand(input);
|
|
33
39
|
* const response = await client.send(command);
|
|
34
40
|
* ```
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-kinesis",
|
|
3
3
|
"description": "AWS SDK for JavaScript Kinesis Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.300.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,9 +21,9 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/config-resolver": "3.
|
|
26
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.300.0",
|
|
25
|
+
"@aws-sdk/config-resolver": "3.300.0",
|
|
26
|
+
"@aws-sdk/credential-provider-node": "3.300.0",
|
|
27
27
|
"@aws-sdk/eventstream-serde-browser": "3.296.0",
|
|
28
28
|
"@aws-sdk/eventstream-serde-config-resolver": "3.296.0",
|
|
29
29
|
"@aws-sdk/eventstream-serde-node": "3.299.0",
|
|
@@ -35,12 +35,12 @@
|
|
|
35
35
|
"@aws-sdk/middleware-host-header": "3.296.0",
|
|
36
36
|
"@aws-sdk/middleware-logger": "3.296.0",
|
|
37
37
|
"@aws-sdk/middleware-recursion-detection": "3.296.0",
|
|
38
|
-
"@aws-sdk/middleware-retry": "3.
|
|
38
|
+
"@aws-sdk/middleware-retry": "3.300.0",
|
|
39
39
|
"@aws-sdk/middleware-serde": "3.296.0",
|
|
40
40
|
"@aws-sdk/middleware-signing": "3.299.0",
|
|
41
41
|
"@aws-sdk/middleware-stack": "3.296.0",
|
|
42
42
|
"@aws-sdk/middleware-user-agent": "3.299.0",
|
|
43
|
-
"@aws-sdk/node-config-provider": "3.
|
|
43
|
+
"@aws-sdk/node-config-provider": "3.300.0",
|
|
44
44
|
"@aws-sdk/node-http-handler": "3.296.0",
|
|
45
45
|
"@aws-sdk/protocol-http": "3.296.0",
|
|
46
46
|
"@aws-sdk/smithy-client": "3.296.0",
|
|
@@ -50,11 +50,11 @@
|
|
|
50
50
|
"@aws-sdk/util-body-length-browser": "3.295.0",
|
|
51
51
|
"@aws-sdk/util-body-length-node": "3.295.0",
|
|
52
52
|
"@aws-sdk/util-defaults-mode-browser": "3.296.0",
|
|
53
|
-
"@aws-sdk/util-defaults-mode-node": "3.
|
|
53
|
+
"@aws-sdk/util-defaults-mode-node": "3.300.0",
|
|
54
54
|
"@aws-sdk/util-endpoints": "3.296.0",
|
|
55
55
|
"@aws-sdk/util-retry": "3.296.0",
|
|
56
56
|
"@aws-sdk/util-user-agent-browser": "3.299.0",
|
|
57
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
57
|
+
"@aws-sdk/util-user-agent-node": "3.300.0",
|
|
58
58
|
"@aws-sdk/util-utf8": "3.295.0",
|
|
59
59
|
"@aws-sdk/util-waiter": "3.296.0",
|
|
60
60
|
"tslib": "^2.5.0"
|