Skip to content

Commit b6a0927

Browse files
author
awstools
committed
docs(client-dynamodb): Documentation update for secondary indexes and Create_Table.
1 parent e0a3e91 commit b6a0927

21 files changed

+214
-171
lines changed

‎clients/client-dynamodb/src/commands/BatchExecuteStatementCommand.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,7 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen
3131
* <p>This operation allows you to perform batch reads or writes on data stored in DynamoDB,
3232
* using PartiQL. Each read statement in a <code>BatchExecuteStatement</code> must specify
3333
* an equality condition on all key attributes. This enforces that each <code>SELECT</code>
34-
* statement in a batch returns at most a single item. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ql-reference.multiplestatements.batching.html">Running batch operations with PartiQL for DynamoDB
35-
* </a>.</p>
34+
* statement in a batch returns at most a single item. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ql-reference.multiplestatements.batching.html">Running batch operations with PartiQL for DynamoDB </a>.</p>
3635
* <note>
3736
* <p>The entire batch must consist of either read statements or write statements, you
3837
* cannot mix both in one batch.</p>
@@ -205,7 +204,7 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen
205204
*
206205
* @throws {@link RequestLimitExceeded} (client fault)
207206
* <p>Throughput exceeds the current throughput quota for your account. Please contact
208-
* <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a
207+
* <a href="https://aws.amazon.com/support">Amazon Web ServicesSupport</a> to request a
209208
* quota increase.</p>
210209
*
211210
* @throws {@link DynamoDBServiceException}

‎clients/client-dynamodb/src/commands/BatchGetItemCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ export interface BatchGetItemCommandOutput extends BatchGetItemOutput, __Metadat
262262
*
263263
* @throws {@link RequestLimitExceeded} (client fault)
264264
* <p>Throughput exceeds the current throughput quota for your account. Please contact
265-
* <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a
265+
* <a href="https://aws.amazon.com/support">Amazon Web ServicesSupport</a> to request a
266266
* quota increase.</p>
267267
*
268268
* @throws {@link ResourceNotFoundException} (client fault)

‎clients/client-dynamodb/src/commands/BatchWriteItemCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@ export interface BatchWriteItemCommandOutput extends BatchWriteItemOutput, __Met
313313
*
314314
* @throws {@link RequestLimitExceeded} (client fault)
315315
* <p>Throughput exceeds the current throughput quota for your account. Please contact
316-
* <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a
316+
* <a href="https://aws.amazon.com/support">Amazon Web ServicesSupport</a> to request a
317317
* quota increase.</p>
318318
*
319319
* @throws {@link ResourceNotFoundException} (client fault)

‎clients/client-dynamodb/src/commands/DeleteItemCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ export interface DeleteItemCommandOutput extends DeleteItemOutput, __MetadataBea
207207
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
208208
*
209209
* @throws {@link ConditionalCheckFailedException} (client fault)
210-
* <p>A condition specified in the operation could not be evaluated.</p>
210+
* <p>A condition specified in the operation failed to be evaluated.</p>
211211
*
212212
* @throws {@link InternalServerError} (server fault)
213213
* <p>An error occurred on the server side.</p>
@@ -229,7 +229,7 @@ export interface DeleteItemCommandOutput extends DeleteItemOutput, __MetadataBea
229229
*
230230
* @throws {@link RequestLimitExceeded} (client fault)
231231
* <p>Throughput exceeds the current throughput quota for your account. Please contact
232-
* <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a
232+
* <a href="https://aws.amazon.com/support">Amazon Web ServicesSupport</a> to request a
233233
* quota increase.</p>
234234
*
235235
* @throws {@link ResourceNotFoundException} (client fault)

‎clients/client-dynamodb/src/commands/DescribeContinuousBackupsCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ export interface DescribeContinuousBackupsCommandOutput extends DescribeContinuo
3737
* <code>LatestRestorableDateTime</code>. </p>
3838
* <p>
3939
* <code>LatestRestorableDateTime</code> is typically 5 minutes before the current time.
40-
* You can restore your table to any point in time in the last 35 days. You can set the recovery period to any value between 1 and 35 days. </p>
40+
* You can restore your table to any point in time in the last 35 days. You can set the
41+
* recovery period to any value between 1 and 35 days. </p>
4142
* <p>You can call <code>DescribeContinuousBackups</code> at a maximum rate of 10 times per
4243
* second.</p>
4344
* @example

‎clients/client-dynamodb/src/commands/ExecuteStatementCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementOutput, _
190190
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
191191
*
192192
* @throws {@link ConditionalCheckFailedException} (client fault)
193-
* <p>A condition specified in the operation could not be evaluated.</p>
193+
* <p>A condition specified in the operation failed to be evaluated.</p>
194194
*
195195
* @throws {@link DuplicateItemException} (client fault)
196196
* <p> There was an attempt to insert an item with the same primary key as an item that
@@ -211,7 +211,7 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementOutput, _
211211
*
212212
* @throws {@link RequestLimitExceeded} (client fault)
213213
* <p>Throughput exceeds the current throughput quota for your account. Please contact
214-
* <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a
214+
* <a href="https://aws.amazon.com/support">Amazon Web ServicesSupport</a> to request a
215215
* quota increase.</p>
216216
*
217217
* @throws {@link ResourceNotFoundException} (client fault)

‎clients/client-dynamodb/src/commands/ExecuteTransactionCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ export interface ExecuteTransactionCommandOutput extends ExecuteTransactionOutpu
201201
*
202202
* @throws {@link RequestLimitExceeded} (client fault)
203203
* <p>Throughput exceeds the current throughput quota for your account. Please contact
204-
* <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a
204+
* <a href="https://aws.amazon.com/support">Amazon Web ServicesSupport</a> to request a
205205
* quota increase.</p>
206206
*
207207
* @throws {@link ResourceNotFoundException} (client fault)

‎clients/client-dynamodb/src/commands/GetItemCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ export interface GetItemCommandOutput extends GetItemOutput, __MetadataBearer {}
195195
*
196196
* @throws {@link RequestLimitExceeded} (client fault)
197197
* <p>Throughput exceeds the current throughput quota for your account. Please contact
198-
* <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a
198+
* <a href="https://aws.amazon.com/support">Amazon Web ServicesSupport</a> to request a
199199
* quota increase.</p>
200200
*
201201
* @throws {@link ResourceNotFoundException} (client fault)

‎clients/client-dynamodb/src/commands/PutItemCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ export interface PutItemCommandOutput extends PutItemOutput, __MetadataBearer {}
217217
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
218218
*
219219
* @throws {@link ConditionalCheckFailedException} (client fault)
220-
* <p>A condition specified in the operation could not be evaluated.</p>
220+
* <p>A condition specified in the operation failed to be evaluated.</p>
221221
*
222222
* @throws {@link InternalServerError} (server fault)
223223
* <p>An error occurred on the server side.</p>
@@ -239,7 +239,7 @@ export interface PutItemCommandOutput extends PutItemOutput, __MetadataBearer {}
239239
*
240240
* @throws {@link RequestLimitExceeded} (client fault)
241241
* <p>Throughput exceeds the current throughput quota for your account. Please contact
242-
* <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a
242+
* <a href="https://aws.amazon.com/support">Amazon Web ServicesSupport</a> to request a
243243
* quota increase.</p>
244244
*
245245
* @throws {@link ResourceNotFoundException} (client fault)

‎clients/client-dynamodb/src/commands/QueryCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ export interface QueryCommandOutput extends QueryOutput, __MetadataBearer {}
271271
*
272272
* @throws {@link RequestLimitExceeded} (client fault)
273273
* <p>Throughput exceeds the current throughput quota for your account. Please contact
274-
* <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a
274+
* <a href="https://aws.amazon.com/support">Amazon Web ServicesSupport</a> to request a
275275
* quota increase.</p>
276276
*
277277
* @throws {@link ResourceNotFoundException} (client fault)

‎clients/client-dynamodb/src/commands/RestoreTableToPointInTimeCommand.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,9 @@ export interface RestoreTableToPointInTimeCommandOutput extends RestoreTableToPo
3030
/**
3131
* <p>Restores the specified table to the specified point in time within
3232
* <code>EarliestRestorableDateTime</code> and <code>LatestRestorableDateTime</code>.
33-
* You can restore your table to any point in time in the last 35 days. You can set the recovery period to any value between 1 and 35 days. Any number of
34-
* users can execute up to 50 concurrent restores (any type of restore) in a given account. </p>
33+
* You can restore your table to any point in time in the last 35 days. You can set the
34+
* recovery period to any value between 1 and 35 days. Any number of users can execute up
35+
* to 50 concurrent restores (any type of restore) in a given account. </p>
3536
* <p>When you restore using point in time recovery, DynamoDB restores your table data to
3637
* the state based on the selected date and time (day:hour:minute:second) to a new table. </p>
3738
* <p>Along with data, the following are also included on the new restored table using point

‎clients/client-dynamodb/src/commands/ScanCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ export interface ScanCommandOutput extends ScanOutput, __MetadataBearer {}
255255
*
256256
* @throws {@link RequestLimitExceeded} (client fault)
257257
* <p>Throughput exceeds the current throughput quota for your account. Please contact
258-
* <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a
258+
* <a href="https://aws.amazon.com/support">Amazon Web ServicesSupport</a> to request a
259259
* quota increase.</p>
260260
*
261261
* @throws {@link ResourceNotFoundException} (client fault)

‎clients/client-dynamodb/src/commands/TagResourceCommand.ts

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,19 @@ export interface TagResourceCommandOutput extends __MetadataBearer {}
3535
* <ul>
3636
* <li>
3737
* <p>
38-
* <code>TagResource</code> is an asynchronous operation. If you issue a <a>ListTagsOfResource</a> request immediately after a <code>TagResource</code> request, DynamoDB might return your previous tag set, if there was one, or an empty tag set. This is because <code>ListTagsOfResource</code> uses an eventually consistent query, and the metadata for your tags or table might not be available at that moment. Wait for a few seconds, and then try the <code>ListTagsOfResource</code> request again.</p>
38+
* <code>TagResource</code> is an asynchronous operation. If you issue a <a>ListTagsOfResource</a> request immediately after a
39+
* <code>TagResource</code> request, DynamoDB might return your
40+
* previous tag set, if there was one, or an empty tag set. This is because
41+
* <code>ListTagsOfResource</code> uses an eventually consistent query, and the
42+
* metadata for your tags or table might not be available at that moment. Wait for
43+
* a few seconds, and then try the <code>ListTagsOfResource</code> request
44+
* again.</p>
3945
* </li>
4046
* <li>
41-
* <p>The application or removal of tags using <code>TagResource</code> and <code>UntagResource</code> APIs is eventually consistent. <code>ListTagsOfResource</code> API will only reflect the changes after a few seconds.</p>
47+
* <p>The application or removal of tags using <code>TagResource</code> and
48+
* <code>UntagResource</code> APIs is eventually consistent.
49+
* <code>ListTagsOfResource</code> API will only reflect the changes after a
50+
* few seconds.</p>
4251
* </li>
4352
* </ul>
4453
* <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>

‎clients/client-dynamodb/src/commands/TransactGetItemsCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ export interface TransactGetItemsCommandOutput extends TransactGetItemsOutput, _
222222
*
223223
* @throws {@link RequestLimitExceeded} (client fault)
224224
* <p>Throughput exceeds the current throughput quota for your account. Please contact
225-
* <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a
225+
* <a href="https://aws.amazon.com/support">Amazon Web ServicesSupport</a> to request a
226226
* quota increase.</p>
227227
*
228228
* @throws {@link ResourceNotFoundException} (client fault)

‎clients/client-dynamodb/src/commands/TransactWriteItemsCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -326,7 +326,7 @@ export interface TransactWriteItemsCommandOutput extends TransactWriteItemsOutpu
326326
*
327327
* @throws {@link RequestLimitExceeded} (client fault)
328328
* <p>Throughput exceeds the current throughput quota for your account. Please contact
329-
* <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a
329+
* <a href="https://aws.amazon.com/support">Amazon Web ServicesSupport</a> to request a
330330
* quota increase.</p>
331331
*
332332
* @throws {@link ResourceNotFoundException} (client fault)

‎clients/client-dynamodb/src/commands/UntagResourceCommand.ts

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,19 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {}
3333
* <ul>
3434
* <li>
3535
* <p>
36-
* <code>UntagResource</code> is an asynchronous operation. If you issue a <a>ListTagsOfResource</a> request immediately after an <code>UntagResource</code> request, DynamoDB might return your previous tag set, if there was one, or an empty tag set. This is because <code>ListTagsOfResource</code> uses an eventually consistent query, and the metadata for your tags or table might not be available at that moment. Wait for a few seconds, and then try the <code>ListTagsOfResource</code> request again.</p>
36+
* <code>UntagResource</code> is an asynchronous operation. If you issue a <a>ListTagsOfResource</a> request immediately after an
37+
* <code>UntagResource</code> request, DynamoDB might return your
38+
* previous tag set, if there was one, or an empty tag set. This is because
39+
* <code>ListTagsOfResource</code> uses an eventually consistent query, and the
40+
* metadata for your tags or table might not be available at that moment. Wait for
41+
* a few seconds, and then try the <code>ListTagsOfResource</code> request
42+
* again.</p>
3743
* </li>
3844
* <li>
39-
* <p>The application or removal of tags using <code>TagResource</code> and <code>UntagResource</code> APIs is eventually consistent. <code>ListTagsOfResource</code> API will only reflect the changes after a few seconds.</p>
45+
* <p>The application or removal of tags using <code>TagResource</code> and
46+
* <code>UntagResource</code> APIs is eventually consistent.
47+
* <code>ListTagsOfResource</code> API will only reflect the changes after a
48+
* few seconds.</p>
4049
* </li>
4150
* </ul>
4251
* <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>

‎clients/client-dynamodb/src/commands/UpdateContinuousBackupsCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ export interface UpdateContinuousBackupsCommandOutput extends UpdateContinuousBa
3939
* <code>LatestRestorableDateTime</code>. </p>
4040
* <p>
4141
* <code>LatestRestorableDateTime</code> is typically 5 minutes before the current time.
42-
* You can restore your table to any point in time in the last 35 days. You can set the recovery period to any value between 1 and 35 days.</p>
42+
* You can restore your table to any point in time in the last 35 days. You can set the
43+
* <code>RecoveryPeriodInDays</code> to any value between 1 and 35 days.</p>
4344
* @example
4445
* Use a bare-bones client and the command you need to make an API call.
4546
* ```javascript

‎clients/client-dynamodb/src/commands/UpdateItemCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ export interface UpdateItemCommandOutput extends UpdateItemOutput, __MetadataBea
210210
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
211211
*
212212
* @throws {@link ConditionalCheckFailedException} (client fault)
213-
* <p>A condition specified in the operation could not be evaluated.</p>
213+
* <p>A condition specified in the operation failed to be evaluated.</p>
214214
*
215215
* @throws {@link InternalServerError} (server fault)
216216
* <p>An error occurred on the server side.</p>
@@ -232,7 +232,7 @@ export interface UpdateItemCommandOutput extends UpdateItemOutput, __MetadataBea
232232
*
233233
* @throws {@link RequestLimitExceeded} (client fault)
234234
* <p>Throughput exceeds the current throughput quota for your account. Please contact
235-
* <a href="https://aws.amazon.com/support">Amazon Web Services Support</a> to request a
235+
* <a href="https://aws.amazon.com/support">Amazon Web ServicesSupport</a> to request a
236236
* quota increase.</p>
237237
*
238238
* @throws {@link ResourceNotFoundException} (client fault)

0 commit comments

Comments
 (0)