@aws-sdk/client-dynamodb-streams 3.686.0 → 3.691.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.
@@ -14,13 +14,13 @@ export interface DescribeStreamInput {
14
14
  * <p>The maximum number of shard objects to return. The upper limit is 100.</p>
15
15
  * @public
16
16
  */
17
- Limit?: number;
17
+ Limit?: number | undefined;
18
18
  /**
19
19
  * <p>The shard ID of the first item that this operation will evaluate. Use the value that was
20
20
  * returned for <code>LastEvaluatedShardId</code> in the previous operation. </p>
21
21
  * @public
22
22
  */
23
- ExclusiveStartShardId?: string;
23
+ ExclusiveStartShardId?: string | undefined;
24
24
  }
25
25
  /**
26
26
  * @public
@@ -89,12 +89,12 @@ export interface SequenceNumberRange {
89
89
  * <p>The first sequence number for the stream records contained within a shard. String contains numeric characters only.</p>
90
90
  * @public
91
91
  */
92
- StartingSequenceNumber?: string;
92
+ StartingSequenceNumber?: string | undefined;
93
93
  /**
94
94
  * <p>The last sequence number for the stream records contained within a shard. String contains numeric characters only.</p>
95
95
  * @public
96
96
  */
97
- EndingSequenceNumber?: string;
97
+ EndingSequenceNumber?: string | undefined;
98
98
  }
99
99
  /**
100
100
  * <p>A uniquely identified group of stream records within a stream.</p>
@@ -105,17 +105,17 @@ export interface Shard {
105
105
  * <p>The system-generated identifier for this shard.</p>
106
106
  * @public
107
107
  */
108
- ShardId?: string;
108
+ ShardId?: string | undefined;
109
109
  /**
110
110
  * <p>The range of possible sequence numbers for the shard.</p>
111
111
  * @public
112
112
  */
113
- SequenceNumberRange?: SequenceNumberRange;
113
+ SequenceNumberRange?: SequenceNumberRange | undefined;
114
114
  /**
115
115
  * <p>The shard ID of the current shard's parent.</p>
116
116
  * @public
117
117
  */
118
- ParentShardId?: string;
118
+ ParentShardId?: string | undefined;
119
119
  }
120
120
  /**
121
121
  * @public
@@ -154,7 +154,7 @@ export interface StreamDescription {
154
154
  * <p>The Amazon Resource Name (ARN) for the stream.</p>
155
155
  * @public
156
156
  */
157
- StreamArn?: string;
157
+ StreamArn?: string | undefined;
158
158
  /**
159
159
  * <p>A timestamp, in ISO 8601 format, for this stream.</p>
160
160
  * <p>Note that <code>LatestStreamLabel</code> is not a unique identifier for the stream, because it is
@@ -174,7 +174,7 @@ export interface StreamDescription {
174
174
  * </ul>
175
175
  * @public
176
176
  */
177
- StreamLabel?: string;
177
+ StreamLabel?: string | undefined;
178
178
  /**
179
179
  * <p>Indicates the current status of the stream:</p>
180
180
  * <ul>
@@ -197,7 +197,7 @@ export interface StreamDescription {
197
197
  * </ul>
198
198
  * @public
199
199
  */
200
- StreamStatus?: StreamStatus;
200
+ StreamStatus?: StreamStatus | undefined;
201
201
  /**
202
202
  * <p>Indicates the format of the records within this stream:</p>
203
203
  * <ul>
@@ -220,27 +220,27 @@ export interface StreamDescription {
220
220
  * </ul>
221
221
  * @public
222
222
  */
223
- StreamViewType?: StreamViewType;
223
+ StreamViewType?: StreamViewType | undefined;
224
224
  /**
225
225
  * <p>The date and time when the request to create this stream was issued.</p>
226
226
  * @public
227
227
  */
228
- CreationRequestDateTime?: Date;
228
+ CreationRequestDateTime?: Date | undefined;
229
229
  /**
230
230
  * <p>The DynamoDB table with which the stream is associated.</p>
231
231
  * @public
232
232
  */
233
- TableName?: string;
233
+ TableName?: string | undefined;
234
234
  /**
235
235
  * <p>The key attribute(s) of the stream's DynamoDB table.</p>
236
236
  * @public
237
237
  */
238
- KeySchema?: KeySchemaElement[];
238
+ KeySchema?: KeySchemaElement[] | undefined;
239
239
  /**
240
240
  * <p>The shards that comprise the stream.</p>
241
241
  * @public
242
242
  */
243
- Shards?: Shard[];
243
+ Shards?: Shard[] | undefined;
244
244
  /**
245
245
  * <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>
246
246
  * <p>If <code>LastEvaluatedShardId</code> is empty, then the "last page" of results has been
@@ -250,7 +250,7 @@ export interface StreamDescription {
250
250
  * set is when <code>LastEvaluatedShardId</code> is empty.</p>
251
251
  * @public
252
252
  */
253
- LastEvaluatedShardId?: string;
253
+ LastEvaluatedShardId?: string | undefined;
254
254
  }
255
255
  /**
256
256
  * <p>Represents the output of a <code>DescribeStream</code> operation.</p>
@@ -261,7 +261,7 @@ export interface DescribeStreamOutput {
261
261
  * <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>
262
262
  * @public
263
263
  */
264
- StreamDescription?: StreamDescription;
264
+ StreamDescription?: StreamDescription | undefined;
265
265
  }
266
266
  /**
267
267
  * <p>An error occurred on the server side.</p>
@@ -317,7 +317,7 @@ export interface GetRecordsInput {
317
317
  * <p>The maximum number of records to return from the shard. The upper limit is 1000.</p>
318
318
  * @public
319
319
  */
320
- Limit?: number;
320
+ Limit?: number | undefined;
321
321
  }
322
322
  /**
323
323
  * @public
@@ -342,12 +342,12 @@ export interface Identity {
342
342
  * principalId is "dynamodb.amazonaws.com".</p>
343
343
  * @public
344
344
  */
345
- PrincipalId?: string;
345
+ PrincipalId?: string | undefined;
346
346
  /**
347
347
  * <p>The type of the identity. For Time To Live, the type is "Service".</p>
348
348
  * @public
349
349
  */
350
- Type?: string;
350
+ Type?: string | undefined;
351
351
  }
352
352
  /**
353
353
  * <p>There is no limit to the number of daily on-demand backups that can be taken. </p>
@@ -459,7 +459,7 @@ export interface GetShardIteratorInput {
459
459
  * <p>The sequence number of a stream record in the shard from which to start reading.</p>
460
460
  * @public
461
461
  */
462
- SequenceNumber?: string;
462
+ SequenceNumber?: string | undefined;
463
463
  }
464
464
  /**
465
465
  * <p>Represents the output of a <code>GetShardIterator</code> operation.</p>
@@ -470,7 +470,7 @@ export interface GetShardIteratorOutput {
470
470
  * <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>
471
471
  * @public
472
472
  */
473
- ShardIterator?: string;
473
+ ShardIterator?: string | undefined;
474
474
  }
475
475
  /**
476
476
  * <p>Represents the input of a <code>ListStreams</code> operation.</p>
@@ -481,19 +481,19 @@ export interface ListStreamsInput {
481
481
  * <p>If this parameter is provided, then only the streams associated with this table name are returned.</p>
482
482
  * @public
483
483
  */
484
- TableName?: string;
484
+ TableName?: string | undefined;
485
485
  /**
486
486
  * <p>The maximum number of streams to return. The upper limit is 100.</p>
487
487
  * @public
488
488
  */
489
- Limit?: number;
489
+ Limit?: number | undefined;
490
490
  /**
491
491
  * <p>The ARN (Amazon Resource Name) of the first item that this operation will evaluate. Use the
492
492
  * value that was returned for <code>LastEvaluatedStreamArn</code> in the previous operation.
493
493
  * </p>
494
494
  * @public
495
495
  */
496
- ExclusiveStartStreamArn?: string;
496
+ ExclusiveStartStreamArn?: string | undefined;
497
497
  }
498
498
  /**
499
499
  * <p>Represents all of the data describing a particular stream.</p>
@@ -504,12 +504,12 @@ export interface _Stream {
504
504
  * <p>The Amazon Resource Name (ARN) for the stream.</p>
505
505
  * @public
506
506
  */
507
- StreamArn?: string;
507
+ StreamArn?: string | undefined;
508
508
  /**
509
509
  * <p>The DynamoDB table with which the stream is associated.</p>
510
510
  * @public
511
511
  */
512
- TableName?: string;
512
+ TableName?: string | undefined;
513
513
  /**
514
514
  * <p>A timestamp, in ISO 8601 format, for this stream.</p>
515
515
  * <p>Note that <code>LatestStreamLabel</code> is not a unique identifier for the stream, because it is
@@ -529,7 +529,7 @@ export interface _Stream {
529
529
  * </ul>
530
530
  * @public
531
531
  */
532
- StreamLabel?: string;
532
+ StreamLabel?: string | undefined;
533
533
  }
534
534
  /**
535
535
  * <p>Represents the output of a <code>ListStreams</code> operation.</p>
@@ -540,7 +540,7 @@ export interface ListStreamsOutput {
540
540
  * <p>A list of stream descriptors associated with the current account and endpoint.</p>
541
541
  * @public
542
542
  */
543
- Streams?: _Stream[];
543
+ Streams?: _Stream[] | undefined;
544
544
  /**
545
545
  * <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>
546
546
  * <p>If <code>LastEvaluatedStreamArn</code> is empty, then the "last page" of results has been
@@ -550,7 +550,7 @@ export interface ListStreamsOutput {
550
550
  * result set is when <code>LastEvaluatedStreamArn</code> is empty.</p>
551
551
  * @public
552
552
  */
553
- LastEvaluatedStreamArn?: string;
553
+ LastEvaluatedStreamArn?: string | undefined;
554
554
  }
555
555
  /**
556
556
  * <p>Represents the data for an attribute.</p>
@@ -806,32 +806,32 @@ export interface StreamRecord {
806
806
  * <p>The approximate date and time when the stream record was created, in <a href="http://www.epochconverter.com/">UNIX epoch time</a> format and rounded down to the closest second.</p>
807
807
  * @public
808
808
  */
809
- ApproximateCreationDateTime?: Date;
809
+ ApproximateCreationDateTime?: Date | undefined;
810
810
  /**
811
811
  * <p>The primary key attribute(s) for the DynamoDB item that was modified.</p>
812
812
  * @public
813
813
  */
814
- Keys?: Record<string, AttributeValue>;
814
+ Keys?: Record<string, AttributeValue> | undefined;
815
815
  /**
816
816
  * <p>The item in the DynamoDB table as it appeared after it was modified.</p>
817
817
  * @public
818
818
  */
819
- NewImage?: Record<string, AttributeValue>;
819
+ NewImage?: Record<string, AttributeValue> | undefined;
820
820
  /**
821
821
  * <p>The item in the DynamoDB table as it appeared before it was modified.</p>
822
822
  * @public
823
823
  */
824
- OldImage?: Record<string, AttributeValue>;
824
+ OldImage?: Record<string, AttributeValue> | undefined;
825
825
  /**
826
826
  * <p>The sequence number of the stream record.</p>
827
827
  * @public
828
828
  */
829
- SequenceNumber?: string;
829
+ SequenceNumber?: string | undefined;
830
830
  /**
831
831
  * <p>The size of the stream record, in bytes.</p>
832
832
  * @public
833
833
  */
834
- SizeBytes?: number;
834
+ SizeBytes?: number | undefined;
835
835
  /**
836
836
  * <p>The type of data from the modified DynamoDB item that was captured in this stream record:</p>
837
837
  * <ul>
@@ -854,7 +854,7 @@ export interface StreamRecord {
854
854
  * </ul>
855
855
  * @public
856
856
  */
857
- StreamViewType?: StreamViewType;
857
+ StreamViewType?: StreamViewType | undefined;
858
858
  }
859
859
  /**
860
860
  * <p>A description of a unique event within a stream.</p>
@@ -865,7 +865,7 @@ export interface _Record {
865
865
  * <p>A globally unique identifier for the event that was recorded in this stream record.</p>
866
866
  * @public
867
867
  */
868
- eventID?: string;
868
+ eventID?: string | undefined;
869
869
  /**
870
870
  * <p>The type of data modification that was performed on the DynamoDB table:</p>
871
871
  * <ul>
@@ -884,7 +884,7 @@ export interface _Record {
884
884
  * </ul>
885
885
  * @public
886
886
  */
887
- eventName?: OperationType;
887
+ eventName?: OperationType | undefined;
888
888
  /**
889
889
  * <p>The version number of the stream record format. This number is updated whenever the structure of <code>Record</code> is modified.</p>
890
890
  * <p>Client applications must not assume that <code>eventVersion</code> will remain at a particular
@@ -892,22 +892,22 @@ export interface _Record {
892
892
  * only increase as the low-level DynamoDB Streams API evolves.</p>
893
893
  * @public
894
894
  */
895
- eventVersion?: string;
895
+ eventVersion?: string | undefined;
896
896
  /**
897
897
  * <p>The Amazon Web Services service from which the stream record originated. For DynamoDB Streams, this is <code>aws:dynamodb</code>.</p>
898
898
  * @public
899
899
  */
900
- eventSource?: string;
900
+ eventSource?: string | undefined;
901
901
  /**
902
902
  * <p>The region in which the <code>GetRecords</code> request was received.</p>
903
903
  * @public
904
904
  */
905
- awsRegion?: string;
905
+ awsRegion?: string | undefined;
906
906
  /**
907
907
  * <p>The main body of the stream record, containing all of the DynamoDB-specific fields.</p>
908
908
  * @public
909
909
  */
910
- dynamodb?: StreamRecord;
910
+ dynamodb?: StreamRecord | undefined;
911
911
  /**
912
912
  * <p>Items that are deleted by the Time to Live process after expiration have the following fields: </p>
913
913
  * <ul>
@@ -922,7 +922,7 @@ export interface _Record {
922
922
  * </ul>
923
923
  * @public
924
924
  */
925
- userIdentity?: Identity;
925
+ userIdentity?: Identity | undefined;
926
926
  }
927
927
  /**
928
928
  * <p>Represents the output of a <code>GetRecords</code> operation.</p>
@@ -933,12 +933,12 @@ export interface GetRecordsOutput {
933
933
  * <p>The stream records from the shard, which were retrieved using the shard iterator.</p>
934
934
  * @public
935
935
  */
936
- Records?: _Record[];
936
+ Records?: _Record[] | undefined;
937
937
  /**
938
938
  * <p>The next position in the shard from which to start sequentially reading stream records. If
939
939
  * set to <code>null</code>, the shard has been closed and the requested iterator will not return
940
940
  * any more data.</p>
941
941
  * @public
942
942
  */
943
- NextShardIterator?: string;
943
+ NextShardIterator?: string | undefined;
944
944
  }
@@ -2,8 +2,8 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-cli
2
2
  import { DynamoDBStreamsServiceException as __BaseException } from "./DynamoDBStreamsServiceException";
3
3
  export interface DescribeStreamInput {
4
4
  StreamArn: string | undefined;
5
- Limit?: number;
6
- ExclusiveStartShardId?: string;
5
+ Limit?: number | undefined;
6
+ ExclusiveStartShardId?: string | undefined;
7
7
  }
8
8
  export declare const KeyType: {
9
9
  readonly HASH: "HASH";
@@ -15,13 +15,13 @@ export interface KeySchemaElement {
15
15
  KeyType: KeyType | undefined;
16
16
  }
17
17
  export interface SequenceNumberRange {
18
- StartingSequenceNumber?: string;
19
- EndingSequenceNumber?: string;
18
+ StartingSequenceNumber?: string | undefined;
19
+ EndingSequenceNumber?: string | undefined;
20
20
  }
21
21
  export interface Shard {
22
- ShardId?: string;
23
- SequenceNumberRange?: SequenceNumberRange;
24
- ParentShardId?: string;
22
+ ShardId?: string | undefined;
23
+ SequenceNumberRange?: SequenceNumberRange | undefined;
24
+ ParentShardId?: string | undefined;
25
25
  }
26
26
  export declare const StreamStatus: {
27
27
  readonly DISABLED: "DISABLED";
@@ -39,18 +39,18 @@ export declare const StreamViewType: {
39
39
  export type StreamViewType =
40
40
  (typeof StreamViewType)[keyof typeof StreamViewType];
41
41
  export interface StreamDescription {
42
- StreamArn?: string;
43
- StreamLabel?: string;
44
- StreamStatus?: StreamStatus;
45
- StreamViewType?: StreamViewType;
46
- CreationRequestDateTime?: Date;
47
- TableName?: string;
48
- KeySchema?: KeySchemaElement[];
49
- Shards?: Shard[];
50
- LastEvaluatedShardId?: string;
42
+ StreamArn?: string | undefined;
43
+ StreamLabel?: string | undefined;
44
+ StreamStatus?: StreamStatus | undefined;
45
+ StreamViewType?: StreamViewType | undefined;
46
+ CreationRequestDateTime?: Date | undefined;
47
+ TableName?: string | undefined;
48
+ KeySchema?: KeySchemaElement[] | undefined;
49
+ Shards?: Shard[] | undefined;
50
+ LastEvaluatedShardId?: string | undefined;
51
51
  }
52
52
  export interface DescribeStreamOutput {
53
- StreamDescription?: StreamDescription;
53
+ StreamDescription?: StreamDescription | undefined;
54
54
  }
55
55
  export declare class InternalServerError extends __BaseException {
56
56
  readonly name: "InternalServerError";
@@ -75,7 +75,7 @@ export declare class ExpiredIteratorException extends __BaseException {
75
75
  }
76
76
  export interface GetRecordsInput {
77
77
  ShardIterator: string | undefined;
78
- Limit?: number;
78
+ Limit?: number | undefined;
79
79
  }
80
80
  export declare const OperationType: {
81
81
  readonly INSERT: "INSERT";
@@ -84,8 +84,8 @@ export declare const OperationType: {
84
84
  };
85
85
  export type OperationType = (typeof OperationType)[keyof typeof OperationType];
86
86
  export interface Identity {
87
- PrincipalId?: string;
88
- Type?: string;
87
+ PrincipalId?: string | undefined;
88
+ Type?: string | undefined;
89
89
  }
90
90
  export declare class LimitExceededException extends __BaseException {
91
91
  readonly name: "LimitExceededException";
@@ -113,24 +113,24 @@ export interface GetShardIteratorInput {
113
113
  StreamArn: string | undefined;
114
114
  ShardId: string | undefined;
115
115
  ShardIteratorType: ShardIteratorType | undefined;
116
- SequenceNumber?: string;
116
+ SequenceNumber?: string | undefined;
117
117
  }
118
118
  export interface GetShardIteratorOutput {
119
- ShardIterator?: string;
119
+ ShardIterator?: string | undefined;
120
120
  }
121
121
  export interface ListStreamsInput {
122
- TableName?: string;
123
- Limit?: number;
124
- ExclusiveStartStreamArn?: string;
122
+ TableName?: string | undefined;
123
+ Limit?: number | undefined;
124
+ ExclusiveStartStreamArn?: string | undefined;
125
125
  }
126
126
  export interface _Stream {
127
- StreamArn?: string;
128
- TableName?: string;
129
- StreamLabel?: string;
127
+ StreamArn?: string | undefined;
128
+ TableName?: string | undefined;
129
+ StreamLabel?: string | undefined;
130
130
  }
131
131
  export interface ListStreamsOutput {
132
- Streams?: _Stream[];
133
- LastEvaluatedStreamArn?: string;
132
+ Streams?: _Stream[] | undefined;
133
+ LastEvaluatedStreamArn?: string | undefined;
134
134
  }
135
135
  export type AttributeValue =
136
136
  | AttributeValue.BMember
@@ -304,24 +304,24 @@ export declare namespace AttributeValue {
304
304
  const visit: <T>(value: AttributeValue, visitor: Visitor<T>) => T;
305
305
  }
306
306
  export interface StreamRecord {
307
- ApproximateCreationDateTime?: Date;
308
- Keys?: Record<string, AttributeValue>;
309
- NewImage?: Record<string, AttributeValue>;
310
- OldImage?: Record<string, AttributeValue>;
311
- SequenceNumber?: string;
312
- SizeBytes?: number;
313
- StreamViewType?: StreamViewType;
307
+ ApproximateCreationDateTime?: Date | undefined;
308
+ Keys?: Record<string, AttributeValue> | undefined;
309
+ NewImage?: Record<string, AttributeValue> | undefined;
310
+ OldImage?: Record<string, AttributeValue> | undefined;
311
+ SequenceNumber?: string | undefined;
312
+ SizeBytes?: number | undefined;
313
+ StreamViewType?: StreamViewType | undefined;
314
314
  }
315
315
  export interface _Record {
316
- eventID?: string;
317
- eventName?: OperationType;
318
- eventVersion?: string;
319
- eventSource?: string;
320
- awsRegion?: string;
321
- dynamodb?: StreamRecord;
322
- userIdentity?: Identity;
316
+ eventID?: string | undefined;
317
+ eventName?: OperationType | undefined;
318
+ eventVersion?: string | undefined;
319
+ eventSource?: string | undefined;
320
+ awsRegion?: string | undefined;
321
+ dynamodb?: StreamRecord | undefined;
322
+ userIdentity?: Identity | undefined;
323
323
  }
324
324
  export interface GetRecordsOutput {
325
- Records?: _Record[];
326
- NextShardIterator?: string;
325
+ Records?: _Record[] | undefined;
326
+ NextShardIterator?: string | undefined;
327
327
  }
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.686.0",
4
+ "version": "3.691.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",
@@ -20,19 +20,19 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
- "@aws-sdk/client-sso-oidc": "3.686.0",
24
- "@aws-sdk/client-sts": "3.686.0",
25
- "@aws-sdk/core": "3.686.0",
26
- "@aws-sdk/credential-provider-node": "3.686.0",
23
+ "@aws-sdk/client-sso-oidc": "3.691.0",
24
+ "@aws-sdk/client-sts": "3.691.0",
25
+ "@aws-sdk/core": "3.691.0",
26
+ "@aws-sdk/credential-provider-node": "3.691.0",
27
27
  "@aws-sdk/middleware-host-header": "3.686.0",
28
28
  "@aws-sdk/middleware-logger": "3.686.0",
29
29
  "@aws-sdk/middleware-recursion-detection": "3.686.0",
30
- "@aws-sdk/middleware-user-agent": "3.686.0",
30
+ "@aws-sdk/middleware-user-agent": "3.691.0",
31
31
  "@aws-sdk/region-config-resolver": "3.686.0",
32
32
  "@aws-sdk/types": "3.686.0",
33
33
  "@aws-sdk/util-endpoints": "3.686.0",
34
34
  "@aws-sdk/util-user-agent-browser": "3.686.0",
35
- "@aws-sdk/util-user-agent-node": "3.686.0",
35
+ "@aws-sdk/util-user-agent-node": "3.691.0",
36
36
  "@smithy/config-resolver": "^3.0.10",
37
37
  "@smithy/core": "^2.5.1",
38
38
  "@smithy/fetch-http-handler": "^4.0.0",