@aws-sdk/client-dynamodb-streams 3.775.0 → 3.782.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 (5) hide show
  1. package/dist-types/commands/DescribeStreamCommand.d.ts +1 -65
  2. package/dist-types/commands/GetRecordsCommand.d.ts +1 -81
  3. package/dist-types/commands/GetShardIteratorCommand.d.ts +7 -7
  4. package/dist-types/commands/ListStreamsCommand.d.ts +14 -14
  5. package/package.json +5 -5
package/dist-types/commands/DescribeStreamCommand.d.ts CHANGED
@@ -96,72 +96,8 @@ declare const DescribeStreamCommand_base: {
96
96
  * @throws {@link DynamoDBStreamsServiceException}
97
97
  * <p>Base exception class for all service exceptions from DynamoDBStreams service.</p>
98
98
  *
99
- * @public
100
- * @example To describe a stream with a given stream ARN
101
- * ```javascript
102
- * // The following example describes a stream with a given stream ARN.
103
- * const input = {
104
- * "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252"
105
- * };
106
- * const command = new DescribeStreamCommand(input);
107
- * const response = await client.send(command);
108
- * /* response ==
109
- * {
110
- * "StreamDescription": {
111
- * "CreationRequestDateTime": "Wed May 20 13:51:10 PDT 2015",
112
- * "KeySchema": [
113
- * {
114
- * "AttributeName": "ForumName",
115
- * "KeyType": "HASH"
116
- * },
117
- * {
118
- * "AttributeName": "Subject",
119
- * "KeyType": "RANGE"
120
- * }
121
- * ],
122
- * "Shards": [
123
- * {
124
- * "SequenceNumberRange": {
125
- * "EndingSequenceNumber": "20500000000000000910398",
126
- * "StartingSequenceNumber": "20500000000000000910398"
127
- * },
128
- * "ShardId": "shardId-00000001414562045508-2bac9cd2"
129
- * },
130
- * {
131
- * "ParentShardId": "shardId-00000001414562045508-2bac9cd2",
132
- * "SequenceNumberRange": {
133
- * "EndingSequenceNumber": "820400000000000001192334",
134
- * "StartingSequenceNumber": "820400000000000001192334"
135
- * },
136
- * "ShardId": "shardId-00000001414576573621-f55eea83"
137
- * },
138
- * {
139
- * "ParentShardId": "shardId-00000001414576573621-f55eea83",
140
- * "SequenceNumberRange": {
141
- * "EndingSequenceNumber": "1683700000000000001135967",
142
- * "StartingSequenceNumber": "1683700000000000001135967"
143
- * },
144
- * "ShardId": "shardId-00000001414592258131-674fd923"
145
- * },
146
- * {
147
- * "ParentShardId": "shardId-00000001414592258131-674fd923",
148
- * "SequenceNumberRange": {
149
- * "StartingSequenceNumber": "2574600000000000000935255"
150
- * },
151
- * "ShardId": "shardId-00000001414608446368-3a1afbaf"
152
- * }
153
- * ],
154
- * "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252",
155
- * "StreamLabel": "2015-05-20T20:51:10.252",
156
- * "StreamStatus": "ENABLED",
157
- * "StreamViewType": "NEW_AND_OLD_IMAGES",
158
- * "TableName": "Forum"
159
- * }
160
- * }
161
- * *\/
162
- * // example id: to-describe-a-stream-with-a-given-stream-arn-1473457835200
163
- * ```
164
99
  *
100
+ * @public
165
101
  */
166
102
  export declare class DescribeStreamCommand extends DescribeStreamCommand_base {
167
103
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/GetRecordsCommand.d.ts CHANGED
@@ -178,88 +178,8 @@ declare const GetRecordsCommand_base: {
178
178
  * @throws {@link DynamoDBStreamsServiceException}
179
179
  * <p>Base exception class for all service exceptions from DynamoDBStreams service.</p>
180
180
  *
181
- * @public
182
- * @example To retrieve all the stream records from a shard
183
- * ```javascript
184
- * // The following example retrieves all the stream records from a shard.
185
- * const input = {
186
- * "ShardIterator": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAEvJp6D+zaQ... <remaining characters omitted> ..."
187
- * };
188
- * const command = new GetRecordsCommand(input);
189
- * const response = await client.send(command);
190
- * /* response ==
191
- * {
192
- * "NextShardIterator": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAGQBYshYDEe ... <remaining characters omitted> ...",
193
- * "Records": [
194
- * {
195
- * "awsRegion": "us-west-2",
196
- * "dynamodb": {
197
- * "ApproximateCreationDateTime": "1.46480646E9",
198
- * "Keys": {
199
- * "ForumName": {
200
- * "S": "DynamoDB"
201
- * },
202
- * "Subject": {
203
- * "S": "DynamoDB Thread 3"
204
- * }
205
- * },
206
- * "SequenceNumber": "300000000000000499659",
207
- * "SizeBytes": 41,
208
- * "StreamViewType": "KEYS_ONLY"
209
- * },
210
- * "eventID": "e2fd9c34eff2d779b297b26f5fef4206",
211
- * "eventName": "INSERT",
212
- * "eventSource": "aws:dynamodb",
213
- * "eventVersion": "1.0"
214
- * },
215
- * {
216
- * "awsRegion": "us-west-2",
217
- * "dynamodb": {
218
- * "ApproximateCreationDateTime": "1.46480527E9",
219
- * "Keys": {
220
- * "ForumName": {
221
- * "S": "DynamoDB"
222
- * },
223
- * "Subject": {
224
- * "S": "DynamoDB Thread 1"
225
- * }
226
- * },
227
- * "SequenceNumber": "400000000000000499660",
228
- * "SizeBytes": 41,
229
- * "StreamViewType": "KEYS_ONLY"
230
- * },
231
- * "eventID": "4b25bd0da9a181a155114127e4837252",
232
- * "eventName": "MODIFY",
233
- * "eventSource": "aws:dynamodb",
234
- * "eventVersion": "1.0"
235
- * },
236
- * {
237
- * "awsRegion": "us-west-2",
238
- * "dynamodb": {
239
- * "ApproximateCreationDateTime": "1.46480646E9",
240
- * "Keys": {
241
- * "ForumName": {
242
- * "S": "DynamoDB"
243
- * },
244
- * "Subject": {
245
- * "S": "DynamoDB Thread 2"
246
- * }
247
- * },
248
- * "SequenceNumber": "500000000000000499661",
249
- * "SizeBytes": 41,
250
- * "StreamViewType": "KEYS_ONLY"
251
- * },
252
- * "eventID": "740280c73a3df7842edab3548a1b08ad",
253
- * "eventName": "REMOVE",
254
- * "eventSource": "aws:dynamodb",
255
- * "eventVersion": "1.0"
256
- * }
257
- * ]
258
- * }
259
- * *\/
260
- * // example id: to-retrieve-all-the-stream-records-from-a-shard-1473707781419
261
- * ```
262
181
  *
182
+ * @public
263
183
  */
264
184
  export declare class GetRecordsCommand extends GetRecordsCommand_base {
265
185
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/GetShardIteratorCommand.d.ts CHANGED
@@ -86,25 +86,25 @@ declare const GetShardIteratorCommand_base: {
86
86
  * @throws {@link DynamoDBStreamsServiceException}
87
87
  * <p>Base exception class for all service exceptions from DynamoDBStreams service.</p>
88
88
  *
89
- * @public
89
+ *
90
90
  * @example To obtain a shard iterator for the provided stream ARN and shard ID
91
91
  * ```javascript
92
92
  * // The following example returns a shard iterator for the provided stream ARN and shard ID.
93
93
  * const input = {
94
- * "ShardId": "00000001414576573621-f55eea83",
95
- * "ShardIteratorType": "TRIM_HORIZON",
96
- * "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252"
94
+ * ShardId: "00000001414576573621-f55eea83",
95
+ * ShardIteratorType: "TRIM_HORIZON",
96
+ * StreamArn: "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252"
97
97
  * };
98
98
  * const command = new GetShardIteratorCommand(input);
99
99
  * const response = await client.send(command);
100
- * /* response ==
100
+ * /* response is
101
101
  * {
102
- * "ShardIterator": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAEvJp6D+zaQ... <remaining characters omitted> ..."
102
+ * ShardIterator: "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAEvJp6D+zaQ... <remaining characters omitted> ..."
103
103
  * }
104
104
  * *\/
105
- * // example id: to-obtain-a-shard-iterator-for-the-provided-stream-arn-and-shard-id-1473459941476
106
105
  * ```
107
106
  *
107
+ * @public
108
108
  */
109
109
  export declare class GetShardIteratorCommand extends GetShardIteratorCommand_base {
110
110
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/ListStreamsCommand.d.ts CHANGED
@@ -76,37 +76,37 @@ declare const ListStreamsCommand_base: {
76
76
  * @throws {@link DynamoDBStreamsServiceException}
77
77
  * <p>Base exception class for all service exceptions from DynamoDBStreams service.</p>
78
78
  *
79
- * @public
79
+ *
80
80
  * @example To list all of the stream ARNs
81
81
  * ```javascript
82
82
  * // The following example lists all of the stream ARNs.
83
- * const input = {};
83
+ * const input = { /* empty *\/ };
84
84
  * const command = new ListStreamsCommand(input);
85
85
  * const response = await client.send(command);
86
- * /* response ==
86
+ * /* response is
87
87
  * {
88
- * "Streams": [
88
+ * Streams: [
89
89
  * {
90
- * "StreamArn": "arn:aws:dynamodb:us-wesst-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252",
91
- * "StreamLabel": "2015-05-20T20:51:10.252",
92
- * "TableName": "Forum"
90
+ * StreamArn: "arn:aws:dynamodb:us-wesst-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252",
91
+ * StreamLabel: "2015-05-20T20:51:10.252",
92
+ * TableName: "Forum"
93
93
  * },
94
94
  * {
95
- * "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:50:02.714",
96
- * "StreamLabel": "2015-05-20T20:50:02.714",
97
- * "TableName": "Forum"
95
+ * StreamArn: "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:50:02.714",
96
+ * StreamLabel: "2015-05-20T20:50:02.714",
97
+ * TableName: "Forum"
98
98
  * },
99
99
  * {
100
- * "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-19T23:03:50.641",
101
- * "StreamLabel": "2015-05-19T23:03:50.641",
102
- * "TableName": "Forum"
100
+ * StreamArn: "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-19T23:03:50.641",
101
+ * StreamLabel: "2015-05-19T23:03:50.641",
102
+ * TableName: "Forum"
103
103
  * }
104
104
  * ]
105
105
  * }
106
106
  * *\/
107
- * // example id: to-list-all-of-the-stream-arns--1473459534285
108
107
  * ```
109
108
  *
109
+ * @public
110
110
  */
111
111
  export declare class ListStreamsCommand extends ListStreamsCommand_base {
112
112
  /** @internal type navigation helper, not in runtime. */
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.775.0",
4
+ "version": "3.782.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-dynamodb-streams",
@@ -21,16 +21,16 @@
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
23
  "@aws-sdk/core": "3.775.0",
24
- "@aws-sdk/credential-provider-node": "3.775.0",
24
+ "@aws-sdk/credential-provider-node": "3.782.0",
25
25
  "@aws-sdk/middleware-host-header": "3.775.0",
26
26
  "@aws-sdk/middleware-logger": "3.775.0",
27
27
  "@aws-sdk/middleware-recursion-detection": "3.775.0",
28
- "@aws-sdk/middleware-user-agent": "3.775.0",
28
+ "@aws-sdk/middleware-user-agent": "3.782.0",
29
29
  "@aws-sdk/region-config-resolver": "3.775.0",
30
30
  "@aws-sdk/types": "3.775.0",
31
- "@aws-sdk/util-endpoints": "3.775.0",
31
+ "@aws-sdk/util-endpoints": "3.782.0",
32
32
  "@aws-sdk/util-user-agent-browser": "3.775.0",
33
- "@aws-sdk/util-user-agent-node": "3.775.0",
33
+ "@aws-sdk/util-user-agent-node": "3.782.0",
34
34
  "@smithy/config-resolver": "^4.1.0",
35
35
  "@smithy/core": "^3.2.0",
36
36
  "@smithy/fetch-http-handler": "^5.0.2",