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