@aws-sdk/client-dynamodb-streams 3.325.0 → 3.327.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.
|
@@ -41,6 +41,34 @@ export interface DescribeStreamCommandOutput extends DescribeStreamOutput, __Met
|
|
|
41
41
|
* };
|
|
42
42
|
* const command = new DescribeStreamCommand(input);
|
|
43
43
|
* const response = await client.send(command);
|
|
44
|
+
* // { // DescribeStreamOutput
|
|
45
|
+
* // StreamDescription: { // StreamDescription
|
|
46
|
+
* // StreamArn: "STRING_VALUE",
|
|
47
|
+
* // StreamLabel: "STRING_VALUE",
|
|
48
|
+
* // StreamStatus: "ENABLING" || "ENABLED" || "DISABLING" || "DISABLED",
|
|
49
|
+
* // StreamViewType: "NEW_IMAGE" || "OLD_IMAGE" || "NEW_AND_OLD_IMAGES" || "KEYS_ONLY",
|
|
50
|
+
* // CreationRequestDateTime: new Date("TIMESTAMP"),
|
|
51
|
+
* // TableName: "STRING_VALUE",
|
|
52
|
+
* // KeySchema: [ // KeySchema
|
|
53
|
+
* // { // KeySchemaElement
|
|
54
|
+
* // AttributeName: "STRING_VALUE", // required
|
|
55
|
+
* // KeyType: "HASH" || "RANGE", // required
|
|
56
|
+
* // },
|
|
57
|
+
* // ],
|
|
58
|
+
* // Shards: [ // ShardDescriptionList
|
|
59
|
+
* // { // Shard
|
|
60
|
+
* // ShardId: "STRING_VALUE",
|
|
61
|
+
* // SequenceNumberRange: { // SequenceNumberRange
|
|
62
|
+
* // StartingSequenceNumber: "STRING_VALUE",
|
|
63
|
+
* // EndingSequenceNumber: "STRING_VALUE",
|
|
64
|
+
* // },
|
|
65
|
+
* // ParentShardId: "STRING_VALUE",
|
|
66
|
+
* // },
|
|
67
|
+
* // ],
|
|
68
|
+
* // LastEvaluatedShardId: "STRING_VALUE",
|
|
69
|
+
* // },
|
|
70
|
+
* // };
|
|
71
|
+
*
|
|
44
72
|
* ```
|
|
45
73
|
*
|
|
46
74
|
* @param DescribeStreamCommandInput - {@link DescribeStreamCommandInput}
|
|
@@ -57,6 +85,8 @@ export interface DescribeStreamCommandOutput extends DescribeStreamOutput, __Met
|
|
|
57
85
|
* might not be specified correctly, or its status might not be
|
|
58
86
|
* <code>ACTIVE</code>.</p>
|
|
59
87
|
*
|
|
88
|
+
* @throws {@link DynamoDBStreamsServiceException}
|
|
89
|
+
* <p>Base exception class for all service exceptions from DynamoDBStreams service.</p>
|
|
60
90
|
*
|
|
61
91
|
* @example To describe a stream with a given stream ARN
|
|
62
92
|
* ```javascript
|
|
@@ -42,6 +42,80 @@ export interface GetRecordsCommandOutput extends GetRecordsOutput, __MetadataBea
|
|
|
42
42
|
* };
|
|
43
43
|
* const command = new GetRecordsCommand(input);
|
|
44
44
|
* const response = await client.send(command);
|
|
45
|
+
* // { // GetRecordsOutput
|
|
46
|
+
* // Records: [ // RecordList
|
|
47
|
+
* // { // Record
|
|
48
|
+
* // eventID: "STRING_VALUE",
|
|
49
|
+
* // eventName: "INSERT" || "MODIFY" || "REMOVE",
|
|
50
|
+
* // eventVersion: "STRING_VALUE",
|
|
51
|
+
* // eventSource: "STRING_VALUE",
|
|
52
|
+
* // awsRegion: "STRING_VALUE",
|
|
53
|
+
* // dynamodb: { // StreamRecord
|
|
54
|
+
* // ApproximateCreationDateTime: new Date("TIMESTAMP"),
|
|
55
|
+
* // Keys: { // AttributeMap
|
|
56
|
+
* // "<keys>": { // AttributeValue Union: only one key present
|
|
57
|
+
* // S: "STRING_VALUE",
|
|
58
|
+
* // N: "STRING_VALUE",
|
|
59
|
+
* // B: "BLOB_VALUE",
|
|
60
|
+
* // SS: [ // StringSetAttributeValue
|
|
61
|
+
* // "STRING_VALUE",
|
|
62
|
+
* // ],
|
|
63
|
+
* // NS: [ // NumberSetAttributeValue
|
|
64
|
+
* // "STRING_VALUE",
|
|
65
|
+
* // ],
|
|
66
|
+
* // BS: [ // BinarySetAttributeValue
|
|
67
|
+
* // "BLOB_VALUE",
|
|
68
|
+
* // ],
|
|
69
|
+
* // M: { // MapAttributeValue
|
|
70
|
+
* // "<keys>": {// Union: only one key present
|
|
71
|
+
* // S: "STRING_VALUE",
|
|
72
|
+
* // N: "STRING_VALUE",
|
|
73
|
+
* // B: "BLOB_VALUE",
|
|
74
|
+
* // SS: [
|
|
75
|
+
* // "STRING_VALUE",
|
|
76
|
+
* // ],
|
|
77
|
+
* // NS: [
|
|
78
|
+
* // "STRING_VALUE",
|
|
79
|
+
* // ],
|
|
80
|
+
* // BS: [
|
|
81
|
+
* // "BLOB_VALUE",
|
|
82
|
+
* // ],
|
|
83
|
+
* // M: {
|
|
84
|
+
* // "<keys>": "<AttributeValue>",
|
|
85
|
+
* // },
|
|
86
|
+
* // L: [ // ListAttributeValue
|
|
87
|
+
* // "<AttributeValue>",
|
|
88
|
+
* // ],
|
|
89
|
+
* // NULL: true || false,
|
|
90
|
+
* // BOOL: true || false,
|
|
91
|
+
* // },
|
|
92
|
+
* // },
|
|
93
|
+
* // L: [
|
|
94
|
+
* // "<AttributeValue>",
|
|
95
|
+
* // ],
|
|
96
|
+
* // NULL: true || false,
|
|
97
|
+
* // BOOL: true || false,
|
|
98
|
+
* // },
|
|
99
|
+
* // },
|
|
100
|
+
* // NewImage: {
|
|
101
|
+
* // "<keys>": "<AttributeValue>",
|
|
102
|
+
* // },
|
|
103
|
+
* // OldImage: {
|
|
104
|
+
* // "<keys>": "<AttributeValue>",
|
|
105
|
+
* // },
|
|
106
|
+
* // SequenceNumber: "STRING_VALUE",
|
|
107
|
+
* // SizeBytes: Number("long"),
|
|
108
|
+
* // StreamViewType: "NEW_IMAGE" || "OLD_IMAGE" || "NEW_AND_OLD_IMAGES" || "KEYS_ONLY",
|
|
109
|
+
* // },
|
|
110
|
+
* // userIdentity: { // Identity
|
|
111
|
+
* // PrincipalId: "STRING_VALUE",
|
|
112
|
+
* // Type: "STRING_VALUE",
|
|
113
|
+
* // },
|
|
114
|
+
* // },
|
|
115
|
+
* // ],
|
|
116
|
+
* // NextShardIterator: "STRING_VALUE",
|
|
117
|
+
* // };
|
|
118
|
+
*
|
|
45
119
|
* ```
|
|
46
120
|
*
|
|
47
121
|
* @param GetRecordsCommandInput - {@link GetRecordsCommandInput}
|
|
@@ -90,6 +164,8 @@ export interface GetRecordsCommandOutput extends GetRecordsOutput, __MetadataBea
|
|
|
90
164
|
* </li>
|
|
91
165
|
* </ul>
|
|
92
166
|
*
|
|
167
|
+
* @throws {@link DynamoDBStreamsServiceException}
|
|
168
|
+
* <p>Base exception class for all service exceptions from DynamoDBStreams service.</p>
|
|
93
169
|
*
|
|
94
170
|
* @example To retrieve all the stream records from a shard
|
|
95
171
|
* ```javascript
|
|
@@ -41,6 +41,10 @@ export interface GetShardIteratorCommandOutput extends GetShardIteratorOutput, _
|
|
|
41
41
|
* };
|
|
42
42
|
* const command = new GetShardIteratorCommand(input);
|
|
43
43
|
* const response = await client.send(command);
|
|
44
|
+
* // { // GetShardIteratorOutput
|
|
45
|
+
* // ShardIterator: "STRING_VALUE",
|
|
46
|
+
* // };
|
|
47
|
+
*
|
|
44
48
|
* ```
|
|
45
49
|
*
|
|
46
50
|
* @param GetShardIteratorCommandInput - {@link GetShardIteratorCommandInput}
|
|
@@ -71,6 +75,8 @@ export interface GetShardIteratorCommandOutput extends GetShardIteratorOutput, _
|
|
|
71
75
|
* </li>
|
|
72
76
|
* </ul>
|
|
73
77
|
*
|
|
78
|
+
* @throws {@link DynamoDBStreamsServiceException}
|
|
79
|
+
* <p>Base exception class for all service exceptions from DynamoDBStreams service.</p>
|
|
74
80
|
*
|
|
75
81
|
* @example To obtain a shard iterator for the provided stream ARN and shard ID
|
|
76
82
|
* ```javascript
|
|
@@ -38,6 +38,17 @@ export interface ListStreamsCommandOutput extends ListStreamsOutput, __MetadataB
|
|
|
38
38
|
* };
|
|
39
39
|
* const command = new ListStreamsCommand(input);
|
|
40
40
|
* const response = await client.send(command);
|
|
41
|
+
* // { // ListStreamsOutput
|
|
42
|
+
* // Streams: [ // StreamList
|
|
43
|
+
* // { // Stream
|
|
44
|
+
* // StreamArn: "STRING_VALUE",
|
|
45
|
+
* // TableName: "STRING_VALUE",
|
|
46
|
+
* // StreamLabel: "STRING_VALUE",
|
|
47
|
+
* // },
|
|
48
|
+
* // ],
|
|
49
|
+
* // LastEvaluatedStreamArn: "STRING_VALUE",
|
|
50
|
+
* // };
|
|
51
|
+
*
|
|
41
52
|
* ```
|
|
42
53
|
*
|
|
43
54
|
* @param ListStreamsCommandInput - {@link ListStreamsCommandInput}
|
|
@@ -54,6 +65,8 @@ export interface ListStreamsCommandOutput extends ListStreamsOutput, __MetadataB
|
|
|
54
65
|
* might not be specified correctly, or its status might not be
|
|
55
66
|
* <code>ACTIVE</code>.</p>
|
|
56
67
|
*
|
|
68
|
+
* @throws {@link DynamoDBStreamsServiceException}
|
|
69
|
+
* <p>Base exception class for all service exceptions from DynamoDBStreams service.</p>
|
|
57
70
|
*
|
|
58
71
|
* @example To list all of the stream ARNs
|
|
59
72
|
* ```javascript
|
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.327.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.
|
|
24
|
+
"@aws-sdk/client-sts": "3.327.0",
|
|
25
25
|
"@aws-sdk/config-resolver": "3.310.0",
|
|
26
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
+
"@aws-sdk/credential-provider-node": "3.327.0",
|
|
27
27
|
"@aws-sdk/fetch-http-handler": "3.310.0",
|
|
28
28
|
"@aws-sdk/hash-node": "3.310.0",
|
|
29
29
|
"@aws-sdk/invalid-dependency": "3.310.0",
|
|
@@ -32,11 +32,11 @@
|
|
|
32
32
|
"@aws-sdk/middleware-host-header": "3.325.0",
|
|
33
33
|
"@aws-sdk/middleware-logger": "3.325.0",
|
|
34
34
|
"@aws-sdk/middleware-recursion-detection": "3.325.0",
|
|
35
|
-
"@aws-sdk/middleware-retry": "3.
|
|
35
|
+
"@aws-sdk/middleware-retry": "3.327.0",
|
|
36
36
|
"@aws-sdk/middleware-serde": "3.325.0",
|
|
37
37
|
"@aws-sdk/middleware-signing": "3.325.0",
|
|
38
38
|
"@aws-sdk/middleware-stack": "3.325.0",
|
|
39
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
39
|
+
"@aws-sdk/middleware-user-agent": "3.327.0",
|
|
40
40
|
"@aws-sdk/node-config-provider": "3.310.0",
|
|
41
41
|
"@aws-sdk/node-http-handler": "3.321.1",
|
|
42
42
|
"@aws-sdk/protocol-http": "3.310.0",
|
|
@@ -48,8 +48,8 @@
|
|
|
48
48
|
"@aws-sdk/util-body-length-node": "3.310.0",
|
|
49
49
|
"@aws-sdk/util-defaults-mode-browser": "3.325.0",
|
|
50
50
|
"@aws-sdk/util-defaults-mode-node": "3.325.0",
|
|
51
|
-
"@aws-sdk/util-endpoints": "3.
|
|
52
|
-
"@aws-sdk/util-retry": "3.
|
|
51
|
+
"@aws-sdk/util-endpoints": "3.327.0",
|
|
52
|
+
"@aws-sdk/util-retry": "3.327.0",
|
|
53
53
|
"@aws-sdk/util-user-agent-browser": "3.310.0",
|
|
54
54
|
"@aws-sdk/util-user-agent-node": "3.310.0",
|
|
55
55
|
"@aws-sdk/util-utf8": "3.310.0",
|