Skip to content

Commit c015a19

Browse files
authored
Update Enhanced client docs (#4031)
The docs for transactGetItems and transactWriteItems contained outdated information regarding the max number of items. This makes the doc a bit more generic by not specifying the max number, and linking to the low-level client docs for more information.
1 parent f611a86 commit c015a19

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/DynamoDbEnhancedClient.java

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ default BatchWriteResult batchWriteItem(Consumer<BatchWriteItemEnhancedRequest.B
269269

270270
/**
271271
* Retrieves multiple items from one or more tables in a single atomic transaction. TransactGetItem is a composite operation
272-
* where the request contains a set of up to 25 get requests, each containing a table reference and a
272+
* where the request contains a set of get requests, each containing a table reference and a
273273
* {@link GetItemEnhancedRequest}. The list of results correspond to the ordering of the request definitions; for example
274274
* the third addGetItem() call on the request builder will match the third result (index 2) of the result.
275275
* <p>
@@ -297,6 +297,7 @@ default BatchWriteResult batchWriteItem(Consumer<BatchWriteItemEnhancedRequest.B
297297
* MyItem item = results.get(3).getItem(secondItemTable);
298298
* }
299299
* </pre>
300+
* See {@link DynamoDbClient#transactGetItems(Consumer)} to learn more about {@code TransactGetItems}.
300301
*
301302
* @param request A {@link TransactGetItemsEnhancedRequest} containing keys with table references.
302303
* @return a list of {@link Document} with the results.
@@ -307,7 +308,7 @@ default List<Document> transactGetItems(TransactGetItemsEnhancedRequest request)
307308

308309
/**
309310
* Retrieves multiple items from one or more tables in a single atomic transaction. TransactGetItem is a composite operation
310-
* where the request contains a set of up to 25 get requests, each containing a table reference and a
311+
* where the request contains a set of get requests, each containing a table reference and a
311312
* {@link GetItemEnhancedRequest}. The list of results correspond to the ordering of the request definitions; for example
312313
* the third addGetItem() call on the request builder will match the third result (index 2) of the result.
313314
* <p>
@@ -336,17 +337,20 @@ default List<Document> transactGetItems(TransactGetItemsEnhancedRequest request)
336337
* MyItem item = results.get(3).getItem(secondItemTable);
337338
* }
338339
* </pre>
340+
* <p>
341+
* See {@link DynamoDbClient#transactGetItems(Consumer)} to learn more about {@code TransactGetItems}.
339342
*
340343
* @param requestConsumer a {@link Consumer} of {@link TransactGetItemsEnhancedRequest} containing keys with table references.
341344
* @return a list of {@link Document} with the results.
345+
*
342346
*/
343347
default List<Document> transactGetItems(Consumer<TransactGetItemsEnhancedRequest.Builder> requestConsumer) {
344348
throw new UnsupportedOperationException();
345349
}
346350

347351
/**
348352
* Writes and/or modifies multiple items from one or more tables in a single atomic transaction. TransactGetItem is a
349-
* composite operation where the request contains a set of up to 25 action requests, each containing a table reference and
353+
* composite operation where the request contains a set of action requests, each containing a table reference and
350354
* one of the following requests:
351355
* <ul>
352356
* <li>Condition check of item - {@link ConditionCheck}</li>
@@ -384,6 +388,7 @@ default List<Document> transactGetItems(Consumer<TransactGetItemsEnhancedRequest
384388
* .build());
385389
* }
386390
* </pre>
391+
* See {@link DynamoDbClient#transactWriteItems(Consumer)} to learn more about {@code TransactWriteItems}.
387392
*
388393
* @param request A {@link BatchWriteItemEnhancedRequest} containing keys grouped by tables.
389394
*/
@@ -393,7 +398,7 @@ default Void transactWriteItems(TransactWriteItemsEnhancedRequest request) {
393398

394399
/**
395400
* Writes and/or modifies multiple items from one or more tables in a single atomic transaction. TransactGetItem is a
396-
* composite operation where the request contains a set of up to 25 action requests, each containing a table reference and
401+
* composite operation where the request contains a set of action requests, each containing a table reference and
397402
* one of the following requests:
398403
* <ul>
399404
* <li>Condition check of item - {@link ConditionCheck}</li>
@@ -427,6 +432,7 @@ default Void transactWriteItems(TransactWriteItemsEnhancedRequest request) {
427432
* .addUpdateItem(secondItemTable, i -> i.item(item4)));
428433
* }
429434
* </pre>
435+
* See {@link DynamoDbClient#transactWriteItems(Consumer)} to learn more about {@code TransactWriteItems}.
430436
*
431437
* @param requestConsumer a {@link Consumer} of {@link TransactWriteItemsEnhancedRequest} containing keys and items grouped
432438
* by tables.

0 commit comments

Comments
 (0)