@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
|
@@ -20,10 +20,10 @@ export interface UpdateContinuousBackupsCommandOutput extends UpdateContinuousBa
|
|
|
20
20
|
* current <code>ContinuousBackupsDescription</code>. Continuous backups are
|
|
21
21
|
* <code>ENABLED</code> on all tables at table creation. If point in time recovery is
|
|
22
22
|
* enabled, <code>PointInTimeRecoveryStatus</code> will be set to ENABLED.</p>
|
|
23
|
-
*
|
|
23
|
+
* <p> Once continuous backups and point in time recovery are enabled, you can restore to
|
|
24
24
|
* any point in time within <code>EarliestRestorableDateTime</code> and
|
|
25
25
|
* <code>LatestRestorableDateTime</code>. </p>
|
|
26
|
-
*
|
|
26
|
+
* <p>
|
|
27
27
|
* <code>LatestRestorableDateTime</code> is typically 5 minutes before the current time.
|
|
28
28
|
* You can restore your table to any point in time during the last 35 days. </p>
|
|
29
29
|
* @example
|
|
@@ -18,23 +18,42 @@ export interface UpdateGlobalTableCommandOutput extends UpdateGlobalTableOutput,
|
|
|
18
18
|
* exist to be able to use this operation. Any replica to be added must be empty, have the
|
|
19
19
|
* same name as the global table, have the same key schema, have DynamoDB Streams enabled,
|
|
20
20
|
* and have the same provisioned and maximum write capacity units.</p>
|
|
21
|
-
*
|
|
22
|
-
* <p>
|
|
21
|
+
* <important>
|
|
22
|
+
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
|
|
23
|
+
* 2017.11.29 (Legacy)</a> of global tables. We recommend using
|
|
24
|
+
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
|
|
25
|
+
* when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than
|
|
26
|
+
* 2017.11.29 (Legacy). To determine which version you are using, see
|
|
27
|
+
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html">Determining the version</a>.
|
|
28
|
+
* To update existing global tables from version 2017.11.29 (Legacy) to version
|
|
29
|
+
* 2019.11.21 (Current), see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html">
|
|
30
|
+
* Updating global tables</a>.
|
|
31
|
+
* </p>
|
|
32
|
+
* </important>
|
|
33
|
+
* <note>
|
|
34
|
+
* <p>
|
|
35
|
+
* This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
|
|
36
|
+
* 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
|
|
37
|
+
* 2019.11.21</a> you can use <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeTable.html">DescribeTable</a> instead.
|
|
38
|
+
* </p>
|
|
39
|
+
* <p>
|
|
40
|
+
* Although you can use <code>UpdateGlobalTable</code> to add replicas and remove
|
|
23
41
|
* replicas in a single request, for simplicity we recommend that you issue separate
|
|
24
|
-
* requests for adding or removing replicas
|
|
25
|
-
*
|
|
26
|
-
*
|
|
42
|
+
* requests for adding or removing replicas.
|
|
43
|
+
* </p>
|
|
44
|
+
* </note>
|
|
45
|
+
* <p> If global secondary indexes are specified, then the following conditions must also be
|
|
27
46
|
* met: </p>
|
|
28
|
-
*
|
|
47
|
+
* <ul>
|
|
29
48
|
* <li>
|
|
30
|
-
*
|
|
49
|
+
* <p> The global secondary indexes must have the same name. </p>
|
|
31
50
|
* </li>
|
|
32
51
|
* <li>
|
|
33
|
-
*
|
|
52
|
+
* <p> The global secondary indexes must have the same hash key and sort key (if
|
|
34
53
|
* present). </p>
|
|
35
54
|
* </li>
|
|
36
55
|
* <li>
|
|
37
|
-
*
|
|
56
|
+
* <p> The global secondary indexes must have the same provisioned and maximum write
|
|
38
57
|
* capacity units. </p>
|
|
39
58
|
* </li>
|
|
40
59
|
* </ul>
|
|
@@ -15,6 +15,18 @@ export interface UpdateGlobalTableSettingsCommandOutput extends UpdateGlobalTabl
|
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
17
|
* <p>Updates settings for a global table.</p>
|
|
18
|
+
* <important>
|
|
19
|
+
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
|
|
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>
|
|
18
30
|
* @example
|
|
19
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
20
32
|
* ```javascript
|
|
@@ -19,7 +19,7 @@ export interface UpdateItemCommandOutput extends UpdateItemOutput, __MetadataBea
|
|
|
19
19
|
* conditional update on an existing item (insert a new attribute name-value pair if it
|
|
20
20
|
* doesn't exist, or replace an existing name-value pair if it has certain expected
|
|
21
21
|
* attribute values).</p>
|
|
22
|
-
*
|
|
22
|
+
* <p>You can also return the item's attribute values in the same <code>UpdateItem</code>
|
|
23
23
|
* operation using the <code>ReturnValues</code> parameter.</p>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -16,21 +16,26 @@ export interface UpdateTableCommandOutput extends UpdateTableOutput, __MetadataB
|
|
|
16
16
|
/**
|
|
17
17
|
* <p>Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB
|
|
18
18
|
* Streams settings for a given table.</p>
|
|
19
|
-
*
|
|
20
|
-
*
|
|
19
|
+
* <important>
|
|
20
|
+
* <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>
|
|
21
|
+
* of global tables.
|
|
22
|
+
* </p>
|
|
23
|
+
* </important>
|
|
24
|
+
* <p>You can only perform one of the following operations at once:</p>
|
|
25
|
+
* <ul>
|
|
21
26
|
* <li>
|
|
22
|
-
*
|
|
27
|
+
* <p>Modify the provisioned throughput settings of the table.</p>
|
|
23
28
|
* </li>
|
|
24
29
|
* <li>
|
|
25
|
-
*
|
|
30
|
+
* <p>Remove a global secondary index from the table.</p>
|
|
26
31
|
* </li>
|
|
27
32
|
* <li>
|
|
28
|
-
*
|
|
33
|
+
* <p>Create a new global secondary index on the table. After the index begins
|
|
29
34
|
* backfilling, you can use <code>UpdateTable</code> to perform other
|
|
30
35
|
* operations.</p>
|
|
31
36
|
* </li>
|
|
32
37
|
* </ul>
|
|
33
|
-
*
|
|
38
|
+
* <p>
|
|
34
39
|
* <code>UpdateTable</code> is an asynchronous operation; while it is executing, the table
|
|
35
40
|
* status changes from <code>ACTIVE</code> to <code>UPDATING</code>. While it is
|
|
36
41
|
* <code>UPDATING</code>, you cannot issue another <code>UpdateTable</code> request.
|
|
@@ -15,10 +15,11 @@ export interface UpdateTableReplicaAutoScalingCommandOutput extends UpdateTableR
|
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
17
|
* <p>Updates auto scaling settings on your global tables at once.</p>
|
|
18
|
-
*
|
|
19
|
-
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version
|
|
20
|
-
*
|
|
21
|
-
*
|
|
18
|
+
* <important>
|
|
19
|
+
* <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>
|
|
20
|
+
* of global tables.
|
|
21
|
+
* </p>
|
|
22
|
+
* </important>
|
|
22
23
|
* @example
|
|
23
24
|
* Use a bare-bones client and the command you need to make an API call.
|
|
24
25
|
* ```javascript
|
|
@@ -19,25 +19,25 @@ export interface UpdateTimeToLiveCommandOutput extends UpdateTimeToLiveOutput, _
|
|
|
19
19
|
* <code>TimeToLiveSpecification</code>. It can take up to one hour for the change to
|
|
20
20
|
* fully process. Any additional <code>UpdateTimeToLive</code> calls for the same table
|
|
21
21
|
* during this one hour duration result in a <code>ValidationException</code>. </p>
|
|
22
|
-
*
|
|
22
|
+
* <p>TTL compares the current time in epoch time format to the time stored in the TTL
|
|
23
23
|
* attribute of an item. If the epoch time value stored in the attribute is less than the
|
|
24
24
|
* current time, the item is marked as expired and subsequently deleted.</p>
|
|
25
|
-
*
|
|
25
|
+
* <note>
|
|
26
26
|
* <p> The epoch time format is the number of seconds elapsed since 12:00:00 AM January
|
|
27
27
|
* 1, 1970 UTC. </p>
|
|
28
|
-
*
|
|
29
|
-
*
|
|
28
|
+
* </note>
|
|
29
|
+
* <p>DynamoDB deletes expired items on a best-effort basis to ensure availability of
|
|
30
30
|
* throughput for other data operations. </p>
|
|
31
|
-
*
|
|
31
|
+
* <important>
|
|
32
32
|
* <p>DynamoDB typically deletes expired items within two days of expiration. The exact
|
|
33
33
|
* duration within which an item gets deleted after expiration is specific to the
|
|
34
34
|
* nature of the workload. Items that have expired and not been deleted will still show
|
|
35
35
|
* up in reads, queries, and scans.</p>
|
|
36
|
-
*
|
|
37
|
-
*
|
|
36
|
+
* </important>
|
|
37
|
+
* <p>As items are deleted, they are removed from any local secondary index and global
|
|
38
38
|
* secondary index immediately in the same eventually consistent way as a standard delete
|
|
39
39
|
* operation.</p>
|
|
40
|
-
*
|
|
40
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html">Time To Live</a> in the
|
|
41
41
|
* Amazon DynamoDB Developer Guide. </p>
|
|
42
42
|
* @example
|
|
43
43
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
|
|
|
12
12
|
defaultSigningName: string;
|
|
13
13
|
};
|
|
14
14
|
export interface EndpointParameters extends __EndpointParameters {
|
|
15
|
-
Region
|
|
15
|
+
Region?: string;
|
|
16
16
|
UseDualStack?: boolean;
|
|
17
17
|
UseFIPS?: boolean;
|
|
18
18
|
Endpoint?: string;
|