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