@aws-sdk/client-dynamodb 3.38.0 → 3.42.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 +41 -0
- package/README.md +18 -16
- package/dist-cjs/endpoints.js +162 -27
- package/dist-cjs/runtimeConfig.browser.js +6 -3
- package/dist-cjs/runtimeConfig.js +5 -3
- package/dist-es/endpoints.js +162 -27
- 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 +3413 -2779
- 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/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 +27 -27
|
@@ -127,6 +127,14 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
127
127
|
* Optional logger for logging debug/info/warn/error.
|
|
128
128
|
*/
|
|
129
129
|
logger?: __Logger;
|
|
130
|
+
/**
|
|
131
|
+
* Enables IPv6/IPv4 dualstack endpoint.
|
|
132
|
+
*/
|
|
133
|
+
useDualstackEndpoint?: boolean | __Provider<boolean>;
|
|
134
|
+
/**
|
|
135
|
+
* Enables FIPS compatible endpoints.
|
|
136
|
+
*/
|
|
137
|
+
useFipsEndpoint?: boolean | __Provider<boolean>;
|
|
130
138
|
/**
|
|
131
139
|
* Unique service identifier.
|
|
132
140
|
* @internal
|
|
@@ -173,23 +181,24 @@ export interface DynamoDBClientResolvedConfig extends DynamoDBClientResolvedConf
|
|
|
173
181
|
/**
|
|
174
182
|
* <fullname>Amazon DynamoDB</fullname>
|
|
175
183
|
*
|
|
184
|
+
* <p>Amazon DynamoDB is a fully managed NoSQL database service that provides fast
|
|
185
|
+
* and predictable performance with seamless scalability. DynamoDB lets you
|
|
186
|
+
* offload the administrative burdens of operating and scaling a distributed database, so
|
|
187
|
+
* that you don't have to worry about hardware provisioning, setup and configuration,
|
|
188
|
+
* replication, software patching, or cluster scaling.</p>
|
|
176
189
|
*
|
|
177
|
-
*
|
|
178
|
-
*
|
|
179
|
-
*
|
|
180
|
-
*
|
|
181
|
-
*
|
|
182
|
-
*
|
|
183
|
-
* <p>With DynamoDB, you can create database tables that can store and retrieve any amount of
|
|
184
|
-
* data, and serve any level of request traffic. You can scale up or scale down your tables'
|
|
185
|
-
* throughput capacity without downtime or performance degradation, and use the AWS Management
|
|
186
|
-
* Console to monitor resource utilization and performance metrics.</p>
|
|
190
|
+
* <p>With DynamoDB, you can create database tables that can store and retrieve
|
|
191
|
+
* any amount of data, and serve any level of request traffic. You can scale up or scale
|
|
192
|
+
* down your tables' throughput capacity without downtime or performance degradation, and
|
|
193
|
+
* use the Amazon Web Services Management Console to monitor resource utilization and performance
|
|
194
|
+
* metrics.</p>
|
|
187
195
|
*
|
|
188
|
-
*
|
|
189
|
-
*
|
|
190
|
-
*
|
|
191
|
-
*
|
|
192
|
-
*
|
|
196
|
+
* <p>DynamoDB automatically spreads the data and traffic for your tables over
|
|
197
|
+
* a sufficient number of servers to handle your throughput and storage requirements, while
|
|
198
|
+
* maintaining consistent and fast performance. All of your data is stored on solid state
|
|
199
|
+
* disks (SSDs) and automatically replicated across multiple Availability Zones in an
|
|
200
|
+
* Amazon Web Services Region, providing built-in high availability and data
|
|
201
|
+
* durability.</p>
|
|
193
202
|
*/
|
|
194
203
|
export declare class DynamoDBClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, DynamoDBClientResolvedConfig> {
|
|
195
204
|
/**
|
|
@@ -7,9 +7,12 @@ export interface BatchExecuteStatementCommandInput extends BatchExecuteStatement
|
|
|
7
7
|
export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatementOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
11
|
-
*
|
|
12
|
-
*
|
|
10
|
+
* <p>This operation allows you to perform batch reads or writes on data stored in DynamoDB,
|
|
11
|
+
* using PartiQL.</p>
|
|
12
|
+
* <note>
|
|
13
|
+
* <p>The entire batch must consist of either read statements or write statements, you
|
|
14
|
+
* cannot mix both in one batch.</p>
|
|
15
|
+
* </note>
|
|
13
16
|
* @example
|
|
14
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
18
|
* ```javascript
|
|
@@ -22,7 +25,7 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen
|
|
|
22
25
|
*
|
|
23
26
|
* @see {@link BatchExecuteStatementCommandInput} for command's `input` shape.
|
|
24
27
|
* @see {@link BatchExecuteStatementCommandOutput} for command's `response` shape.
|
|
25
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
28
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
26
29
|
*
|
|
27
30
|
*/
|
|
28
31
|
export declare class BatchExecuteStatementCommand extends $Command<BatchExecuteStatementCommandInput, BatchExecuteStatementCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -7,49 +7,50 @@ export interface BatchGetItemCommandInput extends BatchGetItemInput {
|
|
|
7
7
|
export interface BatchGetItemCommandOutput extends BatchGetItemOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>The <code>BatchGetItem</code> operation returns the attributes of one or more items
|
|
11
|
-
*
|
|
12
|
-
*
|
|
10
|
+
* <p>The <code>BatchGetItem</code> operation returns the attributes of one or more items
|
|
11
|
+
* from one or more tables. You identify requested items by primary key.</p>
|
|
12
|
+
* <p>A single operation can retrieve up to 16 MB of data, which can contain as many as 100
|
|
13
13
|
* items. <code>BatchGetItem</code> returns a partial result if the response size limit is
|
|
14
14
|
* exceeded, the table's provisioned throughput is exceeded, or an internal processing
|
|
15
15
|
* failure occurs. If a partial result is returned, the operation returns a value for
|
|
16
16
|
* <code>UnprocessedKeys</code>. You can use this value to retry the operation starting
|
|
17
17
|
* with the next item to get.</p>
|
|
18
|
-
*
|
|
18
|
+
* <important>
|
|
19
19
|
* <p>If you request more than 100 items, <code>BatchGetItem</code> returns a
|
|
20
20
|
* <code>ValidationException</code> with the message "Too many items requested for
|
|
21
21
|
* the BatchGetItem call."</p>
|
|
22
|
-
*
|
|
23
|
-
*
|
|
22
|
+
* </important>
|
|
23
|
+
* <p>For example, if you ask to retrieve 100 items, but each individual item is 300 KB in
|
|
24
24
|
* size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns
|
|
25
25
|
* an appropriate <code>UnprocessedKeys</code> value so you can get the next page of
|
|
26
26
|
* results. If desired, your application can include its own logic to assemble the pages of
|
|
27
27
|
* results into one dataset.</p>
|
|
28
|
-
*
|
|
28
|
+
* <p>If <i>none</i> of the items can be processed due to insufficient
|
|
29
29
|
* provisioned throughput on all of the tables in the request, then
|
|
30
30
|
* <code>BatchGetItem</code> returns a
|
|
31
31
|
* <code>ProvisionedThroughputExceededException</code>. If <i>at least
|
|
32
32
|
* one</i> of the items is successfully processed, then
|
|
33
33
|
* <code>BatchGetItem</code> completes successfully, while returning the keys of the
|
|
34
34
|
* unread items in <code>UnprocessedKeys</code>.</p>
|
|
35
|
-
*
|
|
36
|
-
* <p>If DynamoDB returns any unprocessed items, you should retry the batch operation on
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations">Batch
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
*
|
|
35
|
+
* <important>
|
|
36
|
+
* <p>If DynamoDB returns any unprocessed items, you should retry the batch operation on
|
|
37
|
+
* those items. However, <i>we strongly recommend that you use an exponential
|
|
38
|
+
* backoff algorithm</i>. If you retry the batch operation immediately, the
|
|
39
|
+
* underlying read or write requests can still fail due to throttling on the individual
|
|
40
|
+
* tables. If you delay the batch operation using exponential backoff, the individual
|
|
41
|
+
* requests in the batch are much more likely to succeed.</p>
|
|
42
|
+
* <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
|
|
43
|
+
* Developer Guide</i>.</p>
|
|
44
|
+
* </important>
|
|
45
|
+
* <p>By default, <code>BatchGetItem</code> performs eventually consistent reads on every
|
|
46
|
+
* table in the request. If you want strongly consistent reads instead, you can set
|
|
47
|
+
* <code>ConsistentRead</code> to <code>true</code> for any or all tables.</p>
|
|
48
|
+
* <p>In order to minimize response latency, <code>BatchGetItem</code> retrieves items in
|
|
49
|
+
* parallel.</p>
|
|
50
|
+
* <p>When designing your application, keep in mind that DynamoDB does not return items in
|
|
51
|
+
* any particular order. To help parse the response by item, include the primary key values
|
|
52
|
+
* for the items in your request in the <code>ProjectionExpression</code> parameter.</p>
|
|
53
|
+
* <p>If a requested item does not exist, it is not returned in the result. Requests for
|
|
53
54
|
* nonexistent items consume the minimum read capacity units according to the type of read.
|
|
54
55
|
* 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
|
|
55
56
|
* Guide</i>.</p>
|
|
@@ -65,7 +66,7 @@ export interface BatchGetItemCommandOutput extends BatchGetItemOutput, __Metadat
|
|
|
65
66
|
*
|
|
66
67
|
* @see {@link BatchGetItemCommandInput} for command's `input` shape.
|
|
67
68
|
* @see {@link BatchGetItemCommandOutput} for command's `response` shape.
|
|
68
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
69
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
69
70
|
*
|
|
70
71
|
*/
|
|
71
72
|
export declare class BatchGetItemCommand extends $Command<BatchGetItemCommandInput, BatchGetItemCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -7,79 +7,83 @@ export interface BatchWriteItemCommandInput extends BatchWriteItemInput {
|
|
|
7
7
|
export interface BatchWriteItemCommandOutput extends BatchWriteItemOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>The <code>BatchWriteItem</code> operation puts or deletes multiple items in one or
|
|
11
|
-
* tables. A single call to <code>BatchWriteItem</code> can write up to 16 MB of data,
|
|
10
|
+
* <p>The <code>BatchWriteItem</code> operation puts or deletes multiple items in one or
|
|
11
|
+
* more tables. A single call to <code>BatchWriteItem</code> can write up to 16 MB of data,
|
|
12
12
|
* which can comprise as many as 25 put or delete requests. Individual items to be written
|
|
13
13
|
* can be as large as 400 KB.</p>
|
|
14
|
-
*
|
|
14
|
+
* <note>
|
|
15
15
|
* <p>
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
16
|
+
* <code>BatchWriteItem</code> cannot update items. To update items, use the
|
|
17
|
+
* <code>UpdateItem</code> action.</p>
|
|
18
|
+
* </note>
|
|
19
|
+
* <p>The individual <code>PutItem</code> and <code>DeleteItem</code> operations specified
|
|
20
|
+
* in <code>BatchWriteItem</code> are atomic; however <code>BatchWriteItem</code> as a
|
|
21
|
+
* whole is not. If any requested operations fail because the table's provisioned
|
|
22
|
+
* throughput is exceeded or an internal processing failure occurs, the failed operations
|
|
23
|
+
* are returned in the <code>UnprocessedItems</code> response parameter. You can
|
|
24
|
+
* investigate and optionally resend the requests. Typically, you would call
|
|
25
|
+
* <code>BatchWriteItem</code> in a loop. Each iteration would check for unprocessed
|
|
26
|
+
* items and submit a new <code>BatchWriteItem</code> request with those unprocessed items
|
|
27
|
+
* until all items have been processed.</p>
|
|
28
|
+
* <p>If <i>none</i> of the items can be processed due to insufficient
|
|
28
29
|
* provisioned throughput on all of the tables in the request, then
|
|
29
30
|
* <code>BatchWriteItem</code> returns a
|
|
30
31
|
* <code>ProvisionedThroughputExceededException</code>.</p>
|
|
31
|
-
*
|
|
32
|
-
* <p>If DynamoDB returns any unprocessed items, you should retry the batch operation on
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
32
|
+
* <important>
|
|
33
|
+
* <p>If DynamoDB returns any unprocessed items, you should retry the batch operation on
|
|
34
|
+
* those items. However, <i>we strongly recommend that you use an exponential
|
|
35
|
+
* backoff algorithm</i>. If you retry the batch operation immediately, the
|
|
36
|
+
* underlying read or write requests can still fail due to throttling on the individual
|
|
37
|
+
* tables. If you delay the batch operation using exponential backoff, the individual
|
|
38
|
+
* requests in the batch are much more likely to succeed.</p>
|
|
38
39
|
* <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
|
|
39
40
|
* Developer Guide</i>.</p>
|
|
40
|
-
*
|
|
41
|
+
* </important>
|
|
41
42
|
*
|
|
42
|
-
*
|
|
43
|
+
* <p>With <code>BatchWriteItem</code>, you can efficiently write or delete large amounts of
|
|
43
44
|
* data, such as from Amazon EMR, or copy data from another database into DynamoDB. In
|
|
44
45
|
* order to improve performance with these large-scale operations,
|
|
45
46
|
* <code>BatchWriteItem</code> does not behave in the same way as individual
|
|
46
47
|
* <code>PutItem</code> and <code>DeleteItem</code> calls would. For example, you
|
|
47
48
|
* cannot specify conditions on individual put and delete requests, and
|
|
48
49
|
* <code>BatchWriteItem</code> does not return deleted items in the response.</p>
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
*
|
|
50
|
+
* <p>If you use a programming language that supports concurrency, you can use threads to
|
|
51
|
+
* write items in parallel. Your application must include the necessary logic to manage the
|
|
52
|
+
* threads. With languages that don't support threading, you must update or delete the
|
|
53
|
+
* specified items one at a time. In both situations, <code>BatchWriteItem</code> performs
|
|
54
|
+
* the specified put and delete operations in parallel, giving you the power of the thread
|
|
55
|
+
* pool approach without having to introduce complexity into your application.</p>
|
|
56
|
+
* <p>Parallel processing reduces latency, but each specified put and delete request
|
|
57
|
+
* consumes the same number of write capacity units whether it is processed in parallel or
|
|
58
|
+
* not. Delete operations on nonexistent items consume one write capacity unit.</p>
|
|
59
|
+
* <p>If one or more of the following is true, DynamoDB rejects the entire batch write
|
|
60
|
+
* operation:</p>
|
|
61
|
+
* <ul>
|
|
59
62
|
* <li>
|
|
60
|
-
*
|
|
63
|
+
* <p>One or more tables specified in the <code>BatchWriteItem</code> request does
|
|
64
|
+
* not exist.</p>
|
|
61
65
|
* </li>
|
|
62
66
|
* <li>
|
|
63
|
-
*
|
|
67
|
+
* <p>Primary key attributes specified on an item in the request do not match those
|
|
68
|
+
* in the corresponding table's primary key schema.</p>
|
|
64
69
|
* </li>
|
|
65
70
|
* <li>
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
*
|
|
71
|
+
* <p>You try to perform multiple operations on the same item in the same
|
|
72
|
+
* <code>BatchWriteItem</code> request. For example, you cannot put and delete
|
|
73
|
+
* the same item in the same <code>BatchWriteItem</code> request. </p>
|
|
69
74
|
* </li>
|
|
70
75
|
* <li>
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
*
|
|
74
|
-
* </li>
|
|
76
|
+
* <p> Your request contains at least two items with identical hash and range keys
|
|
77
|
+
* (which essentially is two put operations). </p>
|
|
78
|
+
* </li>
|
|
75
79
|
* <li>
|
|
76
|
-
*
|
|
80
|
+
* <p>There are more than 25 requests in the batch.</p>
|
|
77
81
|
* </li>
|
|
78
82
|
* <li>
|
|
79
|
-
*
|
|
83
|
+
* <p>Any individual item in a batch exceeds 400 KB.</p>
|
|
80
84
|
* </li>
|
|
81
85
|
* <li>
|
|
82
|
-
*
|
|
86
|
+
* <p>The total request size exceeds 16 MB.</p>
|
|
83
87
|
* </li>
|
|
84
88
|
* </ul>
|
|
85
89
|
* @example
|
|
@@ -94,7 +98,7 @@ export interface BatchWriteItemCommandOutput extends BatchWriteItemOutput, __Met
|
|
|
94
98
|
*
|
|
95
99
|
* @see {@link BatchWriteItemCommandInput} for command's `input` shape.
|
|
96
100
|
* @see {@link BatchWriteItemCommandOutput} for command's `response` shape.
|
|
97
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
101
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
98
102
|
*
|
|
99
103
|
*/
|
|
100
104
|
export declare class BatchWriteItemCommand extends $Command<BatchWriteItemCommandInput, BatchWriteItemCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -8,34 +8,34 @@ export interface CreateBackupCommandOutput extends CreateBackupOutput, __Metadat
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Creates a backup for an existing table.</p>
|
|
11
|
-
*
|
|
11
|
+
* <p> Each time you create an on-demand backup, the entire table data is backed up. There
|
|
12
12
|
* is no limit to the number of on-demand backups that can be taken. </p>
|
|
13
|
-
*
|
|
13
|
+
* <p> When you create an on-demand backup, a time marker of the request is cataloged, and
|
|
14
14
|
* the backup is created asynchronously, by applying all changes until the time of the
|
|
15
15
|
* request to the last full table snapshot. Backup requests are processed instantaneously
|
|
16
16
|
* and become available for restore within minutes. </p>
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
17
|
+
* <p>You can call <code>CreateBackup</code> at a maximum rate of 50 times per
|
|
18
|
+
* second.</p>
|
|
19
|
+
* <p>All backups in DynamoDB work without consuming any provisioned throughput on the
|
|
20
|
+
* table.</p>
|
|
21
|
+
* <p> If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to
|
|
22
|
+
* contain all data committed to the table up to 14:24:00, and data committed after
|
|
21
23
|
* 14:26:00 will not be. The backup might contain data modifications made between 14:24:00
|
|
22
24
|
* and 14:26:00. On-demand backup does not support causal consistency. </p>
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
* </p>
|
|
26
|
-
* <ul>
|
|
25
|
+
* <p> Along with data, the following are also included on the backups: </p>
|
|
26
|
+
* <ul>
|
|
27
27
|
* <li>
|
|
28
|
-
*
|
|
29
|
-
*
|
|
28
|
+
* <p>Global secondary indexes (GSIs)</p>
|
|
29
|
+
* </li>
|
|
30
30
|
* <li>
|
|
31
|
-
*
|
|
32
|
-
*
|
|
31
|
+
* <p>Local secondary indexes (LSIs)</p>
|
|
32
|
+
* </li>
|
|
33
33
|
* <li>
|
|
34
|
-
*
|
|
35
|
-
*
|
|
34
|
+
* <p>Streams</p>
|
|
35
|
+
* </li>
|
|
36
36
|
* <li>
|
|
37
|
-
*
|
|
38
|
-
*
|
|
37
|
+
* <p>Provisioned read and write capacity</p>
|
|
38
|
+
* </li>
|
|
39
39
|
* </ul>
|
|
40
40
|
* @example
|
|
41
41
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -49,7 +49,7 @@ export interface CreateBackupCommandOutput extends CreateBackupOutput, __Metadat
|
|
|
49
49
|
*
|
|
50
50
|
* @see {@link CreateBackupCommandInput} for command's `input` shape.
|
|
51
51
|
* @see {@link CreateBackupCommandOutput} for command's `response` shape.
|
|
52
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
52
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
53
53
|
*
|
|
54
54
|
*/
|
|
55
55
|
export declare class CreateBackupCommand extends $Command<CreateBackupCommandInput, CreateBackupCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -10,71 +10,60 @@ export interface CreateGlobalTableCommandOutput extends CreateGlobalTableOutput,
|
|
|
10
10
|
* <p>Creates a global table from an existing table. A global table creates a replication
|
|
11
11
|
* relationship between two or more DynamoDB tables with the same table name in the
|
|
12
12
|
* provided Regions. </p>
|
|
13
|
-
*
|
|
14
|
-
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
|
|
15
|
-
*
|
|
13
|
+
* <note>
|
|
14
|
+
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
|
|
15
|
+
* 2017.11.29</a> of global tables.</p>
|
|
16
|
+
* </note>
|
|
16
17
|
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
18
|
+
* <p>If you want to add a new replica table to a global table, each of the following
|
|
19
|
+
* conditions must be true:</p>
|
|
20
|
+
* <ul>
|
|
20
21
|
* <li>
|
|
21
|
-
*
|
|
22
|
+
* <p>The table must have the same primary key as all of the other replicas.</p>
|
|
22
23
|
* </li>
|
|
23
24
|
* <li>
|
|
24
|
-
*
|
|
25
|
+
* <p>The table must have the same name as all of the other replicas.</p>
|
|
25
26
|
* </li>
|
|
26
27
|
* <li>
|
|
27
|
-
*
|
|
28
|
-
*
|
|
28
|
+
* <p>The table must have DynamoDB Streams enabled, with the stream containing both
|
|
29
|
+
* the new and the old images of the item.</p>
|
|
29
30
|
* </li>
|
|
30
31
|
* <li>
|
|
31
|
-
*
|
|
32
|
+
* <p>None of the replica tables in the global table can contain any data.</p>
|
|
32
33
|
* </li>
|
|
33
34
|
* </ul>
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
* </p>
|
|
35
|
+
* <p> If global secondary indexes are specified, then the following conditions must also be
|
|
36
|
+
* met: </p>
|
|
37
37
|
* <ul>
|
|
38
38
|
* <li>
|
|
39
|
-
*
|
|
40
|
-
* The global secondary indexes must have the same name.
|
|
41
|
-
* </p>
|
|
39
|
+
* <p> The global secondary indexes must have the same name. </p>
|
|
42
40
|
* </li>
|
|
43
41
|
* <li>
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
* </p>
|
|
42
|
+
* <p> The global secondary indexes must have the same hash key and sort key (if
|
|
43
|
+
* present). </p>
|
|
47
44
|
* </li>
|
|
48
45
|
* </ul>
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
* </p>
|
|
46
|
+
* <p> If local secondary indexes are specified, then the following conditions must also be
|
|
47
|
+
* met: </p>
|
|
52
48
|
* <ul>
|
|
53
49
|
* <li>
|
|
54
|
-
*
|
|
55
|
-
* The local secondary indexes must have the same name.
|
|
56
|
-
* </p>
|
|
50
|
+
* <p> The local secondary indexes must have the same name. </p>
|
|
57
51
|
* </li>
|
|
58
52
|
* <li>
|
|
59
|
-
*
|
|
60
|
-
*
|
|
61
|
-
* </p>
|
|
53
|
+
* <p> The local secondary indexes must have the same hash key and sort key (if
|
|
54
|
+
* present). </p>
|
|
62
55
|
* </li>
|
|
63
56
|
* </ul>
|
|
64
57
|
*
|
|
65
|
-
*
|
|
66
|
-
* <p>
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
*
|
|
70
|
-
*
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
*
|
|
74
|
-
* equal replicated write capacity units to matching secondary indexes across
|
|
75
|
-
* your global table.
|
|
76
|
-
* </p>
|
|
77
|
-
* </important>
|
|
58
|
+
* <important>
|
|
59
|
+
* <p> Write capacity settings should be set consistently across your replica tables and
|
|
60
|
+
* secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the
|
|
61
|
+
* write capacity settings for all of your global tables replicas and indexes. </p>
|
|
62
|
+
* <p> If you prefer to manage write capacity settings manually, you should provision
|
|
63
|
+
* equal replicated write capacity units to your replica tables. You should also
|
|
64
|
+
* provision equal replicated write capacity units to matching secondary indexes across
|
|
65
|
+
* your global table. </p>
|
|
66
|
+
* </important>
|
|
78
67
|
* @example
|
|
79
68
|
* Use a bare-bones client and the command you need to make an API call.
|
|
80
69
|
* ```javascript
|
|
@@ -87,7 +76,7 @@ export interface CreateGlobalTableCommandOutput extends CreateGlobalTableOutput,
|
|
|
87
76
|
*
|
|
88
77
|
* @see {@link CreateGlobalTableCommandInput} for command's `input` shape.
|
|
89
78
|
* @see {@link CreateGlobalTableCommandOutput} for command's `response` shape.
|
|
90
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
79
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
91
80
|
*
|
|
92
81
|
*/
|
|
93
82
|
export declare class CreateGlobalTableCommand extends $Command<CreateGlobalTableCommandInput, CreateGlobalTableCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -7,19 +7,19 @@ export interface CreateTableCommandInput extends CreateTableInput {
|
|
|
7
7
|
export interface CreateTableCommandOutput extends CreateTableOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>The <code>CreateTable</code> operation adds a new table to your account. In an
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
10
|
+
* <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
|
|
11
|
+
* have two tables with same name if you create the tables in different Regions.</p>
|
|
12
|
+
* <p>
|
|
13
|
+
* <code>CreateTable</code> is an asynchronous operation. Upon receiving a
|
|
14
|
+
* <code>CreateTable</code> request, DynamoDB immediately returns a response with a
|
|
15
|
+
* <code>TableStatus</code> of <code>CREATING</code>. After the table is created,
|
|
16
|
+
* DynamoDB sets the <code>TableStatus</code> to <code>ACTIVE</code>. You can perform read
|
|
17
|
+
* and write operations only on an <code>ACTIVE</code> table. </p>
|
|
18
|
+
* <p>You can optionally define secondary indexes on the new table, as part of the
|
|
19
|
+
* <code>CreateTable</code> operation. If you want to create multiple tables with
|
|
20
|
+
* secondary indexes on them, you must create the tables sequentially. Only one table with
|
|
21
|
+
* secondary indexes can be in the <code>CREATING</code> state at any given time.</p>
|
|
22
|
+
* <p>You can use the <code>DescribeTable</code> action to check the table status.</p>
|
|
23
23
|
* @example
|
|
24
24
|
* Use a bare-bones client and the command you need to make an API call.
|
|
25
25
|
* ```javascript
|
|
@@ -32,7 +32,7 @@ export interface CreateTableCommandOutput extends CreateTableOutput, __MetadataB
|
|
|
32
32
|
*
|
|
33
33
|
* @see {@link CreateTableCommandInput} for command's `input` shape.
|
|
34
34
|
* @see {@link CreateTableCommandOutput} for command's `response` shape.
|
|
35
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
35
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
36
36
|
*
|
|
37
37
|
*/
|
|
38
38
|
export declare class CreateTableCommand extends $Command<CreateTableCommandInput, CreateTableCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -8,7 +8,8 @@ export interface DeleteBackupCommandOutput extends DeleteBackupOutput, __Metadat
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Deletes an existing backup of a table.</p>
|
|
11
|
-
*
|
|
11
|
+
* <p>You can call <code>DeleteBackup</code> at a maximum rate of 10 times per
|
|
12
|
+
* second.</p>
|
|
12
13
|
* @example
|
|
13
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
15
|
* ```javascript
|
|
@@ -21,7 +22,7 @@ export interface DeleteBackupCommandOutput extends DeleteBackupOutput, __Metadat
|
|
|
21
22
|
*
|
|
22
23
|
* @see {@link DeleteBackupCommandInput} for command's `input` shape.
|
|
23
24
|
* @see {@link DeleteBackupCommandOutput} for command's `response` shape.
|
|
24
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
25
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
25
26
|
*
|
|
26
27
|
*/
|
|
27
28
|
export declare class DeleteBackupCommand extends $Command<DeleteBackupCommandInput, DeleteBackupCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -7,12 +7,17 @@ export interface DeleteItemCommandInput extends DeleteItemInput {
|
|
|
7
7
|
export interface DeleteItemCommandOutput extends DeleteItemOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes a single item in a table by primary key. You can perform a conditional delete
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
10
|
+
* <p>Deletes a single item in a table by primary key. You can perform a conditional delete
|
|
11
|
+
* operation that deletes the item if it exists, or if it has an expected attribute
|
|
12
|
+
* value.</p>
|
|
13
|
+
* <p>In addition to deleting an item, you can also return the item's attribute values in
|
|
14
|
+
* the same operation, using the <code>ReturnValues</code> parameter.</p>
|
|
15
|
+
* <p>Unless you specify conditions, the <code>DeleteItem</code> is an idempotent operation;
|
|
16
|
+
* running it multiple times on the same item or attribute does <i>not</i>
|
|
17
|
+
* result in an error response.</p>
|
|
18
|
+
* <p>Conditional deletes are useful for deleting items only if specific conditions are met.
|
|
19
|
+
* If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not
|
|
20
|
+
* deleted.</p>
|
|
16
21
|
* @example
|
|
17
22
|
* Use a bare-bones client and the command you need to make an API call.
|
|
18
23
|
* ```javascript
|
|
@@ -25,7 +30,7 @@ export interface DeleteItemCommandOutput extends DeleteItemOutput, __MetadataBea
|
|
|
25
30
|
*
|
|
26
31
|
* @see {@link DeleteItemCommandInput} for command's `input` shape.
|
|
27
32
|
* @see {@link DeleteItemCommandOutput} for command's `response` shape.
|
|
28
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
33
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
29
34
|
*
|
|
30
35
|
*/
|
|
31
36
|
export declare class DeleteItemCommand extends $Command<DeleteItemCommandInput, DeleteItemCommandOutput, DynamoDBClientResolvedConfig> {
|