@aws-sdk/client-dynamodb-streams 3.288.0 → 3.290.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,80 @@ 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
+ * @throws {@link InternalServerError} (server fault)
41
+ * <p>An error occurred on the server side.</p>
42
+ *
43
+ * @throws {@link ResourceNotFoundException} (client fault)
44
+ * <p>The operation tried to access a nonexistent table or index. The resource
45
+ * might not be specified correctly, or its status might not be
46
+ * <code>ACTIVE</code>.</p>
47
+ *
48
+ *
49
+ * @example To describe a stream with a given stream ARN
50
+ * ```javascript
51
+ * // The following example describes a stream with a given stream ARN.
52
+ * const input = {
53
+ * "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252"
54
+ * };
55
+ * const command = new DescribeStreamCommand(input);
56
+ * const response = await client.send(command);
57
+ * /* response ==
58
+ * {
59
+ * "StreamDescription": {
60
+ * "CreationRequestDateTime": "Wed May 20 13:51:10 PDT 2015",
61
+ * "KeySchema": [
62
+ * {
63
+ * "AttributeName": "ForumName",
64
+ * "KeyType": "HASH"
65
+ * },
66
+ * {
67
+ * "AttributeName": "Subject",
68
+ * "KeyType": "RANGE"
69
+ * }
70
+ * ],
71
+ * "Shards": [
72
+ * {
73
+ * "SequenceNumberRange": {
74
+ * "EndingSequenceNumber": "20500000000000000910398",
75
+ * "StartingSequenceNumber": "20500000000000000910398"
76
+ * },
77
+ * "ShardId": "shardId-00000001414562045508-2bac9cd2"
78
+ * },
79
+ * {
80
+ * "ParentShardId": "shardId-00000001414562045508-2bac9cd2",
81
+ * "SequenceNumberRange": {
82
+ * "EndingSequenceNumber": "820400000000000001192334",
83
+ * "StartingSequenceNumber": "820400000000000001192334"
84
+ * },
85
+ * "ShardId": "shardId-00000001414576573621-f55eea83"
86
+ * },
87
+ * {
88
+ * "ParentShardId": "shardId-00000001414576573621-f55eea83",
89
+ * "SequenceNumberRange": {
90
+ * "EndingSequenceNumber": "1683700000000000001135967",
91
+ * "StartingSequenceNumber": "1683700000000000001135967"
92
+ * },
93
+ * "ShardId": "shardId-00000001414592258131-674fd923"
94
+ * },
95
+ * {
96
+ * "ParentShardId": "shardId-00000001414592258131-674fd923",
97
+ * "SequenceNumberRange": {
98
+ * "StartingSequenceNumber": "2574600000000000000935255"
99
+ * },
100
+ * "ShardId": "shardId-00000001414608446368-3a1afbaf"
101
+ * }
102
+ * ],
103
+ * "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252",
104
+ * "StreamLabel": "2015-05-20T20:51:10.252",
105
+ * "StreamStatus": "ENABLED",
106
+ * "StreamViewType": "NEW_AND_OLD_IMAGES",
107
+ * "TableName": "Forum"
108
+ * }
109
+ * }
110
+ * *\/
111
+ * // example id: to-describe-a-stream-with-a-given-stream-arn-1473457835200
112
+ * ```
113
+ *
40
114
  */
41
115
  export declare class DescribeStreamCommand extends $Command<DescribeStreamCommandInput, DescribeStreamCommandOutput, DynamoDBStreamsClientResolvedConfig> {
42
116
  readonly input: DescribeStreamCommandInput;
@@ -39,6 +39,128 @@ 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
+ * @throws {@link ExpiredIteratorException} (client fault)
43
+ * <p>The shard iterator has expired and can no longer be used to retrieve stream records. A shard
44
+ * iterator expires 15 minutes after it is retrieved using the <code>GetShardIterator</code>
45
+ * action.</p>
46
+ *
47
+ * @throws {@link InternalServerError} (server fault)
48
+ * <p>An error occurred on the server side.</p>
49
+ *
50
+ * @throws {@link LimitExceededException} (client fault)
51
+ * <p>There is no limit to the number of daily on-demand backups that can be taken. </p>
52
+ * <p>For most purposes, up to 500 simultaneous table operations are allowed per account. These operations
53
+ * include <code>CreateTable</code>, <code>UpdateTable</code>,
54
+ * <code>DeleteTable</code>,<code>UpdateTimeToLive</code>,
55
+ * <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>. </p>
56
+ * <p>When you are creating a table with one or more secondary
57
+ * indexes, you can have up to 250 such requests running at a time. However, if the table or
58
+ * index specifications are complex, then DynamoDB might temporarily reduce the number
59
+ * of concurrent operations.</p>
60
+ * <p>When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.</p>
61
+ * <p>There is a soft account quota of 2,500 tables.</p>
62
+ *
63
+ * @throws {@link ResourceNotFoundException} (client fault)
64
+ * <p>The operation tried to access a nonexistent table or index. The resource
65
+ * might not be specified correctly, or its status might not be
66
+ * <code>ACTIVE</code>.</p>
67
+ *
68
+ * @throws {@link TrimmedDataAccessException} (client fault)
69
+ * <p>The operation attempted to read past the oldest stream record in a shard.</p>
70
+ * <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>
71
+ * <ul>
72
+ * <li>
73
+ * <p>You request a shard iterator with a sequence number older than the trim point (24 hours).</p>
74
+ * </li>
75
+ * <li>
76
+ * <p>You obtain a shard iterator, but before you use the iterator in a <code>GetRecords</code>
77
+ * request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes
78
+ * the iterator to access a record that no longer exists.</p>
79
+ * </li>
80
+ * </ul>
81
+ *
82
+ *
83
+ * @example To retrieve all the stream records from a shard
84
+ * ```javascript
85
+ * // The following example retrieves all the stream records from a shard.
86
+ * const input = {
87
+ * "ShardIterator": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAEvJp6D+zaQ... <remaining characters omitted> ..."
88
+ * };
89
+ * const command = new GetRecordsCommand(input);
90
+ * const response = await client.send(command);
91
+ * /* response ==
92
+ * {
93
+ * "NextShardIterator": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAGQBYshYDEe ... <remaining characters omitted> ...",
94
+ * "Records": [
95
+ * {
96
+ * "awsRegion": "us-west-2",
97
+ * "dynamodb": {
98
+ * "ApproximateCreationDateTime": "1.46480646E9",
99
+ * "Keys": {
100
+ * "ForumName": {
101
+ * "S": "DynamoDB"
102
+ * },
103
+ * "Subject": {
104
+ * "S": "DynamoDB Thread 3"
105
+ * }
106
+ * },
107
+ * "SequenceNumber": "300000000000000499659",
108
+ * "SizeBytes": 41,
109
+ * "StreamViewType": "KEYS_ONLY"
110
+ * },
111
+ * "eventID": "e2fd9c34eff2d779b297b26f5fef4206",
112
+ * "eventName": "INSERT",
113
+ * "eventSource": "aws:dynamodb",
114
+ * "eventVersion": "1.0"
115
+ * },
116
+ * {
117
+ * "awsRegion": "us-west-2",
118
+ * "dynamodb": {
119
+ * "ApproximateCreationDateTime": "1.46480527E9",
120
+ * "Keys": {
121
+ * "ForumName": {
122
+ * "S": "DynamoDB"
123
+ * },
124
+ * "Subject": {
125
+ * "S": "DynamoDB Thread 1"
126
+ * }
127
+ * },
128
+ * "SequenceNumber": "400000000000000499660",
129
+ * "SizeBytes": 41,
130
+ * "StreamViewType": "KEYS_ONLY"
131
+ * },
132
+ * "eventID": "4b25bd0da9a181a155114127e4837252",
133
+ * "eventName": "MODIFY",
134
+ * "eventSource": "aws:dynamodb",
135
+ * "eventVersion": "1.0"
136
+ * },
137
+ * {
138
+ * "awsRegion": "us-west-2",
139
+ * "dynamodb": {
140
+ * "ApproximateCreationDateTime": "1.46480646E9",
141
+ * "Keys": {
142
+ * "ForumName": {
143
+ * "S": "DynamoDB"
144
+ * },
145
+ * "Subject": {
146
+ * "S": "DynamoDB Thread 2"
147
+ * }
148
+ * },
149
+ * "SequenceNumber": "500000000000000499661",
150
+ * "SizeBytes": 41,
151
+ * "StreamViewType": "KEYS_ONLY"
152
+ * },
153
+ * "eventID": "740280c73a3df7842edab3548a1b08ad",
154
+ * "eventName": "REMOVE",
155
+ * "eventSource": "aws:dynamodb",
156
+ * "eventVersion": "1.0"
157
+ * }
158
+ * ]
159
+ * }
160
+ * *\/
161
+ * // example id: to-retrieve-all-the-stream-records-from-a-shard-1473707781419
162
+ * ```
163
+ *
42
164
  */
43
165
  export declare class GetRecordsCommand extends $Command<GetRecordsCommandInput, GetRecordsCommandOutput, DynamoDBStreamsClientResolvedConfig> {
44
166
  readonly input: GetRecordsCommandInput;
@@ -36,6 +36,47 @@ 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
+ * @throws {@link InternalServerError} (server fault)
40
+ * <p>An error occurred on the server side.</p>
41
+ *
42
+ * @throws {@link ResourceNotFoundException} (client fault)
43
+ * <p>The operation tried to access a nonexistent table or index. The resource
44
+ * might not be specified correctly, or its status might not be
45
+ * <code>ACTIVE</code>.</p>
46
+ *
47
+ * @throws {@link TrimmedDataAccessException} (client fault)
48
+ * <p>The operation attempted to read past the oldest stream record in a shard.</p>
49
+ * <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>
50
+ * <ul>
51
+ * <li>
52
+ * <p>You request a shard iterator with a sequence number older than the trim point (24 hours).</p>
53
+ * </li>
54
+ * <li>
55
+ * <p>You obtain a shard iterator, but before you use the iterator in a <code>GetRecords</code>
56
+ * request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes
57
+ * the iterator to access a record that no longer exists.</p>
58
+ * </li>
59
+ * </ul>
60
+ *
61
+ *
62
+ * @example To obtain a shard iterator for the provided stream ARN and shard ID
63
+ * ```javascript
64
+ * // The following example returns a shard iterator for the provided stream ARN and shard ID.
65
+ * const input = {
66
+ * "ShardId": "00000001414576573621-f55eea83",
67
+ * "ShardIteratorType": "TRIM_HORIZON",
68
+ * "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252"
69
+ * };
70
+ * const command = new GetShardIteratorCommand(input);
71
+ * const response = await client.send(command);
72
+ * /* response ==
73
+ * {
74
+ * "ShardIterator": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAEvJp6D+zaQ... <remaining characters omitted> ..."
75
+ * }
76
+ * *\/
77
+ * // example id: to-obtain-a-shard-iterator-for-the-provided-stream-arn-and-shard-id-1473459941476
78
+ * ```
79
+ *
39
80
  */
40
81
  export declare class GetShardIteratorCommand extends $Command<GetShardIteratorCommandInput, GetShardIteratorCommandOutput, DynamoDBStreamsClientResolvedConfig> {
41
82
  readonly input: GetShardIteratorCommandInput;
@@ -34,6 +34,45 @@ 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
+ * @throws {@link InternalServerError} (server fault)
38
+ * <p>An error occurred on the server side.</p>
39
+ *
40
+ * @throws {@link ResourceNotFoundException} (client fault)
41
+ * <p>The operation tried to access a nonexistent table or index. The resource
42
+ * might not be specified correctly, or its status might not be
43
+ * <code>ACTIVE</code>.</p>
44
+ *
45
+ *
46
+ * @example To list all of the stream ARNs
47
+ * ```javascript
48
+ * // The following example lists all of the stream ARNs.
49
+ * const input = {};
50
+ * const command = new ListStreamsCommand(input);
51
+ * const response = await client.send(command);
52
+ * /* response ==
53
+ * {
54
+ * "Streams": [
55
+ * {
56
+ * "StreamArn": "arn:aws:dynamodb:us-wesst-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252",
57
+ * "StreamLabel": "2015-05-20T20:51:10.252",
58
+ * "TableName": "Forum"
59
+ * },
60
+ * {
61
+ * "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:50:02.714",
62
+ * "StreamLabel": "2015-05-20T20:50:02.714",
63
+ * "TableName": "Forum"
64
+ * },
65
+ * {
66
+ * "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-19T23:03:50.641",
67
+ * "StreamLabel": "2015-05-19T23:03:50.641",
68
+ * "TableName": "Forum"
69
+ * }
70
+ * ]
71
+ * }
72
+ * *\/
73
+ * // example id: to-list-all-of-the-stream-arns--1473459534285
74
+ * ```
75
+ *
37
76
  */
38
77
  export declare class ListStreamsCommand extends $Command<ListStreamsCommandInput, ListStreamsCommandOutput, DynamoDBStreamsClientResolvedConfig> {
39
78
  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.288.0",
4
+ "version": "3.290.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.288.0",
24
- "@aws-sdk/config-resolver": "3.287.0",
25
- "@aws-sdk/credential-provider-node": "3.288.0",
26
- "@aws-sdk/fetch-http-handler": "3.282.0",
27
- "@aws-sdk/hash-node": "3.272.0",
28
- "@aws-sdk/invalid-dependency": "3.272.0",
29
- "@aws-sdk/middleware-content-length": "3.282.0",
30
- "@aws-sdk/middleware-endpoint": "3.282.0",
31
- "@aws-sdk/middleware-host-header": "3.282.0",
32
- "@aws-sdk/middleware-logger": "3.288.0",
33
- "@aws-sdk/middleware-recursion-detection": "3.282.0",
34
- "@aws-sdk/middleware-retry": "3.287.0",
35
- "@aws-sdk/middleware-serde": "3.272.0",
36
- "@aws-sdk/middleware-signing": "3.282.0",
37
- "@aws-sdk/middleware-stack": "3.272.0",
38
- "@aws-sdk/middleware-user-agent": "3.282.0",
39
- "@aws-sdk/node-config-provider": "3.287.0",
40
- "@aws-sdk/node-http-handler": "3.282.0",
41
- "@aws-sdk/protocol-http": "3.282.0",
42
- "@aws-sdk/smithy-client": "3.279.0",
43
- "@aws-sdk/types": "3.272.0",
44
- "@aws-sdk/url-parser": "3.272.0",
23
+ "@aws-sdk/client-sts": "3.290.0",
24
+ "@aws-sdk/config-resolver": "3.290.0",
25
+ "@aws-sdk/credential-provider-node": "3.290.0",
26
+ "@aws-sdk/fetch-http-handler": "3.290.0",
27
+ "@aws-sdk/hash-node": "3.290.0",
28
+ "@aws-sdk/invalid-dependency": "3.290.0",
29
+ "@aws-sdk/middleware-content-length": "3.290.0",
30
+ "@aws-sdk/middleware-endpoint": "3.290.0",
31
+ "@aws-sdk/middleware-host-header": "3.290.0",
32
+ "@aws-sdk/middleware-logger": "3.290.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.290.0",
34
+ "@aws-sdk/middleware-retry": "3.290.0",
35
+ "@aws-sdk/middleware-serde": "3.290.0",
36
+ "@aws-sdk/middleware-signing": "3.290.0",
37
+ "@aws-sdk/middleware-stack": "3.290.0",
38
+ "@aws-sdk/middleware-user-agent": "3.290.0",
39
+ "@aws-sdk/node-config-provider": "3.290.0",
40
+ "@aws-sdk/node-http-handler": "3.290.0",
41
+ "@aws-sdk/protocol-http": "3.290.0",
42
+ "@aws-sdk/smithy-client": "3.290.0",
43
+ "@aws-sdk/types": "3.290.0",
44
+ "@aws-sdk/url-parser": "3.290.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.279.0",
49
- "@aws-sdk/util-defaults-mode-node": "3.287.0",
50
- "@aws-sdk/util-endpoints": "3.272.0",
51
- "@aws-sdk/util-retry": "3.272.0",
52
- "@aws-sdk/util-user-agent-browser": "3.282.0",
53
- "@aws-sdk/util-user-agent-node": "3.287.0",
48
+ "@aws-sdk/util-defaults-mode-browser": "3.290.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.290.0",
50
+ "@aws-sdk/util-endpoints": "3.290.0",
51
+ "@aws-sdk/util-retry": "3.290.0",
52
+ "@aws-sdk/util-user-agent-browser": "3.290.0",
53
+ "@aws-sdk/util-user-agent-node": "3.290.0",
54
54
  "@aws-sdk/util-utf8": "3.254.0",
55
55
  "tslib": "^2.3.1"
56
56
  },