@aws-sdk/client-dynamodb 3.40.0 → 3.41.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 +11 -0
- package/README.md +18 -16
- package/dist-cjs/endpoints.js +8 -0
- package/dist-es/endpoints.js +8 -0
- package/dist-types/DynamoDB.d.ts +606 -567
- package/dist-types/DynamoDBClient.d.ts +16 -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/package.json +4 -4
|
@@ -14,23 +14,24 @@ export interface TransactGetItemsCommandOutput extends TransactGetItemsOutput, _
|
|
|
14
14
|
* <code>TransactGetItem</code> objects, each of which contains a <code>Get</code>
|
|
15
15
|
* structure that specifies an item to retrieve from a table in the account and Region. A
|
|
16
16
|
* call to <code>TransactGetItems</code> cannot retrieve items from tables in more than one
|
|
17
|
-
*
|
|
18
|
-
* 4 MB.</p>
|
|
19
|
-
*
|
|
20
|
-
*
|
|
17
|
+
* Amazon Web Services account or Region. The aggregate size of the items in the
|
|
18
|
+
* transaction cannot exceed 4 MB.</p>
|
|
19
|
+
* <p>DynamoDB rejects the entire <code>TransactGetItems</code> request if any of
|
|
20
|
+
* the following is true:</p>
|
|
21
|
+
* <ul>
|
|
21
22
|
* <li>
|
|
22
|
-
*
|
|
23
|
-
*
|
|
23
|
+
* <p>A conflicting operation is in the process of updating an item to be
|
|
24
|
+
* read.</p>
|
|
24
25
|
* </li>
|
|
25
26
|
* <li>
|
|
26
|
-
*
|
|
27
|
-
*
|
|
27
|
+
* <p>There is insufficient provisioned capacity for the transaction to be
|
|
28
|
+
* completed.</p>
|
|
28
29
|
* </li>
|
|
29
30
|
* <li>
|
|
30
|
-
*
|
|
31
|
+
* <p>There is a user error, such as an invalid data format.</p>
|
|
31
32
|
* </li>
|
|
32
33
|
* <li>
|
|
33
|
-
*
|
|
34
|
+
* <p>The aggregate size of the items in the transaction cannot exceed 4 MB.</p>
|
|
34
35
|
* </li>
|
|
35
36
|
* </ul>
|
|
36
37
|
* @example
|
|
@@ -45,7 +46,7 @@ export interface TransactGetItemsCommandOutput extends TransactGetItemsOutput, _
|
|
|
45
46
|
*
|
|
46
47
|
* @see {@link TransactGetItemsCommandInput} for command's `input` shape.
|
|
47
48
|
* @see {@link TransactGetItemsCommandOutput} for command's `response` shape.
|
|
48
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
49
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
49
50
|
*
|
|
50
51
|
*/
|
|
51
52
|
export declare class TransactGetItemsCommand extends $Command<TransactGetItemsCommandInput, TransactGetItemsCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -10,75 +10,77 @@ export interface TransactWriteItemsCommandOutput extends TransactWriteItemsOutpu
|
|
|
10
10
|
* <p>
|
|
11
11
|
* <code>TransactWriteItems</code> is a synchronous write operation that groups up to 25
|
|
12
12
|
* action requests. These actions can target items in different tables, but not in
|
|
13
|
-
* different
|
|
14
|
-
* example, you cannot both <code>ConditionCheck</code> and <code>Update</code>
|
|
15
|
-
* item. The aggregate size of the items in the transaction cannot exceed 4
|
|
13
|
+
* different Amazon Web Services accounts or Regions, and no two actions can target the same
|
|
14
|
+
* item. For example, you cannot both <code>ConditionCheck</code> and <code>Update</code>
|
|
15
|
+
* the same item. The aggregate size of the items in the transaction cannot exceed 4
|
|
16
|
+
* MB.</p>
|
|
16
17
|
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
18
|
+
* <p>The actions are completed atomically so that either all of them succeed, or all of
|
|
19
|
+
* them fail. They are defined by the following objects:</p>
|
|
19
20
|
*
|
|
20
|
-
*
|
|
21
|
+
* <ul>
|
|
21
22
|
* <li>
|
|
22
|
-
*
|
|
23
|
-
* <code>Put</code>
|
|
24
|
-
* item. This structure specifies the primary key of the
|
|
25
|
-
* name of the table to write it in, an optional condition
|
|
26
|
-
* satisfied for the write to succeed, a list of the item's
|
|
27
|
-
* indicating whether to retrieve the item's attributes if
|
|
28
|
-
* met.</p>
|
|
29
|
-
* </li>
|
|
30
|
-
* <li>
|
|
31
|
-
* <p>
|
|
32
|
-
* <code>Update</code> Initiates an <code>UpdateItem</code> operation to
|
|
33
|
-
* update an existing item. This structure specifies the primary key of the item to
|
|
34
|
-
* be updated, the name of the table where it resides, an optional condition
|
|
35
|
-
* expression that must be satisfied for the update to succeed, an expression that
|
|
36
|
-
* defines one or more attributes to be updated, and a field indicating whether to
|
|
37
|
-
* retrieve the item's attributes if the condition is not met.</p>
|
|
23
|
+
* <p>
|
|
24
|
+
* <code>Put</code> — Initiates a <code>PutItem</code>
|
|
25
|
+
* operation to write a new item. This structure specifies the primary key of the
|
|
26
|
+
* item to be written, the name of the table to write it in, an optional condition
|
|
27
|
+
* expression that must be satisfied for the write to succeed, a list of the item's
|
|
28
|
+
* attributes, and a field indicating whether to retrieve the item's attributes if
|
|
29
|
+
* the condition is not met.</p>
|
|
38
30
|
* </li>
|
|
39
31
|
* <li>
|
|
40
|
-
*
|
|
41
|
-
* <code>
|
|
42
|
-
*
|
|
43
|
-
* be
|
|
44
|
-
* expression that must be satisfied for the
|
|
32
|
+
* <p>
|
|
33
|
+
* <code>Update</code> — Initiates an <code>UpdateItem</code>
|
|
34
|
+
* operation to update an existing item. This structure specifies the primary key
|
|
35
|
+
* of the item to be updated, the name of the table where it resides, an optional
|
|
36
|
+
* condition expression that must be satisfied for the update to succeed, an
|
|
37
|
+
* expression that defines one or more attributes to be updated, and a field
|
|
45
38
|
* indicating whether to retrieve the item's attributes if the condition is not
|
|
46
39
|
* met.</p>
|
|
47
40
|
* </li>
|
|
48
41
|
* <li>
|
|
49
|
-
*
|
|
50
|
-
* <code>
|
|
51
|
-
*
|
|
52
|
-
* the item to be
|
|
53
|
-
* expression that must be satisfied for the
|
|
54
|
-
* indicating whether to retrieve the item's attributes if the condition is
|
|
55
|
-
* met.</p>
|
|
42
|
+
* <p>
|
|
43
|
+
* <code>Delete</code> — Initiates a <code>DeleteItem</code>
|
|
44
|
+
* operation to delete an existing item. This structure specifies the primary key
|
|
45
|
+
* of the item to be deleted, the name of the table where it resides, an optional
|
|
46
|
+
* condition expression that must be satisfied for the deletion to succeed, and a
|
|
47
|
+
* field indicating whether to retrieve the item's attributes if the condition is
|
|
48
|
+
* not met.</p>
|
|
49
|
+
* </li>
|
|
50
|
+
* <li>
|
|
51
|
+
* <p>
|
|
52
|
+
* <code>ConditionCheck</code> — Applies a condition to an item
|
|
53
|
+
* that is not being modified by the transaction. This structure specifies the
|
|
54
|
+
* primary key of the item to be checked, the name of the table where it resides, a
|
|
55
|
+
* condition expression that must be satisfied for the transaction to succeed, and
|
|
56
|
+
* a field indicating whether to retrieve the item's attributes if the condition is
|
|
57
|
+
* not met.</p>
|
|
56
58
|
* </li>
|
|
57
59
|
* </ul>
|
|
58
60
|
*
|
|
59
|
-
*
|
|
60
|
-
*
|
|
61
|
+
* <p>DynamoDB rejects the entire <code>TransactWriteItems</code> request if any of the
|
|
62
|
+
* following is true:</p>
|
|
63
|
+
* <ul>
|
|
61
64
|
* <li>
|
|
62
|
-
*
|
|
65
|
+
* <p>A condition in one of the condition expressions is not met.</p>
|
|
63
66
|
* </li>
|
|
64
67
|
* <li>
|
|
65
|
-
*
|
|
66
|
-
* item.</p>
|
|
68
|
+
* <p>An ongoing operation is in the process of updating the same item.</p>
|
|
67
69
|
* </li>
|
|
68
70
|
* <li>
|
|
69
|
-
*
|
|
70
|
-
*
|
|
71
|
+
* <p>There is insufficient provisioned capacity for the transaction to be
|
|
72
|
+
* completed.</p>
|
|
71
73
|
* </li>
|
|
72
74
|
* <li>
|
|
73
|
-
*
|
|
74
|
-
* large, or a similar validation error occurs because of changes
|
|
75
|
-
* transaction.</p>
|
|
75
|
+
* <p>An item size becomes too large (bigger than 400 KB), a local secondary index
|
|
76
|
+
* (LSI) becomes too large, or a similar validation error occurs because of changes
|
|
77
|
+
* made by the transaction.</p>
|
|
76
78
|
* </li>
|
|
77
79
|
* <li>
|
|
78
|
-
*
|
|
80
|
+
* <p>The aggregate size of the items in the transaction exceeds 4 MB.</p>
|
|
79
81
|
* </li>
|
|
80
82
|
* <li>
|
|
81
|
-
*
|
|
83
|
+
* <p>There is a user error, such as an invalid data format.</p>
|
|
82
84
|
* </li>
|
|
83
85
|
* </ul>
|
|
84
86
|
* @example
|
|
@@ -93,7 +95,7 @@ export interface TransactWriteItemsCommandOutput extends TransactWriteItemsOutpu
|
|
|
93
95
|
*
|
|
94
96
|
* @see {@link TransactWriteItemsCommandInput} for command's `input` shape.
|
|
95
97
|
* @see {@link TransactWriteItemsCommandOutput} for command's `response` shape.
|
|
96
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
98
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
97
99
|
*
|
|
98
100
|
*/
|
|
99
101
|
export declare class TransactWriteItemsCommand extends $Command<TransactWriteItemsCommandInput, TransactWriteItemsCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -9,9 +9,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Removes the association of tags from an Amazon DynamoDB resource. You can call
|
|
11
11
|
* <code>UntagResource</code> up to five times per second, per account. </p>
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
* in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
|
12
|
+
* <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>
|
|
13
|
+
* in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
|
15
14
|
* @example
|
|
16
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
16
|
* ```javascript
|
|
@@ -24,7 +23,7 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
|
|
|
24
23
|
*
|
|
25
24
|
* @see {@link UntagResourceCommandInput} for command's `input` shape.
|
|
26
25
|
* @see {@link UntagResourceCommandOutput} for command's `response` shape.
|
|
27
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
26
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
28
27
|
*
|
|
29
28
|
*/
|
|
30
29
|
export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -8,15 +8,15 @@ export interface UpdateContinuousBackupsCommandOutput extends UpdateContinuousBa
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>
|
|
11
|
-
* <code>UpdateContinuousBackups</code> enables or disables point in time recovery for
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
11
|
+
* <code>UpdateContinuousBackups</code> enables or disables point in time recovery for
|
|
12
|
+
* the specified table. A successful <code>UpdateContinuousBackups</code> call returns the
|
|
13
|
+
* current <code>ContinuousBackupsDescription</code>. Continuous backups are
|
|
14
|
+
* <code>ENABLED</code> on all tables at table creation. If point in time recovery is
|
|
15
|
+
* enabled, <code>PointInTimeRecoveryStatus</code> will be set to ENABLED.</p>
|
|
16
|
+
* <p> Once continuous backups and point in time recovery are enabled, you can restore to
|
|
17
|
+
* any point in time within <code>EarliestRestorableDateTime</code> and
|
|
18
|
+
* <code>LatestRestorableDateTime</code>. </p>
|
|
19
|
+
* <p>
|
|
20
20
|
* <code>LatestRestorableDateTime</code> is typically 5 minutes before the current time.
|
|
21
21
|
* You can restore your table to any point in time during the last 35 days. </p>
|
|
22
22
|
* @example
|
|
@@ -31,7 +31,7 @@ export interface UpdateContinuousBackupsCommandOutput extends UpdateContinuousBa
|
|
|
31
31
|
*
|
|
32
32
|
* @see {@link UpdateContinuousBackupsCommandInput} for command's `input` shape.
|
|
33
33
|
* @see {@link UpdateContinuousBackupsCommandOutput} for command's `response` shape.
|
|
34
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
34
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
35
35
|
*
|
|
36
36
|
*/
|
|
37
37
|
export declare class UpdateContinuousBackupsCommand extends $Command<UpdateContinuousBackupsCommandInput, UpdateContinuousBackupsCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -7,7 +7,12 @@ export interface UpdateContributorInsightsCommandInput extends UpdateContributor
|
|
|
7
7
|
export interface UpdateContributorInsightsCommandOutput extends UpdateContributorInsightsOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Updates the status for contributor insights for a specific table or index
|
|
10
|
+
* <p>Updates the status for contributor insights for a specific table or index. CloudWatch
|
|
11
|
+
* Contributor Insights for DynamoDB graphs display the partition key and (if applicable)
|
|
12
|
+
* sort key of frequently accessed items and frequently throttled items in plaintext. If
|
|
13
|
+
* you require the use of AWS Key Management Service (KMS) to encrypt this table’s
|
|
14
|
+
* partition key and sort key data with an AWS managed key or customer managed key, you
|
|
15
|
+
* should not enable CloudWatch Contributor Insights for DynamoDB for this table.</p>
|
|
11
16
|
* @example
|
|
12
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
18
|
* ```javascript
|
|
@@ -20,7 +25,7 @@ export interface UpdateContributorInsightsCommandOutput extends UpdateContributo
|
|
|
20
25
|
*
|
|
21
26
|
* @see {@link UpdateContributorInsightsCommandInput} for command's `input` shape.
|
|
22
27
|
* @see {@link UpdateContributorInsightsCommandOutput} for command's `response` shape.
|
|
23
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
28
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
24
29
|
*
|
|
25
30
|
*/
|
|
26
31
|
export declare class UpdateContributorInsightsCommand extends $Command<UpdateContributorInsightsCommandInput, UpdateContributorInsightsCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -12,28 +12,23 @@ export interface UpdateGlobalTableCommandOutput extends UpdateGlobalTableOutput,
|
|
|
12
12
|
* same name as the global table, have the same key schema, have DynamoDB Streams enabled,
|
|
13
13
|
* and have the same provisioned and maximum write capacity units.</p>
|
|
14
14
|
* <note>
|
|
15
|
-
* <p>Although you can use <code>UpdateGlobalTable</code> to add replicas and remove
|
|
16
|
-
* a single request, for simplicity we recommend that you issue separate
|
|
17
|
-
* adding or removing replicas.</p>
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
* </p>
|
|
15
|
+
* <p>Although you can use <code>UpdateGlobalTable</code> to add replicas and remove
|
|
16
|
+
* replicas in a single request, for simplicity we recommend that you issue separate
|
|
17
|
+
* requests for adding or removing replicas.</p>
|
|
18
|
+
* </note>
|
|
19
|
+
* <p> If global secondary indexes are specified, then the following conditions must also be
|
|
20
|
+
* met: </p>
|
|
22
21
|
* <ul>
|
|
23
22
|
* <li>
|
|
24
|
-
*
|
|
25
|
-
* The global secondary indexes must have the same name.
|
|
26
|
-
* </p>
|
|
23
|
+
* <p> The global secondary indexes must have the same name. </p>
|
|
27
24
|
* </li>
|
|
28
25
|
* <li>
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* </p>
|
|
26
|
+
* <p> The global secondary indexes must have the same hash key and sort key (if
|
|
27
|
+
* present). </p>
|
|
32
28
|
* </li>
|
|
33
29
|
* <li>
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
* </p>
|
|
30
|
+
* <p> The global secondary indexes must have the same provisioned and maximum write
|
|
31
|
+
* capacity units. </p>
|
|
37
32
|
* </li>
|
|
38
33
|
* </ul>
|
|
39
34
|
* @example
|
|
@@ -48,7 +43,7 @@ export interface UpdateGlobalTableCommandOutput extends UpdateGlobalTableOutput,
|
|
|
48
43
|
*
|
|
49
44
|
* @see {@link UpdateGlobalTableCommandInput} for command's `input` shape.
|
|
50
45
|
* @see {@link UpdateGlobalTableCommandOutput} for command's `response` shape.
|
|
51
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
46
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
52
47
|
*
|
|
53
48
|
*/
|
|
54
49
|
export declare class UpdateGlobalTableCommand extends $Command<UpdateGlobalTableCommandInput, UpdateGlobalTableCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -20,7 +20,7 @@ export interface UpdateGlobalTableSettingsCommandOutput extends UpdateGlobalTabl
|
|
|
20
20
|
*
|
|
21
21
|
* @see {@link UpdateGlobalTableSettingsCommandInput} for command's `input` shape.
|
|
22
22
|
* @see {@link UpdateGlobalTableSettingsCommandOutput} for command's `response` shape.
|
|
23
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
23
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
24
24
|
*
|
|
25
25
|
*/
|
|
26
26
|
export declare class UpdateGlobalTableSettingsCommand extends $Command<UpdateGlobalTableSettingsCommandInput, UpdateGlobalTableSettingsCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -7,9 +7,13 @@ export interface UpdateItemCommandInput extends UpdateItemInput {
|
|
|
7
7
|
export interface UpdateItemCommandOutput extends UpdateItemOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Edits an existing item's attributes, or adds a new item to the table if it does not
|
|
11
|
-
*
|
|
12
|
-
*
|
|
10
|
+
* <p>Edits an existing item's attributes, or adds a new item to the table if it does not
|
|
11
|
+
* already exist. You can put, delete, or add attribute values. You can also perform a
|
|
12
|
+
* conditional update on an existing item (insert a new attribute name-value pair if it
|
|
13
|
+
* doesn't exist, or replace an existing name-value pair if it has certain expected
|
|
14
|
+
* attribute values).</p>
|
|
15
|
+
* <p>You can also return the item's attribute values in the same <code>UpdateItem</code>
|
|
16
|
+
* operation using the <code>ReturnValues</code> parameter.</p>
|
|
13
17
|
* @example
|
|
14
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
19
|
* ```javascript
|
|
@@ -22,7 +26,7 @@ export interface UpdateItemCommandOutput extends UpdateItemOutput, __MetadataBea
|
|
|
22
26
|
*
|
|
23
27
|
* @see {@link UpdateItemCommandInput} for command's `input` shape.
|
|
24
28
|
* @see {@link UpdateItemCommandOutput} for command's `response` shape.
|
|
25
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
29
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
26
30
|
*
|
|
27
31
|
*/
|
|
28
32
|
export declare class UpdateItemCommand extends $Command<UpdateItemCommandInput, UpdateItemCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -7,29 +7,31 @@ export interface UpdateTableCommandInput extends UpdateTableInput {
|
|
|
7
7
|
export interface UpdateTableCommandOutput extends UpdateTableOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB
|
|
11
|
-
*
|
|
12
|
-
*
|
|
10
|
+
* <p>Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB
|
|
11
|
+
* Streams settings for a given table.</p>
|
|
12
|
+
* <p>You can only perform one of the following operations at once:</p>
|
|
13
|
+
* <ul>
|
|
13
14
|
* <li>
|
|
14
|
-
*
|
|
15
|
+
* <p>Modify the provisioned throughput settings of the table.</p>
|
|
15
16
|
* </li>
|
|
16
17
|
* <li>
|
|
17
|
-
*
|
|
18
|
+
* <p>Enable or disable DynamoDB Streams on the table.</p>
|
|
18
19
|
* </li>
|
|
19
20
|
* <li>
|
|
20
|
-
*
|
|
21
|
+
* <p>Remove a global secondary index from the table.</p>
|
|
21
22
|
* </li>
|
|
22
23
|
* <li>
|
|
23
|
-
*
|
|
24
|
+
* <p>Create a new global secondary index on the table. After the index begins
|
|
24
25
|
* backfilling, you can use <code>UpdateTable</code> to perform other
|
|
25
26
|
* operations.</p>
|
|
26
27
|
* </li>
|
|
27
28
|
* </ul>
|
|
28
|
-
*
|
|
29
|
-
* <code>UpdateTable</code> is an asynchronous operation; while it is executing, the table
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
29
|
+
* <p>
|
|
30
|
+
* <code>UpdateTable</code> is an asynchronous operation; while it is executing, the table
|
|
31
|
+
* status changes from <code>ACTIVE</code> to <code>UPDATING</code>. While it is
|
|
32
|
+
* <code>UPDATING</code>, you cannot issue another <code>UpdateTable</code> request.
|
|
33
|
+
* When the table returns to the <code>ACTIVE</code> state, the <code>UpdateTable</code>
|
|
34
|
+
* operation is complete.</p>
|
|
33
35
|
* @example
|
|
34
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
37
|
* ```javascript
|
|
@@ -42,7 +44,7 @@ export interface UpdateTableCommandOutput extends UpdateTableOutput, __MetadataB
|
|
|
42
44
|
*
|
|
43
45
|
* @see {@link UpdateTableCommandInput} for command's `input` shape.
|
|
44
46
|
* @see {@link UpdateTableCommandOutput} for command's `response` shape.
|
|
45
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
47
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
46
48
|
*
|
|
47
49
|
*/
|
|
48
50
|
export declare class UpdateTableCommand extends $Command<UpdateTableCommandInput, UpdateTableCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -8,9 +8,10 @@ export interface UpdateTableReplicaAutoScalingCommandOutput extends UpdateTableR
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Updates auto scaling settings on your global tables at once.</p>
|
|
11
|
-
*
|
|
12
|
-
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version
|
|
13
|
-
*
|
|
11
|
+
* <note>
|
|
12
|
+
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version
|
|
13
|
+
* 2019.11.21</a> of global tables.</p>
|
|
14
|
+
* </note>
|
|
14
15
|
* @example
|
|
15
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
17
|
* ```javascript
|
|
@@ -23,7 +24,7 @@ export interface UpdateTableReplicaAutoScalingCommandOutput extends UpdateTableR
|
|
|
23
24
|
*
|
|
24
25
|
* @see {@link UpdateTableReplicaAutoScalingCommandInput} for command's `input` shape.
|
|
25
26
|
* @see {@link UpdateTableReplicaAutoScalingCommandOutput} for command's `response` shape.
|
|
26
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
27
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
27
28
|
*
|
|
28
29
|
*/
|
|
29
30
|
export declare class UpdateTableReplicaAutoScalingCommand extends $Command<UpdateTableReplicaAutoScalingCommandInput, UpdateTableReplicaAutoScalingCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -7,31 +7,31 @@ export interface UpdateTimeToLiveCommandInput extends UpdateTimeToLiveInput {
|
|
|
7
7
|
export interface UpdateTimeToLiveCommandOutput extends UpdateTimeToLiveOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>The <code>UpdateTimeToLive</code> method enables or disables Time to Live (TTL) for
|
|
11
|
-
* specified table. A successful <code>UpdateTimeToLive</code> call returns the current
|
|
10
|
+
* <p>The <code>UpdateTimeToLive</code> method enables or disables Time to Live (TTL) for
|
|
11
|
+
* the specified table. A successful <code>UpdateTimeToLive</code> call returns the current
|
|
12
12
|
* <code>TimeToLiveSpecification</code>. It can take up to one hour for the change to
|
|
13
13
|
* fully process. Any additional <code>UpdateTimeToLive</code> calls for the same table
|
|
14
14
|
* during this one hour duration result in a <code>ValidationException</code>. </p>
|
|
15
|
-
*
|
|
15
|
+
* <p>TTL compares the current time in epoch time format to the time stored in the TTL
|
|
16
16
|
* attribute of an item. If the epoch time value stored in the attribute is less than the
|
|
17
17
|
* current time, the item is marked as expired and subsequently deleted.</p>
|
|
18
18
|
* <note>
|
|
19
|
-
* <p> The epoch time format is the number of seconds elapsed since 12:00:00 AM January
|
|
20
|
-
* 1970 UTC. </p>
|
|
19
|
+
* <p> The epoch time format is the number of seconds elapsed since 12:00:00 AM January
|
|
20
|
+
* 1, 1970 UTC. </p>
|
|
21
21
|
* </note>
|
|
22
22
|
* <p>DynamoDB deletes expired items on a best-effort basis to ensure availability of
|
|
23
|
-
* throughput for other data operations.
|
|
24
|
-
*
|
|
25
|
-
* <
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
* </important>
|
|
23
|
+
* throughput for other data operations. </p>
|
|
24
|
+
* <important>
|
|
25
|
+
* <p>DynamoDB typically deletes expired items within two days of expiration. The exact
|
|
26
|
+
* duration within which an item gets deleted after expiration is specific to the
|
|
27
|
+
* nature of the workload. Items that have expired and not been deleted will still show
|
|
28
|
+
* up in reads, queries, and scans.</p>
|
|
29
|
+
* </important>
|
|
31
30
|
* <p>As items are deleted, they are removed from any local secondary index and global
|
|
32
31
|
* secondary index immediately in the same eventually consistent way as a standard delete
|
|
33
32
|
* operation.</p>
|
|
34
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html">Time To Live</a> in the
|
|
33
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html">Time To Live</a> in the
|
|
34
|
+
* Amazon DynamoDB Developer Guide. </p>
|
|
35
35
|
* @example
|
|
36
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
37
|
* ```javascript
|
|
@@ -44,7 +44,7 @@ export interface UpdateTimeToLiveCommandOutput extends UpdateTimeToLiveOutput, _
|
|
|
44
44
|
*
|
|
45
45
|
* @see {@link UpdateTimeToLiveCommandInput} for command's `input` shape.
|
|
46
46
|
* @see {@link UpdateTimeToLiveCommandOutput} for command's `response` shape.
|
|
47
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
47
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
48
48
|
*
|
|
49
49
|
*/
|
|
50
50
|
export declare class UpdateTimeToLiveCommand extends $Command<UpdateTimeToLiveCommandInput, UpdateTimeToLiveCommandOutput, DynamoDBClientResolvedConfig> {
|