@aws-sdk/client-dynamodb 3.282.0 → 3.287.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.
- package/README.md +0 -2
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/pagination/ListContributorInsightsPaginator.js +1 -8
- package/dist-cjs/pagination/ListExportsPaginator.js +1 -8
- package/dist-cjs/pagination/ListImportsPaginator.js +1 -8
- package/dist-cjs/pagination/ListTablesPaginator.js +1 -8
- package/dist-cjs/pagination/QueryPaginator.js +1 -8
- package/dist-cjs/pagination/ScanPaginator.js +1 -8
- package/dist-cjs/protocols/Aws_json1_0.js +3 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/pagination/ListContributorInsightsPaginator.js +1 -8
- package/dist-es/pagination/ListExportsPaginator.js +1 -8
- package/dist-es/pagination/ListImportsPaginator.js +1 -8
- package/dist-es/pagination/ListTablesPaginator.js +1 -8
- package/dist-es/pagination/QueryPaginator.js +1 -8
- package/dist-es/pagination/ScanPaginator.js +1 -8
- package/dist-es/protocols/Aws_json1_0.js +3 -0
- package/dist-types/DynamoDB.d.ts +314 -250
- package/dist-types/DynamoDBClient.d.ts +3 -6
- package/dist-types/commands/BatchExecuteStatementCommand.d.ts +4 -4
- package/dist-types/commands/BatchGetItemCommand.d.ts +11 -11
- package/dist-types/commands/BatchWriteItemCommand.d.ts +19 -20
- package/dist-types/commands/CreateBackupCommand.d.ts +11 -11
- package/dist-types/commands/CreateGlobalTableCommand.d.ts +27 -21
- package/dist-types/commands/CreateTableCommand.d.ts +3 -3
- package/dist-types/commands/DeleteBackupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteItemCommand.d.ts +3 -3
- package/dist-types/commands/DeleteTableCommand.d.ts +10 -6
- package/dist-types/commands/DescribeBackupCommand.d.ts +1 -1
- package/dist-types/commands/DescribeContinuousBackupsCommand.d.ts +3 -3
- package/dist-types/commands/DescribeContributorInsightsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEndpointsCommand.d.ts +3 -1
- package/dist-types/commands/DescribeGlobalTableCommand.d.ts +11 -4
- package/dist-types/commands/DescribeGlobalTableSettingsCommand.d.ts +11 -3
- package/dist-types/commands/DescribeLimitsCommand.d.ts +23 -27
- package/dist-types/commands/DescribeTableCommand.d.ts +7 -2
- package/dist-types/commands/DescribeTableReplicaAutoScalingCommand.d.ts +4 -4
- package/dist-types/commands/ExecuteStatementCommand.d.ts +4 -3
- package/dist-types/commands/ExecuteTransactionCommand.d.ts +2 -2
- package/dist-types/commands/GetItemCommand.d.ts +1 -1
- package/dist-types/commands/ListBackupsCommand.d.ts +2 -2
- package/dist-types/commands/ListGlobalTablesCommand.d.ts +11 -3
- package/dist-types/commands/ListTagsOfResourceCommand.d.ts +1 -1
- package/dist-types/commands/PutItemCommand.d.ts +6 -7
- package/dist-types/commands/QueryCommand.d.ts +10 -11
- package/dist-types/commands/RestoreTableFromBackupCommand.d.ts +9 -9
- package/dist-types/commands/RestoreTableToPointInTimeCommand.d.ts +19 -20
- package/dist-types/commands/ScanCommand.d.ts +4 -4
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/TransactGetItemsCommand.d.ts +6 -6
- package/dist-types/commands/TransactWriteItemsCommand.d.ts +14 -17
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContinuousBackupsCommand.d.ts +2 -2
- package/dist-types/commands/UpdateGlobalTableCommand.d.ts +28 -9
- package/dist-types/commands/UpdateGlobalTableSettingsCommand.d.ts +12 -0
- package/dist-types/commands/UpdateItemCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTableCommand.d.ts +11 -6
- package/dist-types/commands/UpdateTableReplicaAutoScalingCommand.d.ts +5 -4
- package/dist-types/commands/UpdateTimeToLiveCommand.d.ts +8 -8
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +1596 -1541
- package/dist-types/pagination/Interfaces.d.ts +1 -2
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +3 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +1 -2
- package/package.json +10 -10
package/dist-types/DynamoDB.d.ts
CHANGED
|
@@ -55,20 +55,17 @@ import { UpdateTimeToLiveCommandInput, UpdateTimeToLiveCommandOutput } from "./c
|
|
|
55
55
|
import { DynamoDBClient } from "./DynamoDBClient";
|
|
56
56
|
/**
|
|
57
57
|
* <fullname>Amazon DynamoDB</fullname>
|
|
58
|
-
*
|
|
59
|
-
* <p>Amazon DynamoDB is a fully managed NoSQL database service that provides fast
|
|
58
|
+
* <p>Amazon DynamoDB is a fully managed NoSQL database service that provides fast
|
|
60
59
|
* and predictable performance with seamless scalability. DynamoDB lets you
|
|
61
60
|
* offload the administrative burdens of operating and scaling a distributed database, so
|
|
62
61
|
* that you don't have to worry about hardware provisioning, setup and configuration,
|
|
63
62
|
* replication, software patching, or cluster scaling.</p>
|
|
64
|
-
*
|
|
65
|
-
* <p>With DynamoDB, you can create database tables that can store and retrieve
|
|
63
|
+
* <p>With DynamoDB, you can create database tables that can store and retrieve
|
|
66
64
|
* any amount of data, and serve any level of request traffic. You can scale up or scale
|
|
67
65
|
* down your tables' throughput capacity without downtime or performance degradation, and
|
|
68
66
|
* use the Amazon Web Services Management Console to monitor resource utilization and performance
|
|
69
67
|
* metrics.</p>
|
|
70
|
-
*
|
|
71
|
-
* <p>DynamoDB automatically spreads the data and traffic for your tables over
|
|
68
|
+
* <p>DynamoDB automatically spreads the data and traffic for your tables over
|
|
72
69
|
* a sufficient number of servers to handle your throughput and storage requirements, while
|
|
73
70
|
* maintaining consistent and fast performance. All of your data is stored on solid state
|
|
74
71
|
* disks (SSDs) and automatically replicated across multiple Availability Zones in an
|
|
@@ -81,15 +78,15 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
81
78
|
* using PartiQL. Each read statement in a <code>BatchExecuteStatement</code> must specify
|
|
82
79
|
* an equality condition on all key attributes. This enforces that each <code>SELECT</code>
|
|
83
80
|
* statement in a batch returns at most a single item.</p>
|
|
84
|
-
*
|
|
81
|
+
* <note>
|
|
85
82
|
* <p>The entire batch must consist of either read statements or write statements, you
|
|
86
83
|
* cannot mix both in one batch.</p>
|
|
87
|
-
*
|
|
88
|
-
*
|
|
84
|
+
* </note>
|
|
85
|
+
* <important>
|
|
89
86
|
* <p>A HTTP 200 response does not mean that all statements in the BatchExecuteStatement
|
|
90
87
|
* succeeded. Error details for individual statements can be found under the <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchStatementResponse.html#DDB-Type-BatchStatementResponse-Error">Error</a> field of the <code>BatchStatementResponse</code> for each
|
|
91
88
|
* statement.</p>
|
|
92
|
-
*
|
|
89
|
+
* </important>
|
|
93
90
|
*/
|
|
94
91
|
batchExecuteStatement(args: BatchExecuteStatementCommandInput, options?: __HttpHandlerOptions): Promise<BatchExecuteStatementCommandOutput>;
|
|
95
92
|
batchExecuteStatement(args: BatchExecuteStatementCommandInput, cb: (err: any, data?: BatchExecuteStatementCommandOutput) => void): void;
|
|
@@ -97,30 +94,30 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
97
94
|
/**
|
|
98
95
|
* <p>The <code>BatchGetItem</code> operation returns the attributes of one or more items
|
|
99
96
|
* from one or more tables. You identify requested items by primary key.</p>
|
|
100
|
-
*
|
|
97
|
+
* <p>A single operation can retrieve up to 16 MB of data, which can contain as many as 100
|
|
101
98
|
* items. <code>BatchGetItem</code> returns a partial result if the response size limit is
|
|
102
99
|
* exceeded, the table's provisioned throughput is exceeded, or an internal processing
|
|
103
100
|
* failure occurs. If a partial result is returned, the operation returns a value for
|
|
104
101
|
* <code>UnprocessedKeys</code>. You can use this value to retry the operation starting
|
|
105
102
|
* with the next item to get.</p>
|
|
106
|
-
*
|
|
103
|
+
* <important>
|
|
107
104
|
* <p>If you request more than 100 items, <code>BatchGetItem</code> returns a
|
|
108
105
|
* <code>ValidationException</code> with the message "Too many items requested for
|
|
109
106
|
* the BatchGetItem call."</p>
|
|
110
|
-
*
|
|
111
|
-
*
|
|
107
|
+
* </important>
|
|
108
|
+
* <p>For example, if you ask to retrieve 100 items, but each individual item is 300 KB in
|
|
112
109
|
* size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns
|
|
113
110
|
* an appropriate <code>UnprocessedKeys</code> value so you can get the next page of
|
|
114
111
|
* results. If desired, your application can include its own logic to assemble the pages of
|
|
115
112
|
* results into one dataset.</p>
|
|
116
|
-
*
|
|
113
|
+
* <p>If <i>none</i> of the items can be processed due to insufficient
|
|
117
114
|
* provisioned throughput on all of the tables in the request, then
|
|
118
115
|
* <code>BatchGetItem</code> returns a
|
|
119
116
|
* <code>ProvisionedThroughputExceededException</code>. If <i>at least
|
|
120
117
|
* one</i> of the items is successfully processed, then
|
|
121
118
|
* <code>BatchGetItem</code> completes successfully, while returning the keys of the
|
|
122
119
|
* unread items in <code>UnprocessedKeys</code>.</p>
|
|
123
|
-
*
|
|
120
|
+
* <important>
|
|
124
121
|
* <p>If DynamoDB returns any unprocessed items, you should retry the batch operation on
|
|
125
122
|
* those items. However, <i>we strongly recommend that you use an exponential
|
|
126
123
|
* backoff algorithm</i>. If you retry the batch operation immediately, the
|
|
@@ -129,16 +126,16 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
129
126
|
* requests in the batch are much more likely to succeed.</p>
|
|
130
127
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB
|
|
131
128
|
* Developer Guide</i>.</p>
|
|
132
|
-
*
|
|
133
|
-
*
|
|
129
|
+
* </important>
|
|
130
|
+
* <p>By default, <code>BatchGetItem</code> performs eventually consistent reads on every
|
|
134
131
|
* table in the request. If you want strongly consistent reads instead, you can set
|
|
135
132
|
* <code>ConsistentRead</code> to <code>true</code> for any or all tables.</p>
|
|
136
|
-
*
|
|
133
|
+
* <p>In order to minimize response latency, <code>BatchGetItem</code> retrieves items in
|
|
137
134
|
* parallel.</p>
|
|
138
|
-
*
|
|
135
|
+
* <p>When designing your application, keep in mind that DynamoDB does not return items in
|
|
139
136
|
* any particular order. To help parse the response by item, include the primary key values
|
|
140
137
|
* for the items in your request in the <code>ProjectionExpression</code> parameter.</p>
|
|
141
|
-
*
|
|
138
|
+
* <p>If a requested item does not exist, it is not returned in the result. Requests for
|
|
142
139
|
* nonexistent items consume the minimum read capacity units according to the type of read.
|
|
143
140
|
* For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations">Working with Tables</a> in the <i>Amazon DynamoDB Developer
|
|
144
141
|
* Guide</i>.</p>
|
|
@@ -153,14 +150,14 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
153
150
|
* individual items can be up to 400 KB once stored, it's important to note that an item's
|
|
154
151
|
* representation might be greater than 400KB while being sent in DynamoDB's JSON format
|
|
155
152
|
* for the API call. For more details on this distinction, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html">Naming Rules and Data Types</a>.</p>
|
|
156
|
-
*
|
|
153
|
+
* <note>
|
|
157
154
|
* <p>
|
|
158
|
-
*
|
|
155
|
+
* <code>BatchWriteItem</code> cannot update items. If you perform a <code>BatchWriteItem</code>
|
|
159
156
|
* operation on an existing item, that item's values will be overwritten by the
|
|
160
157
|
* operation and it will appear like it was updated. To update items, we recommend you
|
|
161
158
|
* use the <code>UpdateItem</code> action.</p>
|
|
162
|
-
*
|
|
163
|
-
*
|
|
159
|
+
* </note>
|
|
160
|
+
* <p>The individual <code>PutItem</code> and <code>DeleteItem</code> operations specified
|
|
164
161
|
* in <code>BatchWriteItem</code> are atomic; however <code>BatchWriteItem</code> as a
|
|
165
162
|
* whole is not. If any requested operations fail because the table's provisioned
|
|
166
163
|
* throughput is exceeded or an internal processing failure occurs, the failed operations
|
|
@@ -169,11 +166,11 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
169
166
|
* <code>BatchWriteItem</code> in a loop. Each iteration would check for unprocessed
|
|
170
167
|
* items and submit a new <code>BatchWriteItem</code> request with those unprocessed items
|
|
171
168
|
* until all items have been processed.</p>
|
|
172
|
-
*
|
|
169
|
+
* <p>If <i>none</i> of the items can be processed due to insufficient
|
|
173
170
|
* provisioned throughput on all of the tables in the request, then
|
|
174
171
|
* <code>BatchWriteItem</code> returns a
|
|
175
172
|
* <code>ProvisionedThroughputExceededException</code>.</p>
|
|
176
|
-
*
|
|
173
|
+
* <important>
|
|
177
174
|
* <p>If DynamoDB returns any unprocessed items, you should retry the batch operation on
|
|
178
175
|
* those items. However, <i>we strongly recommend that you use an exponential
|
|
179
176
|
* backoff algorithm</i>. If you retry the batch operation immediately, the
|
|
@@ -182,52 +179,51 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
182
179
|
* requests in the batch are much more likely to succeed.</p>
|
|
183
180
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#Programming.Errors.BatchOperations">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB
|
|
184
181
|
* Developer Guide</i>.</p>
|
|
185
|
-
*
|
|
186
|
-
*
|
|
187
|
-
* <p>With <code>BatchWriteItem</code>, you can efficiently write or delete large amounts of
|
|
182
|
+
* </important>
|
|
183
|
+
* <p>With <code>BatchWriteItem</code>, you can efficiently write or delete large amounts of
|
|
188
184
|
* data, such as from Amazon EMR, or copy data from another database into DynamoDB. In
|
|
189
185
|
* order to improve performance with these large-scale operations,
|
|
190
186
|
* <code>BatchWriteItem</code> does not behave in the same way as individual
|
|
191
187
|
* <code>PutItem</code> and <code>DeleteItem</code> calls would. For example, you
|
|
192
188
|
* cannot specify conditions on individual put and delete requests, and
|
|
193
189
|
* <code>BatchWriteItem</code> does not return deleted items in the response.</p>
|
|
194
|
-
*
|
|
190
|
+
* <p>If you use a programming language that supports concurrency, you can use threads to
|
|
195
191
|
* write items in parallel. Your application must include the necessary logic to manage the
|
|
196
192
|
* threads. With languages that don't support threading, you must update or delete the
|
|
197
193
|
* specified items one at a time. In both situations, <code>BatchWriteItem</code> performs
|
|
198
194
|
* the specified put and delete operations in parallel, giving you the power of the thread
|
|
199
195
|
* pool approach without having to introduce complexity into your application.</p>
|
|
200
|
-
*
|
|
196
|
+
* <p>Parallel processing reduces latency, but each specified put and delete request
|
|
201
197
|
* consumes the same number of write capacity units whether it is processed in parallel or
|
|
202
198
|
* not. Delete operations on nonexistent items consume one write capacity unit.</p>
|
|
203
|
-
*
|
|
199
|
+
* <p>If one or more of the following is true, DynamoDB rejects the entire batch write
|
|
204
200
|
* operation:</p>
|
|
205
|
-
*
|
|
201
|
+
* <ul>
|
|
206
202
|
* <li>
|
|
207
|
-
*
|
|
203
|
+
* <p>One or more tables specified in the <code>BatchWriteItem</code> request does
|
|
208
204
|
* not exist.</p>
|
|
209
205
|
* </li>
|
|
210
206
|
* <li>
|
|
211
|
-
*
|
|
207
|
+
* <p>Primary key attributes specified on an item in the request do not match those
|
|
212
208
|
* in the corresponding table's primary key schema.</p>
|
|
213
209
|
* </li>
|
|
214
210
|
* <li>
|
|
215
|
-
*
|
|
211
|
+
* <p>You try to perform multiple operations on the same item in the same
|
|
216
212
|
* <code>BatchWriteItem</code> request. For example, you cannot put and delete
|
|
217
213
|
* the same item in the same <code>BatchWriteItem</code> request. </p>
|
|
218
214
|
* </li>
|
|
219
215
|
* <li>
|
|
220
|
-
*
|
|
216
|
+
* <p> Your request contains at least two items with identical hash and range keys
|
|
221
217
|
* (which essentially is two put operations). </p>
|
|
222
218
|
* </li>
|
|
223
219
|
* <li>
|
|
224
|
-
*
|
|
220
|
+
* <p>There are more than 25 requests in the batch.</p>
|
|
225
221
|
* </li>
|
|
226
222
|
* <li>
|
|
227
|
-
*
|
|
223
|
+
* <p>Any individual item in a batch exceeds 400 KB.</p>
|
|
228
224
|
* </li>
|
|
229
225
|
* <li>
|
|
230
|
-
*
|
|
226
|
+
* <p>The total request size exceeds 16 MB.</p>
|
|
231
227
|
* </li>
|
|
232
228
|
* </ul>
|
|
233
229
|
*/
|
|
@@ -236,33 +232,33 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
236
232
|
batchWriteItem(args: BatchWriteItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchWriteItemCommandOutput) => void): void;
|
|
237
233
|
/**
|
|
238
234
|
* <p>Creates a backup for an existing table.</p>
|
|
239
|
-
*
|
|
235
|
+
* <p> Each time you create an on-demand backup, the entire table data is backed up. There
|
|
240
236
|
* is no limit to the number of on-demand backups that can be taken. </p>
|
|
241
|
-
*
|
|
237
|
+
* <p> When you create an on-demand backup, a time marker of the request is cataloged, and
|
|
242
238
|
* the backup is created asynchronously, by applying all changes until the time of the
|
|
243
239
|
* request to the last full table snapshot. Backup requests are processed instantaneously
|
|
244
240
|
* and become available for restore within minutes. </p>
|
|
245
|
-
*
|
|
241
|
+
* <p>You can call <code>CreateBackup</code> at a maximum rate of 50 times per
|
|
246
242
|
* second.</p>
|
|
247
|
-
*
|
|
243
|
+
* <p>All backups in DynamoDB work without consuming any provisioned throughput on the
|
|
248
244
|
* table.</p>
|
|
249
|
-
*
|
|
245
|
+
* <p> If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to
|
|
250
246
|
* contain all data committed to the table up to 14:24:00, and data committed after
|
|
251
247
|
* 14:26:00 will not be. The backup might contain data modifications made between 14:24:00
|
|
252
248
|
* and 14:26:00. On-demand backup does not support causal consistency. </p>
|
|
253
|
-
*
|
|
254
|
-
*
|
|
249
|
+
* <p> Along with data, the following are also included on the backups: </p>
|
|
250
|
+
* <ul>
|
|
255
251
|
* <li>
|
|
256
|
-
*
|
|
252
|
+
* <p>Global secondary indexes (GSIs)</p>
|
|
257
253
|
* </li>
|
|
258
254
|
* <li>
|
|
259
|
-
*
|
|
255
|
+
* <p>Local secondary indexes (LSIs)</p>
|
|
260
256
|
* </li>
|
|
261
257
|
* <li>
|
|
262
|
-
*
|
|
258
|
+
* <p>Streams</p>
|
|
263
259
|
* </li>
|
|
264
260
|
* <li>
|
|
265
|
-
*
|
|
261
|
+
* <p>Provisioned read and write capacity</p>
|
|
266
262
|
* </li>
|
|
267
263
|
* </ul>
|
|
268
264
|
*/
|
|
@@ -273,52 +269,58 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
273
269
|
* <p>Creates a global table from an existing table. A global table creates a replication
|
|
274
270
|
* relationship between two or more DynamoDB tables with the same table name in the
|
|
275
271
|
* provided Regions. </p>
|
|
276
|
-
*
|
|
272
|
+
* <important>
|
|
277
273
|
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
|
|
278
|
-
*
|
|
279
|
-
*
|
|
280
|
-
*
|
|
281
|
-
*
|
|
274
|
+
* 2017.11.29 (Legacy)</a> of global tables. We recommend using
|
|
275
|
+
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
|
|
276
|
+
* when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than
|
|
277
|
+
* 2017.11.29 (Legacy). To determine which version you are using, see
|
|
278
|
+
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
|
|
279
|
+
* To update existing global tables from version 2017.11.29 (Legacy) to version
|
|
280
|
+
* 2019.11.21 (Current), see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html">
|
|
281
|
+
* Updating global tables</a>.
|
|
282
|
+
* </p>
|
|
283
|
+
* </important>
|
|
284
|
+
* <p>If you want to add a new replica table to a global table, each of the following
|
|
282
285
|
* conditions must be true:</p>
|
|
283
|
-
*
|
|
286
|
+
* <ul>
|
|
284
287
|
* <li>
|
|
285
|
-
*
|
|
288
|
+
* <p>The table must have the same primary key as all of the other replicas.</p>
|
|
286
289
|
* </li>
|
|
287
290
|
* <li>
|
|
288
|
-
*
|
|
291
|
+
* <p>The table must have the same name as all of the other replicas.</p>
|
|
289
292
|
* </li>
|
|
290
293
|
* <li>
|
|
291
|
-
*
|
|
294
|
+
* <p>The table must have DynamoDB Streams enabled, with the stream containing both
|
|
292
295
|
* the new and the old images of the item.</p>
|
|
293
296
|
* </li>
|
|
294
297
|
* <li>
|
|
295
|
-
*
|
|
298
|
+
* <p>None of the replica tables in the global table can contain any data.</p>
|
|
296
299
|
* </li>
|
|
297
300
|
* </ul>
|
|
298
|
-
*
|
|
301
|
+
* <p> If global secondary indexes are specified, then the following conditions must also be
|
|
299
302
|
* met: </p>
|
|
300
|
-
*
|
|
303
|
+
* <ul>
|
|
301
304
|
* <li>
|
|
302
|
-
*
|
|
305
|
+
* <p> The global secondary indexes must have the same name. </p>
|
|
303
306
|
* </li>
|
|
304
307
|
* <li>
|
|
305
|
-
*
|
|
308
|
+
* <p> The global secondary indexes must have the same hash key and sort key (if
|
|
306
309
|
* present). </p>
|
|
307
310
|
* </li>
|
|
308
311
|
* </ul>
|
|
309
|
-
*
|
|
312
|
+
* <p> If local secondary indexes are specified, then the following conditions must also be
|
|
310
313
|
* met: </p>
|
|
311
|
-
*
|
|
314
|
+
* <ul>
|
|
312
315
|
* <li>
|
|
313
|
-
*
|
|
316
|
+
* <p> The local secondary indexes must have the same name. </p>
|
|
314
317
|
* </li>
|
|
315
318
|
* <li>
|
|
316
|
-
*
|
|
319
|
+
* <p> The local secondary indexes must have the same hash key and sort key (if
|
|
317
320
|
* present). </p>
|
|
318
321
|
* </li>
|
|
319
322
|
* </ul>
|
|
320
|
-
*
|
|
321
|
-
* <important>
|
|
323
|
+
* <important>
|
|
322
324
|
* <p> Write capacity settings should be set consistently across your replica tables and
|
|
323
325
|
* secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the
|
|
324
326
|
* write capacity settings for all of your global tables replicas and indexes. </p>
|
|
@@ -326,7 +328,7 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
326
328
|
* equal replicated write capacity units to your replica tables. You should also
|
|
327
329
|
* provision equal replicated write capacity units to matching secondary indexes across
|
|
328
330
|
* your global table. </p>
|
|
329
|
-
*
|
|
331
|
+
* </important>
|
|
330
332
|
*/
|
|
331
333
|
createGlobalTable(args: CreateGlobalTableCommandInput, options?: __HttpHandlerOptions): Promise<CreateGlobalTableCommandOutput>;
|
|
332
334
|
createGlobalTable(args: CreateGlobalTableCommandInput, cb: (err: any, data?: CreateGlobalTableCommandOutput) => void): void;
|
|
@@ -334,24 +336,24 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
334
336
|
/**
|
|
335
337
|
* <p>The <code>CreateTable</code> operation adds a new table to your account. In an Amazon Web Services account, table names must be unique within each Region. That is, you can
|
|
336
338
|
* have two tables with same name if you create the tables in different Regions.</p>
|
|
337
|
-
*
|
|
339
|
+
* <p>
|
|
338
340
|
* <code>CreateTable</code> is an asynchronous operation. Upon receiving a
|
|
339
341
|
* <code>CreateTable</code> request, DynamoDB immediately returns a response with a
|
|
340
342
|
* <code>TableStatus</code> of <code>CREATING</code>. After the table is created,
|
|
341
343
|
* DynamoDB sets the <code>TableStatus</code> to <code>ACTIVE</code>. You can perform read
|
|
342
344
|
* and write operations only on an <code>ACTIVE</code> table. </p>
|
|
343
|
-
*
|
|
345
|
+
* <p>You can optionally define secondary indexes on the new table, as part of the
|
|
344
346
|
* <code>CreateTable</code> operation. If you want to create multiple tables with
|
|
345
347
|
* secondary indexes on them, you must create the tables sequentially. Only one table with
|
|
346
348
|
* secondary indexes can be in the <code>CREATING</code> state at any given time.</p>
|
|
347
|
-
*
|
|
349
|
+
* <p>You can use the <code>DescribeTable</code> action to check the table status.</p>
|
|
348
350
|
*/
|
|
349
351
|
createTable(args: CreateTableCommandInput, options?: __HttpHandlerOptions): Promise<CreateTableCommandOutput>;
|
|
350
352
|
createTable(args: CreateTableCommandInput, cb: (err: any, data?: CreateTableCommandOutput) => void): void;
|
|
351
353
|
createTable(args: CreateTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTableCommandOutput) => void): void;
|
|
352
354
|
/**
|
|
353
355
|
* <p>Deletes an existing backup of a table.</p>
|
|
354
|
-
*
|
|
356
|
+
* <p>You can call <code>DeleteBackup</code> at a maximum rate of 10 times per
|
|
355
357
|
* second.</p>
|
|
356
358
|
*/
|
|
357
359
|
deleteBackup(args: DeleteBackupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteBackupCommandOutput>;
|
|
@@ -361,12 +363,12 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
361
363
|
* <p>Deletes a single item in a table by primary key. You can perform a conditional delete
|
|
362
364
|
* operation that deletes the item if it exists, or if it has an expected attribute
|
|
363
365
|
* value.</p>
|
|
364
|
-
*
|
|
366
|
+
* <p>In addition to deleting an item, you can also return the item's attribute values in
|
|
365
367
|
* the same operation, using the <code>ReturnValues</code> parameter.</p>
|
|
366
|
-
*
|
|
368
|
+
* <p>Unless you specify conditions, the <code>DeleteItem</code> is an idempotent operation;
|
|
367
369
|
* running it multiple times on the same item or attribute does <i>not</i>
|
|
368
370
|
* result in an error response.</p>
|
|
369
|
-
*
|
|
371
|
+
* <p>Conditional deletes are useful for deleting items only if specific conditions are met.
|
|
370
372
|
* If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not
|
|
371
373
|
* deleted.</p>
|
|
372
374
|
*/
|
|
@@ -382,24 +384,28 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
382
384
|
* <code>ResourceInUseException</code>. If the specified table does not exist, DynamoDB
|
|
383
385
|
* returns a <code>ResourceNotFoundException</code>. If table is already in the
|
|
384
386
|
* <code>DELETING</code> state, no error is returned. </p>
|
|
385
|
-
*
|
|
387
|
+
* <important>
|
|
388
|
+
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
|
|
389
|
+
* of global tables.
|
|
390
|
+
* </p>
|
|
391
|
+
* </important>
|
|
392
|
+
* <note>
|
|
386
393
|
* <p>DynamoDB might continue to accept data read and write operations, such as
|
|
387
394
|
* <code>GetItem</code> and <code>PutItem</code>, on a table in the
|
|
388
395
|
* <code>DELETING</code> state until the table deletion is complete.</p>
|
|
389
|
-
*
|
|
390
|
-
*
|
|
391
|
-
*
|
|
396
|
+
* </note>
|
|
397
|
+
* <p>When you delete a table, any indexes on that table are also deleted.</p>
|
|
398
|
+
* <p>If you have DynamoDB Streams enabled on the table, then the corresponding stream on
|
|
392
399
|
* that table goes into the <code>DISABLED</code> state, and the stream is automatically
|
|
393
400
|
* deleted after 24 hours.</p>
|
|
394
|
-
*
|
|
395
|
-
* <p>Use the <code>DescribeTable</code> action to check the status of the table. </p>
|
|
401
|
+
* <p>Use the <code>DescribeTable</code> action to check the status of the table. </p>
|
|
396
402
|
*/
|
|
397
403
|
deleteTable(args: DeleteTableCommandInput, options?: __HttpHandlerOptions): Promise<DeleteTableCommandOutput>;
|
|
398
404
|
deleteTable(args: DeleteTableCommandInput, cb: (err: any, data?: DeleteTableCommandOutput) => void): void;
|
|
399
405
|
deleteTable(args: DeleteTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTableCommandOutput) => void): void;
|
|
400
406
|
/**
|
|
401
407
|
* <p>Describes an existing backup of a table.</p>
|
|
402
|
-
*
|
|
408
|
+
* <p>You can call <code>DescribeBackup</code> at a maximum rate of 10 times per
|
|
403
409
|
* second.</p>
|
|
404
410
|
*/
|
|
405
411
|
describeBackup(args: DescribeBackupCommandInput, options?: __HttpHandlerOptions): Promise<DescribeBackupCommandOutput>;
|
|
@@ -410,27 +416,29 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
410
416
|
* table. Continuous backups are <code>ENABLED</code> on all tables at table creation. If
|
|
411
417
|
* point in time recovery is enabled, <code>PointInTimeRecoveryStatus</code> will be set to
|
|
412
418
|
* ENABLED.</p>
|
|
413
|
-
*
|
|
419
|
+
* <p> After continuous backups and point in time recovery are enabled, you can restore to
|
|
414
420
|
* any point in time within <code>EarliestRestorableDateTime</code> and
|
|
415
421
|
* <code>LatestRestorableDateTime</code>. </p>
|
|
416
|
-
*
|
|
422
|
+
* <p>
|
|
417
423
|
* <code>LatestRestorableDateTime</code> is typically 5 minutes before the current time.
|
|
418
424
|
* You can restore your table to any point in time during the last 35 days. </p>
|
|
419
|
-
*
|
|
425
|
+
* <p>You can call <code>DescribeContinuousBackups</code> at a maximum rate of 10 times per
|
|
420
426
|
* second.</p>
|
|
421
427
|
*/
|
|
422
428
|
describeContinuousBackups(args: DescribeContinuousBackupsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeContinuousBackupsCommandOutput>;
|
|
423
429
|
describeContinuousBackups(args: DescribeContinuousBackupsCommandInput, cb: (err: any, data?: DescribeContinuousBackupsCommandOutput) => void): void;
|
|
424
430
|
describeContinuousBackups(args: DescribeContinuousBackupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeContinuousBackupsCommandOutput) => void): void;
|
|
425
431
|
/**
|
|
426
|
-
* <p>Returns information about contributor insights
|
|
432
|
+
* <p>Returns information about contributor insights for a given table or global secondary
|
|
427
433
|
* index.</p>
|
|
428
434
|
*/
|
|
429
435
|
describeContributorInsights(args: DescribeContributorInsightsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeContributorInsightsCommandOutput>;
|
|
430
436
|
describeContributorInsights(args: DescribeContributorInsightsCommandInput, cb: (err: any, data?: DescribeContributorInsightsCommandOutput) => void): void;
|
|
431
437
|
describeContributorInsights(args: DescribeContributorInsightsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeContributorInsightsCommandOutput) => void): void;
|
|
432
438
|
/**
|
|
433
|
-
* <p>Returns the regional endpoint information
|
|
439
|
+
* <p>Returns the regional endpoint information. This action must be included in your VPC
|
|
440
|
+
* endpoint policies, or access to the DescribeEndpoints API will be denied. For more information
|
|
441
|
+
* on policy permissions, please see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/inter-network-traffic-privacy.html#inter-network-traffic-DescribeEndpoints">Internetwork traffic privacy</a>.</p>
|
|
434
442
|
*/
|
|
435
443
|
describeEndpoints(args: DescribeEndpointsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEndpointsCommandOutput>;
|
|
436
444
|
describeEndpoints(args: DescribeEndpointsCommandInput, cb: (err: any, data?: DescribeEndpointsCommandOutput) => void): void;
|
|
@@ -443,21 +451,36 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
443
451
|
describeExport(args: DescribeExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExportCommandOutput) => void): void;
|
|
444
452
|
/**
|
|
445
453
|
* <p>Returns information about the specified global table.</p>
|
|
446
|
-
*
|
|
454
|
+
* <important>
|
|
447
455
|
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
|
|
448
|
-
*
|
|
449
|
-
*
|
|
450
|
-
*
|
|
456
|
+
* 2017.11.29 (Legacy)</a> of global tables. We recommend using
|
|
457
|
+
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
|
|
458
|
+
* when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than
|
|
459
|
+
* 2017.11.29 (Legacy). To determine which version you are using, see
|
|
460
|
+
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
|
|
461
|
+
* To update existing global tables from version 2017.11.29 (Legacy) to version
|
|
462
|
+
* 2019.11.21 (Current), see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html">
|
|
463
|
+
* Updating global tables</a>.
|
|
464
|
+
* </p>
|
|
465
|
+
* </important>
|
|
451
466
|
*/
|
|
452
467
|
describeGlobalTable(args: DescribeGlobalTableCommandInput, options?: __HttpHandlerOptions): Promise<DescribeGlobalTableCommandOutput>;
|
|
453
468
|
describeGlobalTable(args: DescribeGlobalTableCommandInput, cb: (err: any, data?: DescribeGlobalTableCommandOutput) => void): void;
|
|
454
469
|
describeGlobalTable(args: DescribeGlobalTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGlobalTableCommandOutput) => void): void;
|
|
455
470
|
/**
|
|
456
471
|
* <p>Describes Region-specific settings for a global table.</p>
|
|
457
|
-
*
|
|
472
|
+
* <important>
|
|
458
473
|
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
|
|
459
|
-
*
|
|
460
|
-
*
|
|
474
|
+
* 2017.11.29 (Legacy)</a> of global tables. We recommend using
|
|
475
|
+
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
|
|
476
|
+
* when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than
|
|
477
|
+
* 2017.11.29 (Legacy). To determine which version you are using, see
|
|
478
|
+
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
|
|
479
|
+
* To update existing global tables from version 2017.11.29 (Legacy) to version
|
|
480
|
+
* 2019.11.21 (Current), see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html">
|
|
481
|
+
* Updating global tables</a>.
|
|
482
|
+
* </p>
|
|
483
|
+
* </important>
|
|
461
484
|
*/
|
|
462
485
|
describeGlobalTableSettings(args: DescribeGlobalTableSettingsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeGlobalTableSettingsCommandOutput>;
|
|
463
486
|
describeGlobalTableSettings(args: DescribeGlobalTableSettingsCommandInput, cb: (err: any, data?: DescribeGlobalTableSettingsCommandOutput) => void): void;
|
|
@@ -478,77 +501,73 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
478
501
|
* <p>Returns the current provisioned-capacity quotas for your Amazon Web Services account in
|
|
479
502
|
* a Region, both for the Region as a whole and for any one DynamoDB table that you create
|
|
480
503
|
* there.</p>
|
|
481
|
-
*
|
|
504
|
+
* <p>When you establish an Amazon Web Services account, the account has initial quotas on
|
|
482
505
|
* the maximum read capacity units and write capacity units that you can provision across
|
|
483
506
|
* all of your DynamoDB tables in a given Region. Also, there are per-table
|
|
484
507
|
* quotas that apply when you create a table there. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Service,
|
|
485
508
|
* Account, and Table Quotas</a> page in the <i>Amazon DynamoDB
|
|
486
509
|
* Developer Guide</i>.</p>
|
|
487
|
-
*
|
|
488
|
-
* <p>Although you can increase these quotas by filing a case at <a href="https://console.aws.amazon.com/support/home#/">Amazon Web Services Support Center</a>, obtaining the
|
|
510
|
+
* <p>Although you can increase these quotas by filing a case at <a href="https://console.aws.amazon.com/support/home#/">Amazon Web Services Support Center</a>, obtaining the
|
|
489
511
|
* increase is not instantaneous. The <code>DescribeLimits</code> action lets you write
|
|
490
512
|
* code to compare the capacity you are currently using to those quotas imposed by your
|
|
491
513
|
* account so that you have enough time to apply for an increase before you hit a
|
|
492
514
|
* quota.</p>
|
|
493
|
-
*
|
|
494
|
-
* <p>For example, you could use one of the Amazon Web Services SDKs to do the
|
|
515
|
+
* <p>For example, you could use one of the Amazon Web Services SDKs to do the
|
|
495
516
|
* following:</p>
|
|
496
|
-
*
|
|
497
|
-
* <ol>
|
|
517
|
+
* <ol>
|
|
498
518
|
* <li>
|
|
499
|
-
*
|
|
519
|
+
* <p>Call <code>DescribeLimits</code> for a particular Region to obtain your
|
|
500
520
|
* current account quotas on provisioned capacity there.</p>
|
|
501
521
|
* </li>
|
|
502
522
|
* <li>
|
|
503
|
-
*
|
|
523
|
+
* <p>Create a variable to hold the aggregate read capacity units provisioned for
|
|
504
524
|
* all your tables in that Region, and one to hold the aggregate write capacity
|
|
505
525
|
* units. Zero them both.</p>
|
|
506
526
|
* </li>
|
|
507
527
|
* <li>
|
|
508
|
-
*
|
|
528
|
+
* <p>Call <code>ListTables</code> to obtain a list of all your DynamoDB
|
|
509
529
|
* tables.</p>
|
|
510
530
|
* </li>
|
|
511
531
|
* <li>
|
|
512
|
-
*
|
|
532
|
+
* <p>For each table name listed by <code>ListTables</code>, do the
|
|
513
533
|
* following:</p>
|
|
514
|
-
*
|
|
534
|
+
* <ul>
|
|
515
535
|
* <li>
|
|
516
|
-
*
|
|
517
|
-
*
|
|
536
|
+
* <p>Call <code>DescribeTable</code> with the table name.</p>
|
|
537
|
+
* </li>
|
|
518
538
|
* <li>
|
|
519
|
-
*
|
|
539
|
+
* <p>Use the data returned by <code>DescribeTable</code> to add the read
|
|
520
540
|
* capacity units and write capacity units provisioned for the table itself
|
|
521
541
|
* to your variables.</p>
|
|
522
|
-
*
|
|
542
|
+
* </li>
|
|
523
543
|
* <li>
|
|
524
|
-
*
|
|
544
|
+
* <p>If the table has one or more global secondary indexes (GSIs), loop
|
|
525
545
|
* over these GSIs and add their provisioned capacity values to your
|
|
526
546
|
* variables as well.</p>
|
|
527
|
-
*
|
|
547
|
+
* </li>
|
|
528
548
|
* </ul>
|
|
529
549
|
* </li>
|
|
530
550
|
* <li>
|
|
531
|
-
*
|
|
551
|
+
* <p>Report the account quotas for that Region returned by
|
|
532
552
|
* <code>DescribeLimits</code>, along with the total current provisioned
|
|
533
553
|
* capacity levels you have calculated.</p>
|
|
534
554
|
* </li>
|
|
535
555
|
* </ol>
|
|
536
|
-
*
|
|
537
|
-
* <p>This will let you see whether you are getting close to your account-level
|
|
556
|
+
* <p>This will let you see whether you are getting close to your account-level
|
|
538
557
|
* quotas.</p>
|
|
539
|
-
*
|
|
558
|
+
* <p>The per-table quotas apply only when you are creating a new table. They restrict the
|
|
540
559
|
* sum of the provisioned capacity of the new table itself and all its global secondary
|
|
541
560
|
* indexes.</p>
|
|
542
|
-
*
|
|
561
|
+
* <p>For existing tables and their GSIs, DynamoDB doesn't let you increase provisioned
|
|
543
562
|
* capacity extremely rapidly, but the only quota that applies is that the aggregate
|
|
544
563
|
* provisioned capacity over all your tables and GSIs cannot exceed either of the
|
|
545
564
|
* per-account quotas.</p>
|
|
546
|
-
*
|
|
565
|
+
* <note>
|
|
547
566
|
* <p>
|
|
548
|
-
*
|
|
567
|
+
* <code>DescribeLimits</code> should only be called periodically. You can expect
|
|
549
568
|
* throttling errors if you call it more than once in a minute.</p>
|
|
550
|
-
*
|
|
551
|
-
*
|
|
569
|
+
* </note>
|
|
570
|
+
* <p>The <code>DescribeLimits</code> Request element has no content.</p>
|
|
552
571
|
*/
|
|
553
572
|
describeLimits(args: DescribeLimitsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeLimitsCommandOutput>;
|
|
554
573
|
describeLimits(args: DescribeLimitsCommandInput, cb: (err: any, data?: DescribeLimitsCommandOutput) => void): void;
|
|
@@ -556,24 +575,29 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
556
575
|
/**
|
|
557
576
|
* <p>Returns information about the table, including the current status of the table, when
|
|
558
577
|
* it was created, the primary key schema, and any indexes on the table.</p>
|
|
559
|
-
*
|
|
578
|
+
* <important>
|
|
579
|
+
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
|
|
580
|
+
* of global tables.
|
|
581
|
+
* </p>
|
|
582
|
+
* </important>
|
|
583
|
+
* <note>
|
|
560
584
|
* <p>If you issue a <code>DescribeTable</code> request immediately after a
|
|
561
585
|
* <code>CreateTable</code> request, DynamoDB might return a
|
|
562
586
|
* <code>ResourceNotFoundException</code>. This is because
|
|
563
587
|
* <code>DescribeTable</code> uses an eventually consistent query, and the metadata
|
|
564
588
|
* for your table might not be available at that moment. Wait for a few seconds, and
|
|
565
589
|
* then try the <code>DescribeTable</code> request again.</p>
|
|
566
|
-
*
|
|
590
|
+
* </note>
|
|
567
591
|
*/
|
|
568
592
|
describeTable(args: DescribeTableCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTableCommandOutput>;
|
|
569
593
|
describeTable(args: DescribeTableCommandInput, cb: (err: any, data?: DescribeTableCommandOutput) => void): void;
|
|
570
594
|
describeTable(args: DescribeTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTableCommandOutput) => void): void;
|
|
571
595
|
/**
|
|
572
596
|
* <p>Describes auto scaling settings across replicas of the global table at once.</p>
|
|
573
|
-
*
|
|
574
|
-
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version
|
|
575
|
-
*
|
|
576
|
-
*
|
|
597
|
+
* <important>
|
|
598
|
+
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
|
|
599
|
+
* of global tables.</p>
|
|
600
|
+
* </important>
|
|
577
601
|
*/
|
|
578
602
|
describeTableReplicaAutoScaling(args: DescribeTableReplicaAutoScalingCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTableReplicaAutoScalingCommandOutput>;
|
|
579
603
|
describeTableReplicaAutoScaling(args: DescribeTableReplicaAutoScalingCommandInput, cb: (err: any, data?: DescribeTableReplicaAutoScalingCommandOutput) => void): void;
|
|
@@ -603,16 +627,17 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
603
627
|
/**
|
|
604
628
|
* <p>This operation allows you to perform reads and singleton writes on data stored in
|
|
605
629
|
* DynamoDB, using PartiQL.</p>
|
|
606
|
-
*
|
|
630
|
+
* <p>For PartiQL reads (<code>SELECT</code> statement), if the total number of processed
|
|
607
631
|
* items exceeds the maximum dataset size limit of 1 MB, the read stops and results are
|
|
608
632
|
* returned to the user as a <code>LastEvaluatedKey</code> value to continue the read in a
|
|
609
633
|
* subsequent operation. If the filter criteria in <code>WHERE</code> clause does not match
|
|
610
634
|
* any data, the read will return an empty result set.</p>
|
|
611
|
-
*
|
|
635
|
+
* <p>A single <code>SELECT</code> statement response can return up to the maximum number of
|
|
612
636
|
* items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any
|
|
613
637
|
* filtering to the results using <code>WHERE</code> clause). If
|
|
614
638
|
* <code>LastEvaluatedKey</code> is present in the response, you need to paginate the
|
|
615
|
-
* result set
|
|
639
|
+
* result set. If <code>NextToken</code> is present, you need to paginate the result set and include
|
|
640
|
+
* <code>NextToken</code>.</p>
|
|
616
641
|
*/
|
|
617
642
|
executeStatement(args: ExecuteStatementCommandInput, options?: __HttpHandlerOptions): Promise<ExecuteStatementCommandOutput>;
|
|
618
643
|
executeStatement(args: ExecuteStatementCommandInput, cb: (err: any, data?: ExecuteStatementCommandOutput) => void): void;
|
|
@@ -620,12 +645,12 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
620
645
|
/**
|
|
621
646
|
* <p>This operation allows you to perform transactional reads or writes on data stored in
|
|
622
647
|
* DynamoDB, using PartiQL.</p>
|
|
623
|
-
*
|
|
648
|
+
* <note>
|
|
624
649
|
* <p>The entire transaction must consist of either read statements or write statements,
|
|
625
650
|
* you cannot mix both in one transaction. The EXISTS function is an exception and can
|
|
626
651
|
* be used to check the condition of specific attributes of the item in a similar
|
|
627
652
|
* manner to <code>ConditionCheck</code> in the <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/transaction-apis.html#transaction-apis-txwriteitems">TransactWriteItems</a> API.</p>
|
|
628
|
-
*
|
|
653
|
+
* </note>
|
|
629
654
|
*/
|
|
630
655
|
executeTransaction(args: ExecuteTransactionCommandInput, options?: __HttpHandlerOptions): Promise<ExecuteTransactionCommandOutput>;
|
|
631
656
|
executeTransaction(args: ExecuteTransactionCommandInput, cb: (err: any, data?: ExecuteTransactionCommandOutput) => void): void;
|
|
@@ -642,7 +667,7 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
642
667
|
* <p>The <code>GetItem</code> operation returns a set of attributes for the item with the
|
|
643
668
|
* given primary key. If there is no matching item, <code>GetItem</code> does not return
|
|
644
669
|
* any data and there will be no <code>Item</code> element in the response.</p>
|
|
645
|
-
*
|
|
670
|
+
* <p>
|
|
646
671
|
* <code>GetItem</code> provides an eventually consistent read by default. If your
|
|
647
672
|
* application requires a strongly consistent read, set <code>ConsistentRead</code> to
|
|
648
673
|
* <code>true</code>. Although a strongly consistent read might take more time than an
|
|
@@ -662,9 +687,9 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
662
687
|
* given table, specify <code>TableName</code>. <code>ListBackups</code> returns a
|
|
663
688
|
* paginated list of results with at most 1 MB worth of items in a page. You can also
|
|
664
689
|
* specify a maximum number of entries to be returned in a page.</p>
|
|
665
|
-
*
|
|
690
|
+
* <p>In the request, start time is inclusive, but end time is exclusive. Note that these
|
|
666
691
|
* boundaries are for the time at which the original backup was requested.</p>
|
|
667
|
-
*
|
|
692
|
+
* <p>You can call <code>ListBackups</code> a maximum of five times per second.</p>
|
|
668
693
|
*/
|
|
669
694
|
listBackups(args: ListBackupsCommandInput, options?: __HttpHandlerOptions): Promise<ListBackupsCommandOutput>;
|
|
670
695
|
listBackups(args: ListBackupsCommandInput, cb: (err: any, data?: ListBackupsCommandOutput) => void): void;
|
|
@@ -684,10 +709,18 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
684
709
|
listExports(args: ListExportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExportsCommandOutput) => void): void;
|
|
685
710
|
/**
|
|
686
711
|
* <p>Lists all global tables that have a replica in the specified Region.</p>
|
|
687
|
-
*
|
|
712
|
+
* <important>
|
|
688
713
|
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
|
|
689
|
-
*
|
|
690
|
-
*
|
|
714
|
+
* 2017.11.29 (Legacy)</a> of global tables. We recommend using
|
|
715
|
+
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
|
|
716
|
+
* when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than
|
|
717
|
+
* 2017.11.29 (Legacy). To determine which version you are using, see
|
|
718
|
+
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
|
|
719
|
+
* To update existing global tables from version 2017.11.29 (Legacy) to version
|
|
720
|
+
* 2019.11.21 (Current), see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html">
|
|
721
|
+
* Updating global tables</a>.
|
|
722
|
+
* </p>
|
|
723
|
+
* </important>
|
|
691
724
|
*/
|
|
692
725
|
listGlobalTables(args: ListGlobalTablesCommandInput, options?: __HttpHandlerOptions): Promise<ListGlobalTablesCommandOutput>;
|
|
693
726
|
listGlobalTables(args: ListGlobalTablesCommandInput, cb: (err: any, data?: ListGlobalTablesCommandOutput) => void): void;
|
|
@@ -709,7 +742,7 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
709
742
|
/**
|
|
710
743
|
* <p>List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10
|
|
711
744
|
* times per second, per account.</p>
|
|
712
|
-
*
|
|
745
|
+
* <p>For an overview on tagging DynamoDB resources, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html">Tagging for DynamoDB</a>
|
|
713
746
|
* in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
|
714
747
|
*/
|
|
715
748
|
listTagsOfResource(args: ListTagsOfResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsOfResourceCommandOutput>;
|
|
@@ -722,22 +755,21 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
722
755
|
* a new item if one with the specified primary key doesn't exist), or replace an existing
|
|
723
756
|
* item if it has certain attribute values. You can return the item's attribute values in
|
|
724
757
|
* the same operation, using the <code>ReturnValues</code> parameter.</p>
|
|
725
|
-
*
|
|
726
|
-
* <p>When you add an item, the primary key attributes are the only required attributes.
|
|
758
|
+
* <p>When you add an item, the primary key attributes are the only required attributes.
|
|
727
759
|
* </p>
|
|
728
|
-
*
|
|
760
|
+
* <p>Empty String and Binary attribute values are allowed. Attribute values of type String
|
|
729
761
|
* and Binary must have a length greater than zero if the attribute is used as a key
|
|
730
762
|
* attribute for a table or index. Set type attributes cannot be empty. </p>
|
|
731
|
-
*
|
|
763
|
+
* <p>Invalid Requests with empty values will be rejected with a
|
|
732
764
|
* <code>ValidationException</code> exception.</p>
|
|
733
|
-
*
|
|
765
|
+
* <note>
|
|
734
766
|
* <p>To prevent a new item from replacing an existing item, use a conditional
|
|
735
767
|
* expression that contains the <code>attribute_not_exists</code> function with the
|
|
736
768
|
* name of the attribute being used as the partition key for the table. Since every
|
|
737
769
|
* record must contain that attribute, the <code>attribute_not_exists</code> function
|
|
738
770
|
* will only succeed if no matching item exists.</p>
|
|
739
|
-
*
|
|
740
|
-
*
|
|
771
|
+
* </note>
|
|
772
|
+
* <p>For more information about <code>PutItem</code>, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html">Working with
|
|
741
773
|
* Items</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
|
742
774
|
*/
|
|
743
775
|
putItem(args: PutItemCommandInput, options?: __HttpHandlerOptions): Promise<PutItemCommandOutput>;
|
|
@@ -748,8 +780,7 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
748
780
|
* attribute. <code>Query</code> returns all items with that partition key value.
|
|
749
781
|
* Optionally, you can provide a sort key attribute and use a comparison operator to refine
|
|
750
782
|
* the search results.</p>
|
|
751
|
-
*
|
|
752
|
-
* <p>Use the <code>KeyConditionExpression</code> parameter to provide a specific value for
|
|
783
|
+
* <p>Use the <code>KeyConditionExpression</code> parameter to provide a specific value for
|
|
753
784
|
* the partition key. The <code>Query</code> operation will return all of the items from
|
|
754
785
|
* the table or index with that partition key value. You can optionally narrow the scope of
|
|
755
786
|
* the <code>Query</code> operation by specifying a sort key value and a comparison
|
|
@@ -758,39 +789,39 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
758
789
|
* <code>FilterExpression</code>. A <code>FilterExpression</code> determines which
|
|
759
790
|
* items within the results should be returned to you. All of the other results are
|
|
760
791
|
* discarded. </p>
|
|
761
|
-
*
|
|
792
|
+
* <p> A <code>Query</code> operation always returns a result set. If no matching items are
|
|
762
793
|
* found, the result set will be empty. Queries that do not return results consume the
|
|
763
794
|
* minimum number of read capacity units for that type of read operation. </p>
|
|
764
|
-
*
|
|
795
|
+
* <note>
|
|
765
796
|
* <p> DynamoDB calculates the number of read capacity units consumed based on item
|
|
766
797
|
* size, not on the amount of data that is returned to an application. The number of
|
|
767
798
|
* capacity units consumed will be the same whether you request all of the attributes
|
|
768
799
|
* (the default behavior) or just some of them (using a projection expression). The
|
|
769
800
|
* number will also be the same whether or not you use a <code>FilterExpression</code>.
|
|
770
801
|
* </p>
|
|
771
|
-
*
|
|
772
|
-
*
|
|
802
|
+
* </note>
|
|
803
|
+
* <p>
|
|
773
804
|
* <code>Query</code> results are always sorted by the sort key value. If the data type of
|
|
774
805
|
* the sort key is Number, the results are returned in numeric order; otherwise, the
|
|
775
806
|
* results are returned in order of UTF-8 bytes. By default, the sort order is ascending.
|
|
776
807
|
* To reverse the order, set the <code>ScanIndexForward</code> parameter to false. </p>
|
|
777
|
-
*
|
|
808
|
+
* <p> A single <code>Query</code> operation will read up to the maximum number of items set
|
|
778
809
|
* (if using the <code>Limit</code> parameter) or a maximum of 1 MB of data and then apply
|
|
779
810
|
* any filtering to the results using <code>FilterExpression</code>. If
|
|
780
811
|
* <code>LastEvaluatedKey</code> is present in the response, you will need to paginate
|
|
781
812
|
* the result set. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.Pagination">Paginating
|
|
782
813
|
* the Results</a> in the <i>Amazon DynamoDB Developer Guide</i>. </p>
|
|
783
|
-
*
|
|
814
|
+
* <p>
|
|
784
815
|
* <code>FilterExpression</code> is applied after a <code>Query</code> finishes, but before
|
|
785
816
|
* the results are returned. A <code>FilterExpression</code> cannot contain partition key
|
|
786
817
|
* or sort key attributes. You need to specify those attributes in the
|
|
787
818
|
* <code>KeyConditionExpression</code>. </p>
|
|
788
|
-
*
|
|
819
|
+
* <note>
|
|
789
820
|
* <p> A <code>Query</code> operation can return an empty result set and a
|
|
790
821
|
* <code>LastEvaluatedKey</code> if all the items read for the page of results are
|
|
791
822
|
* filtered out. </p>
|
|
792
|
-
*
|
|
793
|
-
*
|
|
823
|
+
* </note>
|
|
824
|
+
* <p>You can query a table, a local secondary index, or a global secondary index. For a
|
|
794
825
|
* query on a table or on a local secondary index, you can set the
|
|
795
826
|
* <code>ConsistentRead</code> parameter to <code>true</code> and obtain a strongly
|
|
796
827
|
* consistent result. Global secondary indexes support eventually consistent reads only, so
|
|
@@ -803,27 +834,27 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
803
834
|
/**
|
|
804
835
|
* <p>Creates a new table from an existing backup. Any number of users can execute up to 4
|
|
805
836
|
* concurrent restores (any type of restore) in a given account. </p>
|
|
806
|
-
*
|
|
837
|
+
* <p>You can call <code>RestoreTableFromBackup</code> at a maximum rate of 10 times per
|
|
807
838
|
* second.</p>
|
|
808
|
-
*
|
|
809
|
-
*
|
|
839
|
+
* <p>You must manually set up the following on the restored table:</p>
|
|
840
|
+
* <ul>
|
|
810
841
|
* <li>
|
|
811
|
-
*
|
|
842
|
+
* <p>Auto scaling policies</p>
|
|
812
843
|
* </li>
|
|
813
844
|
* <li>
|
|
814
|
-
*
|
|
845
|
+
* <p>IAM policies</p>
|
|
815
846
|
* </li>
|
|
816
847
|
* <li>
|
|
817
|
-
*
|
|
848
|
+
* <p>Amazon CloudWatch metrics and alarms</p>
|
|
818
849
|
* </li>
|
|
819
850
|
* <li>
|
|
820
|
-
*
|
|
851
|
+
* <p>Tags</p>
|
|
821
852
|
* </li>
|
|
822
853
|
* <li>
|
|
823
|
-
*
|
|
854
|
+
* <p>Stream settings</p>
|
|
824
855
|
* </li>
|
|
825
856
|
* <li>
|
|
826
|
-
*
|
|
857
|
+
* <p>Time to Live (TTL) settings</p>
|
|
827
858
|
* </li>
|
|
828
859
|
* </ul>
|
|
829
860
|
*/
|
|
@@ -835,51 +866,50 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
835
866
|
* <code>EarliestRestorableDateTime</code> and <code>LatestRestorableDateTime</code>.
|
|
836
867
|
* You can restore your table to any point in time during the last 35 days. Any number of
|
|
837
868
|
* users can execute up to 4 concurrent restores (any type of restore) in a given account. </p>
|
|
838
|
-
*
|
|
869
|
+
* <p> When you restore using point in time recovery, DynamoDB restores your table data to
|
|
839
870
|
* the state based on the selected date and time (day:hour:minute:second) to a new table. </p>
|
|
840
|
-
*
|
|
871
|
+
* <p> Along with data, the following are also included on the new restored table using
|
|
841
872
|
* point in time recovery: </p>
|
|
842
|
-
*
|
|
873
|
+
* <ul>
|
|
843
874
|
* <li>
|
|
844
|
-
*
|
|
875
|
+
* <p>Global secondary indexes (GSIs)</p>
|
|
845
876
|
* </li>
|
|
846
877
|
* <li>
|
|
847
|
-
*
|
|
878
|
+
* <p>Local secondary indexes (LSIs)</p>
|
|
848
879
|
* </li>
|
|
849
880
|
* <li>
|
|
850
|
-
*
|
|
881
|
+
* <p>Provisioned read and write capacity</p>
|
|
851
882
|
* </li>
|
|
852
883
|
* <li>
|
|
853
|
-
*
|
|
854
|
-
*
|
|
855
|
-
*
|
|
884
|
+
* <p>Encryption settings</p>
|
|
885
|
+
* <important>
|
|
886
|
+
* <p> All these settings come from the current settings of the source table at
|
|
856
887
|
* the time of restore. </p>
|
|
857
|
-
*
|
|
888
|
+
* </important>
|
|
858
889
|
* </li>
|
|
859
890
|
* </ul>
|
|
860
|
-
*
|
|
861
|
-
*
|
|
862
|
-
* <ul>
|
|
891
|
+
* <p>You must manually set up the following on the restored table:</p>
|
|
892
|
+
* <ul>
|
|
863
893
|
* <li>
|
|
864
|
-
*
|
|
894
|
+
* <p>Auto scaling policies</p>
|
|
865
895
|
* </li>
|
|
866
896
|
* <li>
|
|
867
|
-
*
|
|
897
|
+
* <p>IAM policies</p>
|
|
868
898
|
* </li>
|
|
869
899
|
* <li>
|
|
870
|
-
*
|
|
900
|
+
* <p>Amazon CloudWatch metrics and alarms</p>
|
|
871
901
|
* </li>
|
|
872
902
|
* <li>
|
|
873
|
-
*
|
|
903
|
+
* <p>Tags</p>
|
|
874
904
|
* </li>
|
|
875
905
|
* <li>
|
|
876
|
-
*
|
|
906
|
+
* <p>Stream settings</p>
|
|
877
907
|
* </li>
|
|
878
908
|
* <li>
|
|
879
|
-
*
|
|
909
|
+
* <p>Time to Live (TTL) settings</p>
|
|
880
910
|
* </li>
|
|
881
911
|
* <li>
|
|
882
|
-
*
|
|
912
|
+
* <p>Point in time recovery settings</p>
|
|
883
913
|
* </li>
|
|
884
914
|
* </ul>
|
|
885
915
|
*/
|
|
@@ -890,24 +920,24 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
890
920
|
* <p>The <code>Scan</code> operation returns one or more items and item attributes by
|
|
891
921
|
* accessing every item in a table or a secondary index. To have DynamoDB return fewer
|
|
892
922
|
* items, you can provide a <code>FilterExpression</code> operation.</p>
|
|
893
|
-
*
|
|
923
|
+
* <p>If the total number of scanned items exceeds the maximum dataset size limit of 1 MB,
|
|
894
924
|
* the scan stops and results are returned to the user as a <code>LastEvaluatedKey</code>
|
|
895
925
|
* value to continue the scan in a subsequent operation. The results also include the
|
|
896
926
|
* number of items exceeding the limit. A scan can result in no table data meeting the
|
|
897
927
|
* filter criteria. </p>
|
|
898
|
-
*
|
|
928
|
+
* <p>A single <code>Scan</code> operation reads up to the maximum number of items set (if
|
|
899
929
|
* using the <code>Limit</code> parameter) or a maximum of 1 MB of data and then apply any
|
|
900
930
|
* filtering to the results using <code>FilterExpression</code>. If
|
|
901
931
|
* <code>LastEvaluatedKey</code> is present in the response, you need to paginate the
|
|
902
932
|
* result set. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Pagination">Paginating the
|
|
903
933
|
* Results</a> in the <i>Amazon DynamoDB Developer Guide</i>. </p>
|
|
904
|
-
*
|
|
934
|
+
* <p>
|
|
905
935
|
* <code>Scan</code> operations proceed sequentially; however, for faster performance on
|
|
906
936
|
* a large table or secondary index, applications can request a parallel <code>Scan</code>
|
|
907
937
|
* operation by providing the <code>Segment</code> and <code>TotalSegments</code>
|
|
908
938
|
* parameters. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.ParallelScan">Parallel
|
|
909
939
|
* Scan</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
|
910
|
-
*
|
|
940
|
+
* <p>
|
|
911
941
|
* <code>Scan</code> uses eventually consistent reads when accessing the data in a table;
|
|
912
942
|
* therefore, the result set might not include the changes to data in the table immediately
|
|
913
943
|
* before the operation began. If you need a consistent copy of the data, as of the time
|
|
@@ -922,7 +952,7 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
922
952
|
* user-defined tags so that they appear on the Billing and Cost Management console for
|
|
923
953
|
* cost allocation tracking. You can call TagResource up to five times per second, per
|
|
924
954
|
* account. </p>
|
|
925
|
-
*
|
|
955
|
+
* <p>For an overview on tagging DynamoDB resources, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html">Tagging for DynamoDB</a>
|
|
926
956
|
* in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
|
927
957
|
*/
|
|
928
958
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
@@ -938,22 +968,22 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
938
968
|
* call to <code>TransactGetItems</code> cannot retrieve items from tables in more than one
|
|
939
969
|
* Amazon Web Services account or Region. The aggregate size of the items in the
|
|
940
970
|
* transaction cannot exceed 4 MB.</p>
|
|
941
|
-
*
|
|
971
|
+
* <p>DynamoDB rejects the entire <code>TransactGetItems</code> request if any of
|
|
942
972
|
* the following is true:</p>
|
|
943
|
-
*
|
|
973
|
+
* <ul>
|
|
944
974
|
* <li>
|
|
945
|
-
*
|
|
975
|
+
* <p>A conflicting operation is in the process of updating an item to be
|
|
946
976
|
* read.</p>
|
|
947
977
|
* </li>
|
|
948
978
|
* <li>
|
|
949
|
-
*
|
|
979
|
+
* <p>There is insufficient provisioned capacity for the transaction to be
|
|
950
980
|
* completed.</p>
|
|
951
981
|
* </li>
|
|
952
982
|
* <li>
|
|
953
|
-
*
|
|
983
|
+
* <p>There is a user error, such as an invalid data format.</p>
|
|
954
984
|
* </li>
|
|
955
985
|
* <li>
|
|
956
|
-
*
|
|
986
|
+
* <p>The aggregate size of the items in the transaction exceeded 4 MB.</p>
|
|
957
987
|
* </li>
|
|
958
988
|
* </ul>
|
|
959
989
|
*/
|
|
@@ -968,13 +998,11 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
968
998
|
* item. For example, you cannot both <code>ConditionCheck</code> and <code>Update</code>
|
|
969
999
|
* the same item. The aggregate size of the items in the transaction cannot exceed 4
|
|
970
1000
|
* MB.</p>
|
|
971
|
-
*
|
|
972
|
-
* <p>The actions are completed atomically so that either all of them succeed, or all of
|
|
1001
|
+
* <p>The actions are completed atomically so that either all of them succeed, or all of
|
|
973
1002
|
* them fail. They are defined by the following objects:</p>
|
|
974
|
-
*
|
|
975
|
-
* <ul>
|
|
1003
|
+
* <ul>
|
|
976
1004
|
* <li>
|
|
977
|
-
*
|
|
1005
|
+
* <p>
|
|
978
1006
|
* <code>Put</code> — Initiates a <code>PutItem</code>
|
|
979
1007
|
* operation to write a new item. This structure specifies the primary key of the
|
|
980
1008
|
* item to be written, the name of the table to write it in, an optional condition
|
|
@@ -983,7 +1011,7 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
983
1011
|
* the condition is not met.</p>
|
|
984
1012
|
* </li>
|
|
985
1013
|
* <li>
|
|
986
|
-
*
|
|
1014
|
+
* <p>
|
|
987
1015
|
* <code>Update</code> — Initiates an <code>UpdateItem</code>
|
|
988
1016
|
* operation to update an existing item. This structure specifies the primary key
|
|
989
1017
|
* of the item to be updated, the name of the table where it resides, an optional
|
|
@@ -993,7 +1021,7 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
993
1021
|
* met.</p>
|
|
994
1022
|
* </li>
|
|
995
1023
|
* <li>
|
|
996
|
-
*
|
|
1024
|
+
* <p>
|
|
997
1025
|
* <code>Delete</code> — Initiates a <code>DeleteItem</code>
|
|
998
1026
|
* operation to delete an existing item. This structure specifies the primary key
|
|
999
1027
|
* of the item to be deleted, the name of the table where it resides, an optional
|
|
@@ -1002,7 +1030,7 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
1002
1030
|
* not met.</p>
|
|
1003
1031
|
* </li>
|
|
1004
1032
|
* <li>
|
|
1005
|
-
*
|
|
1033
|
+
* <p>
|
|
1006
1034
|
* <code>ConditionCheck</code> — Applies a condition to an item
|
|
1007
1035
|
* that is not being modified by the transaction. This structure specifies the
|
|
1008
1036
|
* primary key of the item to be checked, the name of the table where it resides, a
|
|
@@ -1011,30 +1039,29 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
1011
1039
|
* not met.</p>
|
|
1012
1040
|
* </li>
|
|
1013
1041
|
* </ul>
|
|
1014
|
-
*
|
|
1015
|
-
* <p>DynamoDB rejects the entire <code>TransactWriteItems</code> request if any of the
|
|
1042
|
+
* <p>DynamoDB rejects the entire <code>TransactWriteItems</code> request if any of the
|
|
1016
1043
|
* following is true:</p>
|
|
1017
|
-
*
|
|
1044
|
+
* <ul>
|
|
1018
1045
|
* <li>
|
|
1019
|
-
*
|
|
1046
|
+
* <p>A condition in one of the condition expressions is not met.</p>
|
|
1020
1047
|
* </li>
|
|
1021
1048
|
* <li>
|
|
1022
|
-
*
|
|
1049
|
+
* <p>An ongoing operation is in the process of updating the same item.</p>
|
|
1023
1050
|
* </li>
|
|
1024
1051
|
* <li>
|
|
1025
|
-
*
|
|
1052
|
+
* <p>There is insufficient provisioned capacity for the transaction to be
|
|
1026
1053
|
* completed.</p>
|
|
1027
1054
|
* </li>
|
|
1028
1055
|
* <li>
|
|
1029
|
-
*
|
|
1056
|
+
* <p>An item size becomes too large (bigger than 400 KB), a local secondary index
|
|
1030
1057
|
* (LSI) becomes too large, or a similar validation error occurs because of changes
|
|
1031
1058
|
* made by the transaction.</p>
|
|
1032
1059
|
* </li>
|
|
1033
1060
|
* <li>
|
|
1034
|
-
*
|
|
1061
|
+
* <p>The aggregate size of the items in the transaction exceeds 4 MB.</p>
|
|
1035
1062
|
* </li>
|
|
1036
1063
|
* <li>
|
|
1037
|
-
*
|
|
1064
|
+
* <p>There is a user error, such as an invalid data format.</p>
|
|
1038
1065
|
* </li>
|
|
1039
1066
|
* </ul>
|
|
1040
1067
|
*/
|
|
@@ -1044,7 +1071,7 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
1044
1071
|
/**
|
|
1045
1072
|
* <p>Removes the association of tags from an Amazon DynamoDB resource. You can call
|
|
1046
1073
|
* <code>UntagResource</code> up to five times per second, per account. </p>
|
|
1047
|
-
*
|
|
1074
|
+
* <p>For an overview on tagging DynamoDB resources, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html">Tagging for DynamoDB</a>
|
|
1048
1075
|
* in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
|
1049
1076
|
*/
|
|
1050
1077
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
@@ -1057,10 +1084,10 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
1057
1084
|
* current <code>ContinuousBackupsDescription</code>. Continuous backups are
|
|
1058
1085
|
* <code>ENABLED</code> on all tables at table creation. If point in time recovery is
|
|
1059
1086
|
* enabled, <code>PointInTimeRecoveryStatus</code> will be set to ENABLED.</p>
|
|
1060
|
-
*
|
|
1087
|
+
* <p> Once continuous backups and point in time recovery are enabled, you can restore to
|
|
1061
1088
|
* any point in time within <code>EarliestRestorableDateTime</code> and
|
|
1062
1089
|
* <code>LatestRestorableDateTime</code>. </p>
|
|
1063
|
-
*
|
|
1090
|
+
* <p>
|
|
1064
1091
|
* <code>LatestRestorableDateTime</code> is typically 5 minutes before the current time.
|
|
1065
1092
|
* You can restore your table to any point in time during the last 35 days. </p>
|
|
1066
1093
|
*/
|
|
@@ -1084,23 +1111,42 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
1084
1111
|
* exist to be able to use this operation. Any replica to be added must be empty, have the
|
|
1085
1112
|
* same name as the global table, have the same key schema, have DynamoDB Streams enabled,
|
|
1086
1113
|
* and have the same provisioned and maximum write capacity units.</p>
|
|
1087
|
-
*
|
|
1088
|
-
* <p>
|
|
1114
|
+
* <important>
|
|
1115
|
+
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
|
|
1116
|
+
* 2017.11.29 (Legacy)</a> of global tables. We recommend using
|
|
1117
|
+
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
|
|
1118
|
+
* when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than
|
|
1119
|
+
* 2017.11.29 (Legacy). To determine which version you are using, see
|
|
1120
|
+
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
|
|
1121
|
+
* To update existing global tables from version 2017.11.29 (Legacy) to version
|
|
1122
|
+
* 2019.11.21 (Current), see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html">
|
|
1123
|
+
* Updating global tables</a>.
|
|
1124
|
+
* </p>
|
|
1125
|
+
* </important>
|
|
1126
|
+
* <note>
|
|
1127
|
+
* <p>
|
|
1128
|
+
* This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
|
|
1129
|
+
* 2017.11.29</a> of global tables. If you are using global tables <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version
|
|
1130
|
+
* 2019.11.21</a> you can use <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeTable.html">DescribeTable</a> instead.
|
|
1131
|
+
* </p>
|
|
1132
|
+
* <p>
|
|
1133
|
+
* Although you can use <code>UpdateGlobalTable</code> to add replicas and remove
|
|
1089
1134
|
* replicas in a single request, for simplicity we recommend that you issue separate
|
|
1090
|
-
* requests for adding or removing replicas
|
|
1091
|
-
*
|
|
1092
|
-
*
|
|
1135
|
+
* requests for adding or removing replicas.
|
|
1136
|
+
* </p>
|
|
1137
|
+
* </note>
|
|
1138
|
+
* <p> If global secondary indexes are specified, then the following conditions must also be
|
|
1093
1139
|
* met: </p>
|
|
1094
|
-
*
|
|
1140
|
+
* <ul>
|
|
1095
1141
|
* <li>
|
|
1096
|
-
*
|
|
1142
|
+
* <p> The global secondary indexes must have the same name. </p>
|
|
1097
1143
|
* </li>
|
|
1098
1144
|
* <li>
|
|
1099
|
-
*
|
|
1145
|
+
* <p> The global secondary indexes must have the same hash key and sort key (if
|
|
1100
1146
|
* present). </p>
|
|
1101
1147
|
* </li>
|
|
1102
1148
|
* <li>
|
|
1103
|
-
*
|
|
1149
|
+
* <p> The global secondary indexes must have the same provisioned and maximum write
|
|
1104
1150
|
* capacity units. </p>
|
|
1105
1151
|
* </li>
|
|
1106
1152
|
* </ul>
|
|
@@ -1110,6 +1156,18 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
1110
1156
|
updateGlobalTable(args: UpdateGlobalTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGlobalTableCommandOutput) => void): void;
|
|
1111
1157
|
/**
|
|
1112
1158
|
* <p>Updates settings for a global table.</p>
|
|
1159
|
+
* <important>
|
|
1160
|
+
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
|
|
1161
|
+
* 2017.11.29 (Legacy)</a> of global tables. We recommend using
|
|
1162
|
+
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
|
|
1163
|
+
* when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than
|
|
1164
|
+
* 2017.11.29 (Legacy). To determine which version you are using, see
|
|
1165
|
+
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
|
|
1166
|
+
* To update existing global tables from version 2017.11.29 (Legacy) to version
|
|
1167
|
+
* 2019.11.21 (Current), see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html">
|
|
1168
|
+
* Updating global tables</a>.
|
|
1169
|
+
* </p>
|
|
1170
|
+
* </important>
|
|
1113
1171
|
*/
|
|
1114
1172
|
updateGlobalTableSettings(args: UpdateGlobalTableSettingsCommandInput, options?: __HttpHandlerOptions): Promise<UpdateGlobalTableSettingsCommandOutput>;
|
|
1115
1173
|
updateGlobalTableSettings(args: UpdateGlobalTableSettingsCommandInput, cb: (err: any, data?: UpdateGlobalTableSettingsCommandOutput) => void): void;
|
|
@@ -1120,7 +1178,7 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
1120
1178
|
* conditional update on an existing item (insert a new attribute name-value pair if it
|
|
1121
1179
|
* doesn't exist, or replace an existing name-value pair if it has certain expected
|
|
1122
1180
|
* attribute values).</p>
|
|
1123
|
-
*
|
|
1181
|
+
* <p>You can also return the item's attribute values in the same <code>UpdateItem</code>
|
|
1124
1182
|
* operation using the <code>ReturnValues</code> parameter.</p>
|
|
1125
1183
|
*/
|
|
1126
1184
|
updateItem(args: UpdateItemCommandInput, options?: __HttpHandlerOptions): Promise<UpdateItemCommandOutput>;
|
|
@@ -1129,21 +1187,26 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
1129
1187
|
/**
|
|
1130
1188
|
* <p>Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB
|
|
1131
1189
|
* Streams settings for a given table.</p>
|
|
1132
|
-
*
|
|
1133
|
-
*
|
|
1190
|
+
* <important>
|
|
1191
|
+
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
|
|
1192
|
+
* of global tables.
|
|
1193
|
+
* </p>
|
|
1194
|
+
* </important>
|
|
1195
|
+
* <p>You can only perform one of the following operations at once:</p>
|
|
1196
|
+
* <ul>
|
|
1134
1197
|
* <li>
|
|
1135
|
-
*
|
|
1198
|
+
* <p>Modify the provisioned throughput settings of the table.</p>
|
|
1136
1199
|
* </li>
|
|
1137
1200
|
* <li>
|
|
1138
|
-
*
|
|
1201
|
+
* <p>Remove a global secondary index from the table.</p>
|
|
1139
1202
|
* </li>
|
|
1140
1203
|
* <li>
|
|
1141
|
-
*
|
|
1204
|
+
* <p>Create a new global secondary index on the table. After the index begins
|
|
1142
1205
|
* backfilling, you can use <code>UpdateTable</code> to perform other
|
|
1143
1206
|
* operations.</p>
|
|
1144
1207
|
* </li>
|
|
1145
1208
|
* </ul>
|
|
1146
|
-
*
|
|
1209
|
+
* <p>
|
|
1147
1210
|
* <code>UpdateTable</code> is an asynchronous operation; while it is executing, the table
|
|
1148
1211
|
* status changes from <code>ACTIVE</code> to <code>UPDATING</code>. While it is
|
|
1149
1212
|
* <code>UPDATING</code>, you cannot issue another <code>UpdateTable</code> request.
|
|
@@ -1155,10 +1218,11 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
1155
1218
|
updateTable(args: UpdateTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTableCommandOutput) => void): void;
|
|
1156
1219
|
/**
|
|
1157
1220
|
* <p>Updates auto scaling settings on your global tables at once.</p>
|
|
1158
|
-
*
|
|
1159
|
-
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version
|
|
1160
|
-
*
|
|
1161
|
-
*
|
|
1221
|
+
* <important>
|
|
1222
|
+
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
|
|
1223
|
+
* of global tables.
|
|
1224
|
+
* </p>
|
|
1225
|
+
* </important>
|
|
1162
1226
|
*/
|
|
1163
1227
|
updateTableReplicaAutoScaling(args: UpdateTableReplicaAutoScalingCommandInput, options?: __HttpHandlerOptions): Promise<UpdateTableReplicaAutoScalingCommandOutput>;
|
|
1164
1228
|
updateTableReplicaAutoScaling(args: UpdateTableReplicaAutoScalingCommandInput, cb: (err: any, data?: UpdateTableReplicaAutoScalingCommandOutput) => void): void;
|
|
@@ -1169,25 +1233,25 @@ export declare class DynamoDB extends DynamoDBClient {
|
|
|
1169
1233
|
* <code>TimeToLiveSpecification</code>. It can take up to one hour for the change to
|
|
1170
1234
|
* fully process. Any additional <code>UpdateTimeToLive</code> calls for the same table
|
|
1171
1235
|
* during this one hour duration result in a <code>ValidationException</code>. </p>
|
|
1172
|
-
*
|
|
1236
|
+
* <p>TTL compares the current time in epoch time format to the time stored in the TTL
|
|
1173
1237
|
* attribute of an item. If the epoch time value stored in the attribute is less than the
|
|
1174
1238
|
* current time, the item is marked as expired and subsequently deleted.</p>
|
|
1175
|
-
*
|
|
1239
|
+
* <note>
|
|
1176
1240
|
* <p> The epoch time format is the number of seconds elapsed since 12:00:00 AM January
|
|
1177
1241
|
* 1, 1970 UTC. </p>
|
|
1178
|
-
*
|
|
1179
|
-
*
|
|
1242
|
+
* </note>
|
|
1243
|
+
* <p>DynamoDB deletes expired items on a best-effort basis to ensure availability of
|
|
1180
1244
|
* throughput for other data operations. </p>
|
|
1181
|
-
*
|
|
1245
|
+
* <important>
|
|
1182
1246
|
* <p>DynamoDB typically deletes expired items within two days of expiration. The exact
|
|
1183
1247
|
* duration within which an item gets deleted after expiration is specific to the
|
|
1184
1248
|
* nature of the workload. Items that have expired and not been deleted will still show
|
|
1185
1249
|
* up in reads, queries, and scans.</p>
|
|
1186
|
-
*
|
|
1187
|
-
*
|
|
1250
|
+
* </important>
|
|
1251
|
+
* <p>As items are deleted, they are removed from any local secondary index and global
|
|
1188
1252
|
* secondary index immediately in the same eventually consistent way as a standard delete
|
|
1189
1253
|
* operation.</p>
|
|
1190
|
-
*
|
|
1254
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html">Time To Live</a> in the
|
|
1191
1255
|
* Amazon DynamoDB Developer Guide. </p>
|
|
1192
1256
|
*/
|
|
1193
1257
|
updateTimeToLive(args: UpdateTimeToLiveCommandInput, options?: __HttpHandlerOptions): Promise<UpdateTimeToLiveCommandOutput>;
|