@aws-sdk/client-dynamodb 3.282.0 → 3.284.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -2
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-types/DynamoDB.d.ts +314 -250
- package/dist-types/DynamoDBClient.d.ts +3 -6
- package/dist-types/commands/BatchExecuteStatementCommand.d.ts +4 -4
- package/dist-types/commands/BatchGetItemCommand.d.ts +11 -11
- package/dist-types/commands/BatchWriteItemCommand.d.ts +19 -20
- package/dist-types/commands/CreateBackupCommand.d.ts +11 -11
- package/dist-types/commands/CreateGlobalTableCommand.d.ts +27 -21
- package/dist-types/commands/CreateTableCommand.d.ts +3 -3
- package/dist-types/commands/DeleteBackupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteItemCommand.d.ts +3 -3
- package/dist-types/commands/DeleteTableCommand.d.ts +10 -6
- package/dist-types/commands/DescribeBackupCommand.d.ts +1 -1
- package/dist-types/commands/DescribeContinuousBackupsCommand.d.ts +3 -3
- package/dist-types/commands/DescribeContributorInsightsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEndpointsCommand.d.ts +3 -1
- package/dist-types/commands/DescribeGlobalTableCommand.d.ts +11 -4
- package/dist-types/commands/DescribeGlobalTableSettingsCommand.d.ts +11 -3
- package/dist-types/commands/DescribeLimitsCommand.d.ts +23 -27
- package/dist-types/commands/DescribeTableCommand.d.ts +7 -2
- package/dist-types/commands/DescribeTableReplicaAutoScalingCommand.d.ts +4 -4
- package/dist-types/commands/ExecuteStatementCommand.d.ts +4 -3
- package/dist-types/commands/ExecuteTransactionCommand.d.ts +2 -2
- package/dist-types/commands/GetItemCommand.d.ts +1 -1
- package/dist-types/commands/ListBackupsCommand.d.ts +2 -2
- package/dist-types/commands/ListGlobalTablesCommand.d.ts +11 -3
- package/dist-types/commands/ListTagsOfResourceCommand.d.ts +1 -1
- package/dist-types/commands/PutItemCommand.d.ts +6 -7
- package/dist-types/commands/QueryCommand.d.ts +10 -11
- package/dist-types/commands/RestoreTableFromBackupCommand.d.ts +9 -9
- package/dist-types/commands/RestoreTableToPointInTimeCommand.d.ts +19 -20
- package/dist-types/commands/ScanCommand.d.ts +4 -4
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/TransactGetItemsCommand.d.ts +6 -6
- package/dist-types/commands/TransactWriteItemsCommand.d.ts +14 -17
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContinuousBackupsCommand.d.ts +2 -2
- package/dist-types/commands/UpdateGlobalTableCommand.d.ts +28 -9
- package/dist-types/commands/UpdateGlobalTableSettingsCommand.d.ts +12 -0
- package/dist-types/commands/UpdateItemCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTableCommand.d.ts +11 -6
- package/dist-types/commands/UpdateTableReplicaAutoScalingCommand.d.ts +5 -4
- package/dist-types/commands/UpdateTimeToLiveCommand.d.ts +8 -8
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +1584 -1541
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/package.json +1 -1
|
@@ -184,20 +184,17 @@ export interface DynamoDBClientResolvedConfig extends DynamoDBClientResolvedConf
|
|
|
184
184
|
}
|
|
185
185
|
/**
|
|
186
186
|
* <fullname>Amazon DynamoDB</fullname>
|
|
187
|
-
*
|
|
188
|
-
* <p>Amazon DynamoDB is a fully managed NoSQL database service that provides fast
|
|
187
|
+
* <p>Amazon DynamoDB is a fully managed NoSQL database service that provides fast
|
|
189
188
|
* and predictable performance with seamless scalability. DynamoDB lets you
|
|
190
189
|
* offload the administrative burdens of operating and scaling a distributed database, so
|
|
191
190
|
* that you don't have to worry about hardware provisioning, setup and configuration,
|
|
192
191
|
* replication, software patching, or cluster scaling.</p>
|
|
193
|
-
*
|
|
194
|
-
* <p>With DynamoDB, you can create database tables that can store and retrieve
|
|
192
|
+
* <p>With DynamoDB, you can create database tables that can store and retrieve
|
|
195
193
|
* any amount of data, and serve any level of request traffic. You can scale up or scale
|
|
196
194
|
* down your tables' throughput capacity without downtime or performance degradation, and
|
|
197
195
|
* use the Amazon Web Services Management Console to monitor resource utilization and performance
|
|
198
196
|
* metrics.</p>
|
|
199
|
-
*
|
|
200
|
-
* <p>DynamoDB automatically spreads the data and traffic for your tables over
|
|
197
|
+
* <p>DynamoDB automatically spreads the data and traffic for your tables over
|
|
201
198
|
* a sufficient number of servers to handle your throughput and storage requirements, while
|
|
202
199
|
* maintaining consistent and fast performance. All of your data is stored on solid state
|
|
203
200
|
* disks (SSDs) and automatically replicated across multiple Availability Zones in an
|
|
@@ -18,15 +18,15 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen
|
|
|
18
18
|
* using PartiQL. Each read statement in a <code>BatchExecuteStatement</code> must specify
|
|
19
19
|
* an equality condition on all key attributes. This enforces that each <code>SELECT</code>
|
|
20
20
|
* statement in a batch returns at most a single item.</p>
|
|
21
|
-
*
|
|
21
|
+
* <note>
|
|
22
22
|
* <p>The entire batch must consist of either read statements or write statements, you
|
|
23
23
|
* cannot mix both in one batch.</p>
|
|
24
|
-
*
|
|
25
|
-
*
|
|
24
|
+
* </note>
|
|
25
|
+
* <important>
|
|
26
26
|
* <p>A HTTP 200 response does not mean that all statements in the BatchExecuteStatement
|
|
27
27
|
* succeeded. Error details for individual statements can be found under the <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchStatementResponse.html#DDB-Type-BatchStatementResponse-Error">Error</a> field of the <code>BatchStatementResponse</code> for each
|
|
28
28
|
* statement.</p>
|
|
29
|
-
*
|
|
29
|
+
* </important>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -16,30 +16,30 @@ export interface BatchGetItemCommandOutput extends BatchGetItemOutput, __Metadat
|
|
|
16
16
|
/**
|
|
17
17
|
* <p>The <code>BatchGetItem</code> operation returns the attributes of one or more items
|
|
18
18
|
* from one or more tables. You identify requested items by primary key.</p>
|
|
19
|
-
*
|
|
19
|
+
* <p>A single operation can retrieve up to 16 MB of data, which can contain as many as 100
|
|
20
20
|
* items. <code>BatchGetItem</code> returns a partial result if the response size limit is
|
|
21
21
|
* exceeded, the table's provisioned throughput is exceeded, or an internal processing
|
|
22
22
|
* failure occurs. If a partial result is returned, the operation returns a value for
|
|
23
23
|
* <code>UnprocessedKeys</code>. You can use this value to retry the operation starting
|
|
24
24
|
* with the next item to get.</p>
|
|
25
|
-
*
|
|
25
|
+
* <important>
|
|
26
26
|
* <p>If you request more than 100 items, <code>BatchGetItem</code> returns a
|
|
27
27
|
* <code>ValidationException</code> with the message "Too many items requested for
|
|
28
28
|
* the BatchGetItem call."</p>
|
|
29
|
-
*
|
|
30
|
-
*
|
|
29
|
+
* </important>
|
|
30
|
+
* <p>For example, if you ask to retrieve 100 items, but each individual item is 300 KB in
|
|
31
31
|
* size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns
|
|
32
32
|
* an appropriate <code>UnprocessedKeys</code> value so you can get the next page of
|
|
33
33
|
* results. If desired, your application can include its own logic to assemble the pages of
|
|
34
34
|
* results into one dataset.</p>
|
|
35
|
-
*
|
|
35
|
+
* <p>If <i>none</i> of the items can be processed due to insufficient
|
|
36
36
|
* provisioned throughput on all of the tables in the request, then
|
|
37
37
|
* <code>BatchGetItem</code> returns a
|
|
38
38
|
* <code>ProvisionedThroughputExceededException</code>. If <i>at least
|
|
39
39
|
* one</i> of the items is successfully processed, then
|
|
40
40
|
* <code>BatchGetItem</code> completes successfully, while returning the keys of the
|
|
41
41
|
* unread items in <code>UnprocessedKeys</code>.</p>
|
|
42
|
-
*
|
|
42
|
+
* <important>
|
|
43
43
|
* <p>If DynamoDB returns any unprocessed items, you should retry the batch operation on
|
|
44
44
|
* those items. However, <i>we strongly recommend that you use an exponential
|
|
45
45
|
* backoff algorithm</i>. If you retry the batch operation immediately, the
|
|
@@ -48,16 +48,16 @@ export interface BatchGetItemCommandOutput extends BatchGetItemOutput, __Metadat
|
|
|
48
48
|
* requests in the batch are much more likely to succeed.</p>
|
|
49
49
|
* <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
|
|
50
50
|
* Developer Guide</i>.</p>
|
|
51
|
-
*
|
|
52
|
-
*
|
|
51
|
+
* </important>
|
|
52
|
+
* <p>By default, <code>BatchGetItem</code> performs eventually consistent reads on every
|
|
53
53
|
* table in the request. If you want strongly consistent reads instead, you can set
|
|
54
54
|
* <code>ConsistentRead</code> to <code>true</code> for any or all tables.</p>
|
|
55
|
-
*
|
|
55
|
+
* <p>In order to minimize response latency, <code>BatchGetItem</code> retrieves items in
|
|
56
56
|
* parallel.</p>
|
|
57
|
-
*
|
|
57
|
+
* <p>When designing your application, keep in mind that DynamoDB does not return items in
|
|
58
58
|
* any particular order. To help parse the response by item, include the primary key values
|
|
59
59
|
* for the items in your request in the <code>ProjectionExpression</code> parameter.</p>
|
|
60
|
-
*
|
|
60
|
+
* <p>If a requested item does not exist, it is not returned in the result. Requests for
|
|
61
61
|
* nonexistent items consume the minimum read capacity units according to the type of read.
|
|
62
62
|
* 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
|
|
63
63
|
* Guide</i>.</p>
|
|
@@ -20,14 +20,14 @@ export interface BatchWriteItemCommandOutput extends BatchWriteItemOutput, __Met
|
|
|
20
20
|
* individual items can be up to 400 KB once stored, it's important to note that an item's
|
|
21
21
|
* representation might be greater than 400KB while being sent in DynamoDB's JSON format
|
|
22
22
|
* for the API call. For more details on this distinction, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html">Naming Rules and Data Types</a>.</p>
|
|
23
|
-
*
|
|
23
|
+
* <note>
|
|
24
24
|
* <p>
|
|
25
|
-
*
|
|
25
|
+
* <code>BatchWriteItem</code> cannot update items. If you perform a <code>BatchWriteItem</code>
|
|
26
26
|
* operation on an existing item, that item's values will be overwritten by the
|
|
27
27
|
* operation and it will appear like it was updated. To update items, we recommend you
|
|
28
28
|
* use the <code>UpdateItem</code> action.</p>
|
|
29
|
-
*
|
|
30
|
-
*
|
|
29
|
+
* </note>
|
|
30
|
+
* <p>The individual <code>PutItem</code> and <code>DeleteItem</code> operations specified
|
|
31
31
|
* in <code>BatchWriteItem</code> are atomic; however <code>BatchWriteItem</code> as a
|
|
32
32
|
* whole is not. If any requested operations fail because the table's provisioned
|
|
33
33
|
* throughput is exceeded or an internal processing failure occurs, the failed operations
|
|
@@ -36,11 +36,11 @@ export interface BatchWriteItemCommandOutput extends BatchWriteItemOutput, __Met
|
|
|
36
36
|
* <code>BatchWriteItem</code> in a loop. Each iteration would check for unprocessed
|
|
37
37
|
* items and submit a new <code>BatchWriteItem</code> request with those unprocessed items
|
|
38
38
|
* until all items have been processed.</p>
|
|
39
|
-
*
|
|
39
|
+
* <p>If <i>none</i> of the items can be processed due to insufficient
|
|
40
40
|
* provisioned throughput on all of the tables in the request, then
|
|
41
41
|
* <code>BatchWriteItem</code> returns a
|
|
42
42
|
* <code>ProvisionedThroughputExceededException</code>.</p>
|
|
43
|
-
*
|
|
43
|
+
* <important>
|
|
44
44
|
* <p>If DynamoDB returns any unprocessed items, you should retry the batch operation on
|
|
45
45
|
* those items. However, <i>we strongly recommend that you use an exponential
|
|
46
46
|
* backoff algorithm</i>. If you retry the batch operation immediately, the
|
|
@@ -49,52 +49,51 @@ export interface BatchWriteItemCommandOutput extends BatchWriteItemOutput, __Met
|
|
|
49
49
|
* requests in the batch are much more likely to succeed.</p>
|
|
50
50
|
* <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
|
|
51
51
|
* Developer Guide</i>.</p>
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
* <p>With <code>BatchWriteItem</code>, you can efficiently write or delete large amounts of
|
|
52
|
+
* </important>
|
|
53
|
+
* <p>With <code>BatchWriteItem</code>, you can efficiently write or delete large amounts of
|
|
55
54
|
* data, such as from Amazon EMR, or copy data from another database into DynamoDB. In
|
|
56
55
|
* order to improve performance with these large-scale operations,
|
|
57
56
|
* <code>BatchWriteItem</code> does not behave in the same way as individual
|
|
58
57
|
* <code>PutItem</code> and <code>DeleteItem</code> calls would. For example, you
|
|
59
58
|
* cannot specify conditions on individual put and delete requests, and
|
|
60
59
|
* <code>BatchWriteItem</code> does not return deleted items in the response.</p>
|
|
61
|
-
*
|
|
60
|
+
* <p>If you use a programming language that supports concurrency, you can use threads to
|
|
62
61
|
* write items in parallel. Your application must include the necessary logic to manage the
|
|
63
62
|
* threads. With languages that don't support threading, you must update or delete the
|
|
64
63
|
* specified items one at a time. In both situations, <code>BatchWriteItem</code> performs
|
|
65
64
|
* the specified put and delete operations in parallel, giving you the power of the thread
|
|
66
65
|
* pool approach without having to introduce complexity into your application.</p>
|
|
67
|
-
*
|
|
66
|
+
* <p>Parallel processing reduces latency, but each specified put and delete request
|
|
68
67
|
* consumes the same number of write capacity units whether it is processed in parallel or
|
|
69
68
|
* not. Delete operations on nonexistent items consume one write capacity unit.</p>
|
|
70
|
-
*
|
|
69
|
+
* <p>If one or more of the following is true, DynamoDB rejects the entire batch write
|
|
71
70
|
* operation:</p>
|
|
72
|
-
*
|
|
71
|
+
* <ul>
|
|
73
72
|
* <li>
|
|
74
|
-
*
|
|
73
|
+
* <p>One or more tables specified in the <code>BatchWriteItem</code> request does
|
|
75
74
|
* not exist.</p>
|
|
76
75
|
* </li>
|
|
77
76
|
* <li>
|
|
78
|
-
*
|
|
77
|
+
* <p>Primary key attributes specified on an item in the request do not match those
|
|
79
78
|
* in the corresponding table's primary key schema.</p>
|
|
80
79
|
* </li>
|
|
81
80
|
* <li>
|
|
82
|
-
*
|
|
81
|
+
* <p>You try to perform multiple operations on the same item in the same
|
|
83
82
|
* <code>BatchWriteItem</code> request. For example, you cannot put and delete
|
|
84
83
|
* the same item in the same <code>BatchWriteItem</code> request. </p>
|
|
85
84
|
* </li>
|
|
86
85
|
* <li>
|
|
87
|
-
*
|
|
86
|
+
* <p> Your request contains at least two items with identical hash and range keys
|
|
88
87
|
* (which essentially is two put operations). </p>
|
|
89
88
|
* </li>
|
|
90
89
|
* <li>
|
|
91
|
-
*
|
|
90
|
+
* <p>There are more than 25 requests in the batch.</p>
|
|
92
91
|
* </li>
|
|
93
92
|
* <li>
|
|
94
|
-
*
|
|
93
|
+
* <p>Any individual item in a batch exceeds 400 KB.</p>
|
|
95
94
|
* </li>
|
|
96
95
|
* <li>
|
|
97
|
-
*
|
|
96
|
+
* <p>The total request size exceeds 16 MB.</p>
|
|
98
97
|
* </li>
|
|
99
98
|
* </ul>
|
|
100
99
|
* @example
|
|
@@ -15,33 +15,33 @@ export interface CreateBackupCommandOutput extends CreateBackupOutput, __Metadat
|
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
17
|
* <p>Creates a backup for an existing table.</p>
|
|
18
|
-
*
|
|
18
|
+
* <p> Each time you create an on-demand backup, the entire table data is backed up. There
|
|
19
19
|
* is no limit to the number of on-demand backups that can be taken. </p>
|
|
20
|
-
*
|
|
20
|
+
* <p> When you create an on-demand backup, a time marker of the request is cataloged, and
|
|
21
21
|
* the backup is created asynchronously, by applying all changes until the time of the
|
|
22
22
|
* request to the last full table snapshot. Backup requests are processed instantaneously
|
|
23
23
|
* and become available for restore within minutes. </p>
|
|
24
|
-
*
|
|
24
|
+
* <p>You can call <code>CreateBackup</code> at a maximum rate of 50 times per
|
|
25
25
|
* second.</p>
|
|
26
|
-
*
|
|
26
|
+
* <p>All backups in DynamoDB work without consuming any provisioned throughput on the
|
|
27
27
|
* table.</p>
|
|
28
|
-
*
|
|
28
|
+
* <p> If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to
|
|
29
29
|
* contain all data committed to the table up to 14:24:00, and data committed after
|
|
30
30
|
* 14:26:00 will not be. The backup might contain data modifications made between 14:24:00
|
|
31
31
|
* and 14:26:00. On-demand backup does not support causal consistency. </p>
|
|
32
|
-
*
|
|
33
|
-
*
|
|
32
|
+
* <p> Along with data, the following are also included on the backups: </p>
|
|
33
|
+
* <ul>
|
|
34
34
|
* <li>
|
|
35
|
-
*
|
|
35
|
+
* <p>Global secondary indexes (GSIs)</p>
|
|
36
36
|
* </li>
|
|
37
37
|
* <li>
|
|
38
|
-
*
|
|
38
|
+
* <p>Local secondary indexes (LSIs)</p>
|
|
39
39
|
* </li>
|
|
40
40
|
* <li>
|
|
41
|
-
*
|
|
41
|
+
* <p>Streams</p>
|
|
42
42
|
* </li>
|
|
43
43
|
* <li>
|
|
44
|
-
*
|
|
44
|
+
* <p>Provisioned read and write capacity</p>
|
|
45
45
|
* </li>
|
|
46
46
|
* </ul>
|
|
47
47
|
* @example
|
|
@@ -17,52 +17,58 @@ export interface CreateGlobalTableCommandOutput extends CreateGlobalTableOutput,
|
|
|
17
17
|
* <p>Creates a global table from an existing table. A global table creates a replication
|
|
18
18
|
* relationship between two or more DynamoDB tables with the same table name in the
|
|
19
19
|
* provided Regions. </p>
|
|
20
|
-
*
|
|
20
|
+
* <important>
|
|
21
21
|
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
22
|
+
* 2017.11.29 (Legacy)</a> of global tables. We recommend using
|
|
23
|
+
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
|
|
24
|
+
* when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than
|
|
25
|
+
* 2017.11.29 (Legacy). To determine which version you are using, see
|
|
26
|
+
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
|
|
27
|
+
* To update existing global tables from version 2017.11.29 (Legacy) to version
|
|
28
|
+
* 2019.11.21 (Current), see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html">
|
|
29
|
+
* Updating global tables</a>.
|
|
30
|
+
* </p>
|
|
31
|
+
* </important>
|
|
32
|
+
* <p>If you want to add a new replica table to a global table, each of the following
|
|
26
33
|
* conditions must be true:</p>
|
|
27
|
-
*
|
|
34
|
+
* <ul>
|
|
28
35
|
* <li>
|
|
29
|
-
*
|
|
36
|
+
* <p>The table must have the same primary key as all of the other replicas.</p>
|
|
30
37
|
* </li>
|
|
31
38
|
* <li>
|
|
32
|
-
*
|
|
39
|
+
* <p>The table must have the same name as all of the other replicas.</p>
|
|
33
40
|
* </li>
|
|
34
41
|
* <li>
|
|
35
|
-
*
|
|
42
|
+
* <p>The table must have DynamoDB Streams enabled, with the stream containing both
|
|
36
43
|
* the new and the old images of the item.</p>
|
|
37
44
|
* </li>
|
|
38
45
|
* <li>
|
|
39
|
-
*
|
|
46
|
+
* <p>None of the replica tables in the global table can contain any data.</p>
|
|
40
47
|
* </li>
|
|
41
48
|
* </ul>
|
|
42
|
-
*
|
|
49
|
+
* <p> If global secondary indexes are specified, then the following conditions must also be
|
|
43
50
|
* met: </p>
|
|
44
|
-
*
|
|
51
|
+
* <ul>
|
|
45
52
|
* <li>
|
|
46
|
-
*
|
|
53
|
+
* <p> The global secondary indexes must have the same name. </p>
|
|
47
54
|
* </li>
|
|
48
55
|
* <li>
|
|
49
|
-
*
|
|
56
|
+
* <p> The global secondary indexes must have the same hash key and sort key (if
|
|
50
57
|
* present). </p>
|
|
51
58
|
* </li>
|
|
52
59
|
* </ul>
|
|
53
|
-
*
|
|
60
|
+
* <p> If local secondary indexes are specified, then the following conditions must also be
|
|
54
61
|
* met: </p>
|
|
55
|
-
*
|
|
62
|
+
* <ul>
|
|
56
63
|
* <li>
|
|
57
|
-
*
|
|
64
|
+
* <p> The local secondary indexes must have the same name. </p>
|
|
58
65
|
* </li>
|
|
59
66
|
* <li>
|
|
60
|
-
*
|
|
67
|
+
* <p> The local secondary indexes must have the same hash key and sort key (if
|
|
61
68
|
* present). </p>
|
|
62
69
|
* </li>
|
|
63
70
|
* </ul>
|
|
64
|
-
*
|
|
65
|
-
* <important>
|
|
71
|
+
* <important>
|
|
66
72
|
* <p> Write capacity settings should be set consistently across your replica tables and
|
|
67
73
|
* secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the
|
|
68
74
|
* write capacity settings for all of your global tables replicas and indexes. </p>
|
|
@@ -70,7 +76,7 @@ export interface CreateGlobalTableCommandOutput extends CreateGlobalTableOutput,
|
|
|
70
76
|
* equal replicated write capacity units to your replica tables. You should also
|
|
71
77
|
* provision equal replicated write capacity units to matching secondary indexes across
|
|
72
78
|
* your global table. </p>
|
|
73
|
-
*
|
|
79
|
+
* </important>
|
|
74
80
|
* @example
|
|
75
81
|
* Use a bare-bones client and the command you need to make an API call.
|
|
76
82
|
* ```javascript
|
|
@@ -16,17 +16,17 @@ export interface CreateTableCommandOutput extends CreateTableOutput, __MetadataB
|
|
|
16
16
|
/**
|
|
17
17
|
* <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
|
|
18
18
|
* have two tables with same name if you create the tables in different Regions.</p>
|
|
19
|
-
*
|
|
19
|
+
* <p>
|
|
20
20
|
* <code>CreateTable</code> is an asynchronous operation. Upon receiving a
|
|
21
21
|
* <code>CreateTable</code> request, DynamoDB immediately returns a response with a
|
|
22
22
|
* <code>TableStatus</code> of <code>CREATING</code>. After the table is created,
|
|
23
23
|
* DynamoDB sets the <code>TableStatus</code> to <code>ACTIVE</code>. You can perform read
|
|
24
24
|
* and write operations only on an <code>ACTIVE</code> table. </p>
|
|
25
|
-
*
|
|
25
|
+
* <p>You can optionally define secondary indexes on the new table, as part of the
|
|
26
26
|
* <code>CreateTable</code> operation. If you want to create multiple tables with
|
|
27
27
|
* secondary indexes on them, you must create the tables sequentially. Only one table with
|
|
28
28
|
* secondary indexes can be in the <code>CREATING</code> state at any given time.</p>
|
|
29
|
-
*
|
|
29
|
+
* <p>You can use the <code>DescribeTable</code> action to check the table status.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -15,7 +15,7 @@ export interface DeleteBackupCommandOutput extends DeleteBackupOutput, __Metadat
|
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
17
|
* <p>Deletes an existing backup of a table.</p>
|
|
18
|
-
*
|
|
18
|
+
* <p>You can call <code>DeleteBackup</code> at a maximum rate of 10 times per
|
|
19
19
|
* second.</p>
|
|
20
20
|
* @example
|
|
21
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -17,12 +17,12 @@ export interface DeleteItemCommandOutput extends DeleteItemOutput, __MetadataBea
|
|
|
17
17
|
* <p>Deletes a single item in a table by primary key. You can perform a conditional delete
|
|
18
18
|
* operation that deletes the item if it exists, or if it has an expected attribute
|
|
19
19
|
* value.</p>
|
|
20
|
-
*
|
|
20
|
+
* <p>In addition to deleting an item, you can also return the item's attribute values in
|
|
21
21
|
* the same operation, using the <code>ReturnValues</code> parameter.</p>
|
|
22
|
-
*
|
|
22
|
+
* <p>Unless you specify conditions, the <code>DeleteItem</code> is an idempotent operation;
|
|
23
23
|
* running it multiple times on the same item or attribute does <i>not</i>
|
|
24
24
|
* result in an error response.</p>
|
|
25
|
-
*
|
|
25
|
+
* <p>Conditional deletes are useful for deleting items only if specific conditions are met.
|
|
26
26
|
* If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not
|
|
27
27
|
* deleted.</p>
|
|
28
28
|
* @example
|
|
@@ -22,17 +22,21 @@ export interface DeleteTableCommandOutput extends DeleteTableOutput, __MetadataB
|
|
|
22
22
|
* <code>ResourceInUseException</code>. If the specified table does not exist, DynamoDB
|
|
23
23
|
* returns a <code>ResourceNotFoundException</code>. If table is already in the
|
|
24
24
|
* <code>DELETING</code> state, no error is returned. </p>
|
|
25
|
-
*
|
|
25
|
+
* <important>
|
|
26
|
+
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
|
|
27
|
+
* of global tables.
|
|
28
|
+
* </p>
|
|
29
|
+
* </important>
|
|
30
|
+
* <note>
|
|
26
31
|
* <p>DynamoDB might continue to accept data read and write operations, such as
|
|
27
32
|
* <code>GetItem</code> and <code>PutItem</code>, on a table in the
|
|
28
33
|
* <code>DELETING</code> state until the table deletion is complete.</p>
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
34
|
+
* </note>
|
|
35
|
+
* <p>When you delete a table, any indexes on that table are also deleted.</p>
|
|
36
|
+
* <p>If you have DynamoDB Streams enabled on the table, then the corresponding stream on
|
|
32
37
|
* that table goes into the <code>DISABLED</code> state, and the stream is automatically
|
|
33
38
|
* deleted after 24 hours.</p>
|
|
34
|
-
*
|
|
35
|
-
* <p>Use the <code>DescribeTable</code> action to check the status of the table. </p>
|
|
39
|
+
* <p>Use the <code>DescribeTable</code> action to check the status of the table. </p>
|
|
36
40
|
* @example
|
|
37
41
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
42
|
* ```javascript
|
|
@@ -15,7 +15,7 @@ export interface DescribeBackupCommandOutput extends DescribeBackupOutput, __Met
|
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
17
|
* <p>Describes an existing backup of a table.</p>
|
|
18
|
-
*
|
|
18
|
+
* <p>You can call <code>DescribeBackup</code> at a maximum rate of 10 times per
|
|
19
19
|
* second.</p>
|
|
20
20
|
* @example
|
|
21
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -18,13 +18,13 @@ export interface DescribeContinuousBackupsCommandOutput extends DescribeContinuo
|
|
|
18
18
|
* table. Continuous backups are <code>ENABLED</code> on all tables at table creation. If
|
|
19
19
|
* point in time recovery is enabled, <code>PointInTimeRecoveryStatus</code> will be set to
|
|
20
20
|
* ENABLED.</p>
|
|
21
|
-
*
|
|
21
|
+
* <p> After continuous backups and point in time recovery are enabled, you can restore to
|
|
22
22
|
* any point in time within <code>EarliestRestorableDateTime</code> and
|
|
23
23
|
* <code>LatestRestorableDateTime</code>. </p>
|
|
24
|
-
*
|
|
24
|
+
* <p>
|
|
25
25
|
* <code>LatestRestorableDateTime</code> is typically 5 minutes before the current time.
|
|
26
26
|
* You can restore your table to any point in time during the last 35 days. </p>
|
|
27
|
-
*
|
|
27
|
+
* <p>You can call <code>DescribeContinuousBackups</code> at a maximum rate of 10 times per
|
|
28
28
|
* second.</p>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -14,7 +14,7 @@ export interface DescribeContributorInsightsCommandInput extends DescribeContrib
|
|
|
14
14
|
export interface DescribeContributorInsightsCommandOutput extends DescribeContributorInsightsOutput, __MetadataBearer {
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
|
-
* <p>Returns information about contributor insights
|
|
17
|
+
* <p>Returns information about contributor insights for a given table or global secondary
|
|
18
18
|
* index.</p>
|
|
19
19
|
* @example
|
|
20
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -14,7 +14,9 @@ export interface DescribeEndpointsCommandInput extends DescribeEndpointsRequest
|
|
|
14
14
|
export interface DescribeEndpointsCommandOutput extends DescribeEndpointsResponse, __MetadataBearer {
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
|
-
* <p>Returns the regional endpoint information
|
|
17
|
+
* <p>Returns the regional endpoint information. This action must be included in your VPC
|
|
18
|
+
* endpoint policies, or access to the DescribeEndpoints API will be denied. For more information
|
|
19
|
+
* on policy permissions, please see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/inter-network-traffic-privacy.html#inter-network-traffic-DescribeEndpoints">Internetwork traffic privacy</a>.</p>
|
|
18
20
|
* @example
|
|
19
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
20
22
|
* ```javascript
|
|
@@ -15,11 +15,18 @@ export interface DescribeGlobalTableCommandOutput extends DescribeGlobalTableOut
|
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
17
|
* <p>Returns information about the specified global table.</p>
|
|
18
|
-
*
|
|
18
|
+
* <important>
|
|
19
19
|
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
20
|
+
* 2017.11.29 (Legacy)</a> of global tables. We recommend using
|
|
21
|
+
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
|
|
22
|
+
* when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than
|
|
23
|
+
* 2017.11.29 (Legacy). To determine which version you are using, see
|
|
24
|
+
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
|
|
25
|
+
* To update existing global tables from version 2017.11.29 (Legacy) to version
|
|
26
|
+
* 2019.11.21 (Current), see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html">
|
|
27
|
+
* Updating global tables</a>.
|
|
28
|
+
* </p>
|
|
29
|
+
* </important>
|
|
23
30
|
* @example
|
|
24
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
25
32
|
* ```javascript
|
|
@@ -15,10 +15,18 @@ export interface DescribeGlobalTableSettingsCommandOutput extends DescribeGlobal
|
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
17
|
* <p>Describes Region-specific settings for a global table.</p>
|
|
18
|
-
*
|
|
18
|
+
* <important>
|
|
19
19
|
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
|
|
20
|
-
*
|
|
21
|
-
*
|
|
20
|
+
* 2017.11.29 (Legacy)</a> of global tables. We recommend using
|
|
21
|
+
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
|
|
22
|
+
* when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than
|
|
23
|
+
* 2017.11.29 (Legacy). To determine which version you are using, see
|
|
24
|
+
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
|
|
25
|
+
* To update existing global tables from version 2017.11.29 (Legacy) to version
|
|
26
|
+
* 2019.11.21 (Current), see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html">
|
|
27
|
+
* Updating global tables</a>.
|
|
28
|
+
* </p>
|
|
29
|
+
* </important>
|
|
22
30
|
* @example
|
|
23
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
24
32
|
* ```javascript
|