DynamoDbMapper (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.dynamodb.datamodeling.AbstractDynamoDbMapper
- - software.amazon.awssdk.services.dynamodb.datamodeling.DynamoDbMapper

All Implemented Interfaces:: IDynamoDbMapper

public class DynamoDbMapper
extends AbstractDynamoDbMapper

Object mapper for domain-object interaction with DynamoDB.

To use, define a domain class that represents an item in a DynamoDB table and annotate it with the annotations found in the software.amazon.awssdk.services.dynamodbv2.datamodeling package. In order to allow the mapper to correctly persist the data, each modeled property in the domain class should be accessible via getter and setter methods, and each property annotation should be either applied to the getter method or the class field. A minimal example using getter annotations:

 @DynamoDBTable(tableName = "TestTable")
 public class TestClass {

     private Long key;
     private double rangeKey;
     private Long version;

     private Set<Integer> integerSetAttribute;

     @DynamoDBHashKey
     public Long getKey() {
         return key;
     }

     public void setKey(Long key) {
         this.key = key;
     }

     @DynamoDBRangeKey
     public double getRangeKey() {
         return rangeKey;
     }

     public void setRangeKey(double rangeKey) {
         this.rangeKey = rangeKey;
     }

     @DynamoDBAttribute(attributeName = "integerSetAttribute")
     public Set<Integer> getIntegerAttribute() {
         return integerSetAttribute;
     }

     public void setIntegerAttribute(Set<Integer> integerAttribute) {
         this.integerSetAttribute = integerAttribute;
     }

     @DynamoDBVersionAttribute
     public Long getVersion() {
         return version;
     }

     public void setVersion(Long version) {
         this.version = version;
     }
 }

Save instances of annotated classes to DynamoDB, retrieve them, and delete them using the DynamoDbMapper class, as in the following example.

 DynamoDBMapper mapper = new DynamoDBMapper(dynamoDBClient);
 Long hashKey = 105L;
 double rangeKey = 1.0d;
 TestClass obj = mapper.load(TestClass.class, hashKey, rangeKey);
 obj.getIntegerAttribute().add(42);
 mapper.save(obj);
 mapper.delete(obj);

If you don't have your DynamoDB table set up yet, you can use AbstractDynamoDbMapper.generateCreateTableRequest(Class) to construct the CreateTableRequest for the table represented by your annotated class.

 DynamoDBClient dynamoDBClient = new AmazonDynamoDBClient();
 DynamoDBMapper mapper = new DynamoDBMapper(dynamoDBClient);
 CreateTableRequest req = mapper.generateCreateTableRequest(TestClass.class);
 // Table provision throughput is still required since it cannot be specified in your POJO
 req.setProvisionedThroughput(new ProvisionedThroughput(5L, 5L));
 // Fire off the CreateTableRequest using the low-level client
 dynamoDBClient.createTable(req);

When using the save, load, and delete methods, DynamoDbMapper will throw DynamoDbMappingExceptions to indicate that domain classes are incorrectly annotated or otherwise incompatible with this class. Service exceptions will always be propagated as SdkClientException, and DynamoDB-specific subclasses such as ConditionalCheckFailedException will be used when possible.

This class is thread-safe and can be shared between threads. It's also very lightweight, so it doesn't need to be.

See Also:: DynamoDbTable, DynamoDbHashKey, DynamoDbRangeKey, DynamoDbAutoGeneratedKey, DynamoDbAttribute, DynamoDbVersionAttribute, DynamoDbIgnore, DynamoDbMarshalling, DynamoDbMapperConfig

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`DynamoDbMapper.BatchGetItemException`
`static class`	`DynamoDbMapper.FailedBatch`	The return type of batchWrite, batchDelete and batchSave.

Constructor Summary

Constructors
Constructor	Description
`DynamoDbMapper(DynamoDBClient dynamoDb)`	Constructs a new mapper with the service object given, using the default configuration.
`DynamoDbMapper(DynamoDBClient ddb, AwsCredentialsProvider s3CredentialProvider)`	Constructs a new mapper with the service object and S3 client cache given, using the default configuration.
`DynamoDbMapper(DynamoDBClient dynamoDb, DynamoDbMapperConfig config)`	Constructs a new mapper with the service object and configuration given.
`DynamoDbMapper(DynamoDBClient dynamoDb, DynamoDbMapperConfig config, AwsCredentialsProvider s3CredentialProvider)`	Constructs a new mapper with the service object, configuration, and S3 client cache given.
`DynamoDbMapper(DynamoDBClient dynamoDb, DynamoDbMapperConfig config, AttributeTransformer transformer)`	Constructs a new mapper with the given service object, configuration, and transform hook.
`DynamoDbMapper(DynamoDBClient dynamoDb, DynamoDbMapperConfig config, AttributeTransformer transformer, AwsCredentialsProvider s3CredentialsProvider)`	Constructor with all parameters.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,List<Object>>`	`batchLoad(Iterable<? extends Object> itemsToGet, DynamoDbMapperConfig config)`	Retrieves multiple items from multiple tables using their primary keys.
`Map<String,List<Object>>`	`batchLoad(Map<Class<?>,List<KeyPair>> itemsToGet, DynamoDbMapperConfig config)`	Retrieves multiple items from multiple tables using their primary keys.
`List<DynamoDbMapper.FailedBatch>`	`batchWrite(Iterable<? extends Object> objectsToWrite, Iterable<? extends Object> objectsToDelete, DynamoDbMapperConfig config)`	Saves and deletes the objects given using one or more calls to the `DynamoDBClient.batchWriteItem(BatchWriteItemRequest)` API.
`int`	`count(Class<?> clazz, DynamoDbScanExpression scanExpression, DynamoDbMapperConfig config)`	Evaluates the specified scan expression and returns the count of matching items, without returning any of the actual item data.
`<T> int`	`count(Class<T> clazz, DynamoDbQueryExpression<T> queryExpression, DynamoDbMapperConfig config)`	Evaluates the specified query expression and returns the count of matching items, without returning any of the actual item data.
`S3Link`	`createS3Link(String s3region, String bucketName, String key)`	Creates an S3Link with the specified region, bucket name and key.
`S3Link`	`createS3Link(Region s3region, String bucketName, String key)`	Creates an S3Link with the specified region, bucket name and key.
`<T> void`	`delete(T object, DynamoDbDeleteExpression deleteExpression, DynamoDbMapperConfig config)`	Deletes the given object from its DynamoDB table using the provided deleteExpression and provided configuration.
`<T> CreateTableRequest`	`generateCreateTableRequest(Class<T> clazz, DynamoDbMapperConfig config)`
`<T> DeleteTableRequest`	`generateDeleteTableRequest(Class<T> clazz, DynamoDbMapperConfig config)`
`<T> DynamoDbMapperTableModel<T>`	`getTableModel(Class<T> clazz, DynamoDbMapperConfig config)`	Get the table model for the class using the provided configuration override.
`<T> T`	`load(Class<T> clazz, Object hashKey, Object rangeKey, DynamoDbMapperConfig config)`	Returns an object with the given hash key, or null if no such object exists.
`<T> T`	`load(T keyObject, DynamoDbMapperConfig config)`	Returns an object whose keys match those of the prototype key object given, or null if no such item exists.
`<T> T`	`marshallIntoObject(Class<T> clazz, Map<String,AttributeValue> itemAttributes, DynamoDbMapperConfig config)`
`<T> List<T>`	`marshallIntoObjects(Class<T> clazz, List<Map<String,AttributeValue>> itemAttributes, DynamoDbMapperConfig config)`
`<T,H,R> DynamoDbTableMapper<T,H,R>`	`newTableMapper(Class<T> clazz)`	Creates a new table mapper using this mapper to perform operations.
`<T> PaginatedParallelScanList<T>`	`parallelScan(Class<T> clazz, DynamoDbScanExpression scanExpression, int totalSegments, DynamoDbMapperConfig config)`	Scans through an Amazon DynamoDB table on logically partitioned segments in parallel.
`<T> PaginatedQueryList<T>`	`query(Class<T> clazz, DynamoDbQueryExpression<T> queryExpression, DynamoDbMapperConfig config)`	Queries an Amazon DynamoDB table and returns the matching results as an unmodifiable list of instantiated objects.
`<T> QueryResultPage<T>`	`queryPage(Class<T> clazz, DynamoDbQueryExpression<T> queryExpression, DynamoDbMapperConfig config)`	Queries an Amazon DynamoDB table and returns a single page of matching results.
`S3ClientCache`	`s3ClientCache()`	Returns the underlying `S3ClientCache` for accessing S3.
`<T> void`	`save(T object, DynamoDbSaveExpression saveExpression, DynamoDbMapperConfig config)`	Saves an item in DynamoDB.
`<T> PaginatedScanList<T>`	`scan(Class<T> clazz, DynamoDbScanExpression scanExpression, DynamoDbMapperConfig config)`	Scans through an Amazon DynamoDB table and returns the matching results as an unmodifiable list of instantiated objects.
`<T> ScanResultPage<T>`	`scanPage(Class<T> clazz, DynamoDbScanExpression scanExpression, DynamoDbMapperConfig config)`	Scans through an Amazon DynamoDB table and returns a single page of matching results.

Methods inherited from class software.amazon.awssdk.services.dynamodb.datamodeling.AbstractDynamoDbMapper
batchDelete, batchDelete, batchLoad, batchLoad, batchSave, batchSave, batchWrite, count, count, createS3Link, delete, delete, delete, generateCreateTableRequest, generateDeleteTableRequest, getTableModel, load, load, load, load, marshallIntoObject, marshallIntoObjects, parallelScan, query, queryPage, save, save, save, scan, scanPage

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DynamoDbMapper
```
public DynamoDbMapper(DynamoDBClient dynamoDb)
```
    Constructs a new mapper with the service object given, using the default configuration.
    
    Parameters:
    
    dynamoDb - The service object to use for all service calls.
    
    See Also:
    
    DynamoDbMapperConfig.DEFAULT
  - DynamoDbMapper
```
public DynamoDbMapper(DynamoDBClient dynamoDb,
                      DynamoDbMapperConfig config)
```
    Constructs a new mapper with the service object and configuration given.
    
    Parameters:
    
    dynamoDb - The service object to use for all service calls.
    
    config - The default configuration to use for all service calls. It can be overridden on a per-operation basis.
  - DynamoDbMapper
```
public DynamoDbMapper(DynamoDBClient ddb,
                      AwsCredentialsProvider s3CredentialProvider)
```
    Constructs a new mapper with the service object and S3 client cache given, using the default configuration.
    
    Parameters:
    
    ddb - The service object to use for all service calls.
    
    s3CredentialProvider - The credentials provider for accessing S3. Relevant only if S3Link is involved.
    
    See Also:
    
    DynamoDbMapperConfig.DEFAULT
  - DynamoDbMapper
```
public DynamoDbMapper(DynamoDBClient dynamoDb,
                      DynamoDbMapperConfig config,
                      AttributeTransformer transformer)
```
    Constructs a new mapper with the given service object, configuration, and transform hook.
    
    Parameters:
    
    dynamoDb - the service object to use for all service calls
    
    config - the default configuration to use for all service calls. It can be overridden on a per-operation basis
    
    transformer - The custom attribute transformer to invoke when serializing or deserializing an object.
  - DynamoDbMapper
```
public DynamoDbMapper(DynamoDBClient dynamoDb,
                      DynamoDbMapperConfig config,
                      AwsCredentialsProvider s3CredentialProvider)
```
    Constructs a new mapper with the service object, configuration, and S3 client cache given.
    
    Parameters:
    
    dynamoDb - The service object to use for all service calls.
    
    config - The default configuration to use for all service calls. It can be overridden on a per-operation basis.
    
    s3CredentialProvider - The credentials provider for accessing S3. Relevant only if S3Link is involved.
  - DynamoDbMapper
```
public DynamoDbMapper(DynamoDBClient dynamoDb,
                      DynamoDbMapperConfig config,
                      AttributeTransformer transformer,
                      AwsCredentialsProvider s3CredentialsProvider)
```
    Constructor with all parameters.
    
    Parameters:
    
    dynamoDb - The service object to use for all service calls.
    
    config - The default configuration to use for all service calls. It can be overridden on a per-operation basis.
    
    transformer - The custom attribute transformer to invoke when serializing or deserializing an object.
    
    s3CredentialsProvider - The credentials provider for accessing S3. Relevant only if S3Link is involved.
- Method Detail
  - getTableModel
```
public <T> DynamoDbMapperTableModel<T> getTableModel(Class<T> clazz,
                                                     DynamoDbMapperConfig config)
```
    Description copied from interface: IDynamoDbMapper
    
    Get the table model for the class using the provided configuration override.
    
    Specified by:
    
    getTableModel in interface IDynamoDbMapper
    
    Overrides:
    
    getTableModel in class AbstractDynamoDbMapper
  - load
```
public <T> T load(T keyObject,
                  DynamoDbMapperConfig config)
```
    Description copied from interface: IDynamoDbMapper
    
    Returns an object whose keys match those of the prototype key object given, or null if no such item exists.
    
    Specified by:
    
    load in interface IDynamoDbMapper
    
    Overrides:
    
    load in class AbstractDynamoDbMapper
    
    Parameters:
    
    keyObject - An object of the class to load with the keys values to match.
    
    config - Configuration for the service call to retrieve the object from DynamoDB. This configuration overrides the default given at construction.
  - load
```
public <T> T load(Class<T> clazz,
                  Object hashKey,
                  Object rangeKey,
                  DynamoDbMapperConfig config)
```
    Description copied from interface: IDynamoDbMapper
    
    Returns an object with the given hash key, or null if no such object exists.
    
    Specified by:
    
    load in interface IDynamoDbMapper
    
    Overrides:
    
    load in class AbstractDynamoDbMapper
    
    Parameters:
    
    clazz - The class to load, corresponding to a DynamoDB table.
    
    hashKey - The key of the object.
    
    rangeKey - The range key of the object, or null for tables without a range key.
    
    config - Configuration for the service call to retrieve the object from DynamoDB. This configuration overrides the default given at construction.
  - marshallIntoObject
```
public <T> T marshallIntoObject(Class<T> clazz,
                                Map<String,AttributeValue> itemAttributes,
                                DynamoDbMapperConfig config)
```
    Overrides:
    
    marshallIntoObject in class AbstractDynamoDbMapper
  - marshallIntoObjects
```
public <T> List<T> marshallIntoObjects(Class<T> clazz,
                                       List<Map<String,AttributeValue>> itemAttributes,
                                       DynamoDbMapperConfig config)
```
    Overrides:
    
    marshallIntoObjects in class AbstractDynamoDbMapper
  - save
```
public <T> void save(T object,
                     DynamoDbSaveExpression saveExpression,
                     DynamoDbMapperConfig config)
```
    Description copied from interface: IDynamoDbMapper
    Saves an item in DynamoDB. The service method used is determined by the DynamoDbMapperConfig.saveBehavior() value, to use either DynamoDBClient.putItem(PutItemRequest) or DynamoDBClient.updateItem(UpdateItemRequest):
    - UPDATE (default) : UPDATE will not affect unmodeled attributes on a save operation and a null value for the modeled attribute will remove it from that item in DynamoDB. Because of the limitation of updateItem request, the implementation of UPDATE will send a putItem request when a key-only object is being saved, and it will send another updateItem request if the given key(s) already exists in the table.
    - UPDATE_SKIP_NULL_ATTRIBUTES : Similar to UPDATE except that it ignores any null value attribute(s) and will NOT remove them from that item in DynamoDB. It also guarantees to send only one single updateItem request, no matter the object is key-only or not.
    - CLOBBER : CLOBBER will clear and replace all attributes, included unmodeled ones, (delete and recreate) on save. Versioned field constraints will also be disregarded.
    Any options specified in the saveExpression parameter will be overlaid on any constraints due to versioned attributes.
    Specified by:
    
    save in interface IDynamoDbMapper
    
    Overrides:
    
    save in class AbstractDynamoDbMapper
    
    Parameters:
    
    object - The object to save into DynamoDB
    
    saveExpression - The options to apply to this save request
    
    config - The configuration to use, which overrides the default provided at object construction.
    
    See Also:
    
    DynamoDbMapperConfig.SaveBehavior
  - delete
```
public <T> void delete(T object,
                       DynamoDbDeleteExpression deleteExpression,
                       DynamoDbMapperConfig config)
```
    Description copied from interface: IDynamoDbMapper
    
    Deletes the given object from its DynamoDB table using the provided deleteExpression and provided configuration. Any options specified in the deleteExpression parameter will be overlaid on any constraints due to versioned attributes.
    
    Specified by:
    
    delete in interface IDynamoDbMapper
    
    Overrides:
    
    delete in class AbstractDynamoDbMapper
    
    deleteExpression - The options to apply to this delete request
    
    config - Config override object. If DynamoDbMapperConfig.SaveBehavior.CLOBBER is supplied, version fields will not be considered when deleting the object.
  - batchWrite
```
public List<DynamoDbMapper.FailedBatch> batchWrite(Iterable<? extends Object> objectsToWrite,
                                                   Iterable<? extends Object> objectsToDelete,
                                                   DynamoDbMapperConfig config)
```
    Description copied from interface: IDynamoDbMapper
    
    Saves and deletes the objects given using one or more calls to the DynamoDBClient.batchWriteItem(BatchWriteItemRequest) API. Use mapper config to control the retry strategy when UnprocessedItems are returned by the BatchWriteItem API
    This method fails to save the batch if the size of an individual object in the batch exceeds 400 KB. For more information on batch restrictions see, http://docs.aws.amazon .com/amazondynamodb/latest/APIReference/API_BatchWriteItem.html
    
    If one of the write requests is for a table that is not present, this method does not throw a ResourceNotFoundException but returns a FailedBatch which includes this exception and the unprocessed items.
    
    Specified by:
    
    batchWrite in interface IDynamoDbMapper
    
    Overrides:
    
    batchWrite in class AbstractDynamoDbMapper
    
    Parameters:
    
    objectsToWrite - A list of objects to save to DynamoDB. No version checks are performed, as required by the DynamoDBClient.batchWriteItem(BatchWriteItemRequest) API.
    
    objectsToDelete - A list of objects to delete from DynamoDB. No version checks are performed, as required by the DynamoDBClient.batchWriteItem(BatchWriteItemRequest) API.
    
    config - Only DynamoDbMapperConfig.getTableNameOverride() and DynamoDbMapperConfig.batchWriteRetryStrategy() are considered. If TableNameOverride is specified, all objects in the two parameter lists will be considered to belong to the given table override. In particular, this method always acts as if SaveBehavior.CLOBBER was specified regardless of the value of the config parameter.
    
    Returns:
    
    A list of failed batches which includes the unprocessed items and the exceptions causing the failure.
    
    See Also:
    
    DynamoDbMapperConfig.getTableNameOverride(), DynamoDbMapperConfig.batchWriteRetryStrategy()
  - batchLoad
```
public Map<String,List<Object>> batchLoad(Iterable<? extends Object> itemsToGet,
                                          DynamoDbMapperConfig config)
```
    Description copied from interface: IDynamoDbMapper
    
    Retrieves multiple items from multiple tables using their primary keys.
    
    Specified by:
    
    batchLoad in interface IDynamoDbMapper
    
    Overrides:
    
    batchLoad in class AbstractDynamoDbMapper
    
    Parameters:
    
    itemsToGet - Key objects, corresponding to the class to fetch, with their primary key values set.
    
    config - Only DynamoDbMapperConfig.getTableNameOverride() and DynamoDbMapperConfig.getConsistentReads() are considered.
    
    Returns:
    
    A map of the loaded objects. Each key in the map is the name of a DynamoDB table. Each value in the map is a list of objects that have been loaded from that table. All objects for each table can be cast to the associated user defined type that is annotated as mapping that table.
  - batchLoad
```
public Map<String,List<Object>> batchLoad(Map<Class<?>,List<KeyPair>> itemsToGet,
                                          DynamoDbMapperConfig config)
```
    Description copied from interface: IDynamoDbMapper
    
    Retrieves multiple items from multiple tables using their primary keys. Valid only for tables with a single hash key, or a single hash and range key. For other schemas, use DynamoDbMapper#batchLoad(List, DynamoDbMapperConfig)
    
    Specified by:
    
    batchLoad in interface IDynamoDbMapper
    
    Overrides:
    
    batchLoad in class AbstractDynamoDbMapper
    
    Parameters:
    
    itemsToGet - Map from class to load to list of primary key attributes.
    
    config - Only DynamoDbMapperConfig.getTableNameOverride() and DynamoDbMapperConfig.getConsistentReads() are considered.
    
    Returns:
    
    A map of the loaded objects. Each key in the map is the name of a DynamoDB table. Each value in the map is a list of objects that have been loaded from that table. All objects for each table can be cast to the associated user defined type that is annotated as mapping that table.
  - scan
```
public <T> PaginatedScanList<T> scan(Class<T> clazz,
                                     DynamoDbScanExpression scanExpression,
                                     DynamoDbMapperConfig config)
```
    Description copied from interface: IDynamoDbMapper
    
    Scans through an Amazon DynamoDB table and returns the matching results as an unmodifiable list of instantiated objects. The table to scan is determined by looking at the annotations on the specified class, which declares where to store the object data in Amazon DynamoDB, and the scan expression parameter allows the caller to filter results and control how the scan is executed.
    Callers should be aware that the returned list is unmodifiable, and any attempts to modify the list will result in an UnsupportedOperationException.
    You can specify the pagination loading strategy for this scan operation. By default, the list returned is lazily loaded when possible.
    
    Specified by:
    
    scan in interface IDynamoDbMapper
    
    Overrides:
    
    scan in class AbstractDynamoDbMapper
    
    Type Parameters:
    
    T - The type of the objects being returned.
    
    Parameters:
    
    clazz - The class annotated with DynamoDB annotations describing how to store the object data in Amazon DynamoDB.
    
    scanExpression - Details on how to run the scan, including any filters to apply to limit results.
    
    config - The configuration to use for this scan, which overrides the default provided at object construction.
    
    Returns:
    
    An unmodifiable list of the objects constructed from the results of the scan operation.
    
    See Also:
    
    PaginatedScanList, DynamoDbMapperConfig.PaginationLoadingStrategy
  - parallelScan
```
public <T> PaginatedParallelScanList<T> parallelScan(Class<T> clazz,
                                                     DynamoDbScanExpression scanExpression,
                                                     int totalSegments,
                                                     DynamoDbMapperConfig config)
```
    Description copied from interface: IDynamoDbMapper
    
    Scans through an Amazon DynamoDB table on logically partitioned segments in parallel. This method will create a thread pool of the specified size, and each thread will issue scan requests for its assigned segment, following the returned continuation token, until the end of its segment. Callers should be responsible for setting the appropriate number of total segments. More scan segments would result in better performance but more consumed capacity of the table. The results are returned in one unmodifiable list of instantiated objects. The table to scan is determined by looking at the annotations on the specified class, which declares where to store the object data in Amazon DynamoDB, and the scan expression parameter allows the caller to filter results and control how the scan is executed.
    Callers should be aware that the returned list is unmodifiable, and any attempts to modify the list will result in an UnsupportedOperationException.
    You can specify the pagination loading strategy for this parallel scan operation. By default, the list returned is lazily loaded when possible.
    
    Specified by:
    
    parallelScan in interface IDynamoDbMapper
    
    Overrides:
    
    parallelScan in class AbstractDynamoDbMapper
    
    Type Parameters:
    
    T - The type of the objects being returned.
    
    Parameters:
    
    clazz - The class annotated with DynamoDB annotations describing how to store the object data in Amazon DynamoDB.
    
    scanExpression - Details on how to run the scan, including any filters to apply to limit results.
    
    totalSegments - Number of total parallel scan segments. Range: 1 - 4096
    
    config - The configuration to use for this scan, which overrides the default provided at object construction.
    
    Returns:
    
    An unmodifiable list of the objects constructed from the results of the scan operation.
    
    See Also:
    
    PaginatedParallelScanList, DynamoDbMapperConfig.PaginationLoadingStrategy
  - scanPage
```
public <T> ScanResultPage<T> scanPage(Class<T> clazz,
                                      DynamoDbScanExpression scanExpression,
                                      DynamoDbMapperConfig config)
```
    Description copied from interface: IDynamoDbMapper
    
    Scans through an Amazon DynamoDB table and returns a single page of matching results. The table to scan is determined by looking at the annotations on the specified class, which declares where to store the object data in AWS DynamoDB, and the scan expression parameter allows the caller to filter results and control how the scan is executed.
    
    Specified by:
    
    scanPage in interface IDynamoDbMapper
    
    Overrides:
    
    scanPage in class AbstractDynamoDbMapper
    
    Type Parameters:
    
    T - The type of the objects being returned.
    
    Parameters:
    
    clazz - The class annotated with DynamoDB annotations describing how to store the object data in Amazon DynamoDB.
    
    scanExpression - Details on how to run the scan, including any filters to apply to limit results.
    
    config - The configuration to use for this scan, which overrides the default provided at object construction.
  - query
```
public <T> PaginatedQueryList<T> query(Class<T> clazz,
                                       DynamoDbQueryExpression<T> queryExpression,
                                       DynamoDbMapperConfig config)
```
    Description copied from interface: IDynamoDbMapper
    
    Queries an Amazon DynamoDB table and returns the matching results as an unmodifiable list of instantiated objects. The table to query is determined by looking at the annotations on the specified class, which declares where to store the object data in Amazon DynamoDB, and the query expression parameter allows the caller to filter results and control how the query is executed.
    When the query is on any local/global secondary index, callers should be aware that the returned object(s) will only contain item attributes that are projected into the index. All the other unprojected attributes will be saved as type default values.
    Callers should also be aware that the returned list is unmodifiable, and any attempts to modify the list will result in an UnsupportedOperationException.
    You can specify the pagination loading strategy for this query operation. By default, the list returned is lazily loaded when possible.
    
    Specified by:
    
    query in interface IDynamoDbMapper
    
    Overrides:
    
    query in class AbstractDynamoDbMapper
    
    Type Parameters:
    
    T - The type of the objects being returned.
    
    Parameters:
    
    clazz - The class annotated with DynamoDB annotations describing how to store the object data in Amazon DynamoDB.
    
    queryExpression - Details on how to run the query, including any conditions on the key values
    
    config - The configuration to use for this query, which overrides the default provided at object construction.
    
    Returns:
    
    An unmodifiable list of the objects constructed from the results of the query operation.
    
    See Also:
    
    PaginatedQueryList, DynamoDbMapperConfig.PaginationLoadingStrategy
  - queryPage
```
public <T> QueryResultPage<T> queryPage(Class<T> clazz,
                                        DynamoDbQueryExpression<T> queryExpression,
                                        DynamoDbMapperConfig config)
```
    Description copied from interface: IDynamoDbMapper
    
    Queries an Amazon DynamoDB table and returns a single page of matching results. The table to query is determined by looking at the annotations on the specified class, which declares where to store the object data in Amazon DynamoDB, and the query expression parameter allows the caller to filter results and control how the query is executed.
    
    Specified by:
    
    queryPage in interface IDynamoDbMapper
    
    Overrides:
    
    queryPage in class AbstractDynamoDbMapper
    
    Type Parameters:
    
    T - The type of the objects being returned.
    
    Parameters:
    
    clazz - The class annotated with DynamoDB annotations describing how to store the object data in AWS DynamoDB.
    
    queryExpression - Details on how to run the query, including any conditions on the key values
    
    config - The configuration to use for this query, which overrides the default provided at object construction.
  - count
```
public int count(Class<?> clazz,
                 DynamoDbScanExpression scanExpression,
                 DynamoDbMapperConfig config)
```
    Description copied from interface: IDynamoDbMapper
    
    Evaluates the specified scan expression and returns the count of matching items, without returning any of the actual item data.
    This operation will scan your entire table, and can therefore be very expensive. Use with caution.
    
    Specified by:
    
    count in interface IDynamoDbMapper
    
    Overrides:
    
    count in class AbstractDynamoDbMapper
    
    Parameters:
    
    clazz - The class mapped to a DynamoDB table.
    
    scanExpression - The parameters for running the scan.
    
    config - The configuration to use for this scan, which overrides the default provided at object construction.
    
    Returns:
    
    The count of matching items, without returning any of the actual item data.
  - count
```
public <T> int count(Class<T> clazz,
                     DynamoDbQueryExpression<T> queryExpression,
                     DynamoDbMapperConfig config)
```
    Description copied from interface: IDynamoDbMapper
    
    Evaluates the specified query expression and returns the count of matching items, without returning any of the actual item data.
    
    Specified by:
    
    count in interface IDynamoDbMapper
    
    Overrides:
    
    count in class AbstractDynamoDbMapper
    
    Parameters:
    
    clazz - The class mapped to a DynamoDB table.
    
    queryExpression - The parameters for running the scan.
    
    config - The mapper configuration to use for the query, which overrides the default provided at object construction.
    
    Returns:
    
    The count of matching items, without returning any of the actual item data.
  - s3ClientCache
```
public S3ClientCache s3ClientCache()
```
    Description copied from interface: IDynamoDbMapper
    
    Returns the underlying S3ClientCache for accessing S3.
    
    Specified by:
    
    s3ClientCache in interface IDynamoDbMapper
    
    Overrides:
    
    s3ClientCache in class AbstractDynamoDbMapper
  - createS3Link
```
public S3Link createS3Link(Region s3region,
                           String bucketName,
                           String key)
```
    Description copied from interface: IDynamoDbMapper
    
    Creates an S3Link with the specified region, bucket name and key. This method requires the mapper to have been initialized with the necessary credentials for accessing S3.
    
    Specified by:
    
    createS3Link in interface IDynamoDbMapper
    
    Overrides:
    
    createS3Link in class AbstractDynamoDbMapper
  - createS3Link
```
public S3Link createS3Link(String s3region,
                           String bucketName,
                           String key)
```
    Description copied from interface: IDynamoDbMapper
    
    Creates an S3Link with the specified region, bucket name and key. This method requires the mapper to have been initialized with the necessary credentials for accessing S3.
    
    Specified by:
    
    createS3Link in interface IDynamoDbMapper
    
    Overrides:
    
    createS3Link in class AbstractDynamoDbMapper
  - generateCreateTableRequest
```
public <T> CreateTableRequest generateCreateTableRequest(Class<T> clazz,
                                                         DynamoDbMapperConfig config)
```
    Overrides:
    
    generateCreateTableRequest in class AbstractDynamoDbMapper
  - generateDeleteTableRequest
```
public <T> DeleteTableRequest generateDeleteTableRequest(Class<T> clazz,
                                                         DynamoDbMapperConfig config)
```
    Overrides:
    
    generateDeleteTableRequest in class AbstractDynamoDbMapper
  - newTableMapper
```
public <T,H,R> DynamoDbTableMapper<T,H,R> newTableMapper(Class<T> clazz)
```
    Creates a new table mapper using this mapper to perform operations.
    
    Type Parameters:
    
    T - The object type which this mapper operates.
    
    H - The hash key value type.
    
    R - The range key value type; use ? if no range key.
    
    Parameters:
    
    clazz - The object class.
    
    Returns:
    
    The table mapper.

Class DynamoDbMapper

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.dynamodb.datamodeling.AbstractDynamoDbMapper

Methods inherited from class java.lang.Object

Constructor Detail

DynamoDbMapper

DynamoDbMapper

DynamoDbMapper

DynamoDbMapper

DynamoDbMapper

DynamoDbMapper

Method Detail

getTableModel

load

load

marshallIntoObject

marshallIntoObjects

save

delete

batchWrite

batchLoad

batchLoad

scan

parallelScan

scanPage

query

queryPage

count

count

s3ClientCache

createS3Link

createS3Link

generateCreateTableRequest

generateDeleteTableRequest

newTableMapper