Interface DynamoDbAsyncClient
-
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface DynamoDbAsyncClient extends AwsClient
Service client for accessing DynamoDB asynchronously. This can be created using the staticbuilder()
method.Amazon DynamoDB Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. DynamoDB lets you offload the administrative burdens of operating and scaling a distributed database, so that you don't have to worry about hardware provisioning, setup and configuration, replication, software patching, or cluster scaling.
With DynamoDB, you can create database tables that can store and retrieve any amount of data, and serve any level of request traffic. You can scale up or scale down your tables' throughput capacity without downtime or performance degradation, and use the Amazon Web Services Management Console to monitor resource utilization and performance metrics.
DynamoDB automatically spreads the data and traffic for your tables over a sufficient number of servers to handle your throughput and storage requirements, while maintaining consistent and fast performance. All of your data is stored on solid state disks (SSDs) and automatically replicated across multiple Availability Zones in an Amazon Web Services Region, providing built-in high availability and data durability.
-
-
Field Summary
Fields Modifier and Type Field Description static String
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.static String
SERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description default CompletableFuture<BatchExecuteStatementResponse>
batchExecuteStatement(Consumer<BatchExecuteStatementRequest.Builder> batchExecuteStatementRequest)
This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL.default CompletableFuture<BatchExecuteStatementResponse>
batchExecuteStatement(BatchExecuteStatementRequest batchExecuteStatementRequest)
This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL.default CompletableFuture<BatchGetItemResponse>
batchGetItem(Consumer<BatchGetItemRequest.Builder> batchGetItemRequest)
TheBatchGetItem
operation returns the attributes of one or more items from one or more tables.default CompletableFuture<BatchGetItemResponse>
batchGetItem(BatchGetItemRequest batchGetItemRequest)
TheBatchGetItem
operation returns the attributes of one or more items from one or more tables.default BatchGetItemPublisher
batchGetItemPaginator(Consumer<BatchGetItemRequest.Builder> batchGetItemRequest)
This is a variant ofbatchGetItem(software.amazon.awssdk.services.dynamodb.model.BatchGetItemRequest)
operation.default BatchGetItemPublisher
batchGetItemPaginator(BatchGetItemRequest batchGetItemRequest)
This is a variant ofbatchGetItem(software.amazon.awssdk.services.dynamodb.model.BatchGetItemRequest)
operation.default CompletableFuture<BatchWriteItemResponse>
batchWriteItem(Consumer<BatchWriteItemRequest.Builder> batchWriteItemRequest)
TheBatchWriteItem
operation puts or deletes multiple items in one or more tables.default CompletableFuture<BatchWriteItemResponse>
batchWriteItem(BatchWriteItemRequest batchWriteItemRequest)
TheBatchWriteItem
operation puts or deletes multiple items in one or more tables.static DynamoDbAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aDynamoDbAsyncClient
.static DynamoDbAsyncClient
create()
Create aDynamoDbAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture<CreateBackupResponse>
createBackup(Consumer<CreateBackupRequest.Builder> createBackupRequest)
Creates a backup for an existing table.default CompletableFuture<CreateBackupResponse>
createBackup(CreateBackupRequest createBackupRequest)
Creates a backup for an existing table.default CompletableFuture<CreateGlobalTableResponse>
createGlobalTable(Consumer<CreateGlobalTableRequest.Builder> createGlobalTableRequest)
Creates a global table from an existing table.default CompletableFuture<CreateGlobalTableResponse>
createGlobalTable(CreateGlobalTableRequest createGlobalTableRequest)
Creates a global table from an existing table.default CompletableFuture<CreateTableResponse>
createTable(Consumer<CreateTableRequest.Builder> createTableRequest)
TheCreateTable
operation adds a new table to your account.default CompletableFuture<CreateTableResponse>
createTable(CreateTableRequest createTableRequest)
TheCreateTable
operation adds a new table to your account.default CompletableFuture<DeleteBackupResponse>
deleteBackup(Consumer<DeleteBackupRequest.Builder> deleteBackupRequest)
Deletes an existing backup of a table.default CompletableFuture<DeleteBackupResponse>
deleteBackup(DeleteBackupRequest deleteBackupRequest)
Deletes an existing backup of a table.default CompletableFuture<DeleteItemResponse>
deleteItem(Consumer<DeleteItemRequest.Builder> deleteItemRequest)
Deletes a single item in a table by primary key.default CompletableFuture<DeleteItemResponse>
deleteItem(DeleteItemRequest deleteItemRequest)
Deletes a single item in a table by primary key.default CompletableFuture<DeleteTableResponse>
deleteTable(Consumer<DeleteTableRequest.Builder> deleteTableRequest)
TheDeleteTable
operation deletes a table and all of its items.default CompletableFuture<DeleteTableResponse>
deleteTable(DeleteTableRequest deleteTableRequest)
TheDeleteTable
operation deletes a table and all of its items.default CompletableFuture<DescribeBackupResponse>
describeBackup(Consumer<DescribeBackupRequest.Builder> describeBackupRequest)
Describes an existing backup of a table.default CompletableFuture<DescribeBackupResponse>
describeBackup(DescribeBackupRequest describeBackupRequest)
Describes an existing backup of a table.default CompletableFuture<DescribeContinuousBackupsResponse>
describeContinuousBackups(Consumer<DescribeContinuousBackupsRequest.Builder> describeContinuousBackupsRequest)
Checks the status of continuous backups and point in time recovery on the specified table.default CompletableFuture<DescribeContinuousBackupsResponse>
describeContinuousBackups(DescribeContinuousBackupsRequest describeContinuousBackupsRequest)
Checks the status of continuous backups and point in time recovery on the specified table.default CompletableFuture<DescribeContributorInsightsResponse>
describeContributorInsights(Consumer<DescribeContributorInsightsRequest.Builder> describeContributorInsightsRequest)
Returns information about contributor insights for a given table or global secondary index.default CompletableFuture<DescribeContributorInsightsResponse>
describeContributorInsights(DescribeContributorInsightsRequest describeContributorInsightsRequest)
Returns information about contributor insights for a given table or global secondary index.default CompletableFuture<DescribeEndpointsResponse>
describeEndpoints()
Returns the regional endpoint information.default CompletableFuture<DescribeEndpointsResponse>
describeEndpoints(Consumer<DescribeEndpointsRequest.Builder> describeEndpointsRequest)
Returns the regional endpoint information.default CompletableFuture<DescribeEndpointsResponse>
describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest)
Returns the regional endpoint information.default CompletableFuture<DescribeExportResponse>
describeExport(Consumer<DescribeExportRequest.Builder> describeExportRequest)
Describes an existing table export.default CompletableFuture<DescribeExportResponse>
describeExport(DescribeExportRequest describeExportRequest)
Describes an existing table export.default CompletableFuture<DescribeGlobalTableResponse>
describeGlobalTable(Consumer<DescribeGlobalTableRequest.Builder> describeGlobalTableRequest)
Returns information about the specified global table.default CompletableFuture<DescribeGlobalTableResponse>
describeGlobalTable(DescribeGlobalTableRequest describeGlobalTableRequest)
Returns information about the specified global table.default CompletableFuture<DescribeGlobalTableSettingsResponse>
describeGlobalTableSettings(Consumer<DescribeGlobalTableSettingsRequest.Builder> describeGlobalTableSettingsRequest)
Describes Region-specific settings for a global table.default CompletableFuture<DescribeGlobalTableSettingsResponse>
describeGlobalTableSettings(DescribeGlobalTableSettingsRequest describeGlobalTableSettingsRequest)
Describes Region-specific settings for a global table.default CompletableFuture<DescribeImportResponse>
describeImport(Consumer<DescribeImportRequest.Builder> describeImportRequest)
Represents the properties of the import.default CompletableFuture<DescribeImportResponse>
describeImport(DescribeImportRequest describeImportRequest)
Represents the properties of the import.default CompletableFuture<DescribeKinesisStreamingDestinationResponse>
describeKinesisStreamingDestination(Consumer<DescribeKinesisStreamingDestinationRequest.Builder> describeKinesisStreamingDestinationRequest)
Returns information about the status of Kinesis streaming.default CompletableFuture<DescribeKinesisStreamingDestinationResponse>
describeKinesisStreamingDestination(DescribeKinesisStreamingDestinationRequest describeKinesisStreamingDestinationRequest)
Returns information about the status of Kinesis streaming.default CompletableFuture<DescribeLimitsResponse>
describeLimits()
Returns the current provisioned-capacity quotas for your Amazon Web Services account in a Region, both for the Region as a whole and for any one DynamoDB table that you create there.default CompletableFuture<DescribeLimitsResponse>
describeLimits(Consumer<DescribeLimitsRequest.Builder> describeLimitsRequest)
Returns the current provisioned-capacity quotas for your Amazon Web Services account in a Region, both for the Region as a whole and for any one DynamoDB table that you create there.default CompletableFuture<DescribeLimitsResponse>
describeLimits(DescribeLimitsRequest describeLimitsRequest)
Returns the current provisioned-capacity quotas for your Amazon Web Services account in a Region, both for the Region as a whole and for any one DynamoDB table that you create there.default CompletableFuture<DescribeTableResponse>
describeTable(Consumer<DescribeTableRequest.Builder> describeTableRequest)
Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.default CompletableFuture<DescribeTableResponse>
describeTable(DescribeTableRequest describeTableRequest)
Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.default CompletableFuture<DescribeTableReplicaAutoScalingResponse>
describeTableReplicaAutoScaling(Consumer<DescribeTableReplicaAutoScalingRequest.Builder> describeTableReplicaAutoScalingRequest)
Describes auto scaling settings across replicas of the global table at once.default CompletableFuture<DescribeTableReplicaAutoScalingResponse>
describeTableReplicaAutoScaling(DescribeTableReplicaAutoScalingRequest describeTableReplicaAutoScalingRequest)
Describes auto scaling settings across replicas of the global table at once.default CompletableFuture<DescribeTimeToLiveResponse>
describeTimeToLive(Consumer<DescribeTimeToLiveRequest.Builder> describeTimeToLiveRequest)
Gives a description of the Time to Live (TTL) status on the specified table.default CompletableFuture<DescribeTimeToLiveResponse>
describeTimeToLive(DescribeTimeToLiveRequest describeTimeToLiveRequest)
Gives a description of the Time to Live (TTL) status on the specified table.default CompletableFuture<DisableKinesisStreamingDestinationResponse>
disableKinesisStreamingDestination(Consumer<DisableKinesisStreamingDestinationRequest.Builder> disableKinesisStreamingDestinationRequest)
Stops replication from the DynamoDB table to the Kinesis data stream.default CompletableFuture<DisableKinesisStreamingDestinationResponse>
disableKinesisStreamingDestination(DisableKinesisStreamingDestinationRequest disableKinesisStreamingDestinationRequest)
Stops replication from the DynamoDB table to the Kinesis data stream.default CompletableFuture<EnableKinesisStreamingDestinationResponse>
enableKinesisStreamingDestination(Consumer<EnableKinesisStreamingDestinationRequest.Builder> enableKinesisStreamingDestinationRequest)
Starts table data replication to the specified Kinesis data stream at a timestamp chosen during the enable workflow.default CompletableFuture<EnableKinesisStreamingDestinationResponse>
enableKinesisStreamingDestination(EnableKinesisStreamingDestinationRequest enableKinesisStreamingDestinationRequest)
Starts table data replication to the specified Kinesis data stream at a timestamp chosen during the enable workflow.default CompletableFuture<ExecuteStatementResponse>
executeStatement(Consumer<ExecuteStatementRequest.Builder> executeStatementRequest)
This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL.default CompletableFuture<ExecuteStatementResponse>
executeStatement(ExecuteStatementRequest executeStatementRequest)
This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL.default CompletableFuture<ExecuteTransactionResponse>
executeTransaction(Consumer<ExecuteTransactionRequest.Builder> executeTransactionRequest)
This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL.default CompletableFuture<ExecuteTransactionResponse>
executeTransaction(ExecuteTransactionRequest executeTransactionRequest)
This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL.default CompletableFuture<ExportTableToPointInTimeResponse>
exportTableToPointInTime(Consumer<ExportTableToPointInTimeRequest.Builder> exportTableToPointInTimeRequest)
Exports table data to an S3 bucket.default CompletableFuture<ExportTableToPointInTimeResponse>
exportTableToPointInTime(ExportTableToPointInTimeRequest exportTableToPointInTimeRequest)
Exports table data to an S3 bucket.default CompletableFuture<GetItemResponse>
getItem(Consumer<GetItemRequest.Builder> getItemRequest)
TheGetItem
operation returns a set of attributes for the item with the given primary key.default CompletableFuture<GetItemResponse>
getItem(GetItemRequest getItemRequest)
TheGetItem
operation returns a set of attributes for the item with the given primary key.default CompletableFuture<ImportTableResponse>
importTable(Consumer<ImportTableRequest.Builder> importTableRequest)
Imports table data from an S3 bucket.default CompletableFuture<ImportTableResponse>
importTable(ImportTableRequest importTableRequest)
Imports table data from an S3 bucket.default CompletableFuture<ListBackupsResponse>
listBackups()
List DynamoDB backups that are associated with an Amazon Web Services account and weren't made with Amazon Web Services Backup.default CompletableFuture<ListBackupsResponse>
listBackups(Consumer<ListBackupsRequest.Builder> listBackupsRequest)
List DynamoDB backups that are associated with an Amazon Web Services account and weren't made with Amazon Web Services Backup.default CompletableFuture<ListBackupsResponse>
listBackups(ListBackupsRequest listBackupsRequest)
List DynamoDB backups that are associated with an Amazon Web Services account and weren't made with Amazon Web Services Backup.default CompletableFuture<ListContributorInsightsResponse>
listContributorInsights(Consumer<ListContributorInsightsRequest.Builder> listContributorInsightsRequest)
Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes.default CompletableFuture<ListContributorInsightsResponse>
listContributorInsights(ListContributorInsightsRequest listContributorInsightsRequest)
Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes.default ListContributorInsightsPublisher
listContributorInsightsPaginator(Consumer<ListContributorInsightsRequest.Builder> listContributorInsightsRequest)
This is a variant oflistContributorInsights(software.amazon.awssdk.services.dynamodb.model.ListContributorInsightsRequest)
operation.default ListContributorInsightsPublisher
listContributorInsightsPaginator(ListContributorInsightsRequest listContributorInsightsRequest)
This is a variant oflistContributorInsights(software.amazon.awssdk.services.dynamodb.model.ListContributorInsightsRequest)
operation.default CompletableFuture<ListExportsResponse>
listExports(Consumer<ListExportsRequest.Builder> listExportsRequest)
Lists completed exports within the past 90 days.default CompletableFuture<ListExportsResponse>
listExports(ListExportsRequest listExportsRequest)
Lists completed exports within the past 90 days.default ListExportsPublisher
listExportsPaginator(Consumer<ListExportsRequest.Builder> listExportsRequest)
This is a variant oflistExports(software.amazon.awssdk.services.dynamodb.model.ListExportsRequest)
operation.default ListExportsPublisher
listExportsPaginator(ListExportsRequest listExportsRequest)
This is a variant oflistExports(software.amazon.awssdk.services.dynamodb.model.ListExportsRequest)
operation.default CompletableFuture<ListGlobalTablesResponse>
listGlobalTables()
Lists all global tables that have a replica in the specified Region.default CompletableFuture<ListGlobalTablesResponse>
listGlobalTables(Consumer<ListGlobalTablesRequest.Builder> listGlobalTablesRequest)
Lists all global tables that have a replica in the specified Region.default CompletableFuture<ListGlobalTablesResponse>
listGlobalTables(ListGlobalTablesRequest listGlobalTablesRequest)
Lists all global tables that have a replica in the specified Region.default CompletableFuture<ListImportsResponse>
listImports(Consumer<ListImportsRequest.Builder> listImportsRequest)
Lists completed imports within the past 90 days.default CompletableFuture<ListImportsResponse>
listImports(ListImportsRequest listImportsRequest)
Lists completed imports within the past 90 days.default ListImportsPublisher
listImportsPaginator(Consumer<ListImportsRequest.Builder> listImportsRequest)
This is a variant oflistImports(software.amazon.awssdk.services.dynamodb.model.ListImportsRequest)
operation.default ListImportsPublisher
listImportsPaginator(ListImportsRequest listImportsRequest)
This is a variant oflistImports(software.amazon.awssdk.services.dynamodb.model.ListImportsRequest)
operation.default CompletableFuture<ListTablesResponse>
listTables()
Returns an array of table names associated with the current account and endpoint.default CompletableFuture<ListTablesResponse>
listTables(Consumer<ListTablesRequest.Builder> listTablesRequest)
Returns an array of table names associated with the current account and endpoint.default CompletableFuture<ListTablesResponse>
listTables(ListTablesRequest listTablesRequest)
Returns an array of table names associated with the current account and endpoint.default ListTablesPublisher
listTablesPaginator()
This is a variant oflistTables(software.amazon.awssdk.services.dynamodb.model.ListTablesRequest)
operation.default ListTablesPublisher
listTablesPaginator(Consumer<ListTablesRequest.Builder> listTablesRequest)
This is a variant oflistTables(software.amazon.awssdk.services.dynamodb.model.ListTablesRequest)
operation.default ListTablesPublisher
listTablesPaginator(ListTablesRequest listTablesRequest)
This is a variant oflistTables(software.amazon.awssdk.services.dynamodb.model.ListTablesRequest)
operation.default CompletableFuture<ListTagsOfResourceResponse>
listTagsOfResource(Consumer<ListTagsOfResourceRequest.Builder> listTagsOfResourceRequest)
List all tags on an Amazon DynamoDB resource.default CompletableFuture<ListTagsOfResourceResponse>
listTagsOfResource(ListTagsOfResourceRequest listTagsOfResourceRequest)
List all tags on an Amazon DynamoDB resource.default CompletableFuture<PutItemResponse>
putItem(Consumer<PutItemRequest.Builder> putItemRequest)
Creates a new item, or replaces an old item with a new item.default CompletableFuture<PutItemResponse>
putItem(PutItemRequest putItemRequest)
Creates a new item, or replaces an old item with a new item.default CompletableFuture<QueryResponse>
query(Consumer<QueryRequest.Builder> queryRequest)
You must provide the name of the partition key attribute and a single value for that attribute.default CompletableFuture<QueryResponse>
query(QueryRequest queryRequest)
You must provide the name of the partition key attribute and a single value for that attribute.default QueryPublisher
queryPaginator(Consumer<QueryRequest.Builder> queryRequest)
This is a variant ofquery(software.amazon.awssdk.services.dynamodb.model.QueryRequest)
operation.default QueryPublisher
queryPaginator(QueryRequest queryRequest)
This is a variant ofquery(software.amazon.awssdk.services.dynamodb.model.QueryRequest)
operation.default CompletableFuture<RestoreTableFromBackupResponse>
restoreTableFromBackup(Consumer<RestoreTableFromBackupRequest.Builder> restoreTableFromBackupRequest)
Creates a new table from an existing backup.default CompletableFuture<RestoreTableFromBackupResponse>
restoreTableFromBackup(RestoreTableFromBackupRequest restoreTableFromBackupRequest)
Creates a new table from an existing backup.default CompletableFuture<RestoreTableToPointInTimeResponse>
restoreTableToPointInTime(Consumer<RestoreTableToPointInTimeRequest.Builder> restoreTableToPointInTimeRequest)
Restores the specified table to the specified point in time withinEarliestRestorableDateTime
andLatestRestorableDateTime
.default CompletableFuture<RestoreTableToPointInTimeResponse>
restoreTableToPointInTime(RestoreTableToPointInTimeRequest restoreTableToPointInTimeRequest)
Restores the specified table to the specified point in time withinEarliestRestorableDateTime
andLatestRestorableDateTime
.default CompletableFuture<ScanResponse>
scan(Consumer<ScanRequest.Builder> scanRequest)
TheScan
operation returns one or more items and item attributes by accessing every item in a table or a secondary index.default CompletableFuture<ScanResponse>
scan(ScanRequest scanRequest)
TheScan
operation returns one or more items and item attributes by accessing every item in a table or a secondary index.default ScanPublisher
scanPaginator(Consumer<ScanRequest.Builder> scanRequest)
This is a variant ofscan(software.amazon.awssdk.services.dynamodb.model.ScanRequest)
operation.default ScanPublisher
scanPaginator(ScanRequest scanRequest)
This is a variant ofscan(software.amazon.awssdk.services.dynamodb.model.ScanRequest)
operation.default DynamoDbServiceClientConfiguration
serviceClientConfiguration()
default CompletableFuture<TagResourceResponse>
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Associate a set of tags with an Amazon DynamoDB resource.default CompletableFuture<TagResourceResponse>
tagResource(TagResourceRequest tagResourceRequest)
Associate a set of tags with an Amazon DynamoDB resource.default CompletableFuture<TransactGetItemsResponse>
transactGetItems(Consumer<TransactGetItemsRequest.Builder> transactGetItemsRequest)
TransactGetItems
is a synchronous operation that atomically retrieves multiple items from one or more tables (but not from indexes) in a single account and Region.default CompletableFuture<TransactGetItemsResponse>
transactGetItems(TransactGetItemsRequest transactGetItemsRequest)
TransactGetItems
is a synchronous operation that atomically retrieves multiple items from one or more tables (but not from indexes) in a single account and Region.default CompletableFuture<TransactWriteItemsResponse>
transactWriteItems(Consumer<TransactWriteItemsRequest.Builder> transactWriteItemsRequest)
TransactWriteItems
is a synchronous write operation that groups up to 100 action requests.default CompletableFuture<TransactWriteItemsResponse>
transactWriteItems(TransactWriteItemsRequest transactWriteItemsRequest)
TransactWriteItems
is a synchronous write operation that groups up to 100 action requests.default CompletableFuture<UntagResourceResponse>
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes the association of tags from an Amazon DynamoDB resource.default CompletableFuture<UntagResourceResponse>
untagResource(UntagResourceRequest untagResourceRequest)
Removes the association of tags from an Amazon DynamoDB resource.default CompletableFuture<UpdateContinuousBackupsResponse>
updateContinuousBackups(Consumer<UpdateContinuousBackupsRequest.Builder> updateContinuousBackupsRequest)
UpdateContinuousBackups
enables or disables point in time recovery for the specified table.default CompletableFuture<UpdateContinuousBackupsResponse>
updateContinuousBackups(UpdateContinuousBackupsRequest updateContinuousBackupsRequest)
UpdateContinuousBackups
enables or disables point in time recovery for the specified table.default CompletableFuture<UpdateContributorInsightsResponse>
updateContributorInsights(Consumer<UpdateContributorInsightsRequest.Builder> updateContributorInsightsRequest)
Updates the status for contributor insights for a specific table or index.default CompletableFuture<UpdateContributorInsightsResponse>
updateContributorInsights(UpdateContributorInsightsRequest updateContributorInsightsRequest)
Updates the status for contributor insights for a specific table or index.default CompletableFuture<UpdateGlobalTableResponse>
updateGlobalTable(Consumer<UpdateGlobalTableRequest.Builder> updateGlobalTableRequest)
Adds or removes replicas in the specified global table.default CompletableFuture<UpdateGlobalTableResponse>
updateGlobalTable(UpdateGlobalTableRequest updateGlobalTableRequest)
Adds or removes replicas in the specified global table.default CompletableFuture<UpdateGlobalTableSettingsResponse>
updateGlobalTableSettings(Consumer<UpdateGlobalTableSettingsRequest.Builder> updateGlobalTableSettingsRequest)
Updates settings for a global table.default CompletableFuture<UpdateGlobalTableSettingsResponse>
updateGlobalTableSettings(UpdateGlobalTableSettingsRequest updateGlobalTableSettingsRequest)
Updates settings for a global table.default CompletableFuture<UpdateItemResponse>
updateItem(Consumer<UpdateItemRequest.Builder> updateItemRequest)
Edits an existing item's attributes, or adds a new item to the table if it does not already exist.default CompletableFuture<UpdateItemResponse>
updateItem(UpdateItemRequest updateItemRequest)
Edits an existing item's attributes, or adds a new item to the table if it does not already exist.default CompletableFuture<UpdateKinesisStreamingDestinationResponse>
updateKinesisStreamingDestination(Consumer<UpdateKinesisStreamingDestinationRequest.Builder> updateKinesisStreamingDestinationRequest)
The command to update the Kinesis stream destination.default CompletableFuture<UpdateKinesisStreamingDestinationResponse>
updateKinesisStreamingDestination(UpdateKinesisStreamingDestinationRequest updateKinesisStreamingDestinationRequest)
The command to update the Kinesis stream destination.default CompletableFuture<UpdateTableResponse>
updateTable(Consumer<UpdateTableRequest.Builder> updateTableRequest)
Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.default CompletableFuture<UpdateTableResponse>
updateTable(UpdateTableRequest updateTableRequest)
Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.default CompletableFuture<UpdateTableReplicaAutoScalingResponse>
updateTableReplicaAutoScaling(Consumer<UpdateTableReplicaAutoScalingRequest.Builder> updateTableReplicaAutoScalingRequest)
Updates auto scaling settings on your global tables at once.default CompletableFuture<UpdateTableReplicaAutoScalingResponse>
updateTableReplicaAutoScaling(UpdateTableReplicaAutoScalingRequest updateTableReplicaAutoScalingRequest)
Updates auto scaling settings on your global tables at once.default CompletableFuture<UpdateTimeToLiveResponse>
updateTimeToLive(Consumer<UpdateTimeToLiveRequest.Builder> updateTimeToLiveRequest)
TheUpdateTimeToLive
method enables or disables Time to Live (TTL) for the specified table.default CompletableFuture<UpdateTimeToLiveResponse>
updateTimeToLive(UpdateTimeToLiveRequest updateTimeToLiveRequest)
TheUpdateTimeToLive
method enables or disables Time to Live (TTL) for the specified table.default DynamoDbAsyncWaiter
waiter()
Create an instance ofDynamoDbAsyncWaiter
using this client.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
- Constant Field Values
-
-
Method Detail
-
batchExecuteStatement
default CompletableFuture<BatchExecuteStatementResponse> batchExecuteStatement(BatchExecuteStatementRequest batchExecuteStatementRequest)
This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL. Each read statement in a
BatchExecuteStatement
must specify an equality condition on all key attributes. This enforces that eachSELECT
statement in a batch returns at most a single item.The entire batch must consist of either read statements or write statements, you cannot mix both in one batch.
A HTTP 200 response does not mean that all statements in the BatchExecuteStatement succeeded. Error details for individual statements can be found under the Error field of the
BatchStatementResponse
for each statement.- Parameters:
batchExecuteStatementRequest
-- Returns:
- A Java Future containing the result of the BatchExecuteStatement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
batchExecuteStatement
default CompletableFuture<BatchExecuteStatementResponse> batchExecuteStatement(Consumer<BatchExecuteStatementRequest.Builder> batchExecuteStatementRequest)
This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL. Each read statement in a
BatchExecuteStatement
must specify an equality condition on all key attributes. This enforces that eachSELECT
statement in a batch returns at most a single item.The entire batch must consist of either read statements or write statements, you cannot mix both in one batch.
A HTTP 200 response does not mean that all statements in the BatchExecuteStatement succeeded. Error details for individual statements can be found under the Error field of the
BatchStatementResponse
for each statement.
This is a convenience which creates an instance of the
BatchExecuteStatementRequest.Builder
avoiding the need to create one manually viaBatchExecuteStatementRequest.builder()
- Parameters:
batchExecuteStatementRequest
- AConsumer
that will call methods onBatchExecuteStatementRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchExecuteStatement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
batchGetItem
default CompletableFuture<BatchGetItemResponse> batchGetItem(BatchGetItemRequest batchGetItemRequest)
The
BatchGetItem
operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key.A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items.
BatchGetItem
returns a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, more than 1MB per partition is requested, or an internal processing failure occurs. If a partial result is returned, the operation returns a value forUnprocessedKeys
. You can use this value to retry the operation starting with the next item to get.If you request more than 100 items,
BatchGetItem
returns aValidationException
with the message "Too many items requested for the BatchGetItem call."For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate
UnprocessedKeys
value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one dataset.If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then
BatchGetItem
returns aProvisionedThroughputExceededException
. If at least one of the items is successfully processed, thenBatchGetItem
completes successfully, while returning the keys of the unread items inUnprocessedKeys
.If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.
For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.
By default,
BatchGetItem
performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can setConsistentRead
totrue
for any or all tables.In order to minimize response latency,
BatchGetItem
may retrieve items in parallel.When designing your application, keep in mind that DynamoDB does not return items in any particular order. To help parse the response by item, include the primary key values for the items in your request in the
ProjectionExpression
parameter.If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.
- Parameters:
batchGetItemRequest
- Represents the input of aBatchGetItem
operation.- Returns:
- A Java Future containing the result of the BatchGetItem operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
batchGetItem
default CompletableFuture<BatchGetItemResponse> batchGetItem(Consumer<BatchGetItemRequest.Builder> batchGetItemRequest)
The
BatchGetItem
operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key.A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items.
BatchGetItem
returns a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, more than 1MB per partition is requested, or an internal processing failure occurs. If a partial result is returned, the operation returns a value forUnprocessedKeys
. You can use this value to retry the operation starting with the next item to get.If you request more than 100 items,
BatchGetItem
returns aValidationException
with the message "Too many items requested for the BatchGetItem call."For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate
UnprocessedKeys
value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one dataset.If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then
BatchGetItem
returns aProvisionedThroughputExceededException
. If at least one of the items is successfully processed, thenBatchGetItem
completes successfully, while returning the keys of the unread items inUnprocessedKeys
.If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.
For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.
By default,
BatchGetItem
performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can setConsistentRead
totrue
for any or all tables.In order to minimize response latency,
BatchGetItem
may retrieve items in parallel.When designing your application, keep in mind that DynamoDB does not return items in any particular order. To help parse the response by item, include the primary key values for the items in your request in the
ProjectionExpression
parameter.If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.
This is a convenience which creates an instance of the
BatchGetItemRequest.Builder
avoiding the need to create one manually viaBatchGetItemRequest.builder()
- Parameters:
batchGetItemRequest
- AConsumer
that will call methods onBatchGetItemRequest.Builder
to create a request. Represents the input of aBatchGetItem
operation.- Returns:
- A Java Future containing the result of the BatchGetItem operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
batchGetItemPaginator
default BatchGetItemPublisher batchGetItemPaginator(BatchGetItemRequest batchGetItemRequest)
This is a variant of
batchGetItem(software.amazon.awssdk.services.dynamodb.model.BatchGetItemRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.dynamodb.paginators.BatchGetItemPublisher publisher = client.batchGetItemPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.dynamodb.paginators.BatchGetItemPublisher publisher = client.batchGetItemPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.dynamodb.model.BatchGetItemResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.dynamodb.model.BatchGetItemResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
batchGetItem(software.amazon.awssdk.services.dynamodb.model.BatchGetItemRequest)
operation.- Parameters:
batchGetItemRequest
- Represents the input of aBatchGetItem
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
batchGetItemPaginator
default BatchGetItemPublisher batchGetItemPaginator(Consumer<BatchGetItemRequest.Builder> batchGetItemRequest)
This is a variant of
batchGetItem(software.amazon.awssdk.services.dynamodb.model.BatchGetItemRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.dynamodb.paginators.BatchGetItemPublisher publisher = client.batchGetItemPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.dynamodb.paginators.BatchGetItemPublisher publisher = client.batchGetItemPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.dynamodb.model.BatchGetItemResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.dynamodb.model.BatchGetItemResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
batchGetItem(software.amazon.awssdk.services.dynamodb.model.BatchGetItemRequest)
operation.
This is a convenience which creates an instance of the
BatchGetItemRequest.Builder
avoiding the need to create one manually viaBatchGetItemRequest.builder()
- Parameters:
batchGetItemRequest
- AConsumer
that will call methods onBatchGetItemRequest.Builder
to create a request. Represents the input of aBatchGetItem
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
batchWriteItem
default CompletableFuture<BatchWriteItemResponse> batchWriteItem(BatchWriteItemRequest batchWriteItemRequest)
The
BatchWriteItem
operation puts or deletes multiple items in one or more tables. A single call toBatchWriteItem
can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types.BatchWriteItem
cannot update items. If you perform aBatchWriteItem
operation on an existing item, that item's values will be overwritten by the operation and it will appear like it was updated. To update items, we recommend you use theUpdateItem
action.The individual
PutItem
andDeleteItem
operations specified inBatchWriteItem
are atomic; howeverBatchWriteItem
as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in theUnprocessedItems
response parameter. You can investigate and optionally resend the requests. Typically, you would callBatchWriteItem
in a loop. Each iteration would check for unprocessed items and submit a newBatchWriteItem
request with those unprocessed items until all items have been processed.If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then
BatchWriteItem
returns aProvisionedThroughputExceededException
.If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.
For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.
With
BatchWriteItem
, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations,BatchWriteItem
does not behave in the same way as individualPutItem
andDeleteItem
calls would. For example, you cannot specify conditions on individual put and delete requests, andBatchWriteItem
does not return deleted items in the response.If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations,
BatchWriteItem
performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.
If one or more of the following is true, DynamoDB rejects the entire batch write operation:
-
One or more tables specified in the
BatchWriteItem
request does not exist. -
Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema.
-
You try to perform multiple operations on the same item in the same
BatchWriteItem
request. For example, you cannot put and delete the same item in the sameBatchWriteItem
request. -
Your request contains at least two items with identical hash and range keys (which essentially is two put operations).
-
There are more than 25 requests in the batch.
-
Any individual item in a batch exceeds 400 KB.
-
The total request size exceeds 16 MB.
- Parameters:
batchWriteItemRequest
- Represents the input of aBatchWriteItem
operation.- Returns:
- A Java Future containing the result of the BatchWriteItem operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - ItemCollectionSizeLimitExceededException An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
- RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
batchWriteItem
default CompletableFuture<BatchWriteItemResponse> batchWriteItem(Consumer<BatchWriteItemRequest.Builder> batchWriteItemRequest)
The
BatchWriteItem
operation puts or deletes multiple items in one or more tables. A single call toBatchWriteItem
can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types.BatchWriteItem
cannot update items. If you perform aBatchWriteItem
operation on an existing item, that item's values will be overwritten by the operation and it will appear like it was updated. To update items, we recommend you use theUpdateItem
action.The individual
PutItem
andDeleteItem
operations specified inBatchWriteItem
are atomic; howeverBatchWriteItem
as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in theUnprocessedItems
response parameter. You can investigate and optionally resend the requests. Typically, you would callBatchWriteItem
in a loop. Each iteration would check for unprocessed items and submit a newBatchWriteItem
request with those unprocessed items until all items have been processed.If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then
BatchWriteItem
returns aProvisionedThroughputExceededException
.If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.
For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.
With
BatchWriteItem
, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations,BatchWriteItem
does not behave in the same way as individualPutItem
andDeleteItem
calls would. For example, you cannot specify conditions on individual put and delete requests, andBatchWriteItem
does not return deleted items in the response.If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations,
BatchWriteItem
performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.
If one or more of the following is true, DynamoDB rejects the entire batch write operation:
-
One or more tables specified in the
BatchWriteItem
request does not exist. -
Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema.
-
You try to perform multiple operations on the same item in the same
BatchWriteItem
request. For example, you cannot put and delete the same item in the sameBatchWriteItem
request. -
Your request contains at least two items with identical hash and range keys (which essentially is two put operations).
-
There are more than 25 requests in the batch.
-
Any individual item in a batch exceeds 400 KB.
-
The total request size exceeds 16 MB.
This is a convenience which creates an instance of the
BatchWriteItemRequest.Builder
avoiding the need to create one manually viaBatchWriteItemRequest.builder()
- Parameters:
batchWriteItemRequest
- AConsumer
that will call methods onBatchWriteItemRequest.Builder
to create a request. Represents the input of aBatchWriteItem
operation.- Returns:
- A Java Future containing the result of the BatchWriteItem operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - ItemCollectionSizeLimitExceededException An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
- RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
createBackup
default CompletableFuture<CreateBackupResponse> createBackup(CreateBackupRequest createBackupRequest)
Creates a backup for an existing table.
Each time you create an on-demand backup, the entire table data is backed up. There is no limit to the number of on-demand backups that can be taken.
When you create an on-demand backup, a time marker of the request is cataloged, and the backup is created asynchronously, by applying all changes until the time of the request to the last full table snapshot. Backup requests are processed instantaneously and become available for restore within minutes.
You can call
CreateBackup
at a maximum rate of 50 times per second.All backups in DynamoDB work without consuming any provisioned throughput on the table.
If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to contain all data committed to the table up to 14:24:00, and data committed after 14:26:00 will not be. The backup might contain data modifications made between 14:24:00 and 14:26:00. On-demand backup does not support causal consistency.
Along with data, the following are also included on the backups:
-
Global secondary indexes (GSIs)
-
Local secondary indexes (LSIs)
-
Streams
-
Provisioned read and write capacity
- Parameters:
createBackupRequest
-- Returns:
- A Java Future containing the result of the CreateBackup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TableNotFoundException A source table with the name
TableName
does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region. - TableInUseException A target table with the specified name is either being created or deleted.
- ContinuousBackupsUnavailableException Backups have not yet been enabled for this table.
- BackupInUseException There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- TableNotFoundException A source table with the name
- See Also:
- AWS API Documentation
-
-
createBackup
default CompletableFuture<CreateBackupResponse> createBackup(Consumer<CreateBackupRequest.Builder> createBackupRequest)
Creates a backup for an existing table.
Each time you create an on-demand backup, the entire table data is backed up. There is no limit to the number of on-demand backups that can be taken.
When you create an on-demand backup, a time marker of the request is cataloged, and the backup is created asynchronously, by applying all changes until the time of the request to the last full table snapshot. Backup requests are processed instantaneously and become available for restore within minutes.
You can call
CreateBackup
at a maximum rate of 50 times per second.All backups in DynamoDB work without consuming any provisioned throughput on the table.
If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to contain all data committed to the table up to 14:24:00, and data committed after 14:26:00 will not be. The backup might contain data modifications made between 14:24:00 and 14:26:00. On-demand backup does not support causal consistency.
Along with data, the following are also included on the backups:
-
Global secondary indexes (GSIs)
-
Local secondary indexes (LSIs)
-
Streams
-
Provisioned read and write capacity
This is a convenience which creates an instance of the
CreateBackupRequest.Builder
avoiding the need to create one manually viaCreateBackupRequest.builder()
- Parameters:
createBackupRequest
- AConsumer
that will call methods onCreateBackupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateBackup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TableNotFoundException A source table with the name
TableName
does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region. - TableInUseException A target table with the specified name is either being created or deleted.
- ContinuousBackupsUnavailableException Backups have not yet been enabled for this table.
- BackupInUseException There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- TableNotFoundException A source table with the name
- See Also:
- AWS API Documentation
-
-
createGlobalTable
default CompletableFuture<CreateGlobalTableResponse> createGlobalTable(CreateGlobalTableRequest createGlobalTableRequest)
Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
If you want to add a new replica table to a global table, each of the following conditions must be true:
-
The table must have the same primary key as all of the other replicas.
-
The table must have the same name as all of the other replicas.
-
The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.
-
None of the replica tables in the global table can contain any data.
If global secondary indexes are specified, then the following conditions must also be met:
-
The global secondary indexes must have the same name.
-
The global secondary indexes must have the same hash key and sort key (if present).
If local secondary indexes are specified, then the following conditions must also be met:
-
The local secondary indexes must have the same name.
-
The local secondary indexes must have the same hash key and sort key (if present).
Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes.
If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table.
- Parameters:
createGlobalTableRequest
-- Returns:
- A Java Future containing the result of the CreateGlobalTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InternalServerErrorException An error occurred on the server side.
- GlobalTableAlreadyExistsException The specified global table already exists.
- TableNotFoundException A source table with the name
TableName
does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
- See Also:
- AWS API Documentation
-
-
createGlobalTable
default CompletableFuture<CreateGlobalTableResponse> createGlobalTable(Consumer<CreateGlobalTableRequest.Builder> createGlobalTableRequest)
Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
If you want to add a new replica table to a global table, each of the following conditions must be true:
-
The table must have the same primary key as all of the other replicas.
-
The table must have the same name as all of the other replicas.
-
The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.
-
None of the replica tables in the global table can contain any data.
If global secondary indexes are specified, then the following conditions must also be met:
-
The global secondary indexes must have the same name.
-
The global secondary indexes must have the same hash key and sort key (if present).
If local secondary indexes are specified, then the following conditions must also be met:
-
The local secondary indexes must have the same name.
-
The local secondary indexes must have the same hash key and sort key (if present).
Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes.
If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table.
This is a convenience which creates an instance of the
CreateGlobalTableRequest.Builder
avoiding the need to create one manually viaCreateGlobalTableRequest.builder()
- Parameters:
createGlobalTableRequest
- AConsumer
that will call methods onCreateGlobalTableRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateGlobalTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InternalServerErrorException An error occurred on the server side.
- GlobalTableAlreadyExistsException The specified global table already exists.
- TableNotFoundException A source table with the name
TableName
does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
- See Also:
- AWS API Documentation
-
-
createTable
default CompletableFuture<CreateTableResponse> createTable(CreateTableRequest createTableRequest)
The
CreateTable
operation adds a new table to your account. In an Amazon Web Services account, table names must be unique within each Region. That is, you can have two tables with same name if you create the tables in different Regions.CreateTable
is an asynchronous operation. Upon receiving aCreateTable
request, DynamoDB immediately returns a response with aTableStatus
ofCREATING
. After the table is created, DynamoDB sets theTableStatus
toACTIVE
. You can perform read and write operations only on anACTIVE
table.You can optionally define secondary indexes on the new table, as part of the
CreateTable
operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in theCREATING
state at any given time.You can use the
DescribeTable
action to check the table status.- Parameters:
createTableRequest
- Represents the input of aCreateTable
operation.- Returns:
- A Java Future containing the result of the CreateTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
CREATING
state. - LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
- See Also:
- AWS API Documentation
-
createTable
default CompletableFuture<CreateTableResponse> createTable(Consumer<CreateTableRequest.Builder> createTableRequest)
The
CreateTable
operation adds a new table to your account. In an Amazon Web Services account, table names must be unique within each Region. That is, you can have two tables with same name if you create the tables in different Regions.CreateTable
is an asynchronous operation. Upon receiving aCreateTable
request, DynamoDB immediately returns a response with aTableStatus
ofCREATING
. After the table is created, DynamoDB sets theTableStatus
toACTIVE
. You can perform read and write operations only on anACTIVE
table.You can optionally define secondary indexes on the new table, as part of the
CreateTable
operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in theCREATING
state at any given time.You can use the
DescribeTable
action to check the table status.
This is a convenience which creates an instance of the
CreateTableRequest.Builder
avoiding the need to create one manually viaCreateTableRequest.builder()
- Parameters:
createTableRequest
- AConsumer
that will call methods onCreateTableRequest.Builder
to create a request. Represents the input of aCreateTable
operation.- Returns:
- A Java Future containing the result of the CreateTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
CREATING
state. - LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
- See Also:
- AWS API Documentation
-
deleteBackup
default CompletableFuture<DeleteBackupResponse> deleteBackup(DeleteBackupRequest deleteBackupRequest)
Deletes an existing backup of a table.
You can call
DeleteBackup
at a maximum rate of 10 times per second.- Parameters:
deleteBackupRequest
-- Returns:
- A Java Future containing the result of the DeleteBackup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BackupNotFoundException Backup not found for the given BackupARN.
- BackupInUseException There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteBackup
default CompletableFuture<DeleteBackupResponse> deleteBackup(Consumer<DeleteBackupRequest.Builder> deleteBackupRequest)
Deletes an existing backup of a table.
You can call
DeleteBackup
at a maximum rate of 10 times per second.
This is a convenience which creates an instance of the
DeleteBackupRequest.Builder
avoiding the need to create one manually viaDeleteBackupRequest.builder()
- Parameters:
deleteBackupRequest
- AConsumer
that will call methods onDeleteBackupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteBackup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BackupNotFoundException Backup not found for the given BackupARN.
- BackupInUseException There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteItem
default CompletableFuture<DeleteItemResponse> deleteItem(DeleteItemRequest deleteItemRequest)
Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.
In addition to deleting an item, you can also return the item's attribute values in the same operation, using the
ReturnValues
parameter.Unless you specify conditions, the
DeleteItem
is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.
- Parameters:
deleteItemRequest
- Represents the input of aDeleteItem
operation.- Returns:
- A Java Future containing the result of the DeleteItem operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConditionalCheckFailedException A condition specified in the operation could not be evaluated.
- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - ItemCollectionSizeLimitExceededException An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
- TransactionConflictException Operation was rejected because there is an ongoing transaction for the item.
- RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteItem
default CompletableFuture<DeleteItemResponse> deleteItem(Consumer<DeleteItemRequest.Builder> deleteItemRequest)
Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.
In addition to deleting an item, you can also return the item's attribute values in the same operation, using the
ReturnValues
parameter.Unless you specify conditions, the
DeleteItem
is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.
This is a convenience which creates an instance of the
DeleteItemRequest.Builder
avoiding the need to create one manually viaDeleteItemRequest.builder()
- Parameters:
deleteItemRequest
- AConsumer
that will call methods onDeleteItemRequest.Builder
to create a request. Represents the input of aDeleteItem
operation.- Returns:
- A Java Future containing the result of the DeleteItem operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConditionalCheckFailedException A condition specified in the operation could not be evaluated.
- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - ItemCollectionSizeLimitExceededException An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
- TransactionConflictException Operation was rejected because there is an ongoing transaction for the item.
- RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteTable
default CompletableFuture<DeleteTableResponse> deleteTable(DeleteTableRequest deleteTableRequest)
The
DeleteTable
operation deletes a table and all of its items. After aDeleteTable
request, the specified table is in theDELETING
state until DynamoDB completes the deletion. If the table is in theACTIVE
state, you can delete it. If a table is inCREATING
orUPDATING
states, then DynamoDB returns aResourceInUseException
. If the specified table does not exist, DynamoDB returns aResourceNotFoundException
. If table is already in theDELETING
state, no error is returned.This operation only applies to Version 2019.11.21 (Current) of global tables.
DynamoDB might continue to accept data read and write operations, such as
GetItem
andPutItem
, on a table in theDELETING
state until the table deletion is complete.When you delete a table, any indexes on that table are also deleted.
If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the
DISABLED
state, and the stream is automatically deleted after 24 hours.Use the
DescribeTable
action to check the status of the table.- Parameters:
deleteTableRequest
- Represents the input of aDeleteTable
operation.- Returns:
- A Java Future containing the result of the DeleteTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
CREATING
state. - ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
- See Also:
- AWS API Documentation
-
deleteTable
default CompletableFuture<DeleteTableResponse> deleteTable(Consumer<DeleteTableRequest.Builder> deleteTableRequest)
The
DeleteTable
operation deletes a table and all of its items. After aDeleteTable
request, the specified table is in theDELETING
state until DynamoDB completes the deletion. If the table is in theACTIVE
state, you can delete it. If a table is inCREATING
orUPDATING
states, then DynamoDB returns aResourceInUseException
. If the specified table does not exist, DynamoDB returns aResourceNotFoundException
. If table is already in theDELETING
state, no error is returned.This operation only applies to Version 2019.11.21 (Current) of global tables.
DynamoDB might continue to accept data read and write operations, such as
GetItem
andPutItem
, on a table in theDELETING
state until the table deletion is complete.When you delete a table, any indexes on that table are also deleted.
If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the
DISABLED
state, and the stream is automatically deleted after 24 hours.Use the
DescribeTable
action to check the status of the table.
This is a convenience which creates an instance of the
DeleteTableRequest.Builder
avoiding the need to create one manually viaDeleteTableRequest.builder()
- Parameters:
deleteTableRequest
- AConsumer
that will call methods onDeleteTableRequest.Builder
to create a request. Represents the input of aDeleteTable
operation.- Returns:
- A Java Future containing the result of the DeleteTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
CREATING
state. - ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
- See Also:
- AWS API Documentation
-
describeBackup
default CompletableFuture<DescribeBackupResponse> describeBackup(DescribeBackupRequest describeBackupRequest)
Describes an existing backup of a table.
You can call
DescribeBackup
at a maximum rate of 10 times per second.- Parameters:
describeBackupRequest
-- Returns:
- A Java Future containing the result of the DescribeBackup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BackupNotFoundException Backup not found for the given BackupARN.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeBackup
default CompletableFuture<DescribeBackupResponse> describeBackup(Consumer<DescribeBackupRequest.Builder> describeBackupRequest)
Describes an existing backup of a table.
You can call
DescribeBackup
at a maximum rate of 10 times per second.
This is a convenience which creates an instance of the
DescribeBackupRequest.Builder
avoiding the need to create one manually viaDescribeBackupRequest.builder()
- Parameters:
describeBackupRequest
- AConsumer
that will call methods onDescribeBackupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeBackup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BackupNotFoundException Backup not found for the given BackupARN.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeContinuousBackups
default CompletableFuture<DescribeContinuousBackupsResponse> describeContinuousBackups(DescribeContinuousBackupsRequest describeContinuousBackupsRequest)
Checks the status of continuous backups and point in time recovery on the specified table. Continuous backups are
ENABLED
on all tables at table creation. If point in time recovery is enabled,PointInTimeRecoveryStatus
will be set to ENABLED.After continuous backups and point in time recovery are enabled, you can restore to any point in time within
EarliestRestorableDateTime
andLatestRestorableDateTime
.LatestRestorableDateTime
is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days.You can call
DescribeContinuousBackups
at a maximum rate of 10 times per second.- Parameters:
describeContinuousBackupsRequest
-- Returns:
- A Java Future containing the result of the DescribeContinuousBackups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TableNotFoundException A source table with the name
TableName
does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region. - InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- TableNotFoundException A source table with the name
- See Also:
- AWS API Documentation
-
describeContinuousBackups
default CompletableFuture<DescribeContinuousBackupsResponse> describeContinuousBackups(Consumer<DescribeContinuousBackupsRequest.Builder> describeContinuousBackupsRequest)
Checks the status of continuous backups and point in time recovery on the specified table. Continuous backups are
ENABLED
on all tables at table creation. If point in time recovery is enabled,PointInTimeRecoveryStatus
will be set to ENABLED.After continuous backups and point in time recovery are enabled, you can restore to any point in time within
EarliestRestorableDateTime
andLatestRestorableDateTime
.LatestRestorableDateTime
is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days.You can call
DescribeContinuousBackups
at a maximum rate of 10 times per second.
This is a convenience which creates an instance of the
DescribeContinuousBackupsRequest.Builder
avoiding the need to create one manually viaDescribeContinuousBackupsRequest.builder()
- Parameters:
describeContinuousBackupsRequest
- AConsumer
that will call methods onDescribeContinuousBackupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeContinuousBackups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TableNotFoundException A source table with the name
TableName
does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region. - InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- TableNotFoundException A source table with the name
- See Also:
- AWS API Documentation
-
describeContributorInsights
default CompletableFuture<DescribeContributorInsightsResponse> describeContributorInsights(DescribeContributorInsightsRequest describeContributorInsightsRequest)
Returns information about contributor insights for a given table or global secondary index.
- Parameters:
describeContributorInsightsRequest
-- Returns:
- A Java Future containing the result of the DescribeContributorInsights operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
- See Also:
- AWS API Documentation
-
describeContributorInsights
default CompletableFuture<DescribeContributorInsightsResponse> describeContributorInsights(Consumer<DescribeContributorInsightsRequest.Builder> describeContributorInsightsRequest)
Returns information about contributor insights for a given table or global secondary index.
This is a convenience which creates an instance of the
DescribeContributorInsightsRequest.Builder
avoiding the need to create one manually viaDescribeContributorInsightsRequest.builder()
- Parameters:
describeContributorInsightsRequest
- AConsumer
that will call methods onDescribeContributorInsightsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeContributorInsights operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
- See Also:
- AWS API Documentation
-
describeEndpoints
default CompletableFuture<DescribeEndpointsResponse> describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest)
Returns the regional endpoint information. For more information on policy permissions, please see Internetwork traffic privacy.
- Parameters:
describeEndpointsRequest
-- Returns:
- A Java Future containing the result of the DescribeEndpoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeEndpoints
default CompletableFuture<DescribeEndpointsResponse> describeEndpoints(Consumer<DescribeEndpointsRequest.Builder> describeEndpointsRequest)
Returns the regional endpoint information. For more information on policy permissions, please see Internetwork traffic privacy.
This is a convenience which creates an instance of the
DescribeEndpointsRequest.Builder
avoiding the need to create one manually viaDescribeEndpointsRequest.builder()
- Parameters:
describeEndpointsRequest
- AConsumer
that will call methods onDescribeEndpointsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEndpoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeEndpoints
default CompletableFuture<DescribeEndpointsResponse> describeEndpoints()
Returns the regional endpoint information. For more information on policy permissions, please see Internetwork traffic privacy.
- Returns:
- A Java Future containing the result of the DescribeEndpoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeExport
default CompletableFuture<DescribeExportResponse> describeExport(DescribeExportRequest describeExportRequest)
Describes an existing table export.
- Parameters:
describeExportRequest
-- Returns:
- A Java Future containing the result of the DescribeExport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ExportNotFoundException The specified export was not found.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeExport
default CompletableFuture<DescribeExportResponse> describeExport(Consumer<DescribeExportRequest.Builder> describeExportRequest)
Describes an existing table export.
This is a convenience which creates an instance of the
DescribeExportRequest.Builder
avoiding the need to create one manually viaDescribeExportRequest.builder()
- Parameters:
describeExportRequest
- AConsumer
that will call methods onDescribeExportRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeExport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ExportNotFoundException The specified export was not found.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeGlobalTable
default CompletableFuture<DescribeGlobalTableResponse> describeGlobalTable(DescribeGlobalTableRequest describeGlobalTableRequest)
Returns information about the specified global table.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
- Parameters:
describeGlobalTableRequest
-- Returns:
- A Java Future containing the result of the DescribeGlobalTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerErrorException An error occurred on the server side.
- GlobalTableNotFoundException The specified global table does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeGlobalTable
default CompletableFuture<DescribeGlobalTableResponse> describeGlobalTable(Consumer<DescribeGlobalTableRequest.Builder> describeGlobalTableRequest)
Returns information about the specified global table.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
This is a convenience which creates an instance of the
DescribeGlobalTableRequest.Builder
avoiding the need to create one manually viaDescribeGlobalTableRequest.builder()
- Parameters:
describeGlobalTableRequest
- AConsumer
that will call methods onDescribeGlobalTableRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeGlobalTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerErrorException An error occurred on the server side.
- GlobalTableNotFoundException The specified global table does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeGlobalTableSettings
default CompletableFuture<DescribeGlobalTableSettingsResponse> describeGlobalTableSettings(DescribeGlobalTableSettingsRequest describeGlobalTableSettingsRequest)
Describes Region-specific settings for a global table.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
- Parameters:
describeGlobalTableSettingsRequest
-- Returns:
- A Java Future containing the result of the DescribeGlobalTableSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- GlobalTableNotFoundException The specified global table does not exist.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeGlobalTableSettings
default CompletableFuture<DescribeGlobalTableSettingsResponse> describeGlobalTableSettings(Consumer<DescribeGlobalTableSettingsRequest.Builder> describeGlobalTableSettingsRequest)
Describes Region-specific settings for a global table.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
This is a convenience which creates an instance of the
DescribeGlobalTableSettingsRequest.Builder
avoiding the need to create one manually viaDescribeGlobalTableSettingsRequest.builder()
- Parameters:
describeGlobalTableSettingsRequest
- AConsumer
that will call methods onDescribeGlobalTableSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeGlobalTableSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- GlobalTableNotFoundException The specified global table does not exist.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeImport
default CompletableFuture<DescribeImportResponse> describeImport(DescribeImportRequest describeImportRequest)
Represents the properties of the import.
- Parameters:
describeImportRequest
-- Returns:
- A Java Future containing the result of the DescribeImport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ImportNotFoundException The specified import was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeImport
default CompletableFuture<DescribeImportResponse> describeImport(Consumer<DescribeImportRequest.Builder> describeImportRequest)
Represents the properties of the import.
This is a convenience which creates an instance of the
DescribeImportRequest.Builder
avoiding the need to create one manually viaDescribeImportRequest.builder()
- Parameters:
describeImportRequest
- AConsumer
that will call methods onDescribeImportRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeImport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ImportNotFoundException The specified import was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeKinesisStreamingDestination
default CompletableFuture<DescribeKinesisStreamingDestinationResponse> describeKinesisStreamingDestination(DescribeKinesisStreamingDestinationRequest describeKinesisStreamingDestinationRequest)
Returns information about the status of Kinesis streaming.
- Parameters:
describeKinesisStreamingDestinationRequest
-- Returns:
- A Java Future containing the result of the DescribeKinesisStreamingDestination operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
- See Also:
- AWS API Documentation
-
describeKinesisStreamingDestination
default CompletableFuture<DescribeKinesisStreamingDestinationResponse> describeKinesisStreamingDestination(Consumer<DescribeKinesisStreamingDestinationRequest.Builder> describeKinesisStreamingDestinationRequest)
Returns information about the status of Kinesis streaming.
This is a convenience which creates an instance of the
DescribeKinesisStreamingDestinationRequest.Builder
avoiding the need to create one manually viaDescribeKinesisStreamingDestinationRequest.builder()
- Parameters:
describeKinesisStreamingDestinationRequest
- AConsumer
that will call methods onDescribeKinesisStreamingDestinationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeKinesisStreamingDestination operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
- See Also:
- AWS API Documentation
-
describeLimits
default CompletableFuture<DescribeLimitsResponse> describeLimits(DescribeLimitsRequest describeLimitsRequest)
Returns the current provisioned-capacity quotas for your Amazon Web Services account in a Region, both for the Region as a whole and for any one DynamoDB table that you create there.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum read capacity units and write capacity units that you can provision across all of your DynamoDB tables in a given Region. Also, there are per-table quotas that apply when you create a table there. For more information, see Service, Account, and Table Quotas page in the Amazon DynamoDB Developer Guide.
Although you can increase these quotas by filing a case at Amazon Web Services Support Center, obtaining the increase is not instantaneous. The
DescribeLimits
action lets you write code to compare the capacity you are currently using to those quotas imposed by your account so that you have enough time to apply for an increase before you hit a quota.For example, you could use one of the Amazon Web Services SDKs to do the following:
-
Call
DescribeLimits
for a particular Region to obtain your current account quotas on provisioned capacity there. -
Create a variable to hold the aggregate read capacity units provisioned for all your tables in that Region, and one to hold the aggregate write capacity units. Zero them both.
-
Call
ListTables
to obtain a list of all your DynamoDB tables. -
For each table name listed by
ListTables
, do the following:-
Call
DescribeTable
with the table name. -
Use the data returned by
DescribeTable
to add the read capacity units and write capacity units provisioned for the table itself to your variables. -
If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well.
-
-
Report the account quotas for that Region returned by
DescribeLimits
, along with the total current provisioned capacity levels you have calculated.
This will let you see whether you are getting close to your account-level quotas.
The per-table quotas apply only when you are creating a new table. They restrict the sum of the provisioned capacity of the new table itself and all its global secondary indexes.
For existing tables and their GSIs, DynamoDB doesn't let you increase provisioned capacity extremely rapidly, but the only quota that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account quotas.
DescribeLimits
should only be called periodically. You can expect throttling errors if you call it more than once in a minute.The
DescribeLimits
Request element has no content.- Parameters:
describeLimitsRequest
- Represents the input of aDescribeLimits
operation. Has no content.- Returns:
- A Java Future containing the result of the DescribeLimits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
describeLimits
default CompletableFuture<DescribeLimitsResponse> describeLimits(Consumer<DescribeLimitsRequest.Builder> describeLimitsRequest)
Returns the current provisioned-capacity quotas for your Amazon Web Services account in a Region, both for the Region as a whole and for any one DynamoDB table that you create there.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum read capacity units and write capacity units that you can provision across all of your DynamoDB tables in a given Region. Also, there are per-table quotas that apply when you create a table there. For more information, see Service, Account, and Table Quotas page in the Amazon DynamoDB Developer Guide.
Although you can increase these quotas by filing a case at Amazon Web Services Support Center, obtaining the increase is not instantaneous. The
DescribeLimits
action lets you write code to compare the capacity you are currently using to those quotas imposed by your account so that you have enough time to apply for an increase before you hit a quota.For example, you could use one of the Amazon Web Services SDKs to do the following:
-
Call
DescribeLimits
for a particular Region to obtain your current account quotas on provisioned capacity there. -
Create a variable to hold the aggregate read capacity units provisioned for all your tables in that Region, and one to hold the aggregate write capacity units. Zero them both.
-
Call
ListTables
to obtain a list of all your DynamoDB tables. -
For each table name listed by
ListTables
, do the following:-
Call
DescribeTable
with the table name. -
Use the data returned by
DescribeTable
to add the read capacity units and write capacity units provisioned for the table itself to your variables. -
If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well.
-
-
Report the account quotas for that Region returned by
DescribeLimits
, along with the total current provisioned capacity levels you have calculated.
This will let you see whether you are getting close to your account-level quotas.
The per-table quotas apply only when you are creating a new table. They restrict the sum of the provisioned capacity of the new table itself and all its global secondary indexes.
For existing tables and their GSIs, DynamoDB doesn't let you increase provisioned capacity extremely rapidly, but the only quota that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account quotas.
DescribeLimits
should only be called periodically. You can expect throttling errors if you call it more than once in a minute.The
DescribeLimits
Request element has no content.
This is a convenience which creates an instance of the
DescribeLimitsRequest.Builder
avoiding the need to create one manually viaDescribeLimitsRequest.builder()
- Parameters:
describeLimitsRequest
- AConsumer
that will call methods onDescribeLimitsRequest.Builder
to create a request. Represents the input of aDescribeLimits
operation. Has no content.- Returns:
- A Java Future containing the result of the DescribeLimits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
describeLimits
default CompletableFuture<DescribeLimitsResponse> describeLimits()
Returns the current provisioned-capacity quotas for your Amazon Web Services account in a Region, both for the Region as a whole and for any one DynamoDB table that you create there.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum read capacity units and write capacity units that you can provision across all of your DynamoDB tables in a given Region. Also, there are per-table quotas that apply when you create a table there. For more information, see Service, Account, and Table Quotas page in the Amazon DynamoDB Developer Guide.
Although you can increase these quotas by filing a case at Amazon Web Services Support Center, obtaining the increase is not instantaneous. The
DescribeLimits
action lets you write code to compare the capacity you are currently using to those quotas imposed by your account so that you have enough time to apply for an increase before you hit a quota.For example, you could use one of the Amazon Web Services SDKs to do the following:
-
Call
DescribeLimits
for a particular Region to obtain your current account quotas on provisioned capacity there. -
Create a variable to hold the aggregate read capacity units provisioned for all your tables in that Region, and one to hold the aggregate write capacity units. Zero them both.
-
Call
ListTables
to obtain a list of all your DynamoDB tables. -
For each table name listed by
ListTables
, do the following:-
Call
DescribeTable
with the table name. -
Use the data returned by
DescribeTable
to add the read capacity units and write capacity units provisioned for the table itself to your variables. -
If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well.
-
-
Report the account quotas for that Region returned by
DescribeLimits
, along with the total current provisioned capacity levels you have calculated.
This will let you see whether you are getting close to your account-level quotas.
The per-table quotas apply only when you are creating a new table. They restrict the sum of the provisioned capacity of the new table itself and all its global secondary indexes.
For existing tables and their GSIs, DynamoDB doesn't let you increase provisioned capacity extremely rapidly, but the only quota that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account quotas.
DescribeLimits
should only be called periodically. You can expect throttling errors if you call it more than once in a minute.The
DescribeLimits
Request element has no content.- Returns:
- A Java Future containing the result of the DescribeLimits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
describeTable
default CompletableFuture<DescribeTableResponse> describeTable(DescribeTableRequest describeTableRequest)
Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.
This operation only applies to Version 2019.11.21 (Current) of global tables.
If you issue a
DescribeTable
request immediately after aCreateTable
request, DynamoDB might return aResourceNotFoundException
. This is becauseDescribeTable
uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try theDescribeTable
request again.- Parameters:
describeTableRequest
- Represents the input of aDescribeTable
operation.- Returns:
- A Java Future containing the result of the DescribeTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
- See Also:
- AWS API Documentation
-
describeTable
default CompletableFuture<DescribeTableResponse> describeTable(Consumer<DescribeTableRequest.Builder> describeTableRequest)
Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.
This operation only applies to Version 2019.11.21 (Current) of global tables.
If you issue a
DescribeTable
request immediately after aCreateTable
request, DynamoDB might return aResourceNotFoundException
. This is becauseDescribeTable
uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try theDescribeTable
request again.
This is a convenience which creates an instance of the
DescribeTableRequest.Builder
avoiding the need to create one manually viaDescribeTableRequest.builder()
- Parameters:
describeTableRequest
- AConsumer
that will call methods onDescribeTableRequest.Builder
to create a request. Represents the input of aDescribeTable
operation.- Returns:
- A Java Future containing the result of the DescribeTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
- See Also:
- AWS API Documentation
-
describeTableReplicaAutoScaling
default CompletableFuture<DescribeTableReplicaAutoScalingResponse> describeTableReplicaAutoScaling(DescribeTableReplicaAutoScalingRequest describeTableReplicaAutoScalingRequest)
Describes auto scaling settings across replicas of the global table at once.
This operation only applies to Version 2019.11.21 (Current) of global tables.
- Parameters:
describeTableReplicaAutoScalingRequest
-- Returns:
- A Java Future containing the result of the DescribeTableReplicaAutoScaling operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
- See Also:
- AWS API Documentation
-
describeTableReplicaAutoScaling
default CompletableFuture<DescribeTableReplicaAutoScalingResponse> describeTableReplicaAutoScaling(Consumer<DescribeTableReplicaAutoScalingRequest.Builder> describeTableReplicaAutoScalingRequest)
Describes auto scaling settings across replicas of the global table at once.
This operation only applies to Version 2019.11.21 (Current) of global tables.
This is a convenience which creates an instance of the
DescribeTableReplicaAutoScalingRequest.Builder
avoiding the need to create one manually viaDescribeTableReplicaAutoScalingRequest.builder()
- Parameters:
describeTableReplicaAutoScalingRequest
- AConsumer
that will call methods onDescribeTableReplicaAutoScalingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeTableReplicaAutoScaling operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
- See Also:
- AWS API Documentation
-
describeTimeToLive
default CompletableFuture<DescribeTimeToLiveResponse> describeTimeToLive(DescribeTimeToLiveRequest describeTimeToLiveRequest)
Gives a description of the Time to Live (TTL) status on the specified table.
- Parameters:
describeTimeToLiveRequest
-- Returns:
- A Java Future containing the result of the DescribeTimeToLive operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
- See Also:
- AWS API Documentation
-
describeTimeToLive
default CompletableFuture<DescribeTimeToLiveResponse> describeTimeToLive(Consumer<DescribeTimeToLiveRequest.Builder> describeTimeToLiveRequest)
Gives a description of the Time to Live (TTL) status on the specified table.
This is a convenience which creates an instance of the
DescribeTimeToLiveRequest.Builder
avoiding the need to create one manually viaDescribeTimeToLiveRequest.builder()
- Parameters:
describeTimeToLiveRequest
- AConsumer
that will call methods onDescribeTimeToLiveRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeTimeToLive operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
- See Also:
- AWS API Documentation
-
disableKinesisStreamingDestination
default CompletableFuture<DisableKinesisStreamingDestinationResponse> disableKinesisStreamingDestination(DisableKinesisStreamingDestinationRequest disableKinesisStreamingDestinationRequest)
Stops replication from the DynamoDB table to the Kinesis data stream. This is done without deleting either of the resources.
- Parameters:
disableKinesisStreamingDestinationRequest
-- Returns:
- A Java Future containing the result of the DisableKinesisStreamingDestination operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerErrorException An error occurred on the server side.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
CREATING
state. - ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
disableKinesisStreamingDestination
default CompletableFuture<DisableKinesisStreamingDestinationResponse> disableKinesisStreamingDestination(Consumer<DisableKinesisStreamingDestinationRequest.Builder> disableKinesisStreamingDestinationRequest)
Stops replication from the DynamoDB table to the Kinesis data stream. This is done without deleting either of the resources.
This is a convenience which creates an instance of the
DisableKinesisStreamingDestinationRequest.Builder
avoiding the need to create one manually viaDisableKinesisStreamingDestinationRequest.builder()
- Parameters:
disableKinesisStreamingDestinationRequest
- AConsumer
that will call methods onDisableKinesisStreamingDestinationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisableKinesisStreamingDestination operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerErrorException An error occurred on the server side.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
CREATING
state. - ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
enableKinesisStreamingDestination
default CompletableFuture<EnableKinesisStreamingDestinationResponse> enableKinesisStreamingDestination(EnableKinesisStreamingDestinationRequest enableKinesisStreamingDestinationRequest)
Starts table data replication to the specified Kinesis data stream at a timestamp chosen during the enable workflow. If this operation doesn't return results immediately, use DescribeKinesisStreamingDestination to check if streaming to the Kinesis data stream is ACTIVE.
- Parameters:
enableKinesisStreamingDestinationRequest
-- Returns:
- A Java Future containing the result of the EnableKinesisStreamingDestination operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerErrorException An error occurred on the server side.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
CREATING
state. - ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
enableKinesisStreamingDestination
default CompletableFuture<EnableKinesisStreamingDestinationResponse> enableKinesisStreamingDestination(Consumer<EnableKinesisStreamingDestinationRequest.Builder> enableKinesisStreamingDestinationRequest)
Starts table data replication to the specified Kinesis data stream at a timestamp chosen during the enable workflow. If this operation doesn't return results immediately, use DescribeKinesisStreamingDestination to check if streaming to the Kinesis data stream is ACTIVE.
This is a convenience which creates an instance of the
EnableKinesisStreamingDestinationRequest.Builder
avoiding the need to create one manually viaEnableKinesisStreamingDestinationRequest.builder()
- Parameters:
enableKinesisStreamingDestinationRequest
- AConsumer
that will call methods onEnableKinesisStreamingDestinationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the EnableKinesisStreamingDestination operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerErrorException An error occurred on the server side.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
CREATING
state. - ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
executeStatement
default CompletableFuture<ExecuteStatementResponse> executeStatement(ExecuteStatementRequest executeStatementRequest)
This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL.
For PartiQL reads (
SELECT
statement), if the total number of processed items exceeds the maximum dataset size limit of 1 MB, the read stops and results are returned to the user as aLastEvaluatedKey
value to continue the read in a subsequent operation. If the filter criteria inWHERE
clause does not match any data, the read will return an empty result set.A single
SELECT
statement response can return up to the maximum number of items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any filtering to the results usingWHERE
clause). IfLastEvaluatedKey
is present in the response, you need to paginate the result set. IfNextToken
is present, you need to paginate the result set and includeNextToken
.- Parameters:
executeStatementRequest
-- Returns:
- A Java Future containing the result of the ExecuteStatement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConditionalCheckFailedException A condition specified in the operation could not be evaluated.
- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - ItemCollectionSizeLimitExceededException An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
- TransactionConflictException Operation was rejected because there is an ongoing transaction for the item.
- RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- DuplicateItemException There was an attempt to insert an item with the same primary key as an item that already exists in the DynamoDB table.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
executeStatement
default CompletableFuture<ExecuteStatementResponse> executeStatement(Consumer<ExecuteStatementRequest.Builder> executeStatementRequest)
This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL.
For PartiQL reads (
SELECT
statement), if the total number of processed items exceeds the maximum dataset size limit of 1 MB, the read stops and results are returned to the user as aLastEvaluatedKey
value to continue the read in a subsequent operation. If the filter criteria inWHERE
clause does not match any data, the read will return an empty result set.A single
SELECT
statement response can return up to the maximum number of items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any filtering to the results usingWHERE
clause). IfLastEvaluatedKey
is present in the response, you need to paginate the result set. IfNextToken
is present, you need to paginate the result set and includeNextToken
.
This is a convenience which creates an instance of the
ExecuteStatementRequest.Builder
avoiding the need to create one manually viaExecuteStatementRequest.builder()
- Parameters:
executeStatementRequest
- AConsumer
that will call methods onExecuteStatementRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ExecuteStatement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConditionalCheckFailedException A condition specified in the operation could not be evaluated.
- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - ItemCollectionSizeLimitExceededException An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
- TransactionConflictException Operation was rejected because there is an ongoing transaction for the item.
- RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- DuplicateItemException There was an attempt to insert an item with the same primary key as an item that already exists in the DynamoDB table.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
executeTransaction
default CompletableFuture<ExecuteTransactionResponse> executeTransaction(ExecuteTransactionRequest executeTransactionRequest)
This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL.
The entire transaction must consist of either read statements or write statements, you cannot mix both in one transaction. The EXISTS function is an exception and can be used to check the condition of specific attributes of the item in a similar manner to
ConditionCheck
in the TransactWriteItems API.- Parameters:
executeTransactionRequest
-- Returns:
- A Java Future containing the result of the ExecuteTransaction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - TransactionCanceledException The entire transaction request was canceled.
DynamoDB cancels a
TransactWriteItems
request under the following circumstances:-
A condition in one of the condition expressions is not met.
-
A table in the
TransactWriteItems
request is in a different account or region. -
More than one action in the
TransactWriteItems
operation targets the same item. -
There is insufficient provisioned capacity for the transaction to be completed.
-
An item size becomes too large (larger than 400 KB), or a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.
-
There is a user error, such as an invalid data format.
-
There is an ongoing
TransactWriteItems
operation that conflicts with a concurrentTransactWriteItems
request. In this case theTransactWriteItems
operation fails with aTransactionCanceledException
.
DynamoDB cancels a
TransactGetItems
request under the following circumstances:-
There is an ongoing
TransactGetItems
operation that conflicts with a concurrentPutItem
,UpdateItem
,DeleteItem
orTransactWriteItems
request. In this case theTransactGetItems
operation fails with aTransactionCanceledException
. -
A table in the
TransactGetItems
request is in a different account or region. -
There is insufficient provisioned capacity for the transaction to be completed.
-
There is a user error, such as an invalid data format.
If using Java, DynamoDB lists the cancellation reasons on the
CancellationReasons
property. This property is not set for other languages. Transaction cancellation reasons are ordered in the order of requested items, if an item has no error it will haveNone
code andNull
message.Cancellation reason codes and possible error messages:
-
No Errors:
-
Code:
None
-
Message:
null
-
-
Conditional Check Failed:
-
Code:
ConditionalCheckFailed
-
Message: The conditional request failed.
-
-
Item Collection Size Limit Exceeded:
-
Code:
ItemCollectionSizeLimitExceeded
-
Message: Collection size exceeded.
-
-
Transaction Conflict:
-
Code:
TransactionConflict
-
Message: Transaction is ongoing for the item.
-
-
Provisioned Throughput Exceeded:
-
Code:
ProvisionedThroughputExceeded
-
Messages:
-
The level of configured provisioned throughput for the table was exceeded. Consider increasing your provisioning level with the UpdateTable API.
This Message is received when provisioned throughput is exceeded is on a provisioned DynamoDB table.
-
The level of configured provisioned throughput for one or more global secondary indexes of the table was exceeded. Consider increasing your provisioning level for the under-provisioned global secondary indexes with the UpdateTable API.
This message is returned when provisioned throughput is exceeded is on a provisioned GSI.
-
-
-
Throttling Error:
-
Code:
ThrottlingError
-
Messages:
-
Throughput exceeds the current capacity of your table or index. DynamoDB is automatically scaling your table or index so please try again shortly. If exceptions persist, check if you have a hot key: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html.
This message is returned when writes get throttled on an On-Demand table as DynamoDB is automatically scaling the table.
-
Throughput exceeds the current capacity for one or more global secondary indexes. DynamoDB is automatically scaling your index so please try again shortly.
This message is returned when writes get throttled on an On-Demand GSI as DynamoDB is automatically scaling the GSI.
-
-
-
Validation Error:
-
Code:
ValidationError
-
Messages:
-
One or more parameter values were invalid.
-
The update expression attempted to update the secondary index key beyond allowed size limits.
-
The update expression attempted to update the secondary index key to unsupported type.
-
An operand in the update expression has an incorrect data type.
-
Item size to update has exceeded the maximum allowed size.
-
Number overflow. Attempting to store a number with magnitude larger than supported range.
-
Type mismatch for attribute to update.
-
Nesting Levels have exceeded supported limits.
-
The document path provided in the update expression is invalid for update.
-
The provided expression refers to an attribute that does not exist in the item.
-
-
-
- TransactionInProgressException The transaction with the given request token is already in
progress.
Recommended Settings
This is a general recommendation for handling the
TransactionInProgressException
. These settings help ensure that the client retries will trigger completion of the ongoingTransactWriteItems
request.-
Set
clientExecutionTimeout
to a value that allows at least one retry to be processed after 5 seconds have elapsed since the first attempt for theTransactWriteItems
operation. -
Set
socketTimeout
to a value a little lower than therequestTimeout
setting. -
requestTimeout
should be set based on the time taken for the individual retries of a single HTTP request for your use case, but setting it to 1 second or higher should work well to reduce chances of retries andTransactionInProgressException
errors. -
Use exponential backoff when retrying and tune backoff if needed.
Assuming default retry policy, example timeout settings based on the guidelines above are as follows:
Example timeline:
-
0-1000 first attempt
-
1000-1500 first sleep/delay (default retry policy uses 500 ms as base delay for 4xx errors)
-
1500-2500 second attempt
-
2500-3500 second sleep/delay (500 * 2, exponential backoff)
-
3500-4500 third attempt
-
4500-6500 third sleep/delay (500 * 2^2)
-
6500-7500 fourth attempt (this can trigger inline recovery since 5 seconds have elapsed since the first attempt reached TC)
-
- IdempotentParameterMismatchException DynamoDB rejected the request because you retried a request with a different payload but with an idempotent token that was already used.
- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
- See Also:
- AWS API Documentation
-
executeTransaction
default CompletableFuture<ExecuteTransactionResponse> executeTransaction(Consumer<ExecuteTransactionRequest.Builder> executeTransactionRequest)
This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL.
The entire transaction must consist of either read statements or write statements, you cannot mix both in one transaction. The EXISTS function is an exception and can be used to check the condition of specific attributes of the item in a similar manner to
ConditionCheck
in the TransactWriteItems API.
This is a convenience which creates an instance of the
ExecuteTransactionRequest.Builder
avoiding the need to create one manually viaExecuteTransactionRequest.builder()
- Parameters:
executeTransactionRequest
- AConsumer
that will call methods onExecuteTransactionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ExecuteTransaction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - TransactionCanceledException The entire transaction request was canceled.
DynamoDB cancels a
TransactWriteItems
request under the following circumstances:-
A condition in one of the condition expressions is not met.
-
A table in the
TransactWriteItems
request is in a different account or region. -
More than one action in the
TransactWriteItems
operation targets the same item. -
There is insufficient provisioned capacity for the transaction to be completed.
-
An item size becomes too large (larger than 400 KB), or a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.
-
There is a user error, such as an invalid data format.
-
There is an ongoing
TransactWriteItems
operation that conflicts with a concurrentTransactWriteItems
request. In this case theTransactWriteItems
operation fails with aTransactionCanceledException
.
DynamoDB cancels a
TransactGetItems
request under the following circumstances:-
There is an ongoing
TransactGetItems
operation that conflicts with a concurrentPutItem
,UpdateItem
,DeleteItem
orTransactWriteItems
request. In this case theTransactGetItems
operation fails with aTransactionCanceledException
. -
A table in the
TransactGetItems
request is in a different account or region. -
There is insufficient provisioned capacity for the transaction to be completed.
-
There is a user error, such as an invalid data format.
If using Java, DynamoDB lists the cancellation reasons on the
CancellationReasons
property. This property is not set for other languages. Transaction cancellation reasons are ordered in the order of requested items, if an item has no error it will haveNone
code andNull
message.Cancellation reason codes and possible error messages:
-
No Errors:
-
Code:
None
-
Message:
null
-
-
Conditional Check Failed:
-
Code:
ConditionalCheckFailed
-
Message: The conditional request failed.
-
-
Item Collection Size Limit Exceeded:
-
Code:
ItemCollectionSizeLimitExceeded
-
Message: Collection size exceeded.
-
-
Transaction Conflict:
-
Code:
TransactionConflict
-
Message: Transaction is ongoing for the item.
-
-
Provisioned Throughput Exceeded:
-
Code:
ProvisionedThroughputExceeded
-
Messages:
-
The level of configured provisioned throughput for the table was exceeded. Consider increasing your provisioning level with the UpdateTable API.
This Message is received when provisioned throughput is exceeded is on a provisioned DynamoDB table.
-
The level of configured provisioned throughput for one or more global secondary indexes of the table was exceeded. Consider increasing your provisioning level for the under-provisioned global secondary indexes with the UpdateTable API.
This message is returned when provisioned throughput is exceeded is on a provisioned GSI.
-
-
-
Throttling Error:
-
Code:
ThrottlingError
-
Messages:
-
Throughput exceeds the current capacity of your table or index. DynamoDB is automatically scaling your table or index so please try again shortly. If exceptions persist, check if you have a hot key: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html.
This message is returned when writes get throttled on an On-Demand table as DynamoDB is automatically scaling the table.
-
Throughput exceeds the current capacity for one or more global secondary indexes. DynamoDB is automatically scaling your index so please try again shortly.
This message is returned when writes get throttled on an On-Demand GSI as DynamoDB is automatically scaling the GSI.
-
-
-
Validation Error:
-
Code:
ValidationError
-
Messages:
-
One or more parameter values were invalid.
-
The update expression attempted to update the secondary index key beyond allowed size limits.
-
The update expression attempted to update the secondary index key to unsupported type.
-
An operand in the update expression has an incorrect data type.
-
Item size to update has exceeded the maximum allowed size.
-
Number overflow. Attempting to store a number with magnitude larger than supported range.
-
Type mismatch for attribute to update.
-
Nesting Levels have exceeded supported limits.
-
The document path provided in the update expression is invalid for update.
-
The provided expression refers to an attribute that does not exist in the item.
-
-
-
- TransactionInProgressException The transaction with the given request token is already in
progress.
Recommended Settings
This is a general recommendation for handling the
TransactionInProgressException
. These settings help ensure that the client retries will trigger completion of the ongoingTransactWriteItems
request.-
Set
clientExecutionTimeout
to a value that allows at least one retry to be processed after 5 seconds have elapsed since the first attempt for theTransactWriteItems
operation. -
Set
socketTimeout
to a value a little lower than therequestTimeout
setting. -
requestTimeout
should be set based on the time taken for the individual retries of a single HTTP request for your use case, but setting it to 1 second or higher should work well to reduce chances of retries andTransactionInProgressException
errors. -
Use exponential backoff when retrying and tune backoff if needed.
Assuming default retry policy, example timeout settings based on the guidelines above are as follows:
Example timeline:
-
0-1000 first attempt
-
1000-1500 first sleep/delay (default retry policy uses 500 ms as base delay for 4xx errors)
-
1500-2500 second attempt
-
2500-3500 second sleep/delay (500 * 2, exponential backoff)
-
3500-4500 third attempt
-
4500-6500 third sleep/delay (500 * 2^2)
-
6500-7500 fourth attempt (this can trigger inline recovery since 5 seconds have elapsed since the first attempt reached TC)
-
- IdempotentParameterMismatchException DynamoDB rejected the request because you retried a request with a different payload but with an idempotent token that was already used.
- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
- See Also:
- AWS API Documentation
-
exportTableToPointInTime
default CompletableFuture<ExportTableToPointInTimeResponse> exportTableToPointInTime(ExportTableToPointInTimeRequest exportTableToPointInTimeRequest)
Exports table data to an S3 bucket. The table must have point in time recovery enabled, and you can export data from any time within the point in time recovery window.
- Parameters:
exportTableToPointInTimeRequest
-- Returns:
- A Java Future containing the result of the ExportTableToPointInTime operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TableNotFoundException A source table with the name
TableName
does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region. - PointInTimeRecoveryUnavailableException Point in time recovery has not yet been enabled for this source table.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InvalidExportTimeException The specified
ExportTime
is outside of the point in time recovery window. - ExportConflictException There was a conflict when writing to the specified S3 bucket.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- TableNotFoundException A source table with the name
- See Also:
- AWS API Documentation
-
exportTableToPointInTime
default CompletableFuture<ExportTableToPointInTimeResponse> exportTableToPointInTime(Consumer<ExportTableToPointInTimeRequest.Builder> exportTableToPointInTimeRequest)
Exports table data to an S3 bucket. The table must have point in time recovery enabled, and you can export data from any time within the point in time recovery window.
This is a convenience which creates an instance of the
ExportTableToPointInTimeRequest.Builder
avoiding the need to create one manually viaExportTableToPointInTimeRequest.builder()
- Parameters:
exportTableToPointInTimeRequest
- AConsumer
that will call methods onExportTableToPointInTimeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ExportTableToPointInTime operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TableNotFoundException A source table with the name
TableName
does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region. - PointInTimeRecoveryUnavailableException Point in time recovery has not yet been enabled for this source table.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InvalidExportTimeException The specified
ExportTime
is outside of the point in time recovery window. - ExportConflictException There was a conflict when writing to the specified S3 bucket.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- TableNotFoundException A source table with the name
- See Also:
- AWS API Documentation
-
getItem
default CompletableFuture<GetItemResponse> getItem(GetItemRequest getItemRequest)
The
GetItem
operation returns a set of attributes for the item with the given primary key. If there is no matching item,GetItem
does not return any data and there will be noItem
element in the response.GetItem
provides an eventually consistent read by default. If your application requires a strongly consistent read, setConsistentRead
totrue
. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value.- Parameters:
getItemRequest
- Represents the input of aGetItem
operation.- Returns:
- A Java Future containing the result of the GetItem operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getItem
default CompletableFuture<GetItemResponse> getItem(Consumer<GetItemRequest.Builder> getItemRequest)
The
GetItem
operation returns a set of attributes for the item with the given primary key. If there is no matching item,GetItem
does not return any data and there will be noItem
element in the response.GetItem
provides an eventually consistent read by default. If your application requires a strongly consistent read, setConsistentRead
totrue
. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value.
This is a convenience which creates an instance of the
GetItemRequest.Builder
avoiding the need to create one manually viaGetItemRequest.builder()
- Parameters:
getItemRequest
- AConsumer
that will call methods onGetItemRequest.Builder
to create a request. Represents the input of aGetItem
operation.- Returns:
- A Java Future containing the result of the GetItem operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
importTable
default CompletableFuture<ImportTableResponse> importTable(ImportTableRequest importTableRequest)
Imports table data from an S3 bucket.
- Parameters:
importTableRequest
-- Returns:
- A Java Future containing the result of the ImportTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
CREATING
state. - LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- ImportConflictException There was a conflict when importing from the specified S3 source. This can occur when the current import conflicts with a previous import request that had the same client token.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
- See Also:
- AWS API Documentation
-
importTable
default CompletableFuture<ImportTableResponse> importTable(Consumer<ImportTableRequest.Builder> importTableRequest)
Imports table data from an S3 bucket.
This is a convenience which creates an instance of the
ImportTableRequest.Builder
avoiding the need to create one manually viaImportTableRequest.builder()
- Parameters:
importTableRequest
- AConsumer
that will call methods onImportTableRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ImportTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
CREATING
state. - LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- ImportConflictException There was a conflict when importing from the specified S3 source. This can occur when the current import conflicts with a previous import request that had the same client token.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
- See Also:
- AWS API Documentation
-
listBackups
default CompletableFuture<ListBackupsResponse> listBackups(ListBackupsRequest listBackupsRequest)
List DynamoDB backups that are associated with an Amazon Web Services account and weren't made with Amazon Web Services Backup. To list these backups for a given table, specify
TableName
.ListBackups
returns a paginated list of results with at most 1 MB worth of items in a page. You can also specify a maximum number of entries to be returned in a page.In the request, start time is inclusive, but end time is exclusive. Note that these boundaries are for the time at which the original backup was requested.
You can call
ListBackups
a maximum of five times per second.If you want to retrieve the complete list of backups made with Amazon Web Services Backup, use the Amazon Web Services Backup list API.
- Parameters:
listBackupsRequest
-- Returns:
- A Java Future containing the result of the ListBackups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listBackups
default CompletableFuture<ListBackupsResponse> listBackups(Consumer<ListBackupsRequest.Builder> listBackupsRequest)
List DynamoDB backups that are associated with an Amazon Web Services account and weren't made with Amazon Web Services Backup. To list these backups for a given table, specify
TableName
.ListBackups
returns a paginated list of results with at most 1 MB worth of items in a page. You can also specify a maximum number of entries to be returned in a page.In the request, start time is inclusive, but end time is exclusive. Note that these boundaries are for the time at which the original backup was requested.
You can call
ListBackups
a maximum of five times per second.If you want to retrieve the complete list of backups made with Amazon Web Services Backup, use the Amazon Web Services Backup list API.
This is a convenience which creates an instance of the
ListBackupsRequest.Builder
avoiding the need to create one manually viaListBackupsRequest.builder()
- Parameters:
listBackupsRequest
- AConsumer
that will call methods onListBackupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListBackups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listBackups
default CompletableFuture<ListBackupsResponse> listBackups()
List DynamoDB backups that are associated with an Amazon Web Services account and weren't made with Amazon Web Services Backup. To list these backups for a given table, specify
TableName
.ListBackups
returns a paginated list of results with at most 1 MB worth of items in a page. You can also specify a maximum number of entries to be returned in a page.In the request, start time is inclusive, but end time is exclusive. Note that these boundaries are for the time at which the original backup was requested.
You can call
ListBackups
a maximum of five times per second.If you want to retrieve the complete list of backups made with Amazon Web Services Backup, use the Amazon Web Services Backup list API.
- Returns:
- A Java Future containing the result of the ListBackups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listContributorInsights
default CompletableFuture<ListContributorInsightsResponse> listContributorInsights(ListContributorInsightsRequest listContributorInsightsRequest)
Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes.
- Parameters:
listContributorInsightsRequest
-- Returns:
- A Java Future containing the result of the ListContributorInsights operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
- See Also:
- AWS API Documentation
-
listContributorInsights
default CompletableFuture<ListContributorInsightsResponse> listContributorInsights(Consumer<ListContributorInsightsRequest.Builder> listContributorInsightsRequest)
Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes.
This is a convenience which creates an instance of the
ListContributorInsightsRequest.Builder
avoiding the need to create one manually viaListContributorInsightsRequest.builder()
- Parameters:
listContributorInsightsRequest
- AConsumer
that will call methods onListContributorInsightsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListContributorInsights operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
- See Also:
- AWS API Documentation
-
listContributorInsightsPaginator
default ListContributorInsightsPublisher listContributorInsightsPaginator(ListContributorInsightsRequest listContributorInsightsRequest)
This is a variant of
listContributorInsights(software.amazon.awssdk.services.dynamodb.model.ListContributorInsightsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.dynamodb.paginators.ListContributorInsightsPublisher publisher = client.listContributorInsightsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.dynamodb.paginators.ListContributorInsightsPublisher publisher = client.listContributorInsightsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.dynamodb.model.ListContributorInsightsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.dynamodb.model.ListContributorInsightsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listContributorInsights(software.amazon.awssdk.services.dynamodb.model.ListContributorInsightsRequest)
operation.- Parameters:
listContributorInsightsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
- See Also:
- AWS API Documentation
-
listContributorInsightsPaginator
default ListContributorInsightsPublisher listContributorInsightsPaginator(Consumer<ListContributorInsightsRequest.Builder> listContributorInsightsRequest)
This is a variant of
listContributorInsights(software.amazon.awssdk.services.dynamodb.model.ListContributorInsightsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.dynamodb.paginators.ListContributorInsightsPublisher publisher = client.listContributorInsightsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.dynamodb.paginators.ListContributorInsightsPublisher publisher = client.listContributorInsightsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.dynamodb.model.ListContributorInsightsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.dynamodb.model.ListContributorInsightsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listContributorInsights(software.amazon.awssdk.services.dynamodb.model.ListContributorInsightsRequest)
operation.
This is a convenience which creates an instance of the
ListContributorInsightsRequest.Builder
avoiding the need to create one manually viaListContributorInsightsRequest.builder()
- Parameters:
listContributorInsightsRequest
- AConsumer
that will call methods onListContributorInsightsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
- See Also:
- AWS API Documentation
-
listExports
default CompletableFuture<ListExportsResponse> listExports(ListExportsRequest listExportsRequest)
Lists completed exports within the past 90 days.
- Parameters:
listExportsRequest
-- Returns:
- A Java Future containing the result of the ListExports operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
- See Also:
- AWS API Documentation
-
listExports
default CompletableFuture<ListExportsResponse> listExports(Consumer<ListExportsRequest.Builder> listExportsRequest)
Lists completed exports within the past 90 days.
This is a convenience which creates an instance of the
ListExportsRequest.Builder
avoiding the need to create one manually viaListExportsRequest.builder()
- Parameters:
listExportsRequest
- AConsumer
that will call methods onListExportsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListExports operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
- See Also:
- AWS API Documentation
-
listExportsPaginator
default ListExportsPublisher listExportsPaginator(ListExportsRequest listExportsRequest)
This is a variant of
listExports(software.amazon.awssdk.services.dynamodb.model.ListExportsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.dynamodb.paginators.ListExportsPublisher publisher = client.listExportsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.dynamodb.paginators.ListExportsPublisher publisher = client.listExportsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.dynamodb.model.ListExportsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.dynamodb.model.ListExportsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExports(software.amazon.awssdk.services.dynamodb.model.ListExportsRequest)
operation.- Parameters:
listExportsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
- See Also:
- AWS API Documentation
-
listExportsPaginator
default ListExportsPublisher listExportsPaginator(Consumer<ListExportsRequest.Builder> listExportsRequest)
This is a variant of
listExports(software.amazon.awssdk.services.dynamodb.model.ListExportsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.dynamodb.paginators.ListExportsPublisher publisher = client.listExportsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.dynamodb.paginators.ListExportsPublisher publisher = client.listExportsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.dynamodb.model.ListExportsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.dynamodb.model.ListExportsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExports(software.amazon.awssdk.services.dynamodb.model.ListExportsRequest)
operation.
This is a convenience which creates an instance of the
ListExportsRequest.Builder
avoiding the need to create one manually viaListExportsRequest.builder()
- Parameters:
listExportsRequest
- AConsumer
that will call methods onListExportsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
- See Also:
- AWS API Documentation
-
listGlobalTables
default CompletableFuture<ListGlobalTablesResponse> listGlobalTables(ListGlobalTablesRequest listGlobalTablesRequest)
Lists all global tables that have a replica in the specified Region.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
- Parameters:
listGlobalTablesRequest
-- Returns:
- A Java Future containing the result of the ListGlobalTables operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listGlobalTables
default CompletableFuture<ListGlobalTablesResponse> listGlobalTables(Consumer<ListGlobalTablesRequest.Builder> listGlobalTablesRequest)
Lists all global tables that have a replica in the specified Region.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
This is a convenience which creates an instance of the
ListGlobalTablesRequest.Builder
avoiding the need to create one manually viaListGlobalTablesRequest.builder()
- Parameters:
listGlobalTablesRequest
- AConsumer
that will call methods onListGlobalTablesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListGlobalTables operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listGlobalTables
default CompletableFuture<ListGlobalTablesResponse> listGlobalTables()
Lists all global tables that have a replica in the specified Region.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
- Returns:
- A Java Future containing the result of the ListGlobalTables operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listImports
default CompletableFuture<ListImportsResponse> listImports(ListImportsRequest listImportsRequest)
Lists completed imports within the past 90 days.
- Parameters:
listImportsRequest
-- Returns:
- A Java Future containing the result of the ListImports operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
- See Also:
- AWS API Documentation
-
listImports
default CompletableFuture<ListImportsResponse> listImports(Consumer<ListImportsRequest.Builder> listImportsRequest)
Lists completed imports within the past 90 days.
This is a convenience which creates an instance of the
ListImportsRequest.Builder
avoiding the need to create one manually viaListImportsRequest.builder()
- Parameters:
listImportsRequest
- AConsumer
that will call methods onListImportsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListImports operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
- See Also:
- AWS API Documentation
-
listImportsPaginator
default ListImportsPublisher listImportsPaginator(ListImportsRequest listImportsRequest)
This is a variant of
listImports(software.amazon.awssdk.services.dynamodb.model.ListImportsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.dynamodb.paginators.ListImportsPublisher publisher = client.listImportsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.dynamodb.paginators.ListImportsPublisher publisher = client.listImportsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.dynamodb.model.ListImportsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.dynamodb.model.ListImportsResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImports(software.amazon.awssdk.services.dynamodb.model.ListImportsRequest)
operation.- Parameters:
listImportsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
- See Also:
- AWS API Documentation
-
listImportsPaginator
default ListImportsPublisher listImportsPaginator(Consumer<ListImportsRequest.Builder> listImportsRequest)
This is a variant of
listImports(software.amazon.awssdk.services.dynamodb.model.ListImportsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.dynamodb.paginators.ListImportsPublisher publisher = client.listImportsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.dynamodb.paginators.ListImportsPublisher publisher = client.listImportsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.dynamodb.model.ListImportsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.dynamodb.model.ListImportsResponse response) { //... }; });
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImports(software.amazon.awssdk.services.dynamodb.model.ListImportsRequest)
operation.
This is a convenience which creates an instance of the
ListImportsRequest.Builder
avoiding the need to create one manually viaListImportsRequest.builder()
- Parameters:
listImportsRequest
- AConsumer
that will call methods onListImportsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
- See Also:
- AWS API Documentation
-
listTables
default CompletableFuture<ListTablesResponse> listTables(ListTablesRequest listTablesRequest)
Returns an array of table names associated with the current account and endpoint. The output from
ListTables
is paginated, with each page returning a maximum of 100 table names.- Parameters:
listTablesRequest
- Represents the input of aListTables
operation.- Returns:
- A Java Future containing the result of the ListTables operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTables
default CompletableFuture<ListTablesResponse> listTables(Consumer<ListTablesRequest.Builder> listTablesRequest)
Returns an array of table names associated with the current account and endpoint. The output from
ListTables
is paginated, with each page returning a maximum of 100 table names.
This is a convenience which creates an instance of the
ListTablesRequest.Builder
avoiding the need to create one manually viaListTablesRequest.builder()
- Parameters:
listTablesRequest
- AConsumer
that will call methods onListTablesRequest.Builder
to create a request. Represents the input of aListTables
operation.- Returns:
- A Java Future containing the result of the ListTables operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTables
default CompletableFuture<ListTablesResponse> listTables()
Returns an array of table names associated with the current account and endpoint. The output from
ListTables
is paginated, with each page returning a maximum of 100 table names.- Returns:
- A Java Future containing the result of the ListTables operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTablesPaginator
default ListTablesPublisher listTablesPaginator()
This is a variant of
listTables(software.amazon.awssdk.services.dynamodb.model.ListTablesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.dynamodb.paginators.ListTablesPublisher publisher = client.listTablesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.dynamodb.paginators.ListTablesPublisher publisher = client.listTablesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.dynamodb.model.ListTablesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.dynamodb.model.ListTablesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTables(software.amazon.awssdk.services.dynamodb.model.ListTablesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTablesPaginator
default ListTablesPublisher listTablesPaginator(ListTablesRequest listTablesRequest)
This is a variant of
listTables(software.amazon.awssdk.services.dynamodb.model.ListTablesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.dynamodb.paginators.ListTablesPublisher publisher = client.listTablesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.dynamodb.paginators.ListTablesPublisher publisher = client.listTablesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.dynamodb.model.ListTablesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.dynamodb.model.ListTablesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTables(software.amazon.awssdk.services.dynamodb.model.ListTablesRequest)
operation.- Parameters:
listTablesRequest
- Represents the input of aListTables
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTablesPaginator
default ListTablesPublisher listTablesPaginator(Consumer<ListTablesRequest.Builder> listTablesRequest)
This is a variant of
listTables(software.amazon.awssdk.services.dynamodb.model.ListTablesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.dynamodb.paginators.ListTablesPublisher publisher = client.listTablesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.dynamodb.paginators.ListTablesPublisher publisher = client.listTablesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.dynamodb.model.ListTablesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.dynamodb.model.ListTablesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTables(software.amazon.awssdk.services.dynamodb.model.ListTablesRequest)
operation.
This is a convenience which creates an instance of the
ListTablesRequest.Builder
avoiding the need to create one manually viaListTablesRequest.builder()
- Parameters:
listTablesRequest
- AConsumer
that will call methods onListTablesRequest.Builder
to create a request. Represents the input of aListTables
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTagsOfResource
default CompletableFuture<ListTagsOfResourceResponse> listTagsOfResource(ListTagsOfResourceRequest listTagsOfResourceRequest)
List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account.
For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
- Parameters:
listTagsOfResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsOfResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
- See Also:
- AWS API Documentation
-
listTagsOfResource
default CompletableFuture<ListTagsOfResourceResponse> listTagsOfResource(Consumer<ListTagsOfResourceRequest.Builder> listTagsOfResourceRequest)
List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account.
For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
This is a convenience which creates an instance of the
ListTagsOfResourceRequest.Builder
avoiding the need to create one manually viaListTagsOfResourceRequest.builder()
- Parameters:
listTagsOfResourceRequest
- AConsumer
that will call methods onListTagsOfResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsOfResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
- See Also:
- AWS API Documentation
-
putItem
default CompletableFuture<PutItemResponse> putItem(PutItemRequest putItemRequest)
Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. You can return the item's attribute values in the same operation, using the
ReturnValues
parameter.When you add an item, the primary key attributes are the only required attributes.
Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index. Set type attributes cannot be empty.
Invalid Requests with empty values will be rejected with a
ValidationException
exception.To prevent a new item from replacing an existing item, use a conditional expression that contains the
attribute_not_exists
function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, theattribute_not_exists
function will only succeed if no matching item exists.For more information about
PutItem
, see Working with Items in the Amazon DynamoDB Developer Guide.- Parameters:
putItemRequest
- Represents the input of aPutItem
operation.- Returns:
- A Java Future containing the result of the PutItem operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConditionalCheckFailedException A condition specified in the operation could not be evaluated.
- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - ItemCollectionSizeLimitExceededException An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
- TransactionConflictException Operation was rejected because there is an ongoing transaction for the item.
- RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
putItem
default CompletableFuture<PutItemResponse> putItem(Consumer<PutItemRequest.Builder> putItemRequest)
Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. You can return the item's attribute values in the same operation, using the
ReturnValues
parameter.When you add an item, the primary key attributes are the only required attributes.
Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index. Set type attributes cannot be empty.
Invalid Requests with empty values will be rejected with a
ValidationException
exception.To prevent a new item from replacing an existing item, use a conditional expression that contains the
attribute_not_exists
function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, theattribute_not_exists
function will only succeed if no matching item exists.For more information about
PutItem
, see Working with Items in the Amazon DynamoDB Developer Guide.
This is a convenience which creates an instance of the
PutItemRequest.Builder
avoiding the need to create one manually viaPutItemRequest.builder()
- Parameters:
putItemRequest
- AConsumer
that will call methods onPutItemRequest.Builder
to create a request. Represents the input of aPutItem
operation.- Returns:
- A Java Future containing the result of the PutItem operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConditionalCheckFailedException A condition specified in the operation could not be evaluated.
- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - ItemCollectionSizeLimitExceededException An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
- TransactionConflictException Operation was rejected because there is an ongoing transaction for the item.
- RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
query
default CompletableFuture<QueryResponse> query(QueryRequest queryRequest)
You must provide the name of the partition key attribute and a single value for that attribute.
Query
returns all items with that partition key value. Optionally, you can provide a sort key attribute and use a comparison operator to refine the search results.Use the
KeyConditionExpression
parameter to provide a specific value for the partition key. TheQuery
operation will return all of the items from the table or index with that partition key value. You can optionally narrow the scope of theQuery
operation by specifying a sort key value and a comparison operator inKeyConditionExpression
. To further refine theQuery
results, you can optionally provide aFilterExpression
. AFilterExpression
determines which items within the results should be returned to you. All of the other results are discarded.A
Query
operation always returns a result set. If no matching items are found, the result set will be empty. Queries that do not return results consume the minimum number of read capacity units for that type of read operation.DynamoDB calculates the number of read capacity units consumed based on item size, not on the amount of data that is returned to an application. The number of capacity units consumed will be the same whether you request all of the attributes (the default behavior) or just some of them (using a projection expression). The number will also be the same whether or not you use a
FilterExpression
.Query
results are always sorted by the sort key value. If the data type of the sort key is Number, the results are returned in numeric order; otherwise, the results are returned in order of UTF-8 bytes. By default, the sort order is ascending. To reverse the order, set theScanIndexForward
parameter to false.A single
Query
operation will read up to the maximum number of items set (if using theLimit
parameter) or a maximum of 1 MB of data and then apply any filtering to the results usingFilterExpression
. IfLastEvaluatedKey
is present in the response, you will need to paginate the result set. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide.FilterExpression
is applied after aQuery
finishes, but before the results are returned. AFilterExpression
cannot contain partition key or sort key attributes. You need to specify those attributes in theKeyConditionExpression
.A
Query
operation can return an empty result set and aLastEvaluatedKey
if all the items read for the page of results are filtered out.You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local secondary index, you can set the
ConsistentRead
parameter totrue
and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specifyConsistentRead
when querying a global secondary index.- Parameters:
queryRequest
- Represents the input of aQuery
operation.- Returns:
- A Java Future containing the result of the Query operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
query
default CompletableFuture<QueryResponse> query(Consumer<QueryRequest.Builder> queryRequest)
You must provide the name of the partition key attribute and a single value for that attribute.
Query
returns all items with that partition key value. Optionally, you can provide a sort key attribute and use a comparison operator to refine the search results.Use the
KeyConditionExpression
parameter to provide a specific value for the partition key. TheQuery
operation will return all of the items from the table or index with that partition key value. You can optionally narrow the scope of theQuery
operation by specifying a sort key value and a comparison operator inKeyConditionExpression
. To further refine theQuery
results, you can optionally provide aFilterExpression
. AFilterExpression
determines which items within the results should be returned to you. All of the other results are discarded.A
Query
operation always returns a result set. If no matching items are found, the result set will be empty. Queries that do not return results consume the minimum number of read capacity units for that type of read operation.DynamoDB calculates the number of read capacity units consumed based on item size, not on the amount of data that is returned to an application. The number of capacity units consumed will be the same whether you request all of the attributes (the default behavior) or just some of them (using a projection expression). The number will also be the same whether or not you use a
FilterExpression
.Query
results are always sorted by the sort key value. If the data type of the sort key is Number, the results are returned in numeric order; otherwise, the results are returned in order of UTF-8 bytes. By default, the sort order is ascending. To reverse the order, set theScanIndexForward
parameter to false.A single
Query
operation will read up to the maximum number of items set (if using theLimit
parameter) or a maximum of 1 MB of data and then apply any filtering to the results usingFilterExpression
. IfLastEvaluatedKey
is present in the response, you will need to paginate the result set. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide.FilterExpression
is applied after aQuery
finishes, but before the results are returned. AFilterExpression
cannot contain partition key or sort key attributes. You need to specify those attributes in theKeyConditionExpression
.A
Query
operation can return an empty result set and aLastEvaluatedKey
if all the items read for the page of results are filtered out.You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local secondary index, you can set the
ConsistentRead
parameter totrue
and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specifyConsistentRead
when querying a global secondary index.
This is a convenience which creates an instance of the
QueryRequest.Builder
avoiding the need to create one manually viaQueryRequest.builder()
- Parameters:
queryRequest
- AConsumer
that will call methods onQueryRequest.Builder
to create a request. Represents the input of aQuery
operation.- Returns:
- A Java Future containing the result of the Query operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
queryPaginator
default QueryPublisher queryPaginator(QueryRequest queryRequest)
This is a variant of
query(software.amazon.awssdk.services.dynamodb.model.QueryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.dynamodb.paginators.QueryPublisher publisher = client.queryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.dynamodb.paginators.QueryPublisher publisher = client.queryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.dynamodb.model.QueryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.dynamodb.model.QueryResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
query(software.amazon.awssdk.services.dynamodb.model.QueryRequest)
operation.- Parameters:
queryRequest
- Represents the input of aQuery
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
queryPaginator
default QueryPublisher queryPaginator(Consumer<QueryRequest.Builder> queryRequest)
This is a variant of
query(software.amazon.awssdk.services.dynamodb.model.QueryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.dynamodb.paginators.QueryPublisher publisher = client.queryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.dynamodb.paginators.QueryPublisher publisher = client.queryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.dynamodb.model.QueryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.dynamodb.model.QueryResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
query(software.amazon.awssdk.services.dynamodb.model.QueryRequest)
operation.
This is a convenience which creates an instance of the
QueryRequest.Builder
avoiding the need to create one manually viaQueryRequest.builder()
- Parameters:
queryRequest
- AConsumer
that will call methods onQueryRequest.Builder
to create a request. Represents the input of aQuery
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
restoreTableFromBackup
default CompletableFuture<RestoreTableFromBackupResponse> restoreTableFromBackup(RestoreTableFromBackupRequest restoreTableFromBackupRequest)
Creates a new table from an existing backup. Any number of users can execute up to 50 concurrent restores (any type of restore) in a given account.
You can call
RestoreTableFromBackup
at a maximum rate of 10 times per second.You must manually set up the following on the restored table:
-
Auto scaling policies
-
IAM policies
-
Amazon CloudWatch metrics and alarms
-
Tags
-
Stream settings
-
Time to Live (TTL) settings
- Parameters:
restoreTableFromBackupRequest
-- Returns:
- A Java Future containing the result of the RestoreTableFromBackup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TableAlreadyExistsException A target table with the specified name already exists.
- TableInUseException A target table with the specified name is either being created or deleted.
- BackupNotFoundException Backup not found for the given BackupARN.
- BackupInUseException There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
restoreTableFromBackup
default CompletableFuture<RestoreTableFromBackupResponse> restoreTableFromBackup(Consumer<RestoreTableFromBackupRequest.Builder> restoreTableFromBackupRequest)
Creates a new table from an existing backup. Any number of users can execute up to 50 concurrent restores (any type of restore) in a given account.
You can call
RestoreTableFromBackup
at a maximum rate of 10 times per second.You must manually set up the following on the restored table:
-
Auto scaling policies
-
IAM policies
-
Amazon CloudWatch metrics and alarms
-
Tags
-
Stream settings
-
Time to Live (TTL) settings
This is a convenience which creates an instance of the
RestoreTableFromBackupRequest.Builder
avoiding the need to create one manually viaRestoreTableFromBackupRequest.builder()
- Parameters:
restoreTableFromBackupRequest
- AConsumer
that will call methods onRestoreTableFromBackupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RestoreTableFromBackup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TableAlreadyExistsException A target table with the specified name already exists.
- TableInUseException A target table with the specified name is either being created or deleted.
- BackupNotFoundException Backup not found for the given BackupARN.
- BackupInUseException There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
restoreTableToPointInTime
default CompletableFuture<RestoreTableToPointInTimeResponse> restoreTableToPointInTime(RestoreTableToPointInTimeRequest restoreTableToPointInTimeRequest)
Restores the specified table to the specified point in time within
EarliestRestorableDateTime
andLatestRestorableDateTime
. You can restore your table to any point in time during the last 35 days. Any number of users can execute up to 50 concurrent restores (any type of restore) in a given account.When you restore using point in time recovery, DynamoDB restores your table data to the state based on the selected date and time (day:hour:minute:second) to a new table.
Along with data, the following are also included on the new restored table using point in time recovery:
-
Global secondary indexes (GSIs)
-
Local secondary indexes (LSIs)
-
Provisioned read and write capacity
-
Encryption settings
All these settings come from the current settings of the source table at the time of restore.
You must manually set up the following on the restored table:
-
Auto scaling policies
-
IAM policies
-
Amazon CloudWatch metrics and alarms
-
Tags
-
Stream settings
-
Time to Live (TTL) settings
-
Point in time recovery settings
- Parameters:
restoreTableToPointInTimeRequest
-- Returns:
- A Java Future containing the result of the RestoreTableToPointInTime operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TableAlreadyExistsException A target table with the specified name already exists.
- TableNotFoundException A source table with the name
TableName
does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region. - TableInUseException A target table with the specified name is either being created or deleted.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InvalidRestoreTimeException An invalid restore time was specified. RestoreDateTime must be between EarliestRestorableDateTime and LatestRestorableDateTime.
- PointInTimeRecoveryUnavailableException Point in time recovery has not yet been enabled for this source table.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
restoreTableToPointInTime
default CompletableFuture<RestoreTableToPointInTimeResponse> restoreTableToPointInTime(Consumer<RestoreTableToPointInTimeRequest.Builder> restoreTableToPointInTimeRequest)
Restores the specified table to the specified point in time within
EarliestRestorableDateTime
andLatestRestorableDateTime
. You can restore your table to any point in time during the last 35 days. Any number of users can execute up to 50 concurrent restores (any type of restore) in a given account.When you restore using point in time recovery, DynamoDB restores your table data to the state based on the selected date and time (day:hour:minute:second) to a new table.
Along with data, the following are also included on the new restored table using point in time recovery:
-
Global secondary indexes (GSIs)
-
Local secondary indexes (LSIs)
-
Provisioned read and write capacity
-
Encryption settings
All these settings come from the current settings of the source table at the time of restore.
You must manually set up the following on the restored table:
-
Auto scaling policies
-
IAM policies
-
Amazon CloudWatch metrics and alarms
-
Tags
-
Stream settings
-
Time to Live (TTL) settings
-
Point in time recovery settings
This is a convenience which creates an instance of the
RestoreTableToPointInTimeRequest.Builder
avoiding the need to create one manually viaRestoreTableToPointInTimeRequest.builder()
- Parameters:
restoreTableToPointInTimeRequest
- AConsumer
that will call methods onRestoreTableToPointInTimeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RestoreTableToPointInTime operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TableAlreadyExistsException A target table with the specified name already exists.
- TableNotFoundException A source table with the name
TableName
does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region. - TableInUseException A target table with the specified name is either being created or deleted.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InvalidRestoreTimeException An invalid restore time was specified. RestoreDateTime must be between EarliestRestorableDateTime and LatestRestorableDateTime.
- PointInTimeRecoveryUnavailableException Point in time recovery has not yet been enabled for this source table.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
scan
default CompletableFuture<ScanResponse> scan(ScanRequest scanRequest)
The
Scan
operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide aFilterExpression
operation.If the total size of scanned items exceeds the maximum dataset size limit of 1 MB, the scan completes and results are returned to the user. The
LastEvaluatedKey
value is also returned and the requestor can use theLastEvaluatedKey
to continue the scan in a subsequent operation. Each scan response also includes number of items that were scanned (ScannedCount) as part of the request. If using aFilterExpression
, a scan result can result in no items meeting the criteria and theCount
will result in zero. If you did not use aFilterExpression
in the scan request, thenCount
is the same asScannedCount
.Count
andScannedCount
only return the count of items specific to a single scan request and, unless the table is less than 1MB, do not represent the total number of items in the table.A single
Scan
operation first reads up to the maximum number of items set (if using theLimit
parameter) or a maximum of 1 MB of data and then applies any filtering to the results if aFilterExpression
is provided. IfLastEvaluatedKey
is present in the response, pagination is required to complete the full table scan. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide.Scan
operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallelScan
operation by providing theSegment
andTotalSegments
parameters. For more information, see Parallel Scan in the Amazon DynamoDB Developer Guide.By default, a
Scan
uses eventually consistent reads when accessing the items in a table. Therefore, the results from an eventually consistentScan
may not include the latest item changes at the time the scan iterates through each item in the table. If you require a strongly consistent read of each item as the scan iterates through the items in the table, you can set theConsistentRead
parameter to true. Strong consistency only relates to the consistency of the read at the item level.DynamoDB does not provide snapshot isolation for a scan operation when the
ConsistentRead
parameter is set to true. Thus, a DynamoDB scan operation does not guarantee that all reads in a scan see a consistent snapshot of the table when the scan operation was requested.- Parameters:
scanRequest
- Represents the input of aScan
operation.- Returns:
- A Java Future containing the result of the Scan operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
scan
default CompletableFuture<ScanResponse> scan(Consumer<ScanRequest.Builder> scanRequest)
The
Scan
operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide aFilterExpression
operation.If the total size of scanned items exceeds the maximum dataset size limit of 1 MB, the scan completes and results are returned to the user. The
LastEvaluatedKey
value is also returned and the requestor can use theLastEvaluatedKey
to continue the scan in a subsequent operation. Each scan response also includes number of items that were scanned (ScannedCount) as part of the request. If using aFilterExpression
, a scan result can result in no items meeting the criteria and theCount
will result in zero. If you did not use aFilterExpression
in the scan request, thenCount
is the same asScannedCount
.Count
andScannedCount
only return the count of items specific to a single scan request and, unless the table is less than 1MB, do not represent the total number of items in the table.A single
Scan
operation first reads up to the maximum number of items set (if using theLimit
parameter) or a maximum of 1 MB of data and then applies any filtering to the results if aFilterExpression
is provided. IfLastEvaluatedKey
is present in the response, pagination is required to complete the full table scan. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide.Scan
operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallelScan
operation by providing theSegment
andTotalSegments
parameters. For more information, see Parallel Scan in the Amazon DynamoDB Developer Guide.By default, a
Scan
uses eventually consistent reads when accessing the items in a table. Therefore, the results from an eventually consistentScan
may not include the latest item changes at the time the scan iterates through each item in the table. If you require a strongly consistent read of each item as the scan iterates through the items in the table, you can set theConsistentRead
parameter to true. Strong consistency only relates to the consistency of the read at the item level.DynamoDB does not provide snapshot isolation for a scan operation when the
ConsistentRead
parameter is set to true. Thus, a DynamoDB scan operation does not guarantee that all reads in a scan see a consistent snapshot of the table when the scan operation was requested.
This is a convenience which creates an instance of the
ScanRequest.Builder
avoiding the need to create one manually viaScanRequest.builder()
- Parameters:
scanRequest
- AConsumer
that will call methods onScanRequest.Builder
to create a request. Represents the input of aScan
operation.- Returns:
- A Java Future containing the result of the Scan operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
scanPaginator
default ScanPublisher scanPaginator(ScanRequest scanRequest)
This is a variant of
scan(software.amazon.awssdk.services.dynamodb.model.ScanRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.dynamodb.paginators.ScanPublisher publisher = client.scanPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.dynamodb.paginators.ScanPublisher publisher = client.scanPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.dynamodb.model.ScanResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.dynamodb.model.ScanResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
scan(software.amazon.awssdk.services.dynamodb.model.ScanRequest)
operation.- Parameters:
scanRequest
- Represents the input of aScan
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
scanPaginator
default ScanPublisher scanPaginator(Consumer<ScanRequest.Builder> scanRequest)
This is a variant of
scan(software.amazon.awssdk.services.dynamodb.model.ScanRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.dynamodb.paginators.ScanPublisher publisher = client.scanPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.dynamodb.paginators.ScanPublisher publisher = client.scanPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.dynamodb.model.ScanResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.dynamodb.model.ScanResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
scan(software.amazon.awssdk.services.dynamodb.model.ScanRequest)
operation.
This is a convenience which creates an instance of the
ScanRequest.Builder
avoiding the need to create one manually viaScanRequest.builder()
- Parameters:
scanRequest
- AConsumer
that will call methods onScanRequest.Builder
to create a request. Represents the input of aScan
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Associate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. You can call TagResource up to five times per second, per account.
For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - InternalServerErrorException An error occurred on the server side.
- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
CREATING
state. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
- See Also:
- AWS API Documentation
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Associate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. You can call TagResource up to five times per second, per account.
For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - InternalServerErrorException An error occurred on the server side.
- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
CREATING
state. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
- See Also:
- AWS API Documentation
-
transactGetItems
default CompletableFuture<TransactGetItemsResponse> transactGetItems(TransactGetItemsRequest transactGetItemsRequest)
TransactGetItems
is a synchronous operation that atomically retrieves multiple items from one or more tables (but not from indexes) in a single account and Region. ATransactGetItems
call can contain up to 100TransactGetItem
objects, each of which contains aGet
structure that specifies an item to retrieve from a table in the account and Region. A call toTransactGetItems
cannot retrieve items from tables in more than one Amazon Web Services account or Region. The aggregate size of the items in the transaction cannot exceed 4 MB.DynamoDB rejects the entire
TransactGetItems
request if any of the following is true:-
A conflicting operation is in the process of updating an item to be read.
-
There is insufficient provisioned capacity for the transaction to be completed.
-
There is a user error, such as an invalid data format.
-
The aggregate size of the items in the transaction exceeded 4 MB.
- Parameters:
transactGetItemsRequest
-- Returns:
- A Java Future containing the result of the TransactGetItems operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - TransactionCanceledException The entire transaction request was canceled.
DynamoDB cancels a
TransactWriteItems
request under the following circumstances:-
A condition in one of the condition expressions is not met.
-
A table in the
TransactWriteItems
request is in a different account or region. -
More than one action in the
TransactWriteItems
operation targets the same item. -
There is insufficient provisioned capacity for the transaction to be completed.
-
An item size becomes too large (larger than 400 KB), or a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.
-
There is a user error, such as an invalid data format.
-
There is an ongoing
TransactWriteItems
operation that conflicts with a concurrentTransactWriteItems
request. In this case theTransactWriteItems
operation fails with aTransactionCanceledException
.
DynamoDB cancels a
TransactGetItems
request under the following circumstances:-
There is an ongoing
TransactGetItems
operation that conflicts with a concurrentPutItem
,UpdateItem
,DeleteItem
orTransactWriteItems
request. In this case theTransactGetItems
operation fails with aTransactionCanceledException
. -
A table in the
TransactGetItems
request is in a different account or region. -
There is insufficient provisioned capacity for the transaction to be completed.
-
There is a user error, such as an invalid data format.
If using Java, DynamoDB lists the cancellation reasons on the
CancellationReasons
property. This property is not set for other languages. Transaction cancellation reasons are ordered in the order of requested items, if an item has no error it will haveNone
code andNull
message.Cancellation reason codes and possible error messages:
-
No Errors:
-
Code:
None
-
Message:
null
-
-
Conditional Check Failed:
-
Code:
ConditionalCheckFailed
-
Message: The conditional request failed.
-
-
Item Collection Size Limit Exceeded:
-
Code:
ItemCollectionSizeLimitExceeded
-
Message: Collection size exceeded.
-
-
Transaction Conflict:
-
Code:
TransactionConflict
-
Message: Transaction is ongoing for the item.
-
-
Provisioned Throughput Exceeded:
-
Code:
ProvisionedThroughputExceeded
-
Messages:
-
The level of configured provisioned throughput for the table was exceeded. Consider increasing your provisioning level with the UpdateTable API.
This Message is received when provisioned throughput is exceeded is on a provisioned DynamoDB table.
-
The level of configured provisioned throughput for one or more global secondary indexes of the table was exceeded. Consider increasing your provisioning level for the under-provisioned global secondary indexes with the UpdateTable API.
This message is returned when provisioned throughput is exceeded is on a provisioned GSI.
-
-
-
Throttling Error:
-
Code:
ThrottlingError
-
Messages:
-
Throughput exceeds the current capacity of your table or index. DynamoDB is automatically scaling your table or index so please try again shortly. If exceptions persist, check if you have a hot key: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html.
This message is returned when writes get throttled on an On-Demand table as DynamoDB is automatically scaling the table.
-
Throughput exceeds the current capacity for one or more global secondary indexes. DynamoDB is automatically scaling your index so please try again shortly.
This message is returned when writes get throttled on an On-Demand GSI as DynamoDB is automatically scaling the GSI.
-
-
-
Validation Error:
-
Code:
ValidationError
-
Messages:
-
One or more parameter values were invalid.
-
The update expression attempted to update the secondary index key beyond allowed size limits.
-
The update expression attempted to update the secondary index key to unsupported type.
-
An operand in the update expression has an incorrect data type.
-
Item size to update has exceeded the maximum allowed size.
-
Number overflow. Attempting to store a number with magnitude larger than supported range.
-
Type mismatch for attribute to update.
-
Nesting Levels have exceeded supported limits.
-
The document path provided in the update expression is invalid for update.
-
The provided expression refers to an attribute that does not exist in the item.
-
-
-
- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
- See Also:
- AWS API Documentation
-
-
transactGetItems
default CompletableFuture<TransactGetItemsResponse> transactGetItems(Consumer<TransactGetItemsRequest.Builder> transactGetItemsRequest)
TransactGetItems
is a synchronous operation that atomically retrieves multiple items from one or more tables (but not from indexes) in a single account and Region. ATransactGetItems
call can contain up to 100TransactGetItem
objects, each of which contains aGet
structure that specifies an item to retrieve from a table in the account and Region. A call toTransactGetItems
cannot retrieve items from tables in more than one Amazon Web Services account or Region. The aggregate size of the items in the transaction cannot exceed 4 MB.DynamoDB rejects the entire
TransactGetItems
request if any of the following is true:-
A conflicting operation is in the process of updating an item to be read.
-
There is insufficient provisioned capacity for the transaction to be completed.
-
There is a user error, such as an invalid data format.
-
The aggregate size of the items in the transaction exceeded 4 MB.
This is a convenience which creates an instance of the
TransactGetItemsRequest.Builder
avoiding the need to create one manually viaTransactGetItemsRequest.builder()
- Parameters:
transactGetItemsRequest
- AConsumer
that will call methods onTransactGetItemsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TransactGetItems operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - TransactionCanceledException The entire transaction request was canceled.
DynamoDB cancels a
TransactWriteItems
request under the following circumstances:-
A condition in one of the condition expressions is not met.
-
A table in the
TransactWriteItems
request is in a different account or region. -
More than one action in the
TransactWriteItems
operation targets the same item. -
There is insufficient provisioned capacity for the transaction to be completed.
-
An item size becomes too large (larger than 400 KB), or a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.
-
There is a user error, such as an invalid data format.
-
There is an ongoing
TransactWriteItems
operation that conflicts with a concurrentTransactWriteItems
request. In this case theTransactWriteItems
operation fails with aTransactionCanceledException
.
DynamoDB cancels a
TransactGetItems
request under the following circumstances:-
There is an ongoing
TransactGetItems
operation that conflicts with a concurrentPutItem
,UpdateItem
,DeleteItem
orTransactWriteItems
request. In this case theTransactGetItems
operation fails with aTransactionCanceledException
. -
A table in the
TransactGetItems
request is in a different account or region. -
There is insufficient provisioned capacity for the transaction to be completed.
-
There is a user error, such as an invalid data format.
If using Java, DynamoDB lists the cancellation reasons on the
CancellationReasons
property. This property is not set for other languages. Transaction cancellation reasons are ordered in the order of requested items, if an item has no error it will haveNone
code andNull
message.Cancellation reason codes and possible error messages:
-
No Errors:
-
Code:
None
-
Message:
null
-
-
Conditional Check Failed:
-
Code:
ConditionalCheckFailed
-
Message: The conditional request failed.
-
-
Item Collection Size Limit Exceeded:
-
Code:
ItemCollectionSizeLimitExceeded
-
Message: Collection size exceeded.
-
-
Transaction Conflict:
-
Code:
TransactionConflict
-
Message: Transaction is ongoing for the item.
-
-
Provisioned Throughput Exceeded:
-
Code:
ProvisionedThroughputExceeded
-
Messages:
-
The level of configured provisioned throughput for the table was exceeded. Consider increasing your provisioning level with the UpdateTable API.
This Message is received when provisioned throughput is exceeded is on a provisioned DynamoDB table.
-
The level of configured provisioned throughput for one or more global secondary indexes of the table was exceeded. Consider increasing your provisioning level for the under-provisioned global secondary indexes with the UpdateTable API.
This message is returned when provisioned throughput is exceeded is on a provisioned GSI.
-
-
-
Throttling Error:
-
Code:
ThrottlingError
-
Messages:
-
Throughput exceeds the current capacity of your table or index. DynamoDB is automatically scaling your table or index so please try again shortly. If exceptions persist, check if you have a hot key: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html.
This message is returned when writes get throttled on an On-Demand table as DynamoDB is automatically scaling the table.
-
Throughput exceeds the current capacity for one or more global secondary indexes. DynamoDB is automatically scaling your index so please try again shortly.
This message is returned when writes get throttled on an On-Demand GSI as DynamoDB is automatically scaling the GSI.
-
-
-
Validation Error:
-
Code:
ValidationError
-
Messages:
-
One or more parameter values were invalid.
-
The update expression attempted to update the secondary index key beyond allowed size limits.
-
The update expression attempted to update the secondary index key to unsupported type.
-
An operand in the update expression has an incorrect data type.
-
Item size to update has exceeded the maximum allowed size.
-
Number overflow. Attempting to store a number with magnitude larger than supported range.
-
Type mismatch for attribute to update.
-
Nesting Levels have exceeded supported limits.
-
The document path provided in the update expression is invalid for update.
-
The provided expression refers to an attribute that does not exist in the item.
-
-
-
- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
- See Also:
- AWS API Documentation
-
-
transactWriteItems
default CompletableFuture<TransactWriteItemsResponse> transactWriteItems(TransactWriteItemsRequest transactWriteItemsRequest)
TransactWriteItems
is a synchronous write operation that groups up to 100 action requests. These actions can target items in different tables, but not in different Amazon Web Services accounts or Regions, and no two actions can target the same item. For example, you cannot bothConditionCheck
andUpdate
the same item. The aggregate size of the items in the transaction cannot exceed 4 MB.The actions are completed atomically so that either all of them succeed, or all of them fail. They are defined by the following objects:
-
Put
 —  Initiates aPutItem
operation to write a new item. This structure specifies the primary key of the item to be written, the name of the table to write it in, an optional condition expression that must be satisfied for the write to succeed, a list of the item's attributes, and a field indicating whether to retrieve the item's attributes if the condition is not met. -
Update
 —  Initiates anUpdateItem
operation to update an existing item. This structure specifies the primary key of the item to be updated, the name of the table where it resides, an optional condition expression that must be satisfied for the update to succeed, an expression that defines one or more attributes to be updated, and a field indicating whether to retrieve the item's attributes if the condition is not met. -
Delete
 —  Initiates aDeleteItem
operation to delete an existing item. This structure specifies the primary key of the item to be deleted, the name of the table where it resides, an optional condition expression that must be satisfied for the deletion to succeed, and a field indicating whether to retrieve the item's attributes if the condition is not met. -
ConditionCheck
 —  Applies a condition to an item that is not being modified by the transaction. This structure specifies the primary key of the item to be checked, the name of the table where it resides, a condition expression that must be satisfied for the transaction to succeed, and a field indicating whether to retrieve the item's attributes if the condition is not met.
DynamoDB rejects the entire
TransactWriteItems
request if any of the following is true:-
A condition in one of the condition expressions is not met.
-
An ongoing operation is in the process of updating the same item.
-
There is insufficient provisioned capacity for the transaction to be completed.
-
An item size becomes too large (bigger than 400 KB), a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.
-
The aggregate size of the items in the transaction exceeds 4 MB.
-
There is a user error, such as an invalid data format.
- Parameters:
transactWriteItemsRequest
-- Returns:
- A Java Future containing the result of the TransactWriteItems operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - TransactionCanceledException The entire transaction request was canceled.
DynamoDB cancels a
TransactWriteItems
request under the following circumstances:-
A condition in one of the condition expressions is not met.
-
A table in the
TransactWriteItems
request is in a different account or region. -
More than one action in the
TransactWriteItems
operation targets the same item. -
There is insufficient provisioned capacity for the transaction to be completed.
-
An item size becomes too large (larger than 400 KB), or a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.
-
There is a user error, such as an invalid data format.
-
There is an ongoing
TransactWriteItems
operation that conflicts with a concurrentTransactWriteItems
request. In this case theTransactWriteItems
operation fails with aTransactionCanceledException
.
DynamoDB cancels a
TransactGetItems
request under the following circumstances:-
There is an ongoing
TransactGetItems
operation that conflicts with a concurrentPutItem
,UpdateItem
,DeleteItem
orTransactWriteItems
request. In this case theTransactGetItems
operation fails with aTransactionCanceledException
. -
A table in the
TransactGetItems
request is in a different account or region. -
There is insufficient provisioned capacity for the transaction to be completed.
-
There is a user error, such as an invalid data format.
If using Java, DynamoDB lists the cancellation reasons on the
CancellationReasons
property. This property is not set for other languages. Transaction cancellation reasons are ordered in the order of requested items, if an item has no error it will haveNone
code andNull
message.Cancellation reason codes and possible error messages:
-
No Errors:
-
Code:
None
-
Message:
null
-
-
Conditional Check Failed:
-
Code:
ConditionalCheckFailed
-
Message: The conditional request failed.
-
-
Item Collection Size Limit Exceeded:
-
Code:
ItemCollectionSizeLimitExceeded
-
Message: Collection size exceeded.
-
-
Transaction Conflict:
-
Code:
TransactionConflict
-
Message: Transaction is ongoing for the item.
-
-
Provisioned Throughput Exceeded:
-
Code:
ProvisionedThroughputExceeded
-
Messages:
-
The level of configured provisioned throughput for the table was exceeded. Consider increasing your provisioning level with the UpdateTable API.
This Message is received when provisioned throughput is exceeded is on a provisioned DynamoDB table.
-
The level of configured provisioned throughput for one or more global secondary indexes of the table was exceeded. Consider increasing your provisioning level for the under-provisioned global secondary indexes with the UpdateTable API.
This message is returned when provisioned throughput is exceeded is on a provisioned GSI.
-
-
-
Throttling Error:
-
Code:
ThrottlingError
-
Messages:
-
Throughput exceeds the current capacity of your table or index. DynamoDB is automatically scaling your table or index so please try again shortly. If exceptions persist, check if you have a hot key: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html.
This message is returned when writes get throttled on an On-Demand table as DynamoDB is automatically scaling the table.
-
Throughput exceeds the current capacity for one or more global secondary indexes. DynamoDB is automatically scaling your index so please try again shortly.
This message is returned when writes get throttled on an On-Demand GSI as DynamoDB is automatically scaling the GSI.
-
-
-
Validation Error:
-
Code:
ValidationError
-
Messages:
-
One or more parameter values were invalid.
-
The update expression attempted to update the secondary index key beyond allowed size limits.
-
The update expression attempted to update the secondary index key to unsupported type.
-
An operand in the update expression has an incorrect data type.
-
Item size to update has exceeded the maximum allowed size.
-
Number overflow. Attempting to store a number with magnitude larger than supported range.
-
Type mismatch for attribute to update.
-
Nesting Levels have exceeded supported limits.
-
The document path provided in the update expression is invalid for update.
-
The provided expression refers to an attribute that does not exist in the item.
-
-
-
- TransactionInProgressException The transaction with the given request token is already in
progress.
Recommended Settings
This is a general recommendation for handling the
TransactionInProgressException
. These settings help ensure that the client retries will trigger completion of the ongoingTransactWriteItems
request.-
Set
clientExecutionTimeout
to a value that allows at least one retry to be processed after 5 seconds have elapsed since the first attempt for theTransactWriteItems
operation. -
Set
socketTimeout
to a value a little lower than therequestTimeout
setting. -
requestTimeout
should be set based on the time taken for the individual retries of a single HTTP request for your use case, but setting it to 1 second or higher should work well to reduce chances of retries andTransactionInProgressException
errors. -
Use exponential backoff when retrying and tune backoff if needed.
Assuming default retry policy, example timeout settings based on the guidelines above are as follows:
Example timeline:
-
0-1000 first attempt
-
1000-1500 first sleep/delay (default retry policy uses 500 ms as base delay for 4xx errors)
-
1500-2500 second attempt
-
2500-3500 second sleep/delay (500 * 2, exponential backoff)
-
3500-4500 third attempt
-
4500-6500 third sleep/delay (500 * 2^2)
-
6500-7500 fourth attempt (this can trigger inline recovery since 5 seconds have elapsed since the first attempt reached TC)
-
- IdempotentParameterMismatchException DynamoDB rejected the request because you retried a request with a different payload but with an idempotent token that was already used.
- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
- See Also:
- AWS API Documentation
-
-
transactWriteItems
default CompletableFuture<TransactWriteItemsResponse> transactWriteItems(Consumer<TransactWriteItemsRequest.Builder> transactWriteItemsRequest)
TransactWriteItems
is a synchronous write operation that groups up to 100 action requests. These actions can target items in different tables, but not in different Amazon Web Services accounts or Regions, and no two actions can target the same item. For example, you cannot bothConditionCheck
andUpdate
the same item. The aggregate size of the items in the transaction cannot exceed 4 MB.The actions are completed atomically so that either all of them succeed, or all of them fail. They are defined by the following objects:
-
Put
 —  Initiates aPutItem
operation to write a new item. This structure specifies the primary key of the item to be written, the name of the table to write it in, an optional condition expression that must be satisfied for the write to succeed, a list of the item's attributes, and a field indicating whether to retrieve the item's attributes if the condition is not met. -
Update
 —  Initiates anUpdateItem
operation to update an existing item. This structure specifies the primary key of the item to be updated, the name of the table where it resides, an optional condition expression that must be satisfied for the update to succeed, an expression that defines one or more attributes to be updated, and a field indicating whether to retrieve the item's attributes if the condition is not met. -
Delete
 —  Initiates aDeleteItem
operation to delete an existing item. This structure specifies the primary key of the item to be deleted, the name of the table where it resides, an optional condition expression that must be satisfied for the deletion to succeed, and a field indicating whether to retrieve the item's attributes if the condition is not met. -
ConditionCheck
 —  Applies a condition to an item that is not being modified by the transaction. This structure specifies the primary key of the item to be checked, the name of the table where it resides, a condition expression that must be satisfied for the transaction to succeed, and a field indicating whether to retrieve the item's attributes if the condition is not met.
DynamoDB rejects the entire
TransactWriteItems
request if any of the following is true:-
A condition in one of the condition expressions is not met.
-
An ongoing operation is in the process of updating the same item.
-
There is insufficient provisioned capacity for the transaction to be completed.
-
An item size becomes too large (bigger than 400 KB), a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.
-
The aggregate size of the items in the transaction exceeds 4 MB.
-
There is a user error, such as an invalid data format.
This is a convenience which creates an instance of the
TransactWriteItemsRequest.Builder
avoiding the need to create one manually viaTransactWriteItemsRequest.builder()
- Parameters:
transactWriteItemsRequest
- AConsumer
that will call methods onTransactWriteItemsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TransactWriteItems operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - TransactionCanceledException The entire transaction request was canceled.
DynamoDB cancels a
TransactWriteItems
request under the following circumstances:-
A condition in one of the condition expressions is not met.
-
A table in the
TransactWriteItems
request is in a different account or region. -
More than one action in the
TransactWriteItems
operation targets the same item. -
There is insufficient provisioned capacity for the transaction to be completed.
-
An item size becomes too large (larger than 400 KB), or a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.
-
There is a user error, such as an invalid data format.
-
There is an ongoing
TransactWriteItems
operation that conflicts with a concurrentTransactWriteItems
request. In this case theTransactWriteItems
operation fails with aTransactionCanceledException
.
DynamoDB cancels a
TransactGetItems
request under the following circumstances:-
There is an ongoing
TransactGetItems
operation that conflicts with a concurrentPutItem
,UpdateItem
,DeleteItem
orTransactWriteItems
request. In this case theTransactGetItems
operation fails with aTransactionCanceledException
. -
A table in the
TransactGetItems
request is in a different account or region. -
There is insufficient provisioned capacity for the transaction to be completed.
-
There is a user error, such as an invalid data format.
If using Java, DynamoDB lists the cancellation reasons on the
CancellationReasons
property. This property is not set for other languages. Transaction cancellation reasons are ordered in the order of requested items, if an item has no error it will haveNone
code andNull
message.Cancellation reason codes and possible error messages:
-
No Errors:
-
Code:
None
-
Message:
null
-
-
Conditional Check Failed:
-
Code:
ConditionalCheckFailed
-
Message: The conditional request failed.
-
-
Item Collection Size Limit Exceeded:
-
Code:
ItemCollectionSizeLimitExceeded
-
Message: Collection size exceeded.
-
-
Transaction Conflict:
-
Code:
TransactionConflict
-
Message: Transaction is ongoing for the item.
-
-
Provisioned Throughput Exceeded:
-
Code:
ProvisionedThroughputExceeded
-
Messages:
-
The level of configured provisioned throughput for the table was exceeded. Consider increasing your provisioning level with the UpdateTable API.
This Message is received when provisioned throughput is exceeded is on a provisioned DynamoDB table.
-
The level of configured provisioned throughput for one or more global secondary indexes of the table was exceeded. Consider increasing your provisioning level for the under-provisioned global secondary indexes with the UpdateTable API.
This message is returned when provisioned throughput is exceeded is on a provisioned GSI.
-
-
-
Throttling Error:
-
Code:
ThrottlingError
-
Messages:
-
Throughput exceeds the current capacity of your table or index. DynamoDB is automatically scaling your table or index so please try again shortly. If exceptions persist, check if you have a hot key: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html.
This message is returned when writes get throttled on an On-Demand table as DynamoDB is automatically scaling the table.
-
Throughput exceeds the current capacity for one or more global secondary indexes. DynamoDB is automatically scaling your index so please try again shortly.
This message is returned when writes get throttled on an On-Demand GSI as DynamoDB is automatically scaling the GSI.
-
-
-
Validation Error:
-
Code:
ValidationError
-
Messages:
-
One or more parameter values were invalid.
-
The update expression attempted to update the secondary index key beyond allowed size limits.
-
The update expression attempted to update the secondary index key to unsupported type.
-
An operand in the update expression has an incorrect data type.
-
Item size to update has exceeded the maximum allowed size.
-
Number overflow. Attempting to store a number with magnitude larger than supported range.
-
Type mismatch for attribute to update.
-
Nesting Levels have exceeded supported limits.
-
The document path provided in the update expression is invalid for update.
-
The provided expression refers to an attribute that does not exist in the item.
-
-
-
- TransactionInProgressException The transaction with the given request token is already in
progress.
Recommended Settings
This is a general recommendation for handling the
TransactionInProgressException
. These settings help ensure that the client retries will trigger completion of the ongoingTransactWriteItems
request.-
Set
clientExecutionTimeout
to a value that allows at least one retry to be processed after 5 seconds have elapsed since the first attempt for theTransactWriteItems
operation. -
Set
socketTimeout
to a value a little lower than therequestTimeout
setting. -
requestTimeout
should be set based on the time taken for the individual retries of a single HTTP request for your use case, but setting it to 1 second or higher should work well to reduce chances of retries andTransactionInProgressException
errors. -
Use exponential backoff when retrying and tune backoff if needed.
Assuming default retry policy, example timeout settings based on the guidelines above are as follows:
Example timeline:
-
0-1000 first attempt
-
1000-1500 first sleep/delay (default retry policy uses 500 ms as base delay for 4xx errors)
-
1500-2500 second attempt
-
2500-3500 second sleep/delay (500 * 2, exponential backoff)
-
3500-4500 third attempt
-
4500-6500 third sleep/delay (500 * 2^2)
-
6500-7500 fourth attempt (this can trigger inline recovery since 5 seconds have elapsed since the first attempt reached TC)
-
- IdempotentParameterMismatchException DynamoDB rejected the request because you retried a request with a different payload but with an idempotent token that was already used.
- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
- See Also:
- AWS API Documentation
-
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes the association of tags from an Amazon DynamoDB resource. You can call
UntagResource
up to five times per second, per account.For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - InternalServerErrorException An error occurred on the server side.
- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
CREATING
state. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
- See Also:
- AWS API Documentation
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes the association of tags from an Amazon DynamoDB resource. You can call
UntagResource
up to five times per second, per account.For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - InternalServerErrorException An error occurred on the server side.
- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
CREATING
state. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
- See Also:
- AWS API Documentation
-
updateContinuousBackups
default CompletableFuture<UpdateContinuousBackupsResponse> updateContinuousBackups(UpdateContinuousBackupsRequest updateContinuousBackupsRequest)
UpdateContinuousBackups
enables or disables point in time recovery for the specified table. A successfulUpdateContinuousBackups
call returns the currentContinuousBackupsDescription
. Continuous backups areENABLED
on all tables at table creation. If point in time recovery is enabled,PointInTimeRecoveryStatus
will be set to ENABLED.Once continuous backups and point in time recovery are enabled, you can restore to any point in time within
EarliestRestorableDateTime
andLatestRestorableDateTime
.LatestRestorableDateTime
is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days.- Parameters:
updateContinuousBackupsRequest
-- Returns:
- A Java Future containing the result of the UpdateContinuousBackups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TableNotFoundException A source table with the name
TableName
does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region. - ContinuousBackupsUnavailableException Backups have not yet been enabled for this table.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- TableNotFoundException A source table with the name
- See Also:
- AWS API Documentation
-
updateContinuousBackups
default CompletableFuture<UpdateContinuousBackupsResponse> updateContinuousBackups(Consumer<UpdateContinuousBackupsRequest.Builder> updateContinuousBackupsRequest)
UpdateContinuousBackups
enables or disables point in time recovery for the specified table. A successfulUpdateContinuousBackups
call returns the currentContinuousBackupsDescription
. Continuous backups areENABLED
on all tables at table creation. If point in time recovery is enabled,PointInTimeRecoveryStatus
will be set to ENABLED.Once continuous backups and point in time recovery are enabled, you can restore to any point in time within
EarliestRestorableDateTime
andLatestRestorableDateTime
.LatestRestorableDateTime
is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days.
This is a convenience which creates an instance of the
UpdateContinuousBackupsRequest.Builder
avoiding the need to create one manually viaUpdateContinuousBackupsRequest.builder()
- Parameters:
updateContinuousBackupsRequest
- AConsumer
that will call methods onUpdateContinuousBackupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateContinuousBackups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TableNotFoundException A source table with the name
TableName
does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region. - ContinuousBackupsUnavailableException Backups have not yet been enabled for this table.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- TableNotFoundException A source table with the name
- See Also:
- AWS API Documentation
-
updateContributorInsights
default CompletableFuture<UpdateContributorInsightsResponse> updateContributorInsights(UpdateContributorInsightsRequest updateContributorInsightsRequest)
Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of Amazon Web Services Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an Amazon Web Services managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.
- Parameters:
updateContributorInsightsRequest
-- Returns:
- A Java Future containing the result of the UpdateContributorInsights operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
- See Also:
- AWS API Documentation
-
updateContributorInsights
default CompletableFuture<UpdateContributorInsightsResponse> updateContributorInsights(Consumer<UpdateContributorInsightsRequest.Builder> updateContributorInsightsRequest)
Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of Amazon Web Services Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an Amazon Web Services managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.
This is a convenience which creates an instance of the
UpdateContributorInsightsRequest.Builder
avoiding the need to create one manually viaUpdateContributorInsightsRequest.builder()
- Parameters:
updateContributorInsightsRequest
- AConsumer
that will call methods onUpdateContributorInsightsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateContributorInsights operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
- See Also:
- AWS API Documentation
-
updateGlobalTable
default CompletableFuture<UpdateGlobalTableResponse> updateGlobalTable(UpdateGlobalTableRequest updateGlobalTableRequest)
Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, have the same name as the global table, have the same key schema, have DynamoDB Streams enabled, and have the same provisioned and maximum write capacity units.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
This operation only applies to Version 2017.11.29 of global tables. If you are using global tables Version 2019.11.21 you can use UpdateTable instead.
Although you can use
UpdateGlobalTable
to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas.If global secondary indexes are specified, then the following conditions must also be met:
-
The global secondary indexes must have the same name.
-
The global secondary indexes must have the same hash key and sort key (if present).
-
The global secondary indexes must have the same provisioned and maximum write capacity units.
- Parameters:
updateGlobalTableRequest
-- Returns:
- A Java Future containing the result of the UpdateGlobalTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerErrorException An error occurred on the server side.
- GlobalTableNotFoundException The specified global table does not exist.
- ReplicaAlreadyExistsException The specified replica is already part of the global table.
- ReplicaNotFoundException The specified replica is no longer part of the global table.
- TableNotFoundException A source table with the name
TableName
does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
updateGlobalTable
default CompletableFuture<UpdateGlobalTableResponse> updateGlobalTable(Consumer<UpdateGlobalTableRequest.Builder> updateGlobalTableRequest)
Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, have the same name as the global table, have the same key schema, have DynamoDB Streams enabled, and have the same provisioned and maximum write capacity units.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
This operation only applies to Version 2017.11.29 of global tables. If you are using global tables Version 2019.11.21 you can use UpdateTable instead.
Although you can use
UpdateGlobalTable
to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas.If global secondary indexes are specified, then the following conditions must also be met:
-
The global secondary indexes must have the same name.
-
The global secondary indexes must have the same hash key and sort key (if present).
-
The global secondary indexes must have the same provisioned and maximum write capacity units.
This is a convenience which creates an instance of the
UpdateGlobalTableRequest.Builder
avoiding the need to create one manually viaUpdateGlobalTableRequest.builder()
- Parameters:
updateGlobalTableRequest
- AConsumer
that will call methods onUpdateGlobalTableRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateGlobalTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerErrorException An error occurred on the server side.
- GlobalTableNotFoundException The specified global table does not exist.
- ReplicaAlreadyExistsException The specified replica is already part of the global table.
- ReplicaNotFoundException The specified replica is no longer part of the global table.
- TableNotFoundException A source table with the name
TableName
does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
updateGlobalTableSettings
default CompletableFuture<UpdateGlobalTableSettingsResponse> updateGlobalTableSettings(UpdateGlobalTableSettingsRequest updateGlobalTableSettingsRequest)
Updates settings for a global table.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
- Parameters:
updateGlobalTableSettingsRequest
-- Returns:
- A Java Future containing the result of the UpdateGlobalTableSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- GlobalTableNotFoundException The specified global table does not exist.
- ReplicaNotFoundException The specified replica is no longer part of the global table.
- IndexNotFoundException The operation tried to access a nonexistent index.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
CREATING
state. - InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateGlobalTableSettings
default CompletableFuture<UpdateGlobalTableSettingsResponse> updateGlobalTableSettings(Consumer<UpdateGlobalTableSettingsRequest.Builder> updateGlobalTableSettingsRequest)
Updates settings for a global table.
This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.
This is a convenience which creates an instance of the
UpdateGlobalTableSettingsRequest.Builder
avoiding the need to create one manually viaUpdateGlobalTableSettingsRequest.builder()
- Parameters:
updateGlobalTableSettingsRequest
- AConsumer
that will call methods onUpdateGlobalTableSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateGlobalTableSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- GlobalTableNotFoundException The specified global table does not exist.
- ReplicaNotFoundException The specified replica is no longer part of the global table.
- IndexNotFoundException The operation tried to access a nonexistent index.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
CREATING
state. - InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateItem
default CompletableFuture<UpdateItemResponse> updateItem(UpdateItemRequest updateItemRequest)
Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values).
You can also return the item's attribute values in the same
UpdateItem
operation using theReturnValues
parameter.- Parameters:
updateItemRequest
- Represents the input of anUpdateItem
operation.- Returns:
- A Java Future containing the result of the UpdateItem operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConditionalCheckFailedException A condition specified in the operation could not be evaluated.
- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - ItemCollectionSizeLimitExceededException An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
- TransactionConflictException Operation was rejected because there is an ongoing transaction for the item.
- RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateItem
default CompletableFuture<UpdateItemResponse> updateItem(Consumer<UpdateItemRequest.Builder> updateItemRequest)
Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values).
You can also return the item's attribute values in the same
UpdateItem
operation using theReturnValues
parameter.
This is a convenience which creates an instance of the
UpdateItemRequest.Builder
avoiding the need to create one manually viaUpdateItemRequest.builder()
- Parameters:
updateItemRequest
- AConsumer
that will call methods onUpdateItemRequest.Builder
to create a request. Represents the input of anUpdateItem
operation.- Returns:
- A Java Future containing the result of the UpdateItem operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConditionalCheckFailedException A condition specified in the operation could not be evaluated.
- ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - ItemCollectionSizeLimitExceededException An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
- TransactionConflictException Operation was rejected because there is an ongoing transaction for the item.
- RequestLimitExceededException Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateKinesisStreamingDestination
default CompletableFuture<UpdateKinesisStreamingDestinationResponse> updateKinesisStreamingDestination(UpdateKinesisStreamingDestinationRequest updateKinesisStreamingDestinationRequest)
The command to update the Kinesis stream destination.
- Parameters:
updateKinesisStreamingDestinationRequest
-- Returns:
- A Java Future containing the result of the UpdateKinesisStreamingDestination operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerErrorException An error occurred on the server side.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
CREATING
state. - ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateKinesisStreamingDestination
default CompletableFuture<UpdateKinesisStreamingDestinationResponse> updateKinesisStreamingDestination(Consumer<UpdateKinesisStreamingDestinationRequest.Builder> updateKinesisStreamingDestinationRequest)
The command to update the Kinesis stream destination.
This is a convenience which creates an instance of the
UpdateKinesisStreamingDestinationRequest.Builder
avoiding the need to create one manually viaUpdateKinesisStreamingDestinationRequest.builder()
- Parameters:
updateKinesisStreamingDestinationRequest
- AConsumer
that will call methods onUpdateKinesisStreamingDestinationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateKinesisStreamingDestination operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerErrorException An error occurred on the server side.
- LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
CREATING
state. - ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateTable
default CompletableFuture<UpdateTableResponse> updateTable(UpdateTableRequest updateTableRequest)
Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.
This operation only applies to Version 2019.11.21 (Current) of global tables.
You can only perform one of the following operations at once:
-
Modify the provisioned throughput settings of the table.
-
Remove a global secondary index from the table.
-
Create a new global secondary index on the table. After the index begins backfilling, you can use
UpdateTable
to perform other operations.
UpdateTable
is an asynchronous operation; while it's executing, the table status changes fromACTIVE
toUPDATING
. While it'sUPDATING
, you can't issue anotherUpdateTable
request on the base table nor any replicas. When the table returns to theACTIVE
state, theUpdateTable
operation is complete.- Parameters:
updateTableRequest
- Represents the input of anUpdateTable
operation.- Returns:
- A Java Future containing the result of the UpdateTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
CREATING
state. - ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
- See Also:
- AWS API Documentation
-
-
updateTable
default CompletableFuture<UpdateTableResponse> updateTable(Consumer<UpdateTableRequest.Builder> updateTableRequest)
Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.
This operation only applies to Version 2019.11.21 (Current) of global tables.
You can only perform one of the following operations at once:
-
Modify the provisioned throughput settings of the table.
-
Remove a global secondary index from the table.
-
Create a new global secondary index on the table. After the index begins backfilling, you can use
UpdateTable
to perform other operations.
UpdateTable
is an asynchronous operation; while it's executing, the table status changes fromACTIVE
toUPDATING
. While it'sUPDATING
, you can't issue anotherUpdateTable
request on the base table nor any replicas. When the table returns to theACTIVE
state, theUpdateTable
operation is complete.
This is a convenience which creates an instance of the
UpdateTableRequest.Builder
avoiding the need to create one manually viaUpdateTableRequest.builder()
- Parameters:
updateTableRequest
- AConsumer
that will call methods onUpdateTableRequest.Builder
to create a request. Represents the input of anUpdateTable
operation.- Returns:
- A Java Future containing the result of the UpdateTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
CREATING
state. - ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
- See Also:
- AWS API Documentation
-
-
updateTableReplicaAutoScaling
default CompletableFuture<UpdateTableReplicaAutoScalingResponse> updateTableReplicaAutoScaling(UpdateTableReplicaAutoScalingRequest updateTableReplicaAutoScalingRequest)
Updates auto scaling settings on your global tables at once.
This operation only applies to Version 2019.11.21 (Current) of global tables.
- Parameters:
updateTableReplicaAutoScalingRequest
-- Returns:
- A Java Future containing the result of the UpdateTableReplicaAutoScaling operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
CREATING
state. - LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
- See Also:
- AWS API Documentation
-
updateTableReplicaAutoScaling
default CompletableFuture<UpdateTableReplicaAutoScalingResponse> updateTableReplicaAutoScaling(Consumer<UpdateTableReplicaAutoScalingRequest.Builder> updateTableReplicaAutoScalingRequest)
Updates auto scaling settings on your global tables at once.
This operation only applies to Version 2019.11.21 (Current) of global tables.
This is a convenience which creates an instance of the
UpdateTableReplicaAutoScalingRequest.Builder
avoiding the need to create one manually viaUpdateTableReplicaAutoScalingRequest.builder()
- Parameters:
updateTableReplicaAutoScalingRequest
- AConsumer
that will call methods onUpdateTableReplicaAutoScalingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateTableReplicaAutoScaling operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
CREATING
state. - LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
- See Also:
- AWS API Documentation
-
updateTimeToLive
default CompletableFuture<UpdateTimeToLiveResponse> updateTimeToLive(UpdateTimeToLiveRequest updateTimeToLiveRequest)
The
UpdateTimeToLive
method enables or disables Time to Live (TTL) for the specified table. A successfulUpdateTimeToLive
call returns the currentTimeToLiveSpecification
. It can take up to one hour for the change to fully process. Any additionalUpdateTimeToLive
calls for the same table during this one hour duration result in aValidationException
.TTL compares the current time in epoch time format to the time stored in the TTL attribute of an item. If the epoch time value stored in the attribute is less than the current time, the item is marked as expired and subsequently deleted.
The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.
DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations.
DynamoDB typically deletes expired items within two days of expiration. The exact duration within which an item gets deleted after expiration is specific to the nature of the workload. Items that have expired and not been deleted will still show up in reads, queries, and scans.
As items are deleted, they are removed from any local secondary index and global secondary index immediately in the same eventually consistent way as a standard delete operation.
For more information, see Time To Live in the Amazon DynamoDB Developer Guide.
- Parameters:
updateTimeToLiveRequest
- Represents the input of anUpdateTimeToLive
operation.- Returns:
- A Java Future containing the result of the UpdateTimeToLive operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
CREATING
state. - ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
- See Also:
- AWS API Documentation
-
updateTimeToLive
default CompletableFuture<UpdateTimeToLiveResponse> updateTimeToLive(Consumer<UpdateTimeToLiveRequest.Builder> updateTimeToLiveRequest)
The
UpdateTimeToLive
method enables or disables Time to Live (TTL) for the specified table. A successfulUpdateTimeToLive
call returns the currentTimeToLiveSpecification
. It can take up to one hour for the change to fully process. Any additionalUpdateTimeToLive
calls for the same table during this one hour duration result in aValidationException
.TTL compares the current time in epoch time format to the time stored in the TTL attribute of an item. If the epoch time value stored in the attribute is less than the current time, the item is marked as expired and subsequently deleted.
The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.
DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations.
DynamoDB typically deletes expired items within two days of expiration. The exact duration within which an item gets deleted after expiration is specific to the nature of the workload. Items that have expired and not been deleted will still show up in reads, queries, and scans.
As items are deleted, they are removed from any local secondary index and global secondary index immediately in the same eventually consistent way as a standard delete operation.
For more information, see Time To Live in the Amazon DynamoDB Developer Guide.
This is a convenience which creates an instance of the
UpdateTimeToLiveRequest.Builder
avoiding the need to create one manually viaUpdateTimeToLiveRequest.builder()
- Parameters:
updateTimeToLiveRequest
- AConsumer
that will call methods onUpdateTimeToLiveRequest.Builder
to create a request. Represents the input of anUpdateTimeToLive
operation.- Returns:
- A Java Future containing the result of the UpdateTimeToLive operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
CREATING
state. - ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be
ACTIVE
. - LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include
CreateTable
,UpdateTable
,DeleteTable
,UpdateTimeToLive
,RestoreTableFromBackup
, andRestoreTableToPointInTime
.When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
- InternalServerErrorException An error occurred on the server side.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- DynamoDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceInUseException The operation conflicts with the resource's availability. For example, you
attempted to recreate an existing table, or tried to delete a table currently in the
- See Also:
- AWS API Documentation
-
waiter
default DynamoDbAsyncWaiter waiter()
Create an instance ofDynamoDbAsyncWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
DynamoDbAsyncWaiter
-
serviceClientConfiguration
default DynamoDbServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
-
create
static DynamoDbAsyncClient create()
Create aDynamoDbAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.
-
builder
static DynamoDbAsyncClientBuilder builder()
Create a builder that can be used to configure and create aDynamoDbAsyncClient
.
-
-