@aws-sdk/client-dynamodb-streams 3.287.0 → 3.289.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.
|
@@ -37,6 +37,71 @@ export interface DescribeStreamCommandOutput extends DescribeStreamOutput, __Met
|
|
|
37
37
|
* @see {@link DescribeStreamCommandOutput} for command's `response` shape.
|
|
38
38
|
* @see {@link DynamoDBStreamsClientResolvedConfig | config} for DynamoDBStreamsClient's `config` shape.
|
|
39
39
|
*
|
|
40
|
+
* @example To describe a stream with a given stream ARN
|
|
41
|
+
* ```javascript
|
|
42
|
+
* // The following example describes a stream with a given stream ARN.
|
|
43
|
+
* const input = {
|
|
44
|
+
* "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252"
|
|
45
|
+
* };
|
|
46
|
+
* const command = new DescribeStreamCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* /* response ==
|
|
49
|
+
* {
|
|
50
|
+
* "StreamDescription": {
|
|
51
|
+
* "CreationRequestDateTime": "Wed May 20 13:51:10 PDT 2015",
|
|
52
|
+
* "KeySchema": [
|
|
53
|
+
* {
|
|
54
|
+
* "AttributeName": "ForumName",
|
|
55
|
+
* "KeyType": "HASH"
|
|
56
|
+
* },
|
|
57
|
+
* {
|
|
58
|
+
* "AttributeName": "Subject",
|
|
59
|
+
* "KeyType": "RANGE"
|
|
60
|
+
* }
|
|
61
|
+
* ],
|
|
62
|
+
* "Shards": [
|
|
63
|
+
* {
|
|
64
|
+
* "SequenceNumberRange": {
|
|
65
|
+
* "EndingSequenceNumber": "20500000000000000910398",
|
|
66
|
+
* "StartingSequenceNumber": "20500000000000000910398"
|
|
67
|
+
* },
|
|
68
|
+
* "ShardId": "shardId-00000001414562045508-2bac9cd2"
|
|
69
|
+
* },
|
|
70
|
+
* {
|
|
71
|
+
* "ParentShardId": "shardId-00000001414562045508-2bac9cd2",
|
|
72
|
+
* "SequenceNumberRange": {
|
|
73
|
+
* "EndingSequenceNumber": "820400000000000001192334",
|
|
74
|
+
* "StartingSequenceNumber": "820400000000000001192334"
|
|
75
|
+
* },
|
|
76
|
+
* "ShardId": "shardId-00000001414576573621-f55eea83"
|
|
77
|
+
* },
|
|
78
|
+
* {
|
|
79
|
+
* "ParentShardId": "shardId-00000001414576573621-f55eea83",
|
|
80
|
+
* "SequenceNumberRange": {
|
|
81
|
+
* "EndingSequenceNumber": "1683700000000000001135967",
|
|
82
|
+
* "StartingSequenceNumber": "1683700000000000001135967"
|
|
83
|
+
* },
|
|
84
|
+
* "ShardId": "shardId-00000001414592258131-674fd923"
|
|
85
|
+
* },
|
|
86
|
+
* {
|
|
87
|
+
* "ParentShardId": "shardId-00000001414592258131-674fd923",
|
|
88
|
+
* "SequenceNumberRange": {
|
|
89
|
+
* "StartingSequenceNumber": "2574600000000000000935255"
|
|
90
|
+
* },
|
|
91
|
+
* "ShardId": "shardId-00000001414608446368-3a1afbaf"
|
|
92
|
+
* }
|
|
93
|
+
* ],
|
|
94
|
+
* "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252",
|
|
95
|
+
* "StreamLabel": "2015-05-20T20:51:10.252",
|
|
96
|
+
* "StreamStatus": "ENABLED",
|
|
97
|
+
* "StreamViewType": "NEW_AND_OLD_IMAGES",
|
|
98
|
+
* "TableName": "Forum"
|
|
99
|
+
* }
|
|
100
|
+
* }
|
|
101
|
+
* *\/
|
|
102
|
+
* // example id: to-describe-a-stream-with-a-given-stream-arn-1473457835200
|
|
103
|
+
* ```
|
|
104
|
+
*
|
|
40
105
|
*/
|
|
41
106
|
export declare class DescribeStreamCommand extends $Command<DescribeStreamCommandInput, DescribeStreamCommandOutput, DynamoDBStreamsClientResolvedConfig> {
|
|
42
107
|
readonly input: DescribeStreamCommandInput;
|
|
@@ -39,6 +39,87 @@ export interface GetRecordsCommandOutput extends GetRecordsOutput, __MetadataBea
|
|
|
39
39
|
* @see {@link GetRecordsCommandOutput} for command's `response` shape.
|
|
40
40
|
* @see {@link DynamoDBStreamsClientResolvedConfig | config} for DynamoDBStreamsClient's `config` shape.
|
|
41
41
|
*
|
|
42
|
+
* @example To retrieve all the stream records from a shard
|
|
43
|
+
* ```javascript
|
|
44
|
+
* // The following example retrieves all the stream records from a shard.
|
|
45
|
+
* const input = {
|
|
46
|
+
* "ShardIterator": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAEvJp6D+zaQ... <remaining characters omitted> ..."
|
|
47
|
+
* };
|
|
48
|
+
* const command = new GetRecordsCommand(input);
|
|
49
|
+
* const response = await client.send(command);
|
|
50
|
+
* /* response ==
|
|
51
|
+
* {
|
|
52
|
+
* "NextShardIterator": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAGQBYshYDEe ... <remaining characters omitted> ...",
|
|
53
|
+
* "Records": [
|
|
54
|
+
* {
|
|
55
|
+
* "awsRegion": "us-west-2",
|
|
56
|
+
* "dynamodb": {
|
|
57
|
+
* "ApproximateCreationDateTime": "1.46480646E9",
|
|
58
|
+
* "Keys": {
|
|
59
|
+
* "ForumName": {
|
|
60
|
+
* "S": "DynamoDB"
|
|
61
|
+
* },
|
|
62
|
+
* "Subject": {
|
|
63
|
+
* "S": "DynamoDB Thread 3"
|
|
64
|
+
* }
|
|
65
|
+
* },
|
|
66
|
+
* "SequenceNumber": "300000000000000499659",
|
|
67
|
+
* "SizeBytes": 41,
|
|
68
|
+
* "StreamViewType": "KEYS_ONLY"
|
|
69
|
+
* },
|
|
70
|
+
* "eventID": "e2fd9c34eff2d779b297b26f5fef4206",
|
|
71
|
+
* "eventName": "INSERT",
|
|
72
|
+
* "eventSource": "aws:dynamodb",
|
|
73
|
+
* "eventVersion": "1.0"
|
|
74
|
+
* },
|
|
75
|
+
* {
|
|
76
|
+
* "awsRegion": "us-west-2",
|
|
77
|
+
* "dynamodb": {
|
|
78
|
+
* "ApproximateCreationDateTime": "1.46480527E9",
|
|
79
|
+
* "Keys": {
|
|
80
|
+
* "ForumName": {
|
|
81
|
+
* "S": "DynamoDB"
|
|
82
|
+
* },
|
|
83
|
+
* "Subject": {
|
|
84
|
+
* "S": "DynamoDB Thread 1"
|
|
85
|
+
* }
|
|
86
|
+
* },
|
|
87
|
+
* "SequenceNumber": "400000000000000499660",
|
|
88
|
+
* "SizeBytes": 41,
|
|
89
|
+
* "StreamViewType": "KEYS_ONLY"
|
|
90
|
+
* },
|
|
91
|
+
* "eventID": "4b25bd0da9a181a155114127e4837252",
|
|
92
|
+
* "eventName": "MODIFY",
|
|
93
|
+
* "eventSource": "aws:dynamodb",
|
|
94
|
+
* "eventVersion": "1.0"
|
|
95
|
+
* },
|
|
96
|
+
* {
|
|
97
|
+
* "awsRegion": "us-west-2",
|
|
98
|
+
* "dynamodb": {
|
|
99
|
+
* "ApproximateCreationDateTime": "1.46480646E9",
|
|
100
|
+
* "Keys": {
|
|
101
|
+
* "ForumName": {
|
|
102
|
+
* "S": "DynamoDB"
|
|
103
|
+
* },
|
|
104
|
+
* "Subject": {
|
|
105
|
+
* "S": "DynamoDB Thread 2"
|
|
106
|
+
* }
|
|
107
|
+
* },
|
|
108
|
+
* "SequenceNumber": "500000000000000499661",
|
|
109
|
+
* "SizeBytes": 41,
|
|
110
|
+
* "StreamViewType": "KEYS_ONLY"
|
|
111
|
+
* },
|
|
112
|
+
* "eventID": "740280c73a3df7842edab3548a1b08ad",
|
|
113
|
+
* "eventName": "REMOVE",
|
|
114
|
+
* "eventSource": "aws:dynamodb",
|
|
115
|
+
* "eventVersion": "1.0"
|
|
116
|
+
* }
|
|
117
|
+
* ]
|
|
118
|
+
* }
|
|
119
|
+
* *\/
|
|
120
|
+
* // example id: to-retrieve-all-the-stream-records-from-a-shard-1473707781419
|
|
121
|
+
* ```
|
|
122
|
+
*
|
|
42
123
|
*/
|
|
43
124
|
export declare class GetRecordsCommand extends $Command<GetRecordsCommandInput, GetRecordsCommandOutput, DynamoDBStreamsClientResolvedConfig> {
|
|
44
125
|
readonly input: GetRecordsCommandInput;
|
|
@@ -36,6 +36,24 @@ export interface GetShardIteratorCommandOutput extends GetShardIteratorOutput, _
|
|
|
36
36
|
* @see {@link GetShardIteratorCommandOutput} for command's `response` shape.
|
|
37
37
|
* @see {@link DynamoDBStreamsClientResolvedConfig | config} for DynamoDBStreamsClient's `config` shape.
|
|
38
38
|
*
|
|
39
|
+
* @example To obtain a shard iterator for the provided stream ARN and shard ID
|
|
40
|
+
* ```javascript
|
|
41
|
+
* // The following example returns a shard iterator for the provided stream ARN and shard ID.
|
|
42
|
+
* const input = {
|
|
43
|
+
* "ShardId": "00000001414576573621-f55eea83",
|
|
44
|
+
* "ShardIteratorType": "TRIM_HORIZON",
|
|
45
|
+
* "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252"
|
|
46
|
+
* };
|
|
47
|
+
* const command = new GetShardIteratorCommand(input);
|
|
48
|
+
* const response = await client.send(command);
|
|
49
|
+
* /* response ==
|
|
50
|
+
* {
|
|
51
|
+
* "ShardIterator": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAEvJp6D+zaQ... <remaining characters omitted> ..."
|
|
52
|
+
* }
|
|
53
|
+
* *\/
|
|
54
|
+
* // example id: to-obtain-a-shard-iterator-for-the-provided-stream-arn-and-shard-id-1473459941476
|
|
55
|
+
* ```
|
|
56
|
+
*
|
|
39
57
|
*/
|
|
40
58
|
export declare class GetShardIteratorCommand extends $Command<GetShardIteratorCommandInput, GetShardIteratorCommandOutput, DynamoDBStreamsClientResolvedConfig> {
|
|
41
59
|
readonly input: GetShardIteratorCommandInput;
|
|
@@ -34,6 +34,36 @@ export interface ListStreamsCommandOutput extends ListStreamsOutput, __MetadataB
|
|
|
34
34
|
* @see {@link ListStreamsCommandOutput} for command's `response` shape.
|
|
35
35
|
* @see {@link DynamoDBStreamsClientResolvedConfig | config} for DynamoDBStreamsClient's `config` shape.
|
|
36
36
|
*
|
|
37
|
+
* @example To list all of the stream ARNs
|
|
38
|
+
* ```javascript
|
|
39
|
+
* // The following example lists all of the stream ARNs.
|
|
40
|
+
* const input = {};
|
|
41
|
+
* const command = new ListStreamsCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* /* response ==
|
|
44
|
+
* {
|
|
45
|
+
* "Streams": [
|
|
46
|
+
* {
|
|
47
|
+
* "StreamArn": "arn:aws:dynamodb:us-wesst-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252",
|
|
48
|
+
* "StreamLabel": "2015-05-20T20:51:10.252",
|
|
49
|
+
* "TableName": "Forum"
|
|
50
|
+
* },
|
|
51
|
+
* {
|
|
52
|
+
* "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:50:02.714",
|
|
53
|
+
* "StreamLabel": "2015-05-20T20:50:02.714",
|
|
54
|
+
* "TableName": "Forum"
|
|
55
|
+
* },
|
|
56
|
+
* {
|
|
57
|
+
* "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-19T23:03:50.641",
|
|
58
|
+
* "StreamLabel": "2015-05-19T23:03:50.641",
|
|
59
|
+
* "TableName": "Forum"
|
|
60
|
+
* }
|
|
61
|
+
* ]
|
|
62
|
+
* }
|
|
63
|
+
* *\/
|
|
64
|
+
* // example id: to-list-all-of-the-stream-arns--1473459534285
|
|
65
|
+
* ```
|
|
66
|
+
*
|
|
37
67
|
*/
|
|
38
68
|
export declare class ListStreamsCommand extends $Command<ListStreamsCommandInput, ListStreamsCommandOutput, DynamoDBStreamsClientResolvedConfig> {
|
|
39
69
|
readonly input: ListStreamsCommandInput;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-dynamodb-streams",
|
|
3
3
|
"description": "AWS SDK for JavaScript Dynamodb Streams Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.289.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",
|
|
@@ -20,37 +20,37 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
23
|
-
"@aws-sdk/client-sts": "3.
|
|
24
|
-
"@aws-sdk/config-resolver": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
-
"@aws-sdk/fetch-http-handler": "3.
|
|
27
|
-
"@aws-sdk/hash-node": "3.
|
|
28
|
-
"@aws-sdk/invalid-dependency": "3.
|
|
29
|
-
"@aws-sdk/middleware-content-length": "3.
|
|
30
|
-
"@aws-sdk/middleware-endpoint": "3.
|
|
31
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
32
|
-
"@aws-sdk/middleware-logger": "3.
|
|
33
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
34
|
-
"@aws-sdk/middleware-retry": "3.
|
|
35
|
-
"@aws-sdk/middleware-serde": "3.
|
|
36
|
-
"@aws-sdk/middleware-signing": "3.
|
|
37
|
-
"@aws-sdk/middleware-stack": "3.
|
|
38
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
39
|
-
"@aws-sdk/node-config-provider": "3.
|
|
40
|
-
"@aws-sdk/node-http-handler": "3.
|
|
41
|
-
"@aws-sdk/protocol-http": "3.
|
|
42
|
-
"@aws-sdk/smithy-client": "3.
|
|
43
|
-
"@aws-sdk/types": "3.
|
|
44
|
-
"@aws-sdk/url-parser": "3.
|
|
23
|
+
"@aws-sdk/client-sts": "3.289.0",
|
|
24
|
+
"@aws-sdk/config-resolver": "3.289.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.289.0",
|
|
26
|
+
"@aws-sdk/fetch-http-handler": "3.289.0",
|
|
27
|
+
"@aws-sdk/hash-node": "3.289.0",
|
|
28
|
+
"@aws-sdk/invalid-dependency": "3.289.0",
|
|
29
|
+
"@aws-sdk/middleware-content-length": "3.289.0",
|
|
30
|
+
"@aws-sdk/middleware-endpoint": "3.289.0",
|
|
31
|
+
"@aws-sdk/middleware-host-header": "3.289.0",
|
|
32
|
+
"@aws-sdk/middleware-logger": "3.289.0",
|
|
33
|
+
"@aws-sdk/middleware-recursion-detection": "3.289.0",
|
|
34
|
+
"@aws-sdk/middleware-retry": "3.289.0",
|
|
35
|
+
"@aws-sdk/middleware-serde": "3.289.0",
|
|
36
|
+
"@aws-sdk/middleware-signing": "3.289.0",
|
|
37
|
+
"@aws-sdk/middleware-stack": "3.289.0",
|
|
38
|
+
"@aws-sdk/middleware-user-agent": "3.289.0",
|
|
39
|
+
"@aws-sdk/node-config-provider": "3.289.0",
|
|
40
|
+
"@aws-sdk/node-http-handler": "3.289.0",
|
|
41
|
+
"@aws-sdk/protocol-http": "3.289.0",
|
|
42
|
+
"@aws-sdk/smithy-client": "3.289.0",
|
|
43
|
+
"@aws-sdk/types": "3.289.0",
|
|
44
|
+
"@aws-sdk/url-parser": "3.289.0",
|
|
45
45
|
"@aws-sdk/util-base64": "3.208.0",
|
|
46
46
|
"@aws-sdk/util-body-length-browser": "3.188.0",
|
|
47
47
|
"@aws-sdk/util-body-length-node": "3.208.0",
|
|
48
|
-
"@aws-sdk/util-defaults-mode-browser": "3.
|
|
49
|
-
"@aws-sdk/util-defaults-mode-node": "3.
|
|
50
|
-
"@aws-sdk/util-endpoints": "3.
|
|
51
|
-
"@aws-sdk/util-retry": "3.
|
|
52
|
-
"@aws-sdk/util-user-agent-browser": "3.
|
|
53
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
48
|
+
"@aws-sdk/util-defaults-mode-browser": "3.289.0",
|
|
49
|
+
"@aws-sdk/util-defaults-mode-node": "3.289.0",
|
|
50
|
+
"@aws-sdk/util-endpoints": "3.289.0",
|
|
51
|
+
"@aws-sdk/util-retry": "3.289.0",
|
|
52
|
+
"@aws-sdk/util-user-agent-browser": "3.289.0",
|
|
53
|
+
"@aws-sdk/util-user-agent-node": "3.289.0",
|
|
54
54
|
"@aws-sdk/util-utf8": "3.254.0",
|
|
55
55
|
"tslib": "^2.3.1"
|
|
56
56
|
},
|