@aws-sdk/client-dynamodb 3.370.0 → 3.378.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.
Files changed (5) hide show
  1. package/dist-types/commands/BatchWriteItemCommand.d.ts +4 -4
  2. package/dist-types/commands/PutItemCommand.d.ts +2 -1
  3. package/dist-types/commands/ScanCommand.d.ts +33 -17
  4. package/dist-types/models/models_0.d.ts +5 -4
  5. package/package.json +37 -37
package/dist-types/commands/BatchWriteItemCommand.d.ts CHANGED
@@ -31,10 +31,10 @@ export interface BatchWriteItemCommandOutput extends BatchWriteItemOutput, __Met
31
31
  * for the API call. For more details on this distinction, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html">Naming Rules and Data Types</a>.</p>
32
32
  * <note>
33
33
  * <p>
34
- * <code>BatchWriteItem</code> cannot update items. If you perform a
35
- * <code>BatchWriteItem</code> operation on an existing item, that item's values
36
- * will be overwritten by the operation and it will appear like it was updated. To
37
- * update items, we recommend you use the <code>UpdateItem</code> action.</p>
34
+ * <code>BatchWriteItem</code> cannot update items. If you perform a <code>BatchWriteItem</code>
35
+ * operation on an existing item, that item's values will be overwritten by the
36
+ * operation and it will appear like it was updated. To update items, we recommend you
37
+ * use the <code>UpdateItem</code> action.</p>
38
38
  * </note>
39
39
  * <p>The individual <code>PutItem</code> and <code>DeleteItem</code> operations specified
40
40
  * in <code>BatchWriteItem</code> are atomic; however <code>BatchWriteItem</code> as a
package/dist-types/commands/PutItemCommand.d.ts CHANGED
@@ -29,7 +29,8 @@ export interface PutItemCommandOutput extends PutItemOutput, __MetadataBearer {
29
29
  * a new item if one with the specified primary key doesn't exist), or replace an existing
30
30
  * item if it has certain attribute values. You can return the item's attribute values in
31
31
  * the same operation, using the <code>ReturnValues</code> parameter.</p>
32
- * <p>When you add an item, the primary key attributes are the only required attributes. </p>
32
+ * <p>When you add an item, the primary key attributes are the only required attributes.
33
+ * </p>
33
34
  * <p>Empty String and Binary attribute values are allowed. Attribute values of type String
34
35
  * and Binary must have a length greater than zero if the attribute is used as a key
35
36
  * attribute for a table or index. Set type attributes cannot be empty. </p>
package/dist-types/commands/ScanCommand.d.ts CHANGED
@@ -26,29 +26,45 @@ export interface ScanCommandOutput extends ScanOutput, __MetadataBearer {
26
26
  * <p>The <code>Scan</code> operation returns one or more items and item attributes by
27
27
  * accessing every item in a table or a secondary index. To have DynamoDB return fewer
28
28
  * items, you can provide a <code>FilterExpression</code> operation.</p>
29
- * <p>If the total number of scanned items exceeds the maximum dataset size limit of 1 MB,
30
- * the scan stops and results are returned to the user as a <code>LastEvaluatedKey</code>
31
- * value to continue the scan in a subsequent operation. The results also include the
32
- * number of items exceeding the limit. A scan can result in no table data meeting the
33
- * filter criteria. </p>
34
- * <p>A single <code>Scan</code> operation reads up to the maximum number of items set (if
35
- * using the <code>Limit</code> parameter) or a maximum of 1 MB of data and then apply any
36
- * filtering to the results using <code>FilterExpression</code>. If
37
- * <code>LastEvaluatedKey</code> is present in the response, you need to paginate the
38
- * result set. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Pagination">Paginating the
39
- * Results</a> in the <i>Amazon DynamoDB Developer Guide</i>. </p>
29
+ * <p>If the total size of scanned items exceeds the maximum dataset size limit of 1 MB,
30
+ * the scan completes and results are returned to the user. The <code>LastEvaluatedKey</code>
31
+ * value is also returned and the requestor can use the <code>LastEvaluatedKey</code> to continue
32
+ * the scan in a subsequent operation. Each scan response also includes number of items that were
33
+ * scanned (ScannedCount) as part of the request. If using a <code>FilterExpression</code>, a scan result
34
+ * can result in no items meeting the criteria and the <code>Count</code> will result in zero. If
35
+ * you did not use a <code>FilterExpression</code> in the scan request, then <code>Count</code> is
36
+ * the same as <code>ScannedCount</code>.</p>
37
+ * <note>
38
+ * <p>
39
+ * <code>Count</code> and <code>ScannedCount</code> only return the count of items specific to a
40
+ * single scan request and, unless the table is less than 1MB, do not represent the total number
41
+ * of items in the table.
42
+ * </p>
43
+ * </note>
44
+ * <p>A single <code>Scan</code> operation first reads up to the maximum number of items set (if
45
+ * using the <code>Limit</code> parameter) or a maximum of 1 MB of data and then applies any
46
+ * filtering to the results if a <code>FilterExpression</code> is provided. If
47
+ * <code>LastEvaluatedKey</code> is present in the response, pagination is required to complete the
48
+ * full table scan. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Pagination">Paginating the
49
+ * Results</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
40
50
  * <p>
41
51
  * <code>Scan</code> operations proceed sequentially; however, for faster performance on
42
52
  * a large table or secondary index, applications can request a parallel <code>Scan</code>
43
53
  * operation by providing the <code>Segment</code> and <code>TotalSegments</code>
44
54
  * parameters. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.ParallelScan">Parallel
45
55
  * Scan</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
46
- * <p>
47
- * <code>Scan</code> uses eventually consistent reads when accessing the data in a table;
48
- * therefore, the result set might not include the changes to data in the table immediately
49
- * before the operation began. If you need a consistent copy of the data, as of the time
50
- * that the <code>Scan</code> begins, you can set the <code>ConsistentRead</code> parameter
51
- * to <code>true</code>.</p>
56
+ * <p>By default, a <code>Scan</code> uses eventually consistent reads when accessing the items in a table.
57
+ * Therefore, the results from an eventually consistent <code>Scan</code> may not include the latest item
58
+ * changes at the time the scan iterates through each item in the table. If you require a strongly consistent
59
+ * read of each item as the scan iterates through the items in the table, you can set the <code>ConsistentRead</code>
60
+ * parameter to true. Strong consistency only relates to the consistency of the read at the item level.</p>
61
+ * <note>
62
+ * <p>
63
+ * DynamoDB does not provide snapshot isolation for a scan operation when the <code>ConsistentRead</code>
64
+ * parameter is set to true. Thus, a DynamoDB scan operation does not guarantee that all reads in a scan
65
+ * see a consistent snapshot of the table when the scan operation was requested.
66
+ * </p>
67
+ * </note>
52
68
  * @example
53
69
  * Use a bare-bones client and the command you need to make an API call.
54
70
  * ```javascript
package/dist-types/models/models_0.d.ts CHANGED
@@ -6156,7 +6156,7 @@ export interface ExecuteStatementInput {
6156
6156
  Limit?: number;
6157
6157
  /**
6158
6158
  * <p>An optional parameter that returns the item attributes for an
6159
- * <code>ExecuteStatement</code> operation that failed a condition check.</p>
6159
+ * <code>ExecuteStatement</code> operation that failed a condition check.</p>
6160
6160
  * <p>There is no additional cost associated with requesting a return value aside from the
6161
6161
  * small network and processing overhead of receiving a larger response. No read capacity
6162
6162
  * units are consumed.</p>
@@ -7443,8 +7443,8 @@ export interface Update {
7443
7443
  /**
7444
7444
  * <p>Use <code>ReturnValuesOnConditionCheckFailure</code> to get the item attributes if the
7445
7445
  * <code>Update</code> condition fails. For
7446
- * <code>ReturnValuesOnConditionCheckFailure</code>, the valid values are: NONE,
7447
- * ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW.</p>
7446
+ * <code>ReturnValuesOnConditionCheckFailure</code>, the valid values are: NONE and
7447
+ * ALL_OLD.</p>
7448
7448
  */
7449
7449
  ReturnValuesOnConditionCheckFailure?: ReturnValuesOnConditionCheckFailure | string;
7450
7450
  }
@@ -7771,7 +7771,8 @@ export interface WriteRequest {
7771
7771
  */
7772
7772
  export interface BatchExecuteStatementOutput {
7773
7773
  /**
7774
- * <p>The response to each PartiQL statement in the batch.</p>
7774
+ * <p>The response to each PartiQL statement in the batch. The values of the list are
7775
+ * ordered according to the ordering of the request statements.</p>
7775
7776
  */
7776
7777
  Responses?: BatchStatementResponse[];
7777
7778
  /**
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-dynamodb",
3
3
  "description": "AWS SDK for JavaScript Dynamodb Client for Node.js, Browser and React Native",
4
- "version": "3.370.0",
4
+ "version": "3.378.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,46 +21,46 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.370.0",
25
- "@aws-sdk/credential-provider-node": "3.370.0",
26
- "@aws-sdk/middleware-endpoint-discovery": "3.370.0",
27
- "@aws-sdk/middleware-host-header": "3.370.0",
28
- "@aws-sdk/middleware-logger": "3.370.0",
29
- "@aws-sdk/middleware-recursion-detection": "3.370.0",
30
- "@aws-sdk/middleware-signing": "3.370.0",
31
- "@aws-sdk/middleware-user-agent": "3.370.0",
32
- "@aws-sdk/types": "3.370.0",
33
- "@aws-sdk/util-endpoints": "3.370.0",
34
- "@aws-sdk/util-user-agent-browser": "3.370.0",
35
- "@aws-sdk/util-user-agent-node": "3.370.0",
36
- "@smithy/config-resolver": "^1.0.1",
37
- "@smithy/fetch-http-handler": "^1.0.1",
38
- "@smithy/hash-node": "^1.0.1",
39
- "@smithy/invalid-dependency": "^1.0.1",
40
- "@smithy/middleware-content-length": "^1.0.1",
41
- "@smithy/middleware-endpoint": "^1.0.2",
42
- "@smithy/middleware-retry": "^1.0.3",
43
- "@smithy/middleware-serde": "^1.0.1",
44
- "@smithy/middleware-stack": "^1.0.1",
45
- "@smithy/node-config-provider": "^1.0.1",
46
- "@smithy/node-http-handler": "^1.0.2",
47
- "@smithy/protocol-http": "^1.1.0",
48
- "@smithy/smithy-client": "^1.0.3",
49
- "@smithy/types": "^1.1.0",
50
- "@smithy/url-parser": "^1.0.1",
51
- "@smithy/util-base64": "^1.0.1",
52
- "@smithy/util-body-length-browser": "^1.0.1",
53
- "@smithy/util-body-length-node": "^1.0.1",
54
- "@smithy/util-defaults-mode-browser": "^1.0.1",
55
- "@smithy/util-defaults-mode-node": "^1.0.1",
56
- "@smithy/util-retry": "^1.0.3",
57
- "@smithy/util-utf8": "^1.0.1",
58
- "@smithy/util-waiter": "^1.0.1",
24
+ "@aws-sdk/client-sts": "3.378.0",
25
+ "@aws-sdk/credential-provider-node": "3.378.0",
26
+ "@aws-sdk/middleware-endpoint-discovery": "3.378.0",
27
+ "@aws-sdk/middleware-host-header": "3.378.0",
28
+ "@aws-sdk/middleware-logger": "3.378.0",
29
+ "@aws-sdk/middleware-recursion-detection": "3.378.0",
30
+ "@aws-sdk/middleware-signing": "3.378.0",
31
+ "@aws-sdk/middleware-user-agent": "3.378.0",
32
+ "@aws-sdk/types": "3.378.0",
33
+ "@aws-sdk/util-endpoints": "3.378.0",
34
+ "@aws-sdk/util-user-agent-browser": "3.378.0",
35
+ "@aws-sdk/util-user-agent-node": "3.378.0",
36
+ "@smithy/config-resolver": "^2.0.1",
37
+ "@smithy/fetch-http-handler": "^2.0.1",
38
+ "@smithy/hash-node": "^2.0.1",
39
+ "@smithy/invalid-dependency": "^2.0.1",
40
+ "@smithy/middleware-content-length": "^2.0.1",
41
+ "@smithy/middleware-endpoint": "^2.0.1",
42
+ "@smithy/middleware-retry": "^2.0.1",
43
+ "@smithy/middleware-serde": "^2.0.1",
44
+ "@smithy/middleware-stack": "^2.0.0",
45
+ "@smithy/node-config-provider": "^2.0.1",
46
+ "@smithy/node-http-handler": "^2.0.1",
47
+ "@smithy/protocol-http": "^2.0.1",
48
+ "@smithy/smithy-client": "^2.0.1",
49
+ "@smithy/types": "^2.0.2",
50
+ "@smithy/url-parser": "^2.0.1",
51
+ "@smithy/util-base64": "^2.0.0",
52
+ "@smithy/util-body-length-browser": "^2.0.0",
53
+ "@smithy/util-body-length-node": "^2.0.0",
54
+ "@smithy/util-defaults-mode-browser": "^2.0.1",
55
+ "@smithy/util-defaults-mode-node": "^2.0.1",
56
+ "@smithy/util-retry": "^2.0.0",
57
+ "@smithy/util-utf8": "^2.0.0",
58
+ "@smithy/util-waiter": "^2.0.1",
59
59
  "tslib": "^2.5.0",
60
60
  "uuid": "^8.3.2"
61
61
  },
62
62
  "devDependencies": {
63
- "@smithy/service-client-documentation-generator": "^1.0.1",
63
+ "@smithy/service-client-documentation-generator": "^2.0.0",
64
64
  "@tsconfig/node14": "1.0.3",
65
65
  "@types/node": "^14.14.31",
66
66
  "@types/uuid": "^8.3.0",