@aws-sdk/client-dynamodb-streams 3.35.0 → 3.36.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 (81) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/dist-cjs/DynamoDBStreams.js +0 -1
  3. package/dist-cjs/DynamoDBStreamsClient.js +0 -1
  4. package/dist-cjs/commands/DescribeStreamCommand.js +0 -1
  5. package/dist-cjs/commands/GetRecordsCommand.js +0 -1
  6. package/dist-cjs/commands/GetShardIteratorCommand.js +0 -1
  7. package/dist-cjs/commands/ListStreamsCommand.js +0 -1
  8. package/dist-cjs/endpoints.js +0 -1
  9. package/dist-cjs/index.js +0 -1
  10. package/dist-cjs/models/index.js +0 -1
  11. package/dist-cjs/models/models_0.js +0 -1
  12. package/dist-cjs/protocols/Aws_json1_0.js +0 -1
  13. package/dist-cjs/runtimeConfig.browser.js +2 -3
  14. package/dist-cjs/runtimeConfig.js +3 -4
  15. package/dist-cjs/runtimeConfig.native.js +0 -1
  16. package/dist-cjs/runtimeConfig.shared.js +0 -1
  17. package/dist-es/DynamoDBStreams.js +0 -1
  18. package/dist-es/DynamoDBStreamsClient.js +0 -1
  19. package/dist-es/commands/DescribeStreamCommand.js +0 -1
  20. package/dist-es/commands/GetRecordsCommand.js +0 -1
  21. package/dist-es/commands/GetShardIteratorCommand.js +0 -1
  22. package/dist-es/commands/ListStreamsCommand.js +0 -1
  23. package/dist-es/endpoints.js +0 -1
  24. package/dist-es/index.js +0 -1
  25. package/dist-es/models/index.js +0 -1
  26. package/dist-es/models/models_0.js +0 -1
  27. package/dist-es/protocols/Aws_json1_0.js +0 -1
  28. package/dist-es/runtimeConfig.browser.js +1 -2
  29. package/dist-es/runtimeConfig.js +2 -3
  30. package/dist-es/runtimeConfig.native.js +0 -1
  31. package/dist-es/runtimeConfig.shared.js +0 -1
  32. package/package.json +33 -30
  33. package/dist-cjs/DynamoDBStreams.js.map +0 -1
  34. package/dist-cjs/DynamoDBStreamsClient.js.map +0 -1
  35. package/dist-cjs/commands/DescribeStreamCommand.js.map +0 -1
  36. package/dist-cjs/commands/GetRecordsCommand.js.map +0 -1
  37. package/dist-cjs/commands/GetShardIteratorCommand.js.map +0 -1
  38. package/dist-cjs/commands/ListStreamsCommand.js.map +0 -1
  39. package/dist-cjs/endpoints.js.map +0 -1
  40. package/dist-cjs/index.js.map +0 -1
  41. package/dist-cjs/models/index.js.map +0 -1
  42. package/dist-cjs/models/models_0.js.map +0 -1
  43. package/dist-cjs/protocols/Aws_json1_0.js.map +0 -1
  44. package/dist-cjs/runtimeConfig.browser.js.map +0 -1
  45. package/dist-cjs/runtimeConfig.js.map +0 -1
  46. package/dist-cjs/runtimeConfig.native.js.map +0 -1
  47. package/dist-cjs/runtimeConfig.shared.js.map +0 -1
  48. package/dist-es/DynamoDBStreams.js.map +0 -1
  49. package/dist-es/DynamoDBStreamsClient.js.map +0 -1
  50. package/dist-es/commands/DescribeStreamCommand.js.map +0 -1
  51. package/dist-es/commands/GetRecordsCommand.js.map +0 -1
  52. package/dist-es/commands/GetShardIteratorCommand.js.map +0 -1
  53. package/dist-es/commands/ListStreamsCommand.js.map +0 -1
  54. package/dist-es/endpoints.js.map +0 -1
  55. package/dist-es/index.js.map +0 -1
  56. package/dist-es/models/index.js.map +0 -1
  57. package/dist-es/models/models_0.js.map +0 -1
  58. package/dist-es/protocols/Aws_json1_0.js.map +0 -1
  59. package/dist-es/runtimeConfig.browser.js.map +0 -1
  60. package/dist-es/runtimeConfig.js.map +0 -1
  61. package/dist-es/runtimeConfig.native.js.map +0 -1
  62. package/dist-es/runtimeConfig.shared.js.map +0 -1
  63. package/jest.config.js +0 -4
  64. package/src/DynamoDBStreams.ts +0 -171
  65. package/src/DynamoDBStreamsClient.ts +0 -253
  66. package/src/commands/DescribeStreamCommand.ts +0 -103
  67. package/src/commands/GetRecordsCommand.ts +0 -105
  68. package/src/commands/GetShardIteratorCommand.ts +0 -102
  69. package/src/commands/ListStreamsCommand.ts +0 -100
  70. package/src/endpoints.ts +0 -96
  71. package/src/index.ts +0 -7
  72. package/src/models/index.ts +0 -1
  73. package/src/models/models_0.ts +0 -1132
  74. package/src/protocols/Aws_json1_0.ts +0 -918
  75. package/src/runtimeConfig.browser.ts +0 -41
  76. package/src/runtimeConfig.native.ts +0 -17
  77. package/src/runtimeConfig.shared.ts +0 -17
  78. package/src/runtimeConfig.ts +0 -46
  79. package/tsconfig.es.json +0 -10
  80. package/tsconfig.json +0 -33
  81. package/tsconfig.types.json +0 -9
@@ -1,1132 +0,0 @@
1
- import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
-
3
- /**
4
- * <p>Represents the input of a <code>DescribeStream</code> operation.</p>
5
- */
6
- export interface DescribeStreamInput {
7
- /**
8
- * <p>The Amazon Resource Name (ARN) for the stream.</p>
9
- */
10
- StreamArn: string | undefined;
11
-
12
- /**
13
- * <p>The maximum number of shard objects to return. The upper limit is 100.</p>
14
- */
15
- Limit?: number;
16
-
17
- /**
18
- * <p>The shard ID of the first item that this operation will evaluate. Use the value that was
19
- * returned for <code>LastEvaluatedShardId</code> in the previous operation. </p>
20
- */
21
- ExclusiveStartShardId?: string;
22
- }
23
-
24
- export namespace DescribeStreamInput {
25
- /**
26
- * @internal
27
- */
28
- export const filterSensitiveLog = (obj: DescribeStreamInput): any => ({
29
- ...obj,
30
- });
31
- }
32
-
33
- export type KeyType = "HASH" | "RANGE";
34
-
35
- /**
36
- * <p>Represents <i>a single element</i> of a key schema. A key schema specifies
37
- * the attributes that make up the primary key of a table, or the key attributes of an
38
- * index.</p>
39
- * <p>A <code>KeySchemaElement</code> represents exactly one attribute of the primary key. For
40
- * example, a simple primary key would be represented by one <code>KeySchemaElement</code>
41
- * (for the partition key). A composite primary key would require one
42
- * <code>KeySchemaElement</code> for the partition key, and another
43
- * <code>KeySchemaElement</code> for the sort key.</p>
44
- * <p>A <code>KeySchemaElement</code> must be a scalar, top-level attribute (not a nested
45
- * attribute). The data type must be one of String, Number, or Binary. The attribute cannot
46
- * be nested within a List or a Map.</p>
47
- */
48
- export interface KeySchemaElement {
49
- /**
50
- * <p>The name of a key attribute.</p>
51
- */
52
- AttributeName: string | undefined;
53
-
54
- /**
55
- * <p>The role that this key attribute will assume:</p>
56
- * <ul>
57
- * <li>
58
- * <p>
59
- * <code>HASH</code> - partition key</p>
60
- * </li>
61
- * <li>
62
- * <p>
63
- * <code>RANGE</code> - sort key</p>
64
- * </li>
65
- * </ul>
66
- * <note>
67
- * <p>The partition key of an item is also known as its <i>hash
68
- * attribute</i>. The term "hash attribute" derives from DynamoDB's usage of
69
- * an internal hash function to evenly distribute data items across partitions, based
70
- * on their partition key values.</p>
71
- * <p>The sort key of an item is also known as its <i>range
72
- * attribute</i>. The term "range attribute" derives from the way DynamoDB
73
- * stores items with the same partition key physically close together, in sorted order
74
- * by the sort key value.</p>
75
- * </note>
76
- */
77
- KeyType: KeyType | string | undefined;
78
- }
79
-
80
- export namespace KeySchemaElement {
81
- /**
82
- * @internal
83
- */
84
- export const filterSensitiveLog = (obj: KeySchemaElement): any => ({
85
- ...obj,
86
- });
87
- }
88
-
89
- /**
90
- * <p>The beginning and ending sequence numbers for the stream records contained within a shard.</p>
91
- */
92
- export interface SequenceNumberRange {
93
- /**
94
- * <p>The first sequence number for the stream records contained within a shard. String contains numeric characters only.</p>
95
- */
96
- StartingSequenceNumber?: string;
97
-
98
- /**
99
- * <p>The last sequence number for the stream records contained within a shard. String contains numeric characters only.</p>
100
- */
101
- EndingSequenceNumber?: string;
102
- }
103
-
104
- export namespace SequenceNumberRange {
105
- /**
106
- * @internal
107
- */
108
- export const filterSensitiveLog = (obj: SequenceNumberRange): any => ({
109
- ...obj,
110
- });
111
- }
112
-
113
- /**
114
- * <p>A uniquely identified group of stream records within a stream.</p>
115
- */
116
- export interface Shard {
117
- /**
118
- * <p>The system-generated identifier for this shard.</p>
119
- */
120
- ShardId?: string;
121
-
122
- /**
123
- * <p>The range of possible sequence numbers for the shard.</p>
124
- */
125
- SequenceNumberRange?: SequenceNumberRange;
126
-
127
- /**
128
- * <p>The shard ID of the current shard's parent.</p>
129
- */
130
- ParentShardId?: string;
131
- }
132
-
133
- export namespace Shard {
134
- /**
135
- * @internal
136
- */
137
- export const filterSensitiveLog = (obj: Shard): any => ({
138
- ...obj,
139
- });
140
- }
141
-
142
- export type StreamStatus = "DISABLED" | "DISABLING" | "ENABLED" | "ENABLING";
143
-
144
- export type StreamViewType = "KEYS_ONLY" | "NEW_AND_OLD_IMAGES" | "NEW_IMAGE" | "OLD_IMAGE";
145
-
146
- /**
147
- * <p>Represents all of the data describing a particular stream.</p>
148
- */
149
- export interface StreamDescription {
150
- /**
151
- * <p>The Amazon Resource Name (ARN) for the stream.</p>
152
- */
153
- StreamArn?: string;
154
-
155
- /**
156
- * <p>A timestamp, in ISO 8601 format, for this stream.</p>
157
- * <p>Note that <code>LatestStreamLabel</code> is not a unique identifier for the stream, because it is
158
- * possible that a stream from another table might have the same timestamp. However, the
159
- * combination of the following three elements is guaranteed to be unique:</p>
160
- * <ul>
161
- * <li>
162
- * <p>the AWS customer ID.</p>
163
- * </li>
164
- * <li>
165
- * <p>the table name</p>
166
- * </li>
167
- * <li>
168
- * <p>the <code>StreamLabel</code>
169
- * </p>
170
- * </li>
171
- * </ul>
172
- */
173
- StreamLabel?: string;
174
-
175
- /**
176
- * <p>Indicates the current status of the stream:</p>
177
- * <ul>
178
- * <li>
179
- * <p>
180
- * <code>ENABLING</code> - Streams is currently being enabled on the DynamoDB table.</p>
181
- * </li>
182
- * <li>
183
- * <p>
184
- * <code>ENABLED</code> - the stream is enabled.</p>
185
- * </li>
186
- * <li>
187
- * <p>
188
- * <code>DISABLING</code> - Streams is currently being disabled on the DynamoDB table.</p>
189
- * </li>
190
- * <li>
191
- * <p>
192
- * <code>DISABLED</code> - the stream is disabled.</p>
193
- * </li>
194
- * </ul>
195
- */
196
- StreamStatus?: StreamStatus | string;
197
-
198
- /**
199
- * <p>Indicates the format of the records within this stream:</p>
200
- * <ul>
201
- * <li>
202
- * <p>
203
- * <code>KEYS_ONLY</code> - only the key attributes of items that were modified in the DynamoDB table.</p>
204
- * </li>
205
- * <li>
206
- * <p>
207
- * <code>NEW_IMAGE</code> - entire items from the table, as they appeared after they were modified.</p>
208
- * </li>
209
- * <li>
210
- * <p>
211
- * <code>OLD_IMAGE</code> - entire items from the table, as they appeared before they were modified.</p>
212
- * </li>
213
- * <li>
214
- * <p>
215
- * <code>NEW_AND_OLD_IMAGES</code> - both the new and the old images of the items from the table.</p>
216
- * </li>
217
- * </ul>
218
- */
219
- StreamViewType?: StreamViewType | string;
220
-
221
- /**
222
- * <p>The date and time when the request to create this stream was issued.</p>
223
- */
224
- CreationRequestDateTime?: Date;
225
-
226
- /**
227
- * <p>The DynamoDB table with which the stream is associated.</p>
228
- */
229
- TableName?: string;
230
-
231
- /**
232
- * <p>The key attribute(s) of the stream's DynamoDB table.</p>
233
- */
234
- KeySchema?: KeySchemaElement[];
235
-
236
- /**
237
- * <p>The shards that comprise the stream.</p>
238
- */
239
- Shards?: Shard[];
240
-
241
- /**
242
- * <p>The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.</p>
243
- * <p>If <code>LastEvaluatedShardId</code> is empty, then the "last page" of results has been
244
- * processed and there is currently no more data to be retrieved.</p>
245
- * <p>If <code>LastEvaluatedShardId</code> is not empty, it does not necessarily mean that there is
246
- * more data in the result set. The only way to know when you have reached the end of the result
247
- * set is when <code>LastEvaluatedShardId</code> is empty.</p>
248
- */
249
- LastEvaluatedShardId?: string;
250
- }
251
-
252
- export namespace StreamDescription {
253
- /**
254
- * @internal
255
- */
256
- export const filterSensitiveLog = (obj: StreamDescription): any => ({
257
- ...obj,
258
- });
259
- }
260
-
261
- /**
262
- * <p>Represents the output of a <code>DescribeStream</code> operation.</p>
263
- */
264
- export interface DescribeStreamOutput {
265
- /**
266
- * <p>A complete description of the stream, including its creation date and time, the DynamoDB table associated with the stream, the shard IDs within the stream, and the beginning and ending sequence numbers of stream records within the shards.</p>
267
- */
268
- StreamDescription?: StreamDescription;
269
- }
270
-
271
- export namespace DescribeStreamOutput {
272
- /**
273
- * @internal
274
- */
275
- export const filterSensitiveLog = (obj: DescribeStreamOutput): any => ({
276
- ...obj,
277
- });
278
- }
279
-
280
- /**
281
- * <p>An error occurred on the server side.</p>
282
- */
283
- export interface InternalServerError extends __SmithyException, $MetadataBearer {
284
- name: "InternalServerError";
285
- $fault: "server";
286
- /**
287
- * <p>The server encountered an internal error trying to fulfill the request.</p>
288
- */
289
- message?: string;
290
- }
291
-
292
- export namespace InternalServerError {
293
- /**
294
- * @internal
295
- */
296
- export const filterSensitiveLog = (obj: InternalServerError): any => ({
297
- ...obj,
298
- });
299
- }
300
-
301
- /**
302
- * <p>The operation tried to access a nonexistent table or index. The resource
303
- * might not be specified correctly, or its status might not be
304
- * <code>ACTIVE</code>.</p>
305
- */
306
- export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
307
- name: "ResourceNotFoundException";
308
- $fault: "client";
309
- /**
310
- * <p>The resource which is being requested does not exist.</p>
311
- */
312
- message?: string;
313
- }
314
-
315
- export namespace ResourceNotFoundException {
316
- /**
317
- * @internal
318
- */
319
- export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({
320
- ...obj,
321
- });
322
- }
323
-
324
- /**
325
- * <p>The shard iterator has expired and can no longer be used to retrieve stream records. A shard
326
- * iterator expires 15 minutes after it is retrieved using the <code>GetShardIterator</code>
327
- * action.</p>
328
- */
329
- export interface ExpiredIteratorException extends __SmithyException, $MetadataBearer {
330
- name: "ExpiredIteratorException";
331
- $fault: "client";
332
- /**
333
- * <p>The provided iterator exceeds the maximum age allowed.</p>
334
- */
335
- message?: string;
336
- }
337
-
338
- export namespace ExpiredIteratorException {
339
- /**
340
- * @internal
341
- */
342
- export const filterSensitiveLog = (obj: ExpiredIteratorException): any => ({
343
- ...obj,
344
- });
345
- }
346
-
347
- /**
348
- * <p>Represents the input of a <code>GetRecords</code> operation.</p>
349
- */
350
- export interface GetRecordsInput {
351
- /**
352
- * <p>A shard iterator that was retrieved from a previous GetShardIterator operation. This iterator can be used to access the stream records in this shard.</p>
353
- */
354
- ShardIterator: string | undefined;
355
-
356
- /**
357
- * <p>The maximum number of records to return from the shard. The upper limit is 1000.</p>
358
- */
359
- Limit?: number;
360
- }
361
-
362
- export namespace GetRecordsInput {
363
- /**
364
- * @internal
365
- */
366
- export const filterSensitiveLog = (obj: GetRecordsInput): any => ({
367
- ...obj,
368
- });
369
- }
370
-
371
- export type OperationType = "INSERT" | "MODIFY" | "REMOVE";
372
-
373
- /**
374
- * <p>Contains details about the type of identity that made the request.</p>
375
- */
376
- export interface Identity {
377
- /**
378
- * <p>A unique identifier for the entity that made the call. For Time To Live, the
379
- * principalId is "dynamodb.amazonaws.com".</p>
380
- */
381
- PrincipalId?: string;
382
-
383
- /**
384
- * <p>The type of the identity. For Time To Live, the type is "Service".</p>
385
- */
386
- Type?: string;
387
- }
388
-
389
- export namespace Identity {
390
- /**
391
- * @internal
392
- */
393
- export const filterSensitiveLog = (obj: Identity): any => ({
394
- ...obj,
395
- });
396
- }
397
-
398
- /**
399
- * <p>There is no limit to the number of daily on-demand backups that can be
400
- * taken.</p>
401
- * <p>Up to 50 simultaneous table operations are allowed per account. These operations
402
- * include <code>CreateTable</code>, <code>UpdateTable</code>,
403
- * <code>DeleteTable</code>,<code>UpdateTimeToLive</code>,
404
- * <code>RestoreTableFromBackup</code>, and
405
- * <code>RestoreTableToPointInTime</code>.</p>
406
- * <p>The only exception is when you are creating a table with one or more secondary
407
- * indexes. You can have up to 25 such requests running at a time; however, if the table or
408
- * index specifications are complex, DynamoDB might temporarily reduce the number of
409
- * concurrent operations.</p>
410
- * <p>There is a soft account quota of 256 tables.</p>
411
- */
412
- export interface LimitExceededException extends __SmithyException, $MetadataBearer {
413
- name: "LimitExceededException";
414
- $fault: "client";
415
- /**
416
- * <p>Too many operations for a given subscriber.</p>
417
- */
418
- message?: string;
419
- }
420
-
421
- export namespace LimitExceededException {
422
- /**
423
- * @internal
424
- */
425
- export const filterSensitiveLog = (obj: LimitExceededException): any => ({
426
- ...obj,
427
- });
428
- }
429
-
430
- /**
431
- * <p>The operation attempted to read past the oldest stream record in a shard.</p>
432
- * <p>In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if:</p>
433
- * <ul>
434
- * <li>
435
- * <p>You request a shard iterator with a sequence number older than the trim point (24 hours).</p>
436
- * </li>
437
- * <li>
438
- * <p>You obtain a shard iterator, but before you use the iterator in a <code>GetRecords</code>
439
- * request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes
440
- * the iterator to access a record that no longer exists.</p>
441
- * </li>
442
- * </ul>
443
- */
444
- export interface TrimmedDataAccessException extends __SmithyException, $MetadataBearer {
445
- name: "TrimmedDataAccessException";
446
- $fault: "client";
447
- /**
448
- * <p>"The data you are trying to access has been trimmed.</p>
449
- */
450
- message?: string;
451
- }
452
-
453
- export namespace TrimmedDataAccessException {
454
- /**
455
- * @internal
456
- */
457
- export const filterSensitiveLog = (obj: TrimmedDataAccessException): any => ({
458
- ...obj,
459
- });
460
- }
461
-
462
- export type ShardIteratorType = "AFTER_SEQUENCE_NUMBER" | "AT_SEQUENCE_NUMBER" | "LATEST" | "TRIM_HORIZON";
463
-
464
- /**
465
- * <p>Represents the input of a <code>GetShardIterator</code> operation.</p>
466
- */
467
- export interface GetShardIteratorInput {
468
- /**
469
- * <p>The Amazon Resource Name (ARN) for the stream.</p>
470
- */
471
- StreamArn: string | undefined;
472
-
473
- /**
474
- * <p>The identifier of the shard. The iterator will be returned for this shard ID.</p>
475
- */
476
- ShardId: string | undefined;
477
-
478
- /**
479
- * <p>Determines how the shard iterator is used to start reading stream records from the shard:</p>
480
- * <ul>
481
- * <li>
482
- * <p>
483
- * <code>AT_SEQUENCE_NUMBER</code> - Start reading exactly from the position denoted by a
484
- * specific sequence number.</p>
485
- * </li>
486
- * <li>
487
- * <p>
488
- * <code>AFTER_SEQUENCE_NUMBER</code> - Start reading right after the position denoted by a
489
- * specific sequence number.</p>
490
- * </li>
491
- * <li>
492
- * <p>
493
- * <code>TRIM_HORIZON</code> - Start reading at the last (untrimmed) stream record, which is
494
- * the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention.
495
- * Stream records whose age exceeds this limit are subject to removal (trimming) from the
496
- * stream.</p>
497
- * </li>
498
- * <li>
499
- * <p>
500
- * <code>LATEST</code> - Start reading just after the most recent stream record in the
501
- * shard, so that you always read the most recent data in the shard.</p>
502
- * </li>
503
- * </ul>
504
- */
505
- ShardIteratorType: ShardIteratorType | string | undefined;
506
-
507
- /**
508
- * <p>The sequence number of a stream record in the shard from which to start reading.</p>
509
- */
510
- SequenceNumber?: string;
511
- }
512
-
513
- export namespace GetShardIteratorInput {
514
- /**
515
- * @internal
516
- */
517
- export const filterSensitiveLog = (obj: GetShardIteratorInput): any => ({
518
- ...obj,
519
- });
520
- }
521
-
522
- /**
523
- * <p>Represents the output of a <code>GetShardIterator</code> operation.</p>
524
- */
525
- export interface GetShardIteratorOutput {
526
- /**
527
- * <p>The position in the shard from which to start reading stream records sequentially. A shard iterator specifies this position using the sequence number of a stream record in a shard.</p>
528
- */
529
- ShardIterator?: string;
530
- }
531
-
532
- export namespace GetShardIteratorOutput {
533
- /**
534
- * @internal
535
- */
536
- export const filterSensitiveLog = (obj: GetShardIteratorOutput): any => ({
537
- ...obj,
538
- });
539
- }
540
-
541
- /**
542
- * <p>Represents the input of a <code>ListStreams</code> operation.</p>
543
- */
544
- export interface ListStreamsInput {
545
- /**
546
- * <p>If this parameter is provided, then only the streams associated with this table name are returned.</p>
547
- */
548
- TableName?: string;
549
-
550
- /**
551
- * <p>The maximum number of streams to return. The upper limit is 100.</p>
552
- */
553
- Limit?: number;
554
-
555
- /**
556
- * <p>The ARN (Amazon Resource Name) of the first item that this operation will evaluate. Use the
557
- * value that was returned for <code>LastEvaluatedStreamArn</code> in the previous operation.
558
- * </p>
559
- */
560
- ExclusiveStartStreamArn?: string;
561
- }
562
-
563
- export namespace ListStreamsInput {
564
- /**
565
- * @internal
566
- */
567
- export const filterSensitiveLog = (obj: ListStreamsInput): any => ({
568
- ...obj,
569
- });
570
- }
571
-
572
- /**
573
- * <p>Represents all of the data describing a particular stream.</p>
574
- */
575
- export interface _Stream {
576
- /**
577
- * <p>The Amazon Resource Name (ARN) for the stream.</p>
578
- */
579
- StreamArn?: string;
580
-
581
- /**
582
- * <p>The DynamoDB table with which the stream is associated.</p>
583
- */
584
- TableName?: string;
585
-
586
- /**
587
- * <p>A timestamp, in ISO 8601 format, for this stream.</p>
588
- * <p>Note that <code>LatestStreamLabel</code> is not a unique identifier for the stream, because it is
589
- * possible that a stream from another table might have the same timestamp. However, the
590
- * combination of the following three elements is guaranteed to be unique:</p>
591
- * <ul>
592
- * <li>
593
- * <p>the AWS customer ID.</p>
594
- * </li>
595
- * <li>
596
- * <p>the table name</p>
597
- * </li>
598
- * <li>
599
- * <p>the <code>StreamLabel</code>
600
- * </p>
601
- * </li>
602
- * </ul>
603
- */
604
- StreamLabel?: string;
605
- }
606
-
607
- export namespace _Stream {
608
- /**
609
- * @internal
610
- */
611
- export const filterSensitiveLog = (obj: _Stream): any => ({
612
- ...obj,
613
- });
614
- }
615
-
616
- /**
617
- * <p>Represents the output of a <code>ListStreams</code> operation.</p>
618
- */
619
- export interface ListStreamsOutput {
620
- /**
621
- * <p>A list of stream descriptors associated with the current account and endpoint.</p>
622
- */
623
- Streams?: _Stream[];
624
-
625
- /**
626
- * <p>The stream ARN of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.</p>
627
- * <p>If <code>LastEvaluatedStreamArn</code> is empty, then the "last page" of results has been
628
- * processed and there is no more data to be retrieved.</p>
629
- * <p>If <code>LastEvaluatedStreamArn</code> is not empty, it does not necessarily mean that there
630
- * is more data in the result set. The only way to know when you have reached the end of the
631
- * result set is when <code>LastEvaluatedStreamArn</code> is empty.</p>
632
- */
633
- LastEvaluatedStreamArn?: string;
634
- }
635
-
636
- export namespace ListStreamsOutput {
637
- /**
638
- * @internal
639
- */
640
- export const filterSensitiveLog = (obj: ListStreamsOutput): any => ({
641
- ...obj,
642
- });
643
- }
644
-
645
- /**
646
- * <p>Represents the data for an attribute.</p>
647
- * <p>Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.</p>
648
- * <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes">Data Types</a> in the
649
- * <i>Amazon DynamoDB Developer Guide</i>.</p>
650
- */
651
- export type AttributeValue =
652
- | AttributeValue.BMember
653
- | AttributeValue.BOOLMember
654
- | AttributeValue.BSMember
655
- | AttributeValue.LMember
656
- | AttributeValue.MMember
657
- | AttributeValue.NMember
658
- | AttributeValue.NSMember
659
- | AttributeValue.NULLMember
660
- | AttributeValue.SMember
661
- | AttributeValue.SSMember
662
- | AttributeValue.$UnknownMember;
663
-
664
- export namespace AttributeValue {
665
- /**
666
- * <p>An attribute of type String. For example:</p>
667
- * <p>
668
- * <code>"S": "Hello"</code>
669
- * </p>
670
- */
671
- export interface SMember {
672
- S: string;
673
- N?: never;
674
- B?: never;
675
- SS?: never;
676
- NS?: never;
677
- BS?: never;
678
- M?: never;
679
- L?: never;
680
- NULL?: never;
681
- BOOL?: never;
682
- $unknown?: never;
683
- }
684
-
685
- /**
686
- * <p>An attribute of type Number. For example:</p>
687
- * <p>
688
- * <code>"N": "123.45"</code>
689
- * </p>
690
- * <p>Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.</p>
691
- */
692
- export interface NMember {
693
- S?: never;
694
- N: string;
695
- B?: never;
696
- SS?: never;
697
- NS?: never;
698
- BS?: never;
699
- M?: never;
700
- L?: never;
701
- NULL?: never;
702
- BOOL?: never;
703
- $unknown?: never;
704
- }
705
-
706
- /**
707
- * <p>An attribute of type Binary. For example:</p>
708
- * <p>
709
- * <code>"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"</code>
710
- * </p>
711
- */
712
- export interface BMember {
713
- S?: never;
714
- N?: never;
715
- B: Uint8Array;
716
- SS?: never;
717
- NS?: never;
718
- BS?: never;
719
- M?: never;
720
- L?: never;
721
- NULL?: never;
722
- BOOL?: never;
723
- $unknown?: never;
724
- }
725
-
726
- /**
727
- * <p>An attribute of type String Set. For example:</p>
728
- * <p>
729
- * <code>"SS": ["Giraffe", "Hippo" ,"Zebra"]</code>
730
- * </p>
731
- */
732
- export interface SSMember {
733
- S?: never;
734
- N?: never;
735
- B?: never;
736
- SS: string[];
737
- NS?: never;
738
- BS?: never;
739
- M?: never;
740
- L?: never;
741
- NULL?: never;
742
- BOOL?: never;
743
- $unknown?: never;
744
- }
745
-
746
- /**
747
- * <p>An attribute of type Number Set. For example:</p>
748
- * <p>
749
- * <code>"NS": ["42.2", "-19", "7.5", "3.14"]</code>
750
- * </p>
751
- * <p>Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.</p>
752
- */
753
- export interface NSMember {
754
- S?: never;
755
- N?: never;
756
- B?: never;
757
- SS?: never;
758
- NS: string[];
759
- BS?: never;
760
- M?: never;
761
- L?: never;
762
- NULL?: never;
763
- BOOL?: never;
764
- $unknown?: never;
765
- }
766
-
767
- /**
768
- * <p>An attribute of type Binary Set. For example:</p>
769
- * <p>
770
- * <code>"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]</code>
771
- * </p>
772
- */
773
- export interface BSMember {
774
- S?: never;
775
- N?: never;
776
- B?: never;
777
- SS?: never;
778
- NS?: never;
779
- BS: Uint8Array[];
780
- M?: never;
781
- L?: never;
782
- NULL?: never;
783
- BOOL?: never;
784
- $unknown?: never;
785
- }
786
-
787
- /**
788
- * <p>An attribute of type Map. For example:</p>
789
- * <p>
790
- * <code>"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}</code>
791
- * </p>
792
- */
793
- export interface MMember {
794
- S?: never;
795
- N?: never;
796
- B?: never;
797
- SS?: never;
798
- NS?: never;
799
- BS?: never;
800
- M: { [key: string]: AttributeValue };
801
- L?: never;
802
- NULL?: never;
803
- BOOL?: never;
804
- $unknown?: never;
805
- }
806
-
807
- /**
808
- * <p>An attribute of type List. For example:</p>
809
- * <p>
810
- * <code>"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]</code>
811
- * </p>
812
- */
813
- export interface LMember {
814
- S?: never;
815
- N?: never;
816
- B?: never;
817
- SS?: never;
818
- NS?: never;
819
- BS?: never;
820
- M?: never;
821
- L: AttributeValue[];
822
- NULL?: never;
823
- BOOL?: never;
824
- $unknown?: never;
825
- }
826
-
827
- /**
828
- * <p>An attribute of type Null. For example:</p>
829
- * <p>
830
- * <code>"NULL": true</code>
831
- * </p>
832
- */
833
- export interface NULLMember {
834
- S?: never;
835
- N?: never;
836
- B?: never;
837
- SS?: never;
838
- NS?: never;
839
- BS?: never;
840
- M?: never;
841
- L?: never;
842
- NULL: boolean;
843
- BOOL?: never;
844
- $unknown?: never;
845
- }
846
-
847
- /**
848
- * <p>An attribute of type Boolean. For example:</p>
849
- * <p>
850
- * <code>"BOOL": true</code>
851
- * </p>
852
- */
853
- export interface BOOLMember {
854
- S?: never;
855
- N?: never;
856
- B?: never;
857
- SS?: never;
858
- NS?: never;
859
- BS?: never;
860
- M?: never;
861
- L?: never;
862
- NULL?: never;
863
- BOOL: boolean;
864
- $unknown?: never;
865
- }
866
-
867
- export interface $UnknownMember {
868
- S?: never;
869
- N?: never;
870
- B?: never;
871
- SS?: never;
872
- NS?: never;
873
- BS?: never;
874
- M?: never;
875
- L?: never;
876
- NULL?: never;
877
- BOOL?: never;
878
- $unknown: [string, any];
879
- }
880
-
881
- export interface Visitor<T> {
882
- S: (value: string) => T;
883
- N: (value: string) => T;
884
- B: (value: Uint8Array) => T;
885
- SS: (value: string[]) => T;
886
- NS: (value: string[]) => T;
887
- BS: (value: Uint8Array[]) => T;
888
- M: (value: { [key: string]: AttributeValue }) => T;
889
- L: (value: AttributeValue[]) => T;
890
- NULL: (value: boolean) => T;
891
- BOOL: (value: boolean) => T;
892
- _: (name: string, value: any) => T;
893
- }
894
-
895
- export const visit = <T>(value: AttributeValue, visitor: Visitor<T>): T => {
896
- if (value.S !== undefined) return visitor.S(value.S);
897
- if (value.N !== undefined) return visitor.N(value.N);
898
- if (value.B !== undefined) return visitor.B(value.B);
899
- if (value.SS !== undefined) return visitor.SS(value.SS);
900
- if (value.NS !== undefined) return visitor.NS(value.NS);
901
- if (value.BS !== undefined) return visitor.BS(value.BS);
902
- if (value.M !== undefined) return visitor.M(value.M);
903
- if (value.L !== undefined) return visitor.L(value.L);
904
- if (value.NULL !== undefined) return visitor.NULL(value.NULL);
905
- if (value.BOOL !== undefined) return visitor.BOOL(value.BOOL);
906
- return visitor._(value.$unknown[0], value.$unknown[1]);
907
- };
908
-
909
- /**
910
- * @internal
911
- */
912
- export const filterSensitiveLog = (obj: AttributeValue): any => {
913
- if (obj.S !== undefined) return { S: obj.S };
914
- if (obj.N !== undefined) return { N: obj.N };
915
- if (obj.B !== undefined) return { B: obj.B };
916
- if (obj.SS !== undefined) return { SS: obj.SS };
917
- if (obj.NS !== undefined) return { NS: obj.NS };
918
- if (obj.BS !== undefined) return { BS: obj.BS };
919
- if (obj.M !== undefined)
920
- return {
921
- M: Object.entries(obj.M).reduce(
922
- (acc: any, [key, value]: [string, AttributeValue]) => ({
923
- ...acc,
924
- [key]: AttributeValue.filterSensitiveLog(value),
925
- }),
926
- {}
927
- ),
928
- };
929
- if (obj.L !== undefined) return { L: obj.L.map((item) => AttributeValue.filterSensitiveLog(item)) };
930
- if (obj.NULL !== undefined) return { NULL: obj.NULL };
931
- if (obj.BOOL !== undefined) return { BOOL: obj.BOOL };
932
- if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" };
933
- };
934
- }
935
-
936
- /**
937
- * <p>A description of a single data modification that was performed on an item in a DynamoDB table.</p>
938
- */
939
- export interface StreamRecord {
940
- /**
941
- * <p>The approximate date and time when the stream record was created, in <a href="http://www.epochconverter.com/">UNIX epoch time</a> format.</p>
942
- */
943
- ApproximateCreationDateTime?: Date;
944
-
945
- /**
946
- * <p>The primary key attribute(s) for the DynamoDB item that was modified.</p>
947
- */
948
- Keys?: { [key: string]: AttributeValue };
949
-
950
- /**
951
- * <p>The item in the DynamoDB table as it appeared after it was modified.</p>
952
- */
953
- NewImage?: { [key: string]: AttributeValue };
954
-
955
- /**
956
- * <p>The item in the DynamoDB table as it appeared before it was modified.</p>
957
- */
958
- OldImage?: { [key: string]: AttributeValue };
959
-
960
- /**
961
- * <p>The sequence number of the stream record.</p>
962
- */
963
- SequenceNumber?: string;
964
-
965
- /**
966
- * <p>The size of the stream record, in bytes.</p>
967
- */
968
- SizeBytes?: number;
969
-
970
- /**
971
- * <p>The type of data from the modified DynamoDB item that was captured in this stream record:</p>
972
- * <ul>
973
- * <li>
974
- * <p>
975
- * <code>KEYS_ONLY</code> - only the key attributes of the modified item.</p>
976
- * </li>
977
- * <li>
978
- * <p>
979
- * <code>NEW_IMAGE</code> - the entire item, as it appeared after it was modified.</p>
980
- * </li>
981
- * <li>
982
- * <p>
983
- * <code>OLD_IMAGE</code> - the entire item, as it appeared before it was modified.</p>
984
- * </li>
985
- * <li>
986
- * <p>
987
- * <code>NEW_AND_OLD_IMAGES</code> - both the new and the old item images of the item.</p>
988
- * </li>
989
- * </ul>
990
- */
991
- StreamViewType?: StreamViewType | string;
992
- }
993
-
994
- export namespace StreamRecord {
995
- /**
996
- * @internal
997
- */
998
- export const filterSensitiveLog = (obj: StreamRecord): any => ({
999
- ...obj,
1000
- ...(obj.Keys && {
1001
- Keys: Object.entries(obj.Keys).reduce(
1002
- (acc: any, [key, value]: [string, AttributeValue]) => ({
1003
- ...acc,
1004
- [key]: AttributeValue.filterSensitiveLog(value),
1005
- }),
1006
- {}
1007
- ),
1008
- }),
1009
- ...(obj.NewImage && {
1010
- NewImage: Object.entries(obj.NewImage).reduce(
1011
- (acc: any, [key, value]: [string, AttributeValue]) => ({
1012
- ...acc,
1013
- [key]: AttributeValue.filterSensitiveLog(value),
1014
- }),
1015
- {}
1016
- ),
1017
- }),
1018
- ...(obj.OldImage && {
1019
- OldImage: Object.entries(obj.OldImage).reduce(
1020
- (acc: any, [key, value]: [string, AttributeValue]) => ({
1021
- ...acc,
1022
- [key]: AttributeValue.filterSensitiveLog(value),
1023
- }),
1024
- {}
1025
- ),
1026
- }),
1027
- });
1028
- }
1029
-
1030
- /**
1031
- * <p>A description of a unique event within a stream.</p>
1032
- */
1033
- export interface _Record {
1034
- /**
1035
- * <p>A globally unique identifier for the event that was recorded in this stream record.</p>
1036
- */
1037
- eventID?: string;
1038
-
1039
- /**
1040
- * <p>The type of data modification that was performed on the DynamoDB table:</p>
1041
- * <ul>
1042
- * <li>
1043
- * <p>
1044
- * <code>INSERT</code> - a new item was added to the table.</p>
1045
- * </li>
1046
- * <li>
1047
- * <p>
1048
- * <code>MODIFY</code> - one or more of an existing item's attributes were modified.</p>
1049
- * </li>
1050
- * <li>
1051
- * <p>
1052
- * <code>REMOVE</code> - the item was deleted from the table</p>
1053
- * </li>
1054
- * </ul>
1055
- */
1056
- eventName?: OperationType | string;
1057
-
1058
- /**
1059
- * <p>The version number of the stream record format. This number is updated whenever the structure of <code>Record</code> is modified.</p>
1060
- * <p>Client applications must not assume that <code>eventVersion</code> will remain at a particular
1061
- * value, as this number is subject to change at any time. In general, <code>eventVersion</code> will
1062
- * only increase as the low-level DynamoDB Streams API evolves.</p>
1063
- */
1064
- eventVersion?: string;
1065
-
1066
- /**
1067
- * <p>The AWS service from which the stream record originated. For DynamoDB Streams, this is <code>aws:dynamodb</code>.</p>
1068
- */
1069
- eventSource?: string;
1070
-
1071
- /**
1072
- * <p>The region in which the <code>GetRecords</code> request was received.</p>
1073
- */
1074
- awsRegion?: string;
1075
-
1076
- /**
1077
- * <p>The main body of the stream record, containing all of the DynamoDB-specific fields.</p>
1078
- */
1079
- dynamodb?: StreamRecord;
1080
-
1081
- /**
1082
- * <p>Items that are deleted by the Time to Live process after expiration have the following fields: </p>
1083
- * <ul>
1084
- * <li>
1085
- * <p>Records[].userIdentity.type</p>
1086
- * <p>"Service"</p>
1087
- * </li>
1088
- * <li>
1089
- * <p>Records[].userIdentity.principalId</p>
1090
- * <p>"dynamodb.amazonaws.com"</p>
1091
- * </li>
1092
- * </ul>
1093
- */
1094
- userIdentity?: Identity;
1095
- }
1096
-
1097
- export namespace _Record {
1098
- /**
1099
- * @internal
1100
- */
1101
- export const filterSensitiveLog = (obj: _Record): any => ({
1102
- ...obj,
1103
- ...(obj.dynamodb && { dynamodb: StreamRecord.filterSensitiveLog(obj.dynamodb) }),
1104
- });
1105
- }
1106
-
1107
- /**
1108
- * <p>Represents the output of a <code>GetRecords</code> operation.</p>
1109
- */
1110
- export interface GetRecordsOutput {
1111
- /**
1112
- * <p>The stream records from the shard, which were retrieved using the shard iterator.</p>
1113
- */
1114
- Records?: _Record[];
1115
-
1116
- /**
1117
- * <p>The next position in the shard from which to start sequentially reading stream records. If
1118
- * set to <code>null</code>, the shard has been closed and the requested iterator will not return
1119
- * any more data.</p>
1120
- */
1121
- NextShardIterator?: string;
1122
- }
1123
-
1124
- export namespace GetRecordsOutput {
1125
- /**
1126
- * @internal
1127
- */
1128
- export const filterSensitiveLog = (obj: GetRecordsOutput): any => ({
1129
- ...obj,
1130
- ...(obj.Records && { Records: obj.Records.map((item) => _Record.filterSensitiveLog(item)) }),
1131
- });
1132
- }