@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
|
@@ -8,9 +8,10 @@ export interface ListGlobalTablesCommandOutput extends ListGlobalTablesOutput, _
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Lists all global tables that have a replica in the specified Region.</p>
|
|
11
|
-
*
|
|
12
|
-
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
|
|
13
|
-
*
|
|
11
|
+
* <note>
|
|
12
|
+
* <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
|
|
13
|
+
* 2017.11.29</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 ListGlobalTablesCommandOutput extends ListGlobalTablesOutput, _
|
|
|
23
24
|
*
|
|
24
25
|
* @see {@link ListGlobalTablesCommandInput} for command's `input` shape.
|
|
25
26
|
* @see {@link ListGlobalTablesCommandOutput} 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 ListGlobalTablesCommand extends $Command<ListGlobalTablesCommandInput, ListGlobalTablesCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -7,9 +7,9 @@ export interface ListTablesCommandInput extends ListTablesInput {
|
|
|
7
7
|
export interface ListTablesCommandOutput extends ListTablesOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Returns an array of table names associated with the current account and endpoint. The
|
|
11
|
-
*
|
|
12
|
-
*
|
|
10
|
+
* <p>Returns an array of table names associated with the current account and endpoint. The
|
|
11
|
+
* output from <code>ListTables</code> is paginated, with each page returning a maximum of
|
|
12
|
+
* 100 table names.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -22,7 +22,7 @@ export interface ListTablesCommandOutput extends ListTablesOutput, __MetadataBea
|
|
|
22
22
|
*
|
|
23
23
|
* @see {@link ListTablesCommandInput} for command's `input` shape.
|
|
24
24
|
* @see {@link ListTablesCommandOutput} for command's `response` shape.
|
|
25
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
25
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
26
26
|
*
|
|
27
27
|
*/
|
|
28
28
|
export declare class ListTablesCommand extends $Command<ListTablesCommandInput, ListTablesCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -7,10 +7,10 @@ export interface ListTagsOfResourceCommandInput extends ListTagsOfResourceInput
|
|
|
7
7
|
export interface ListTagsOfResourceCommandOutput extends ListTagsOfResourceOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
10
|
+
* <p>List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10
|
|
11
|
+
* times per second, per account.</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>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
16
|
* ```javascript
|
|
@@ -23,7 +23,7 @@ export interface ListTagsOfResourceCommandOutput extends ListTagsOfResourceOutpu
|
|
|
23
23
|
*
|
|
24
24
|
* @see {@link ListTagsOfResourceCommandInput} for command's `input` shape.
|
|
25
25
|
* @see {@link ListTagsOfResourceCommandOutput} for command's `response` shape.
|
|
26
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
26
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
27
27
|
*
|
|
28
28
|
*/
|
|
29
29
|
export declare class ListTagsOfResourceCommand extends $Command<ListTagsOfResourceCommandInput, ListTagsOfResourceCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -7,74 +7,81 @@ export interface PutItemCommandInput extends PutItemInput {
|
|
|
7
7
|
export interface PutItemCommandOutput extends PutItemOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a new item, or replaces an old item with a new item. If an item that has the
|
|
11
|
-
*
|
|
10
|
+
* <p>Creates a new item, or replaces an old item with a new item. If an item that has the
|
|
11
|
+
* same primary key as the new item already exists in the specified table, the new item
|
|
12
|
+
* completely replaces the existing item. You can perform a conditional put operation (add
|
|
13
|
+
* a new item if one with the specified primary key doesn't exist), or replace an existing
|
|
14
|
+
* item if it has certain attribute values. You can return the item's attribute values in
|
|
15
|
+
* the same operation, using the <code>ReturnValues</code> parameter.</p>
|
|
16
|
+
* <important>
|
|
12
17
|
* <p>This topic provides general information about the <code>PutItem</code> API.</p>
|
|
13
|
-
* <p>For information on how to call the <code>PutItem</code> API using the
|
|
18
|
+
* <p>For information on how to call the <code>PutItem</code> API using the Amazon Web Services SDK in specific languages, see the following:</p>
|
|
14
19
|
* <ul>
|
|
15
20
|
* <li>
|
|
16
|
-
*
|
|
17
|
-
* <a href="http://docs.aws.amazon.com/goto/aws-cli/dynamodb-2012-08-10/PutItem"> PutItem in the
|
|
21
|
+
* <p>
|
|
22
|
+
* <a href="http://docs.aws.amazon.com/goto/aws-cli/dynamodb-2012-08-10/PutItem"> PutItem in the Command Line Interface</a>
|
|
18
23
|
* </p>
|
|
19
|
-
*
|
|
24
|
+
* </li>
|
|
20
25
|
* <li>
|
|
21
|
-
*
|
|
22
|
-
* <a href="http://docs.aws.amazon.com/goto/DotNetSDKV3/dynamodb-2012-08-10/PutItem"> PutItem in the
|
|
26
|
+
* <p>
|
|
27
|
+
* <a href="http://docs.aws.amazon.com/goto/DotNetSDKV3/dynamodb-2012-08-10/PutItem"> PutItem in the SDK for .NET</a>
|
|
23
28
|
* </p>
|
|
24
|
-
*
|
|
29
|
+
* </li>
|
|
25
30
|
* <li>
|
|
26
|
-
*
|
|
27
|
-
* <a href="http://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/PutItem"> PutItem in the
|
|
31
|
+
* <p>
|
|
32
|
+
* <a href="http://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/PutItem"> PutItem in the SDK for C++</a>
|
|
28
33
|
* </p>
|
|
29
|
-
*
|
|
34
|
+
* </li>
|
|
30
35
|
* <li>
|
|
31
|
-
*
|
|
32
|
-
* <a href="http://docs.aws.amazon.com/goto/SdkForGoV1/dynamodb-2012-08-10/PutItem"> PutItem in the
|
|
36
|
+
* <p>
|
|
37
|
+
* <a href="http://docs.aws.amazon.com/goto/SdkForGoV1/dynamodb-2012-08-10/PutItem"> PutItem in the SDK for Go</a>
|
|
33
38
|
* </p>
|
|
34
|
-
*
|
|
39
|
+
* </li>
|
|
35
40
|
* <li>
|
|
36
|
-
*
|
|
37
|
-
* <a href="http://docs.aws.amazon.com/goto/SdkForJava/dynamodb-2012-08-10/PutItem"> PutItem in the
|
|
41
|
+
* <p>
|
|
42
|
+
* <a href="http://docs.aws.amazon.com/goto/SdkForJava/dynamodb-2012-08-10/PutItem"> PutItem in the SDK for Java</a>
|
|
38
43
|
* </p>
|
|
39
|
-
*
|
|
44
|
+
* </li>
|
|
40
45
|
* <li>
|
|
41
|
-
*
|
|
42
|
-
* <a href="http://docs.aws.amazon.com/goto/AWSJavaScriptSDK/dynamodb-2012-08-10/PutItem"> PutItem in the
|
|
46
|
+
* <p>
|
|
47
|
+
* <a href="http://docs.aws.amazon.com/goto/AWSJavaScriptSDK/dynamodb-2012-08-10/PutItem"> PutItem in the SDK for JavaScript</a>
|
|
43
48
|
* </p>
|
|
44
|
-
*
|
|
49
|
+
* </li>
|
|
45
50
|
* <li>
|
|
46
|
-
*
|
|
47
|
-
* <a href="http://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/PutItem"> PutItem in the
|
|
51
|
+
* <p>
|
|
52
|
+
* <a href="http://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/PutItem"> PutItem in the SDK for PHP V3</a>
|
|
48
53
|
* </p>
|
|
49
|
-
*
|
|
54
|
+
* </li>
|
|
50
55
|
* <li>
|
|
51
|
-
*
|
|
56
|
+
* <p>
|
|
52
57
|
* <a href="http://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/PutItem">
|
|
53
|
-
* PutItem in the
|
|
58
|
+
* PutItem in the SDK for Python (Boto)</a>
|
|
54
59
|
* </p>
|
|
55
|
-
*
|
|
60
|
+
* </li>
|
|
56
61
|
* <li>
|
|
57
|
-
*
|
|
58
|
-
* <a href="http://docs.aws.amazon.com/goto/SdkForRubyV2/dynamodb-2012-08-10/PutItem"> PutItem in the
|
|
62
|
+
* <p>
|
|
63
|
+
* <a href="http://docs.aws.amazon.com/goto/SdkForRubyV2/dynamodb-2012-08-10/PutItem"> PutItem in the SDK for Ruby V2</a>
|
|
59
64
|
* </p>
|
|
60
|
-
*
|
|
65
|
+
* </li>
|
|
61
66
|
* </ul>
|
|
62
|
-
*
|
|
67
|
+
* </important>
|
|
63
68
|
*
|
|
64
|
-
*
|
|
69
|
+
* <p>When you add an item, the primary key attributes are the only required attributes.
|
|
65
70
|
* Attribute values cannot be null.</p>
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
*
|
|
70
|
-
*
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
*
|
|
74
|
-
*
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
*
|
|
71
|
+
* <p>Empty String and Binary attribute values are allowed. Attribute values of type String
|
|
72
|
+
* and Binary must have a length greater than zero if the attribute is used as a key
|
|
73
|
+
* attribute for a table or index. Set type attributes cannot be empty. </p>
|
|
74
|
+
* <p>Invalid Requests with empty values will be rejected with a
|
|
75
|
+
* <code>ValidationException</code> exception.</p>
|
|
76
|
+
* <note>
|
|
77
|
+
* <p>To prevent a new item from replacing an existing item, use a conditional
|
|
78
|
+
* expression that contains the <code>attribute_not_exists</code> function with the
|
|
79
|
+
* name of the attribute being used as the partition key for the table. Since every
|
|
80
|
+
* record must contain that attribute, the <code>attribute_not_exists</code> function
|
|
81
|
+
* will only succeed if no matching item exists.</p>
|
|
82
|
+
* </note>
|
|
83
|
+
* <p>For more information about <code>PutItem</code>, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html">Working with
|
|
84
|
+
* Items</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
|
78
85
|
* @example
|
|
79
86
|
* Use a bare-bones client and the command you need to make an API call.
|
|
80
87
|
* ```javascript
|
|
@@ -87,7 +94,7 @@ export interface PutItemCommandOutput extends PutItemOutput, __MetadataBearer {
|
|
|
87
94
|
*
|
|
88
95
|
* @see {@link PutItemCommandInput} for command's `input` shape.
|
|
89
96
|
* @see {@link PutItemCommandOutput} for command's `response` shape.
|
|
90
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
97
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
91
98
|
*
|
|
92
99
|
*/
|
|
93
100
|
export declare class PutItemCommand extends $Command<PutItemCommandInput, PutItemCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -7,62 +7,58 @@ export interface QueryCommandInput extends QueryInput {
|
|
|
7
7
|
export interface QueryCommandOutput extends QueryOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
11
|
-
*
|
|
12
|
-
* key and a
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
10
|
+
* <p>You must provide the name of the partition key attribute and a single value for that
|
|
11
|
+
* attribute. <code>Query</code> returns all items with that partition key value.
|
|
12
|
+
* Optionally, you can provide a sort key attribute and use a comparison operator to refine
|
|
13
|
+
* the search results.</p>
|
|
14
|
+
*
|
|
15
|
+
* <p>Use the <code>KeyConditionExpression</code> parameter to provide a specific value for
|
|
16
|
+
* the partition key. The <code>Query</code> operation will return all of the items from
|
|
17
|
+
* the table or index with that partition key value. You can optionally narrow the scope of
|
|
18
|
+
* the <code>Query</code> operation by specifying a sort key value and a comparison
|
|
19
|
+
* operator in <code>KeyConditionExpression</code>. To further refine the
|
|
20
|
+
* <code>Query</code> results, you can optionally provide a
|
|
21
|
+
* <code>FilterExpression</code>. A <code>FilterExpression</code> determines which
|
|
22
|
+
* items within the results should be returned to you. All of the other results are
|
|
23
|
+
* discarded. </p>
|
|
24
|
+
* <p> A <code>Query</code> operation always returns a result set. If no matching items are
|
|
25
|
+
* found, the result set will be empty. Queries that do not return results consume the
|
|
26
|
+
* minimum number of read capacity units for that type of read operation. </p>
|
|
27
27
|
* <note>
|
|
28
|
-
* <p>
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* whether or not you use a <code>FilterExpression</code>.
|
|
28
|
+
* <p> DynamoDB calculates the number of read capacity units consumed based on item
|
|
29
|
+
* size, not on the amount of data that is returned to an application. The number of
|
|
30
|
+
* capacity units consumed will be the same whether you request all of the attributes
|
|
31
|
+
* (the default behavior) or just some of them (using a projection expression). The
|
|
32
|
+
* number will also be the same whether or not you use a <code>FilterExpression</code>.
|
|
34
33
|
* </p>
|
|
35
34
|
* </note>
|
|
36
35
|
* <p>
|
|
37
|
-
* <code>Query</code> results are always sorted by the sort key value. If the data type of
|
|
38
|
-
* the
|
|
39
|
-
*
|
|
40
|
-
* to false.
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
* apply any filtering to the results using <code>FilterExpression</code>. If
|
|
36
|
+
* <code>Query</code> results are always sorted by the sort key value. If the data type of
|
|
37
|
+
* the sort key is Number, the results are returned in numeric order; otherwise, the
|
|
38
|
+
* results are returned in order of UTF-8 bytes. By default, the sort order is ascending.
|
|
39
|
+
* To reverse the order, set the <code>ScanIndexForward</code> parameter to false. </p>
|
|
40
|
+
* <p> A single <code>Query</code> operation will read up to the maximum number of items set
|
|
41
|
+
* (if using the <code>Limit</code> parameter) or a maximum of 1 MB of data and then apply
|
|
42
|
+
* any filtering to the results using <code>FilterExpression</code>. If
|
|
45
43
|
* <code>LastEvaluatedKey</code> is present in the response, you will need to paginate
|
|
46
44
|
* the result set. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.Pagination">Paginating
|
|
47
45
|
* the Results</a> in the <i>Amazon DynamoDB Developer Guide</i>. </p>
|
|
48
46
|
* <p>
|
|
49
47
|
* <code>FilterExpression</code> is applied after a <code>Query</code> finishes, but before
|
|
50
|
-
* the results are returned.
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
* </p>
|
|
48
|
+
* the results are returned. A <code>FilterExpression</code> cannot contain partition key
|
|
49
|
+
* or sort key attributes. You need to specify those attributes in the
|
|
50
|
+
* <code>KeyConditionExpression</code>. </p>
|
|
54
51
|
* <note>
|
|
55
|
-
* <p>
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
* </p>
|
|
52
|
+
* <p> A <code>Query</code> operation can return an empty result set and a
|
|
53
|
+
* <code>LastEvaluatedKey</code> if all the items read for the page of results are
|
|
54
|
+
* filtered out. </p>
|
|
59
55
|
* </note>
|
|
60
56
|
* <p>You can query a table, a local secondary index, or a global secondary index. For a
|
|
61
57
|
* query on a table or on a local secondary index, you can set the
|
|
62
|
-
* <code>ConsistentRead</code> parameter to <code>true</code> and obtain a
|
|
63
|
-
*
|
|
64
|
-
*
|
|
65
|
-
*
|
|
58
|
+
* <code>ConsistentRead</code> parameter to <code>true</code> and obtain a strongly
|
|
59
|
+
* consistent result. Global secondary indexes support eventually consistent reads only, so
|
|
60
|
+
* do not specify <code>ConsistentRead</code> when querying a global secondary
|
|
61
|
+
* index.</p>
|
|
66
62
|
* @example
|
|
67
63
|
* Use a bare-bones client and the command you need to make an API call.
|
|
68
64
|
* ```javascript
|
|
@@ -75,7 +71,7 @@ export interface QueryCommandOutput extends QueryOutput, __MetadataBearer {
|
|
|
75
71
|
*
|
|
76
72
|
* @see {@link QueryCommandInput} for command's `input` shape.
|
|
77
73
|
* @see {@link QueryCommandOutput} for command's `response` shape.
|
|
78
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
74
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
79
75
|
*
|
|
80
76
|
*/
|
|
81
77
|
export declare class QueryCommand extends $Command<QueryCommandInput, QueryCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -7,30 +7,30 @@ export interface RestoreTableFromBackupCommandInput extends RestoreTableFromBack
|
|
|
7
7
|
export interface RestoreTableFromBackupCommandOutput extends RestoreTableFromBackupOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a new table from an existing backup. Any number of users can execute up to 4
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
10
|
+
* <p>Creates a new table from an existing backup. Any number of users can execute up to 4
|
|
11
|
+
* concurrent restores (any type of restore) in a given account. </p>
|
|
12
|
+
* <p>You can call <code>RestoreTableFromBackup</code> at a maximum rate of 10 times per
|
|
13
|
+
* second.</p>
|
|
14
|
+
* <p>You must manually set up the following on the restored table:</p>
|
|
15
|
+
* <ul>
|
|
16
16
|
* <li>
|
|
17
|
-
*
|
|
18
|
-
*
|
|
17
|
+
* <p>Auto scaling policies</p>
|
|
18
|
+
* </li>
|
|
19
19
|
* <li>
|
|
20
|
-
*
|
|
21
|
-
*
|
|
20
|
+
* <p>IAM policies</p>
|
|
21
|
+
* </li>
|
|
22
22
|
* <li>
|
|
23
|
-
*
|
|
24
|
-
*
|
|
23
|
+
* <p>Amazon CloudWatch metrics and alarms</p>
|
|
24
|
+
* </li>
|
|
25
25
|
* <li>
|
|
26
|
-
*
|
|
27
|
-
*
|
|
26
|
+
* <p>Tags</p>
|
|
27
|
+
* </li>
|
|
28
28
|
* <li>
|
|
29
|
-
*
|
|
30
|
-
*
|
|
29
|
+
* <p>Stream settings</p>
|
|
30
|
+
* </li>
|
|
31
31
|
* <li>
|
|
32
|
-
*
|
|
33
|
-
*
|
|
32
|
+
* <p>Time to Live (TTL) settings</p>
|
|
33
|
+
* </li>
|
|
34
34
|
* </ul>
|
|
35
35
|
* @example
|
|
36
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -44,7 +44,7 @@ export interface RestoreTableFromBackupCommandOutput extends RestoreTableFromBac
|
|
|
44
44
|
*
|
|
45
45
|
* @see {@link RestoreTableFromBackupCommandInput} for command's `input` shape.
|
|
46
46
|
* @see {@link RestoreTableFromBackupCommandOutput} 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 RestoreTableFromBackupCommand extends $Command<RestoreTableFromBackupCommandInput, RestoreTableFromBackupCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -8,60 +8,55 @@ export interface RestoreTableToPointInTimeCommandOutput extends RestoreTableToPo
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Restores the specified table to the specified point in time within
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
* </p>
|
|
19
|
-
* <p>
|
|
20
|
-
* Along with data, the following are also included on the new restored table using point in time recovery:
|
|
21
|
-
* </p>
|
|
11
|
+
* <code>EarliestRestorableDateTime</code> and <code>LatestRestorableDateTime</code>.
|
|
12
|
+
* You can restore your table to any point in time during the last 35 days. Any number of
|
|
13
|
+
* users can execute up to 4 concurrent restores (any type of restore) in a given account. </p>
|
|
14
|
+
* <p> When you restore using point in time recovery, DynamoDB restores your table data to
|
|
15
|
+
* the state based on the selected date and time (day:hour:minute:second) to a new table. </p>
|
|
16
|
+
* <p> Along with data, the following are also included on the new restored table using
|
|
17
|
+
* point in time recovery: </p>
|
|
22
18
|
* <ul>
|
|
23
19
|
* <li>
|
|
24
|
-
*
|
|
25
|
-
*
|
|
20
|
+
* <p>Global secondary indexes (GSIs)</p>
|
|
21
|
+
* </li>
|
|
26
22
|
* <li>
|
|
27
|
-
*
|
|
28
|
-
*
|
|
23
|
+
* <p>Local secondary indexes (LSIs)</p>
|
|
24
|
+
* </li>
|
|
29
25
|
* <li>
|
|
30
|
-
*
|
|
31
|
-
*
|
|
26
|
+
* <p>Provisioned read and write capacity</p>
|
|
27
|
+
* </li>
|
|
32
28
|
* <li>
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
* </li>
|
|
29
|
+
* <p>Encryption settings</p>
|
|
30
|
+
* <important>
|
|
31
|
+
* <p> All these settings come from the current settings of the source table at
|
|
32
|
+
* the time of restore. </p>
|
|
33
|
+
* </important>
|
|
34
|
+
* </li>
|
|
40
35
|
* </ul>
|
|
41
36
|
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
37
|
+
* <p>You must manually set up the following on the restored table:</p>
|
|
38
|
+
* <ul>
|
|
44
39
|
* <li>
|
|
45
|
-
*
|
|
46
|
-
*
|
|
40
|
+
* <p>Auto scaling policies</p>
|
|
41
|
+
* </li>
|
|
47
42
|
* <li>
|
|
48
|
-
*
|
|
49
|
-
*
|
|
43
|
+
* <p>IAM policies</p>
|
|
44
|
+
* </li>
|
|
50
45
|
* <li>
|
|
51
|
-
*
|
|
52
|
-
*
|
|
46
|
+
* <p>Amazon CloudWatch metrics and alarms</p>
|
|
47
|
+
* </li>
|
|
53
48
|
* <li>
|
|
54
|
-
*
|
|
55
|
-
*
|
|
49
|
+
* <p>Tags</p>
|
|
50
|
+
* </li>
|
|
56
51
|
* <li>
|
|
57
|
-
*
|
|
58
|
-
*
|
|
52
|
+
* <p>Stream settings</p>
|
|
53
|
+
* </li>
|
|
59
54
|
* <li>
|
|
60
|
-
*
|
|
61
|
-
*
|
|
55
|
+
* <p>Time to Live (TTL) settings</p>
|
|
56
|
+
* </li>
|
|
62
57
|
* <li>
|
|
63
|
-
*
|
|
64
|
-
*
|
|
58
|
+
* <p>Point in time recovery settings</p>
|
|
59
|
+
* </li>
|
|
65
60
|
* </ul>
|
|
66
61
|
* @example
|
|
67
62
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -75,7 +70,7 @@ export interface RestoreTableToPointInTimeCommandOutput extends RestoreTableToPo
|
|
|
75
70
|
*
|
|
76
71
|
* @see {@link RestoreTableToPointInTimeCommandInput} for command's `input` shape.
|
|
77
72
|
* @see {@link RestoreTableToPointInTimeCommandOutput} for command's `response` shape.
|
|
78
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
73
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
79
74
|
*
|
|
80
75
|
*/
|
|
81
76
|
export declare class RestoreTableToPointInTimeCommand extends $Command<RestoreTableToPointInTimeCommandInput, RestoreTableToPointInTimeCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -7,31 +7,32 @@ export interface ScanCommandInput extends ScanInput {
|
|
|
7
7
|
export interface ScanCommandOutput extends ScanOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>The <code>Scan</code> operation returns one or more items and item attributes by
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
10
|
+
* <p>The <code>Scan</code> operation returns one or more items and item attributes by
|
|
11
|
+
* accessing every item in a table or a secondary index. To have DynamoDB return fewer
|
|
12
|
+
* items, you can provide a <code>FilterExpression</code> operation.</p>
|
|
13
|
+
* <p>If the total number of scanned items exceeds the maximum dataset size limit of 1 MB,
|
|
14
|
+
* the scan stops and results are returned to the user as a <code>LastEvaluatedKey</code>
|
|
15
|
+
* value to continue the scan in a subsequent operation. The results also include the
|
|
16
|
+
* number of items exceeding the limit. A scan can result in no table data meeting the
|
|
17
|
+
* filter criteria. </p>
|
|
18
|
+
* <p>A single <code>Scan</code> operation reads up to the maximum number of items set (if
|
|
18
19
|
* using the <code>Limit</code> parameter) or a maximum of 1 MB of data and then apply any
|
|
19
20
|
* filtering to the results using <code>FilterExpression</code>. If
|
|
20
21
|
* <code>LastEvaluatedKey</code> is present in the response, you need to paginate the
|
|
21
22
|
* result set. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Pagination">Paginating the
|
|
22
23
|
* Results</a> in the <i>Amazon DynamoDB Developer Guide</i>. </p>
|
|
23
|
-
*
|
|
24
|
+
* <p>
|
|
24
25
|
* <code>Scan</code> operations proceed sequentially; however, for faster performance on
|
|
25
26
|
* a large table or secondary index, applications can request a parallel <code>Scan</code>
|
|
26
27
|
* operation by providing the <code>Segment</code> and <code>TotalSegments</code>
|
|
27
28
|
* parameters. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.ParallelScan">Parallel
|
|
28
29
|
* Scan</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
|
29
|
-
*
|
|
30
|
-
* <code>Scan</code> uses eventually consistent reads when accessing the data in a
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
30
|
+
* <p>
|
|
31
|
+
* <code>Scan</code> uses eventually consistent reads when accessing the data in a table;
|
|
32
|
+
* therefore, the result set might not include the changes to data in the table immediately
|
|
33
|
+
* before the operation began. If you need a consistent copy of the data, as of the time
|
|
34
|
+
* that the <code>Scan</code> begins, you can set the <code>ConsistentRead</code> parameter
|
|
35
|
+
* to <code>true</code>.</p>
|
|
35
36
|
* @example
|
|
36
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
38
|
* ```javascript
|
|
@@ -44,7 +45,7 @@ export interface ScanCommandOutput extends ScanOutput, __MetadataBearer {
|
|
|
44
45
|
*
|
|
45
46
|
* @see {@link ScanCommandInput} for command's `input` shape.
|
|
46
47
|
* @see {@link ScanCommandOutput} for command's `response` shape.
|
|
47
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
48
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
48
49
|
*
|
|
49
50
|
*/
|
|
50
51
|
export declare class ScanCommand extends $Command<ScanCommandInput, ScanCommandOutput, DynamoDBClientResolvedConfig> {
|
|
@@ -11,9 +11,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
|
|
|
11
11
|
* user-defined tags so that they appear on the Billing and Cost Management console for
|
|
12
12
|
* cost allocation tracking. You can call TagResource up to five times per second, per
|
|
13
13
|
* account. </p>
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
* in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
|
14
|
+
* <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>
|
|
15
|
+
* in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
|
17
16
|
* @example
|
|
18
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
19
18
|
* ```javascript
|
|
@@ -26,7 +25,7 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
|
|
|
26
25
|
*
|
|
27
26
|
* @see {@link TagResourceCommandInput} for command's `input` shape.
|
|
28
27
|
* @see {@link TagResourceCommandOutput} for command's `response` shape.
|
|
29
|
-
* @see {@link DynamoDBClientResolvedConfig | config} for
|
|
28
|
+
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
|
|
30
29
|
*
|
|
31
30
|
*/
|
|
32
31
|
export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, DynamoDBClientResolvedConfig> {
|