@aws-sdk/client-dynamodb 3.282.0 → 3.287.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 (66) hide show
  1. package/README.md +0 -2
  2. package/dist-cjs/endpoint/ruleset.js +3 -3
  3. package/dist-cjs/pagination/ListContributorInsightsPaginator.js +1 -8
  4. package/dist-cjs/pagination/ListExportsPaginator.js +1 -8
  5. package/dist-cjs/pagination/ListImportsPaginator.js +1 -8
  6. package/dist-cjs/pagination/ListTablesPaginator.js +1 -8
  7. package/dist-cjs/pagination/QueryPaginator.js +1 -8
  8. package/dist-cjs/pagination/ScanPaginator.js +1 -8
  9. package/dist-cjs/protocols/Aws_json1_0.js +3 -0
  10. package/dist-es/endpoint/ruleset.js +3 -3
  11. package/dist-es/pagination/ListContributorInsightsPaginator.js +1 -8
  12. package/dist-es/pagination/ListExportsPaginator.js +1 -8
  13. package/dist-es/pagination/ListImportsPaginator.js +1 -8
  14. package/dist-es/pagination/ListTablesPaginator.js +1 -8
  15. package/dist-es/pagination/QueryPaginator.js +1 -8
  16. package/dist-es/pagination/ScanPaginator.js +1 -8
  17. package/dist-es/protocols/Aws_json1_0.js +3 -0
  18. package/dist-types/DynamoDB.d.ts +314 -250
  19. package/dist-types/DynamoDBClient.d.ts +3 -6
  20. package/dist-types/commands/BatchExecuteStatementCommand.d.ts +4 -4
  21. package/dist-types/commands/BatchGetItemCommand.d.ts +11 -11
  22. package/dist-types/commands/BatchWriteItemCommand.d.ts +19 -20
  23. package/dist-types/commands/CreateBackupCommand.d.ts +11 -11
  24. package/dist-types/commands/CreateGlobalTableCommand.d.ts +27 -21
  25. package/dist-types/commands/CreateTableCommand.d.ts +3 -3
  26. package/dist-types/commands/DeleteBackupCommand.d.ts +1 -1
  27. package/dist-types/commands/DeleteItemCommand.d.ts +3 -3
  28. package/dist-types/commands/DeleteTableCommand.d.ts +10 -6
  29. package/dist-types/commands/DescribeBackupCommand.d.ts +1 -1
  30. package/dist-types/commands/DescribeContinuousBackupsCommand.d.ts +3 -3
  31. package/dist-types/commands/DescribeContributorInsightsCommand.d.ts +1 -1
  32. package/dist-types/commands/DescribeEndpointsCommand.d.ts +3 -1
  33. package/dist-types/commands/DescribeGlobalTableCommand.d.ts +11 -4
  34. package/dist-types/commands/DescribeGlobalTableSettingsCommand.d.ts +11 -3
  35. package/dist-types/commands/DescribeLimitsCommand.d.ts +23 -27
  36. package/dist-types/commands/DescribeTableCommand.d.ts +7 -2
  37. package/dist-types/commands/DescribeTableReplicaAutoScalingCommand.d.ts +4 -4
  38. package/dist-types/commands/ExecuteStatementCommand.d.ts +4 -3
  39. package/dist-types/commands/ExecuteTransactionCommand.d.ts +2 -2
  40. package/dist-types/commands/GetItemCommand.d.ts +1 -1
  41. package/dist-types/commands/ListBackupsCommand.d.ts +2 -2
  42. package/dist-types/commands/ListGlobalTablesCommand.d.ts +11 -3
  43. package/dist-types/commands/ListTagsOfResourceCommand.d.ts +1 -1
  44. package/dist-types/commands/PutItemCommand.d.ts +6 -7
  45. package/dist-types/commands/QueryCommand.d.ts +10 -11
  46. package/dist-types/commands/RestoreTableFromBackupCommand.d.ts +9 -9
  47. package/dist-types/commands/RestoreTableToPointInTimeCommand.d.ts +19 -20
  48. package/dist-types/commands/ScanCommand.d.ts +4 -4
  49. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  50. package/dist-types/commands/TransactGetItemsCommand.d.ts +6 -6
  51. package/dist-types/commands/TransactWriteItemsCommand.d.ts +14 -17
  52. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  53. package/dist-types/commands/UpdateContinuousBackupsCommand.d.ts +2 -2
  54. package/dist-types/commands/UpdateGlobalTableCommand.d.ts +28 -9
  55. package/dist-types/commands/UpdateGlobalTableSettingsCommand.d.ts +12 -0
  56. package/dist-types/commands/UpdateItemCommand.d.ts +1 -1
  57. package/dist-types/commands/UpdateTableCommand.d.ts +11 -6
  58. package/dist-types/commands/UpdateTableReplicaAutoScalingCommand.d.ts +5 -4
  59. package/dist-types/commands/UpdateTimeToLiveCommand.d.ts +8 -8
  60. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  61. package/dist-types/models/models_0.d.ts +1596 -1541
  62. package/dist-types/pagination/Interfaces.d.ts +1 -2
  63. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  64. package/dist-types/ts3.4/models/models_0.d.ts +3 -0
  65. package/dist-types/ts3.4/pagination/Interfaces.d.ts +1 -2
  66. package/package.json +10 -10
@@ -17,77 +17,73 @@ export interface DescribeLimitsCommandOutput extends DescribeLimitsOutput, __Met
17
17
  * <p>Returns the current provisioned-capacity quotas for your Amazon Web Services account in
18
18
  * a Region, both for the Region as a whole and for any one DynamoDB table that you create
19
19
  * there.</p>
20
- * <p>When you establish an Amazon Web Services account, the account has initial quotas on
20
+ * <p>When you establish an Amazon Web Services account, the account has initial quotas on
21
21
  * the maximum read capacity units and write capacity units that you can provision across
22
22
  * all of your DynamoDB tables in a given Region. Also, there are per-table
23
23
  * quotas that apply when you create a table there. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Service,
24
24
  * Account, and Table Quotas</a> page in the <i>Amazon DynamoDB
25
25
  * Developer Guide</i>.</p>
26
- *
27
- * <p>Although you can increase these quotas by filing a case at <a href="https://console.aws.amazon.com/support/home#/">Amazon Web Services Support Center</a>, obtaining the
26
+ * <p>Although you can increase these quotas by filing a case at <a href="https://console.aws.amazon.com/support/home#/">Amazon Web Services Support Center</a>, obtaining the
28
27
  * increase is not instantaneous. The <code>DescribeLimits</code> action lets you write
29
28
  * code to compare the capacity you are currently using to those quotas imposed by your
30
29
  * account so that you have enough time to apply for an increase before you hit a
31
30
  * quota.</p>
32
- *
33
- * <p>For example, you could use one of the Amazon Web Services SDKs to do the
31
+ * <p>For example, you could use one of the Amazon Web Services SDKs to do the
34
32
  * following:</p>
35
- *
36
- * <ol>
33
+ * <ol>
37
34
  * <li>
38
- * <p>Call <code>DescribeLimits</code> for a particular Region to obtain your
35
+ * <p>Call <code>DescribeLimits</code> for a particular Region to obtain your
39
36
  * current account quotas on provisioned capacity there.</p>
40
37
  * </li>
41
38
  * <li>
42
- * <p>Create a variable to hold the aggregate read capacity units provisioned for
39
+ * <p>Create a variable to hold the aggregate read capacity units provisioned for
43
40
  * all your tables in that Region, and one to hold the aggregate write capacity
44
41
  * units. Zero them both.</p>
45
42
  * </li>
46
43
  * <li>
47
- * <p>Call <code>ListTables</code> to obtain a list of all your DynamoDB
44
+ * <p>Call <code>ListTables</code> to obtain a list of all your DynamoDB
48
45
  * tables.</p>
49
46
  * </li>
50
47
  * <li>
51
- * <p>For each table name listed by <code>ListTables</code>, do the
48
+ * <p>For each table name listed by <code>ListTables</code>, do the
52
49
  * following:</p>
53
- * <ul>
50
+ * <ul>
54
51
  * <li>
55
- * <p>Call <code>DescribeTable</code> with the table name.</p>
56
- * </li>
52
+ * <p>Call <code>DescribeTable</code> with the table name.</p>
53
+ * </li>
57
54
  * <li>
58
- * <p>Use the data returned by <code>DescribeTable</code> to add the read
55
+ * <p>Use the data returned by <code>DescribeTable</code> to add the read
59
56
  * capacity units and write capacity units provisioned for the table itself
60
57
  * to your variables.</p>
61
- * </li>
58
+ * </li>
62
59
  * <li>
63
- * <p>If the table has one or more global secondary indexes (GSIs), loop
60
+ * <p>If the table has one or more global secondary indexes (GSIs), loop
64
61
  * over these GSIs and add their provisioned capacity values to your
65
62
  * variables as well.</p>
66
- * </li>
63
+ * </li>
67
64
  * </ul>
68
65
  * </li>
69
66
  * <li>
70
- * <p>Report the account quotas for that Region returned by
67
+ * <p>Report the account quotas for that Region returned by
71
68
  * <code>DescribeLimits</code>, along with the total current provisioned
72
69
  * capacity levels you have calculated.</p>
73
70
  * </li>
74
71
  * </ol>
75
- *
76
- * <p>This will let you see whether you are getting close to your account-level
72
+ * <p>This will let you see whether you are getting close to your account-level
77
73
  * quotas.</p>
78
- * <p>The per-table quotas apply only when you are creating a new table. They restrict the
74
+ * <p>The per-table quotas apply only when you are creating a new table. They restrict the
79
75
  * sum of the provisioned capacity of the new table itself and all its global secondary
80
76
  * indexes.</p>
81
- * <p>For existing tables and their GSIs, DynamoDB doesn't let you increase provisioned
77
+ * <p>For existing tables and their GSIs, DynamoDB doesn't let you increase provisioned
82
78
  * capacity extremely rapidly, but the only quota that applies is that the aggregate
83
79
  * provisioned capacity over all your tables and GSIs cannot exceed either of the
84
80
  * per-account quotas.</p>
85
- * <note>
81
+ * <note>
86
82
  * <p>
87
- * <code>DescribeLimits</code> should only be called periodically. You can expect
83
+ * <code>DescribeLimits</code> should only be called periodically. You can expect
88
84
  * throttling errors if you call it more than once in a minute.</p>
89
- * </note>
90
- * <p>The <code>DescribeLimits</code> Request element has no content.</p>
85
+ * </note>
86
+ * <p>The <code>DescribeLimits</code> Request element has no content.</p>
91
87
  * @example
92
88
  * Use a bare-bones client and the command you need to make an API call.
93
89
  * ```javascript
@@ -16,14 +16,19 @@ export interface DescribeTableCommandOutput extends DescribeTableOutput, __Metad
16
16
  /**
17
17
  * <p>Returns information about the table, including the current status of the table, when
18
18
  * it was created, the primary key schema, and any indexes on the table.</p>
19
- * <note>
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
+ * <note>
20
25
  * <p>If you issue a <code>DescribeTable</code> request immediately after a
21
26
  * <code>CreateTable</code> request, DynamoDB might return a
22
27
  * <code>ResourceNotFoundException</code>. This is because
23
28
  * <code>DescribeTable</code> uses an eventually consistent query, and the metadata
24
29
  * for your table might not be available at that moment. Wait for a few seconds, and
25
30
  * then try the <code>DescribeTable</code> request again.</p>
26
- * </note>
31
+ * </note>
27
32
  * @example
28
33
  * Use a bare-bones client and the command you need to make an API call.
29
34
  * ```javascript
@@ -15,10 +15,10 @@ export interface DescribeTableReplicaAutoScalingCommandOutput extends DescribeTa
15
15
  }
16
16
  /**
17
17
  * <p>Describes auto scaling settings across replicas of the global table at once.</p>
18
- * <note>
19
- * <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version
20
- * 2019.11.21</a> of global tables.</p>
21
- * </note>
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.</p>
21
+ * </important>
22
22
  * @example
23
23
  * Use a bare-bones client and the command you need to make an API call.
24
24
  * ```javascript
@@ -16,16 +16,17 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementOutput, _
16
16
  /**
17
17
  * <p>This operation allows you to perform reads and singleton writes on data stored in
18
18
  * DynamoDB, using PartiQL.</p>
19
- * <p>For PartiQL reads (<code>SELECT</code> statement), if the total number of processed
19
+ * <p>For PartiQL reads (<code>SELECT</code> statement), if the total number of processed
20
20
  * items exceeds the maximum dataset size limit of 1 MB, the read stops and results are
21
21
  * returned to the user as a <code>LastEvaluatedKey</code> value to continue the read in a
22
22
  * subsequent operation. If the filter criteria in <code>WHERE</code> clause does not match
23
23
  * any data, the read will return an empty result set.</p>
24
- * <p>A single <code>SELECT</code> statement response can return up to the maximum number of
24
+ * <p>A single <code>SELECT</code> statement response can return up to the maximum number of
25
25
  * items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any
26
26
  * filtering to the results using <code>WHERE</code> clause). If
27
27
  * <code>LastEvaluatedKey</code> is present in the response, you need to paginate the
28
- * result set.</p>
28
+ * result set. If <code>NextToken</code> is present, you need to paginate the result set and include
29
+ * <code>NextToken</code>.</p>
29
30
  * @example
30
31
  * Use a bare-bones client and the command you need to make an API call.
31
32
  * ```javascript
@@ -16,12 +16,12 @@ export interface ExecuteTransactionCommandOutput extends ExecuteTransactionOutpu
16
16
  /**
17
17
  * <p>This operation allows you to perform transactional reads or writes on data stored in
18
18
  * DynamoDB, using PartiQL.</p>
19
- * <note>
19
+ * <note>
20
20
  * <p>The entire transaction must consist of either read statements or write statements,
21
21
  * you cannot mix both in one transaction. The EXISTS function is an exception and can
22
22
  * be used to check the condition of specific attributes of the item in a similar
23
23
  * manner to <code>ConditionCheck</code> in the <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/transaction-apis.html#transaction-apis-txwriteitems">TransactWriteItems</a> API.</p>
24
- * </note>
24
+ * </note>
25
25
  * @example
26
26
  * Use a bare-bones client and the command you need to make an API call.
27
27
  * ```javascript
@@ -17,7 +17,7 @@ export interface GetItemCommandOutput extends GetItemOutput, __MetadataBearer {
17
17
  * <p>The <code>GetItem</code> operation returns a set of attributes for the item with the
18
18
  * given primary key. If there is no matching item, <code>GetItem</code> does not return
19
19
  * any data and there will be no <code>Item</code> element in the response.</p>
20
- * <p>
20
+ * <p>
21
21
  * <code>GetItem</code> provides an eventually consistent read by default. If your
22
22
  * application requires a strongly consistent read, set <code>ConsistentRead</code> to
23
23
  * <code>true</code>. Although a strongly consistent read might take more time than an
@@ -18,9 +18,9 @@ export interface ListBackupsCommandOutput extends ListBackupsOutput, __MetadataB
18
18
  * given table, specify <code>TableName</code>. <code>ListBackups</code> returns a
19
19
  * paginated list of results with at most 1 MB worth of items in a page. You can also
20
20
  * specify a maximum number of entries to be returned in a page.</p>
21
- * <p>In the request, start time is inclusive, but end time is exclusive. Note that these
21
+ * <p>In the request, start time is inclusive, but end time is exclusive. Note that these
22
22
  * boundaries are for the time at which the original backup was requested.</p>
23
- * <p>You can call <code>ListBackups</code> a maximum of five times per second.</p>
23
+ * <p>You can call <code>ListBackups</code> a maximum of five times per second.</p>
24
24
  * @example
25
25
  * Use a bare-bones client and the command you need to make an API call.
26
26
  * ```javascript
@@ -15,10 +15,18 @@ export interface ListGlobalTablesCommandOutput extends ListGlobalTablesOutput, _
15
15
  }
16
16
  /**
17
17
  * <p>Lists all global tables that have a replica in the specified Region.</p>
18
- * <note>
18
+ * <important>
19
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</a> of global tables.</p>
21
- * </note>
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>
22
30
  * @example
23
31
  * Use a bare-bones client and the command you need to make an API call.
24
32
  * ```javascript
@@ -16,7 +16,7 @@ export interface ListTagsOfResourceCommandOutput extends ListTagsOfResourceOutpu
16
16
  /**
17
17
  * <p>List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10
18
18
  * times per second, per account.</p>
19
- * <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>
19
+ * <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>
20
20
  * in the <i>Amazon DynamoDB Developer Guide</i>.</p>
21
21
  * @example
22
22
  * Use a bare-bones client and the command you need to make an API call.
@@ -20,22 +20,21 @@ export interface PutItemCommandOutput extends PutItemOutput, __MetadataBearer {
20
20
  * a new item if one with the specified primary key doesn't exist), or replace an existing
21
21
  * item if it has certain attribute values. You can return the item's attribute values in
22
22
  * the same operation, using the <code>ReturnValues</code> parameter.</p>
23
- *
24
- * <p>When you add an item, the primary key attributes are the only required attributes.
23
+ * <p>When you add an item, the primary key attributes are the only required attributes.
25
24
  * </p>
26
- * <p>Empty String and Binary attribute values are allowed. Attribute values of type String
25
+ * <p>Empty String and Binary attribute values are allowed. Attribute values of type String
27
26
  * and Binary must have a length greater than zero if the attribute is used as a key
28
27
  * attribute for a table or index. Set type attributes cannot be empty. </p>
29
- * <p>Invalid Requests with empty values will be rejected with a
28
+ * <p>Invalid Requests with empty values will be rejected with a
30
29
  * <code>ValidationException</code> exception.</p>
31
- * <note>
30
+ * <note>
32
31
  * <p>To prevent a new item from replacing an existing item, use a conditional
33
32
  * expression that contains the <code>attribute_not_exists</code> function with the
34
33
  * name of the attribute being used as the partition key for the table. Since every
35
34
  * record must contain that attribute, the <code>attribute_not_exists</code> function
36
35
  * will only succeed if no matching item exists.</p>
37
- * </note>
38
- * <p>For more information about <code>PutItem</code>, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html">Working with
36
+ * </note>
37
+ * <p>For more information about <code>PutItem</code>, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html">Working with
39
38
  * Items</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
40
39
  * @example
41
40
  * Use a bare-bones client and the command you need to make an API call.
@@ -18,8 +18,7 @@ export interface QueryCommandOutput extends QueryOutput, __MetadataBearer {
18
18
  * attribute. <code>Query</code> returns all items with that partition key value.
19
19
  * Optionally, you can provide a sort key attribute and use a comparison operator to refine
20
20
  * the search results.</p>
21
- *
22
- * <p>Use the <code>KeyConditionExpression</code> parameter to provide a specific value for
21
+ * <p>Use the <code>KeyConditionExpression</code> parameter to provide a specific value for
23
22
  * the partition key. The <code>Query</code> operation will return all of the items from
24
23
  * the table or index with that partition key value. You can optionally narrow the scope of
25
24
  * the <code>Query</code> operation by specifying a sort key value and a comparison
@@ -28,39 +27,39 @@ export interface QueryCommandOutput extends QueryOutput, __MetadataBearer {
28
27
  * <code>FilterExpression</code>. A <code>FilterExpression</code> determines which
29
28
  * items within the results should be returned to you. All of the other results are
30
29
  * discarded. </p>
31
- * <p> A <code>Query</code> operation always returns a result set. If no matching items are
30
+ * <p> A <code>Query</code> operation always returns a result set. If no matching items are
32
31
  * found, the result set will be empty. Queries that do not return results consume the
33
32
  * minimum number of read capacity units for that type of read operation. </p>
34
- * <note>
33
+ * <note>
35
34
  * <p> DynamoDB calculates the number of read capacity units consumed based on item
36
35
  * size, not on the amount of data that is returned to an application. The number of
37
36
  * capacity units consumed will be the same whether you request all of the attributes
38
37
  * (the default behavior) or just some of them (using a projection expression). The
39
38
  * number will also be the same whether or not you use a <code>FilterExpression</code>.
40
39
  * </p>
41
- * </note>
42
- * <p>
40
+ * </note>
41
+ * <p>
43
42
  * <code>Query</code> results are always sorted by the sort key value. If the data type of
44
43
  * the sort key is Number, the results are returned in numeric order; otherwise, the
45
44
  * results are returned in order of UTF-8 bytes. By default, the sort order is ascending.
46
45
  * To reverse the order, set the <code>ScanIndexForward</code> parameter to false. </p>
47
- * <p> A single <code>Query</code> operation will read up to the maximum number of items set
46
+ * <p> A single <code>Query</code> operation will read up to the maximum number of items set
48
47
  * (if using the <code>Limit</code> parameter) or a maximum of 1 MB of data and then apply
49
48
  * any filtering to the results using <code>FilterExpression</code>. If
50
49
  * <code>LastEvaluatedKey</code> is present in the response, you will need to paginate
51
50
  * the result set. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.Pagination">Paginating
52
51
  * the Results</a> in the <i>Amazon DynamoDB Developer Guide</i>. </p>
53
- * <p>
52
+ * <p>
54
53
  * <code>FilterExpression</code> is applied after a <code>Query</code> finishes, but before
55
54
  * the results are returned. A <code>FilterExpression</code> cannot contain partition key
56
55
  * or sort key attributes. You need to specify those attributes in the
57
56
  * <code>KeyConditionExpression</code>. </p>
58
- * <note>
57
+ * <note>
59
58
  * <p> A <code>Query</code> operation can return an empty result set and a
60
59
  * <code>LastEvaluatedKey</code> if all the items read for the page of results are
61
60
  * filtered out. </p>
62
- * </note>
63
- * <p>You can query a table, a local secondary index, or a global secondary index. For a
61
+ * </note>
62
+ * <p>You can query a table, a local secondary index, or a global secondary index. For a
64
63
  * query on a table or on a local secondary index, you can set the
65
64
  * <code>ConsistentRead</code> parameter to <code>true</code> and obtain a strongly
66
65
  * consistent result. Global secondary indexes support eventually consistent reads only, so
@@ -16,27 +16,27 @@ export interface RestoreTableFromBackupCommandOutput extends RestoreTableFromBac
16
16
  /**
17
17
  * <p>Creates a new table from an existing backup. Any number of users can execute up to 4
18
18
  * concurrent restores (any type of restore) in a given account. </p>
19
- * <p>You can call <code>RestoreTableFromBackup</code> at a maximum rate of 10 times per
19
+ * <p>You can call <code>RestoreTableFromBackup</code> at a maximum rate of 10 times per
20
20
  * second.</p>
21
- * <p>You must manually set up the following on the restored table:</p>
22
- * <ul>
21
+ * <p>You must manually set up the following on the restored table:</p>
22
+ * <ul>
23
23
  * <li>
24
- * <p>Auto scaling policies</p>
24
+ * <p>Auto scaling policies</p>
25
25
  * </li>
26
26
  * <li>
27
- * <p>IAM policies</p>
27
+ * <p>IAM policies</p>
28
28
  * </li>
29
29
  * <li>
30
- * <p>Amazon CloudWatch metrics and alarms</p>
30
+ * <p>Amazon CloudWatch metrics and alarms</p>
31
31
  * </li>
32
32
  * <li>
33
- * <p>Tags</p>
33
+ * <p>Tags</p>
34
34
  * </li>
35
35
  * <li>
36
- * <p>Stream settings</p>
36
+ * <p>Stream settings</p>
37
37
  * </li>
38
38
  * <li>
39
- * <p>Time to Live (TTL) settings</p>
39
+ * <p>Time to Live (TTL) settings</p>
40
40
  * </li>
41
41
  * </ul>
42
42
  * @example
@@ -18,51 +18,50 @@ export interface RestoreTableToPointInTimeCommandOutput extends RestoreTableToPo
18
18
  * <code>EarliestRestorableDateTime</code> and <code>LatestRestorableDateTime</code>.
19
19
  * You can restore your table to any point in time during the last 35 days. Any number of
20
20
  * users can execute up to 4 concurrent restores (any type of restore) in a given account. </p>
21
- * <p> When you restore using point in time recovery, DynamoDB restores your table data to
21
+ * <p> When you restore using point in time recovery, DynamoDB restores your table data to
22
22
  * the state based on the selected date and time (day:hour:minute:second) to a new table. </p>
23
- * <p> Along with data, the following are also included on the new restored table using
23
+ * <p> Along with data, the following are also included on the new restored table using
24
24
  * point in time recovery: </p>
25
- * <ul>
25
+ * <ul>
26
26
  * <li>
27
- * <p>Global secondary indexes (GSIs)</p>
27
+ * <p>Global secondary indexes (GSIs)</p>
28
28
  * </li>
29
29
  * <li>
30
- * <p>Local secondary indexes (LSIs)</p>
30
+ * <p>Local secondary indexes (LSIs)</p>
31
31
  * </li>
32
32
  * <li>
33
- * <p>Provisioned read and write capacity</p>
33
+ * <p>Provisioned read and write capacity</p>
34
34
  * </li>
35
35
  * <li>
36
- * <p>Encryption settings</p>
37
- * <important>
38
- * <p> All these settings come from the current settings of the source table at
36
+ * <p>Encryption settings</p>
37
+ * <important>
38
+ * <p> All these settings come from the current settings of the source table at
39
39
  * the time of restore. </p>
40
- * </important>
40
+ * </important>
41
41
  * </li>
42
42
  * </ul>
43
- *
44
- * <p>You must manually set up the following on the restored table:</p>
45
- * <ul>
43
+ * <p>You must manually set up the following on the restored table:</p>
44
+ * <ul>
46
45
  * <li>
47
- * <p>Auto scaling policies</p>
46
+ * <p>Auto scaling policies</p>
48
47
  * </li>
49
48
  * <li>
50
- * <p>IAM policies</p>
49
+ * <p>IAM policies</p>
51
50
  * </li>
52
51
  * <li>
53
- * <p>Amazon CloudWatch metrics and alarms</p>
52
+ * <p>Amazon CloudWatch metrics and alarms</p>
54
53
  * </li>
55
54
  * <li>
56
- * <p>Tags</p>
55
+ * <p>Tags</p>
57
56
  * </li>
58
57
  * <li>
59
- * <p>Stream settings</p>
58
+ * <p>Stream settings</p>
60
59
  * </li>
61
60
  * <li>
62
- * <p>Time to Live (TTL) settings</p>
61
+ * <p>Time to Live (TTL) settings</p>
63
62
  * </li>
64
63
  * <li>
65
- * <p>Point in time recovery settings</p>
64
+ * <p>Point in time recovery settings</p>
66
65
  * </li>
67
66
  * </ul>
68
67
  * @example
@@ -17,24 +17,24 @@ export interface ScanCommandOutput extends ScanOutput, __MetadataBearer {
17
17
  * <p>The <code>Scan</code> operation returns one or more items and item attributes by
18
18
  * accessing every item in a table or a secondary index. To have DynamoDB return fewer
19
19
  * items, you can provide a <code>FilterExpression</code> operation.</p>
20
- * <p>If the total number of scanned items exceeds the maximum dataset size limit of 1 MB,
20
+ * <p>If the total number of scanned items exceeds the maximum dataset size limit of 1 MB,
21
21
  * the scan stops and results are returned to the user as a <code>LastEvaluatedKey</code>
22
22
  * value to continue the scan in a subsequent operation. The results also include the
23
23
  * number of items exceeding the limit. A scan can result in no table data meeting the
24
24
  * filter criteria. </p>
25
- * <p>A single <code>Scan</code> operation reads up to the maximum number of items set (if
25
+ * <p>A single <code>Scan</code> operation reads up to the maximum number of items set (if
26
26
  * using the <code>Limit</code> parameter) or a maximum of 1 MB of data and then apply any
27
27
  * filtering to the results using <code>FilterExpression</code>. If
28
28
  * <code>LastEvaluatedKey</code> is present in the response, you need to paginate the
29
29
  * result set. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Pagination">Paginating the
30
30
  * Results</a> in the <i>Amazon DynamoDB Developer Guide</i>. </p>
31
- * <p>
31
+ * <p>
32
32
  * <code>Scan</code> operations proceed sequentially; however, for faster performance on
33
33
  * a large table or secondary index, applications can request a parallel <code>Scan</code>
34
34
  * operation by providing the <code>Segment</code> and <code>TotalSegments</code>
35
35
  * parameters. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.ParallelScan">Parallel
36
36
  * Scan</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
37
- * <p>
37
+ * <p>
38
38
  * <code>Scan</code> uses eventually consistent reads when accessing the data in a table;
39
39
  * therefore, the result set might not include the changes to data in the table immediately
40
40
  * before the operation began. If you need a consistent copy of the data, as of the time
@@ -18,7 +18,7 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
18
18
  * user-defined tags so that they appear on the Billing and Cost Management console for
19
19
  * cost allocation tracking. You can call TagResource up to five times per second, per
20
20
  * account. </p>
21
- * <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>
21
+ * <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>
22
22
  * in the <i>Amazon DynamoDB Developer Guide</i>.</p>
23
23
  * @example
24
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -23,22 +23,22 @@ export interface TransactGetItemsCommandOutput extends TransactGetItemsOutput, _
23
23
  * call to <code>TransactGetItems</code> cannot retrieve items from tables in more than one
24
24
  * Amazon Web Services account or Region. The aggregate size of the items in the
25
25
  * transaction cannot exceed 4 MB.</p>
26
- * <p>DynamoDB rejects the entire <code>TransactGetItems</code> request if any of
26
+ * <p>DynamoDB rejects the entire <code>TransactGetItems</code> request if any of
27
27
  * the following is true:</p>
28
- * <ul>
28
+ * <ul>
29
29
  * <li>
30
- * <p>A conflicting operation is in the process of updating an item to be
30
+ * <p>A conflicting operation is in the process of updating an item to be
31
31
  * read.</p>
32
32
  * </li>
33
33
  * <li>
34
- * <p>There is insufficient provisioned capacity for the transaction to be
34
+ * <p>There is insufficient provisioned capacity for the transaction to be
35
35
  * completed.</p>
36
36
  * </li>
37
37
  * <li>
38
- * <p>There is a user error, such as an invalid data format.</p>
38
+ * <p>There is a user error, such as an invalid data format.</p>
39
39
  * </li>
40
40
  * <li>
41
- * <p>The aggregate size of the items in the transaction cannot exceed 4 MB.</p>
41
+ * <p>The aggregate size of the items in the transaction exceeded 4 MB.</p>
42
42
  * </li>
43
43
  * </ul>
44
44
  * @example
@@ -21,13 +21,11 @@ export interface TransactWriteItemsCommandOutput extends TransactWriteItemsOutpu
21
21
  * item. For example, you cannot both <code>ConditionCheck</code> and <code>Update</code>
22
22
  * the same item. The aggregate size of the items in the transaction cannot exceed 4
23
23
  * MB.</p>
24
- *
25
- * <p>The actions are completed atomically so that either all of them succeed, or all of
24
+ * <p>The actions are completed atomically so that either all of them succeed, or all of
26
25
  * them fail. They are defined by the following objects:</p>
27
- *
28
- * <ul>
26
+ * <ul>
29
27
  * <li>
30
- * <p>
28
+ * <p>
31
29
  * <code>Put</code>  —   Initiates a <code>PutItem</code>
32
30
  * operation to write a new item. This structure specifies the primary key of the
33
31
  * item to be written, the name of the table to write it in, an optional condition
@@ -36,7 +34,7 @@ export interface TransactWriteItemsCommandOutput extends TransactWriteItemsOutpu
36
34
  * the condition is not met.</p>
37
35
  * </li>
38
36
  * <li>
39
- * <p>
37
+ * <p>
40
38
  * <code>Update</code>  —   Initiates an <code>UpdateItem</code>
41
39
  * operation to update an existing item. This structure specifies the primary key
42
40
  * of the item to be updated, the name of the table where it resides, an optional
@@ -46,7 +44,7 @@ export interface TransactWriteItemsCommandOutput extends TransactWriteItemsOutpu
46
44
  * met.</p>
47
45
  * </li>
48
46
  * <li>
49
- * <p>
47
+ * <p>
50
48
  * <code>Delete</code>  —   Initiates a <code>DeleteItem</code>
51
49
  * operation to delete an existing item. This structure specifies the primary key
52
50
  * of the item to be deleted, the name of the table where it resides, an optional
@@ -55,7 +53,7 @@ export interface TransactWriteItemsCommandOutput extends TransactWriteItemsOutpu
55
53
  * not met.</p>
56
54
  * </li>
57
55
  * <li>
58
- * <p>
56
+ * <p>
59
57
  * <code>ConditionCheck</code>  —   Applies a condition to an item
60
58
  * that is not being modified by the transaction. This structure specifies the
61
59
  * primary key of the item to be checked, the name of the table where it resides, a
@@ -64,30 +62,29 @@ export interface TransactWriteItemsCommandOutput extends TransactWriteItemsOutpu
64
62
  * not met.</p>
65
63
  * </li>
66
64
  * </ul>
67
- *
68
- * <p>DynamoDB rejects the entire <code>TransactWriteItems</code> request if any of the
65
+ * <p>DynamoDB rejects the entire <code>TransactWriteItems</code> request if any of the
69
66
  * following is true:</p>
70
- * <ul>
67
+ * <ul>
71
68
  * <li>
72
- * <p>A condition in one of the condition expressions is not met.</p>
69
+ * <p>A condition in one of the condition expressions is not met.</p>
73
70
  * </li>
74
71
  * <li>
75
- * <p>An ongoing operation is in the process of updating the same item.</p>
72
+ * <p>An ongoing operation is in the process of updating the same item.</p>
76
73
  * </li>
77
74
  * <li>
78
- * <p>There is insufficient provisioned capacity for the transaction to be
75
+ * <p>There is insufficient provisioned capacity for the transaction to be
79
76
  * completed.</p>
80
77
  * </li>
81
78
  * <li>
82
- * <p>An item size becomes too large (bigger than 400 KB), a local secondary index
79
+ * <p>An item size becomes too large (bigger than 400 KB), a local secondary index
83
80
  * (LSI) becomes too large, or a similar validation error occurs because of changes
84
81
  * made by the transaction.</p>
85
82
  * </li>
86
83
  * <li>
87
- * <p>The aggregate size of the items in the transaction exceeds 4 MB.</p>
84
+ * <p>The aggregate size of the items in the transaction exceeds 4 MB.</p>
88
85
  * </li>
89
86
  * <li>
90
- * <p>There is a user error, such as an invalid data format.</p>
87
+ * <p>There is a user error, such as an invalid data format.</p>
91
88
  * </li>
92
89
  * </ul>
93
90
  * @example
@@ -16,7 +16,7 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
16
16
  /**
17
17
  * <p>Removes the association of tags from an Amazon DynamoDB resource. You can call
18
18
  * <code>UntagResource</code> up to five times per second, per account. </p>
19
- * <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>
19
+ * <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>
20
20
  * in the <i>Amazon DynamoDB Developer Guide</i>.</p>
21
21
  * @example
22
22
  * Use a bare-bones client and the command you need to make an API call.