Package software.amazon.awssdk.services.dynamodb

Interface DynamoDbClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface DynamoDbClient
extends AwsClient

Service client for accessing DynamoDB. This can be created using the static builder() 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 final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default BatchExecuteStatementResponse	batchExecuteStatement(Consumer<BatchExecuteStatementRequest.Builder> batchExecuteStatementRequest)	This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL.
default BatchExecuteStatementResponse	batchExecuteStatement(BatchExecuteStatementRequest batchExecuteStatementRequest)	This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL.
default BatchGetItemResponse	batchGetItem(Consumer<BatchGetItemRequest.Builder> batchGetItemRequest)	The BatchGetItem operation returns the attributes of one or more items from one or more tables.
default BatchGetItemResponse	batchGetItem(BatchGetItemRequest batchGetItemRequest)	The BatchGetItem operation returns the attributes of one or more items from one or more tables.
default BatchGetItemIterable	batchGetItemPaginator(Consumer<BatchGetItemRequest.Builder> batchGetItemRequest)	This is a variant of batchGetItem(software.amazon.awssdk.services.dynamodb.model.BatchGetItemRequest) operation.
default BatchGetItemIterable	batchGetItemPaginator(BatchGetItemRequest batchGetItemRequest)	This is a variant of batchGetItem(software.amazon.awssdk.services.dynamodb.model.BatchGetItemRequest) operation.
default BatchWriteItemResponse	batchWriteItem(Consumer<BatchWriteItemRequest.Builder> batchWriteItemRequest)	The BatchWriteItem operation puts or deletes multiple items in one or more tables.
default BatchWriteItemResponse	batchWriteItem(BatchWriteItemRequest batchWriteItemRequest)	The BatchWriteItem operation puts or deletes multiple items in one or more tables.
static DynamoDbClientBuilder	builder()	Create a builder that can be used to configure and create a DynamoDbClient.
static DynamoDbClient	create()	Create a DynamoDbClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateBackupResponse	createBackup(Consumer<CreateBackupRequest.Builder> createBackupRequest)	Creates a backup for an existing table.
default CreateBackupResponse	createBackup(CreateBackupRequest createBackupRequest)	Creates a backup for an existing table.
default CreateGlobalTableResponse	createGlobalTable(Consumer<CreateGlobalTableRequest.Builder> createGlobalTableRequest)	Creates a global table from an existing table.
default CreateGlobalTableResponse	createGlobalTable(CreateGlobalTableRequest createGlobalTableRequest)	Creates a global table from an existing table.
default CreateTableResponse	createTable(Consumer<CreateTableRequest.Builder> createTableRequest)	The CreateTable operation adds a new table to your account.
default CreateTableResponse	createTable(CreateTableRequest createTableRequest)	The CreateTable operation adds a new table to your account.
default DeleteBackupResponse	deleteBackup(Consumer<DeleteBackupRequest.Builder> deleteBackupRequest)	Deletes an existing backup of a table.
default DeleteBackupResponse	deleteBackup(DeleteBackupRequest deleteBackupRequest)	Deletes an existing backup of a table.
default DeleteItemResponse	deleteItem(Consumer<DeleteItemRequest.Builder> deleteItemRequest)	Deletes a single item in a table by primary key.
default DeleteItemResponse	deleteItem(DeleteItemRequest deleteItemRequest)	Deletes a single item in a table by primary key.
default DeleteResourcePolicyResponse	deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)	Deletes the resource-based policy attached to the resource, which can be a table or stream.
default DeleteResourcePolicyResponse	deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)	Deletes the resource-based policy attached to the resource, which can be a table or stream.
default DeleteTableResponse	deleteTable(Consumer<DeleteTableRequest.Builder> deleteTableRequest)	The DeleteTable operation deletes a table and all of its items.
default DeleteTableResponse	deleteTable(DeleteTableRequest deleteTableRequest)	The DeleteTable operation deletes a table and all of its items.
default DescribeBackupResponse	describeBackup(Consumer<DescribeBackupRequest.Builder> describeBackupRequest)	Describes an existing backup of a table.
default DescribeBackupResponse	describeBackup(DescribeBackupRequest describeBackupRequest)	Describes an existing backup of a table.
default DescribeContinuousBackupsResponse	describeContinuousBackups(Consumer<DescribeContinuousBackupsRequest.Builder> describeContinuousBackupsRequest)	Checks the status of continuous backups and point in time recovery on the specified table.
default DescribeContinuousBackupsResponse	describeContinuousBackups(DescribeContinuousBackupsRequest describeContinuousBackupsRequest)	Checks the status of continuous backups and point in time recovery on the specified table.
default DescribeContributorInsightsResponse	describeContributorInsights(Consumer<DescribeContributorInsightsRequest.Builder> describeContributorInsightsRequest)	Returns information about contributor insights for a given table or global secondary index.
default DescribeContributorInsightsResponse	describeContributorInsights(DescribeContributorInsightsRequest describeContributorInsightsRequest)	Returns information about contributor insights for a given table or global secondary index.
default DescribeEndpointsResponse	describeEndpoints()	Returns the regional endpoint information.
default DescribeEndpointsResponse	describeEndpoints(Consumer<DescribeEndpointsRequest.Builder> describeEndpointsRequest)	Returns the regional endpoint information.
default DescribeEndpointsResponse	describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest)	Returns the regional endpoint information.
default DescribeExportResponse	describeExport(Consumer<DescribeExportRequest.Builder> describeExportRequest)	Describes an existing table export.
default DescribeExportResponse	describeExport(DescribeExportRequest describeExportRequest)	Describes an existing table export.
default DescribeGlobalTableResponse	describeGlobalTable(Consumer<DescribeGlobalTableRequest.Builder> describeGlobalTableRequest)	Returns information about the specified global table.
default DescribeGlobalTableResponse	describeGlobalTable(DescribeGlobalTableRequest describeGlobalTableRequest)	Returns information about the specified global table.
default DescribeGlobalTableSettingsResponse	describeGlobalTableSettings(Consumer<DescribeGlobalTableSettingsRequest.Builder> describeGlobalTableSettingsRequest)	Describes Region-specific settings for a global table.
default DescribeGlobalTableSettingsResponse	describeGlobalTableSettings(DescribeGlobalTableSettingsRequest describeGlobalTableSettingsRequest)	Describes Region-specific settings for a global table.
default DescribeImportResponse	describeImport(Consumer<DescribeImportRequest.Builder> describeImportRequest)	Represents the properties of the import.
default DescribeImportResponse	describeImport(DescribeImportRequest describeImportRequest)	Represents the properties of the import.
default DescribeKinesisStreamingDestinationResponse	describeKinesisStreamingDestination(Consumer<DescribeKinesisStreamingDestinationRequest.Builder> describeKinesisStreamingDestinationRequest)	Returns information about the status of Kinesis streaming.
default DescribeKinesisStreamingDestinationResponse	describeKinesisStreamingDestination(DescribeKinesisStreamingDestinationRequest describeKinesisStreamingDestinationRequest)	Returns information about the status of Kinesis streaming.
default 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 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 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 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 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 DescribeTableReplicaAutoScalingResponse	describeTableReplicaAutoScaling(Consumer<DescribeTableReplicaAutoScalingRequest.Builder> describeTableReplicaAutoScalingRequest)	Describes auto scaling settings across replicas of the global table at once.
default DescribeTableReplicaAutoScalingResponse	describeTableReplicaAutoScaling(DescribeTableReplicaAutoScalingRequest describeTableReplicaAutoScalingRequest)	Describes auto scaling settings across replicas of the global table at once.
default DescribeTimeToLiveResponse	describeTimeToLive(Consumer<DescribeTimeToLiveRequest.Builder> describeTimeToLiveRequest)	Gives a description of the Time to Live (TTL) status on the specified table.
default DescribeTimeToLiveResponse	describeTimeToLive(DescribeTimeToLiveRequest describeTimeToLiveRequest)	Gives a description of the Time to Live (TTL) status on the specified table.
default DisableKinesisStreamingDestinationResponse	disableKinesisStreamingDestination(Consumer<DisableKinesisStreamingDestinationRequest.Builder> disableKinesisStreamingDestinationRequest)	Stops replication from the DynamoDB table to the Kinesis data stream.
default DisableKinesisStreamingDestinationResponse	disableKinesisStreamingDestination(DisableKinesisStreamingDestinationRequest disableKinesisStreamingDestinationRequest)	Stops replication from the DynamoDB table to the Kinesis data stream.
default 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 EnableKinesisStreamingDestinationResponse	enableKinesisStreamingDestination(EnableKinesisStreamingDestinationRequest enableKinesisStreamingDestinationRequest)	Starts table data replication to the specified Kinesis data stream at a timestamp chosen during the enable workflow.
default ExecuteStatementResponse	executeStatement(Consumer<ExecuteStatementRequest.Builder> executeStatementRequest)	This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL.
default ExecuteStatementResponse	executeStatement(ExecuteStatementRequest executeStatementRequest)	This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL.
default ExecuteTransactionResponse	executeTransaction(Consumer<ExecuteTransactionRequest.Builder> executeTransactionRequest)	This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL.
default ExecuteTransactionResponse	executeTransaction(ExecuteTransactionRequest executeTransactionRequest)	This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL.
default ExportTableToPointInTimeResponse	exportTableToPointInTime(Consumer<ExportTableToPointInTimeRequest.Builder> exportTableToPointInTimeRequest)	Exports table data to an S3 bucket.
default ExportTableToPointInTimeResponse	exportTableToPointInTime(ExportTableToPointInTimeRequest exportTableToPointInTimeRequest)	Exports table data to an S3 bucket.
default GetItemResponse	getItem(Consumer<GetItemRequest.Builder> getItemRequest)	The GetItem operation returns a set of attributes for the item with the given primary key.
default GetItemResponse	getItem(GetItemRequest getItemRequest)	The GetItem operation returns a set of attributes for the item with the given primary key.
default GetResourcePolicyResponse	getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest)	Returns the resource-based policy document attached to the resource, which can be a table or stream, in JSON format.
default GetResourcePolicyResponse	getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)	Returns the resource-based policy document attached to the resource, which can be a table or stream, in JSON format.
default ImportTableResponse	importTable(Consumer<ImportTableRequest.Builder> importTableRequest)	Imports table data from an S3 bucket.
default ImportTableResponse	importTable(ImportTableRequest importTableRequest)	Imports table data from an S3 bucket.
default ListBackupsResponse	listBackups()	List DynamoDB backups that are associated with an Amazon Web Services account and weren't made with Amazon Web Services Backup.
default 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 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 ListContributorInsightsResponse	listContributorInsights(Consumer<ListContributorInsightsRequest.Builder> listContributorInsightsRequest)	Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes.
default ListContributorInsightsResponse	listContributorInsights(ListContributorInsightsRequest listContributorInsightsRequest)	Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes.
default ListContributorInsightsIterable	listContributorInsightsPaginator(Consumer<ListContributorInsightsRequest.Builder> listContributorInsightsRequest)	This is a variant of listContributorInsights(software.amazon.awssdk.services.dynamodb.model.ListContributorInsightsRequest) operation.
default ListContributorInsightsIterable	listContributorInsightsPaginator(ListContributorInsightsRequest listContributorInsightsRequest)	This is a variant of listContributorInsights(software.amazon.awssdk.services.dynamodb.model.ListContributorInsightsRequest) operation.
default ListExportsResponse	listExports(Consumer<ListExportsRequest.Builder> listExportsRequest)	Lists completed exports within the past 90 days.
default ListExportsResponse	listExports(ListExportsRequest listExportsRequest)	Lists completed exports within the past 90 days.
default ListExportsIterable	listExportsPaginator(Consumer<ListExportsRequest.Builder> listExportsRequest)	This is a variant of listExports(software.amazon.awssdk.services.dynamodb.model.ListExportsRequest) operation.
default ListExportsIterable	listExportsPaginator(ListExportsRequest listExportsRequest)	This is a variant of listExports(software.amazon.awssdk.services.dynamodb.model.ListExportsRequest) operation.
default ListGlobalTablesResponse	listGlobalTables()	Lists all global tables that have a replica in the specified Region.
default ListGlobalTablesResponse	listGlobalTables(Consumer<ListGlobalTablesRequest.Builder> listGlobalTablesRequest)	Lists all global tables that have a replica in the specified Region.
default ListGlobalTablesResponse	listGlobalTables(ListGlobalTablesRequest listGlobalTablesRequest)	Lists all global tables that have a replica in the specified Region.
default ListImportsResponse	listImports(Consumer<ListImportsRequest.Builder> listImportsRequest)	Lists completed imports within the past 90 days.
default ListImportsResponse	listImports(ListImportsRequest listImportsRequest)	Lists completed imports within the past 90 days.
default ListImportsIterable	listImportsPaginator(Consumer<ListImportsRequest.Builder> listImportsRequest)	This is a variant of listImports(software.amazon.awssdk.services.dynamodb.model.ListImportsRequest) operation.
default ListImportsIterable	listImportsPaginator(ListImportsRequest listImportsRequest)	This is a variant of listImports(software.amazon.awssdk.services.dynamodb.model.ListImportsRequest) operation.
default ListTablesResponse	listTables()	Returns an array of table names associated with the current account and endpoint.
default ListTablesResponse	listTables(Consumer<ListTablesRequest.Builder> listTablesRequest)	Returns an array of table names associated with the current account and endpoint.
default ListTablesResponse	listTables(ListTablesRequest listTablesRequest)	Returns an array of table names associated with the current account and endpoint.
default ListTablesIterable	listTablesPaginator()	This is a variant of listTables(software.amazon.awssdk.services.dynamodb.model.ListTablesRequest) operation.
default ListTablesIterable	listTablesPaginator(Consumer<ListTablesRequest.Builder> listTablesRequest)	This is a variant of listTables(software.amazon.awssdk.services.dynamodb.model.ListTablesRequest) operation.
default ListTablesIterable	listTablesPaginator(ListTablesRequest listTablesRequest)	This is a variant of listTables(software.amazon.awssdk.services.dynamodb.model.ListTablesRequest) operation.
default ListTagsOfResourceResponse	listTagsOfResource(Consumer<ListTagsOfResourceRequest.Builder> listTagsOfResourceRequest)	List all tags on an Amazon DynamoDB resource.
default ListTagsOfResourceResponse	listTagsOfResource(ListTagsOfResourceRequest listTagsOfResourceRequest)	List all tags on an Amazon DynamoDB resource.
default PutItemResponse	putItem(Consumer<PutItemRequest.Builder> putItemRequest)	Creates a new item, or replaces an old item with a new item.
default PutItemResponse	putItem(PutItemRequest putItemRequest)	Creates a new item, or replaces an old item with a new item.
default PutResourcePolicyResponse	putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)	Attaches a resource-based policy document to the resource, which can be a table or stream.
default PutResourcePolicyResponse	putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)	Attaches a resource-based policy document to the resource, which can be a table or stream.
default QueryResponse	query(Consumer<QueryRequest.Builder> queryRequest)	You must provide the name of the partition key attribute and a single value for that attribute.
default QueryResponse	query(QueryRequest queryRequest)	You must provide the name of the partition key attribute and a single value for that attribute.
default QueryIterable	queryPaginator(Consumer<QueryRequest.Builder> queryRequest)	This is a variant of query(software.amazon.awssdk.services.dynamodb.model.QueryRequest) operation.
default QueryIterable	queryPaginator(QueryRequest queryRequest)	This is a variant of query(software.amazon.awssdk.services.dynamodb.model.QueryRequest) operation.
default RestoreTableFromBackupResponse	restoreTableFromBackup(Consumer<RestoreTableFromBackupRequest.Builder> restoreTableFromBackupRequest)	Creates a new table from an existing backup.
default RestoreTableFromBackupResponse	restoreTableFromBackup(RestoreTableFromBackupRequest restoreTableFromBackupRequest)	Creates a new table from an existing backup.
default RestoreTableToPointInTimeResponse	restoreTableToPointInTime(Consumer<RestoreTableToPointInTimeRequest.Builder> restoreTableToPointInTimeRequest)	Restores the specified table to the specified point in time within EarliestRestorableDateTime and LatestRestorableDateTime.
default RestoreTableToPointInTimeResponse	restoreTableToPointInTime(RestoreTableToPointInTimeRequest restoreTableToPointInTimeRequest)	Restores the specified table to the specified point in time within EarliestRestorableDateTime and LatestRestorableDateTime.
default 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.
default 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.
default ScanIterable	scanPaginator(Consumer<ScanRequest.Builder> scanRequest)	This is a variant of scan(software.amazon.awssdk.services.dynamodb.model.ScanRequest) operation.
default ScanIterable	scanPaginator(ScanRequest scanRequest)	This is a variant of scan(software.amazon.awssdk.services.dynamodb.model.ScanRequest) operation.
default DynamoDbServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Associate a set of tags with an Amazon DynamoDB resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Associate a set of tags with an Amazon DynamoDB resource.
default 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 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 TransactWriteItemsResponse	transactWriteItems(Consumer<TransactWriteItemsRequest.Builder> transactWriteItemsRequest)	TransactWriteItems is a synchronous write operation that groups up to 100 action requests.
default TransactWriteItemsResponse	transactWriteItems(TransactWriteItemsRequest transactWriteItemsRequest)	TransactWriteItems is a synchronous write operation that groups up to 100 action requests.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes the association of tags from an Amazon DynamoDB resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes the association of tags from an Amazon DynamoDB resource.
default UpdateContinuousBackupsResponse	updateContinuousBackups(Consumer<UpdateContinuousBackupsRequest.Builder> updateContinuousBackupsRequest)	UpdateContinuousBackups enables or disables point in time recovery for the specified table.
default UpdateContinuousBackupsResponse	updateContinuousBackups(UpdateContinuousBackupsRequest updateContinuousBackupsRequest)	UpdateContinuousBackups enables or disables point in time recovery for the specified table.
default UpdateContributorInsightsResponse	updateContributorInsights(Consumer<UpdateContributorInsightsRequest.Builder> updateContributorInsightsRequest)	Updates the status for contributor insights for a specific table or index.
default UpdateContributorInsightsResponse	updateContributorInsights(UpdateContributorInsightsRequest updateContributorInsightsRequest)	Updates the status for contributor insights for a specific table or index.
default UpdateGlobalTableResponse	updateGlobalTable(Consumer<UpdateGlobalTableRequest.Builder> updateGlobalTableRequest)	Adds or removes replicas in the specified global table.
default UpdateGlobalTableResponse	updateGlobalTable(UpdateGlobalTableRequest updateGlobalTableRequest)	Adds or removes replicas in the specified global table.
default UpdateGlobalTableSettingsResponse	updateGlobalTableSettings(Consumer<UpdateGlobalTableSettingsRequest.Builder> updateGlobalTableSettingsRequest)	Updates settings for a global table.
default UpdateGlobalTableSettingsResponse	updateGlobalTableSettings(UpdateGlobalTableSettingsRequest updateGlobalTableSettingsRequest)	Updates settings for a global table.
default 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 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 UpdateKinesisStreamingDestinationResponse	updateKinesisStreamingDestination(Consumer<UpdateKinesisStreamingDestinationRequest.Builder> updateKinesisStreamingDestinationRequest)	The command to update the Kinesis stream destination.
default UpdateKinesisStreamingDestinationResponse	updateKinesisStreamingDestination(UpdateKinesisStreamingDestinationRequest updateKinesisStreamingDestinationRequest)	The command to update the Kinesis stream destination.
default UpdateTableResponse	updateTable(Consumer<UpdateTableRequest.Builder> updateTableRequest)	Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.
default UpdateTableResponse	updateTable(UpdateTableRequest updateTableRequest)	Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.
default UpdateTableReplicaAutoScalingResponse	updateTableReplicaAutoScaling(Consumer<UpdateTableReplicaAutoScalingRequest.Builder> updateTableReplicaAutoScalingRequest)	Updates auto scaling settings on your global tables at once.
default UpdateTableReplicaAutoScalingResponse	updateTableReplicaAutoScaling(UpdateTableReplicaAutoScalingRequest updateTableReplicaAutoScalingRequest)	Updates auto scaling settings on your global tables at once.
default UpdateTimeToLiveResponse	updateTimeToLive(Consumer<UpdateTimeToLiveRequest.Builder> updateTimeToLiveRequest)	The UpdateTimeToLive method enables or disables Time to Live (TTL) for the specified table.
default UpdateTimeToLiveResponse	updateTimeToLive(UpdateTimeToLiveRequest updateTimeToLiveRequest)	The UpdateTimeToLive method enables or disables Time to Live (TTL) for the specified table.
default DynamoDbWaiter	waiter()	Create an instance of DynamoDbWaiter using this client.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

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 the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

batchExecuteStatement

default BatchExecuteStatementResponse batchExecuteStatement(BatchExecuteStatementRequest batchExecuteStatementRequest)
                                                     throws RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 each SELECT 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:

Result of the BatchExecuteStatement operation returned by the service.

See Also:

• AWS API Documentation

batchExecuteStatement

default BatchExecuteStatementResponse batchExecuteStatement(Consumer<BatchExecuteStatementRequest.Builder> batchExecuteStatementRequest)
                                                     throws RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 each SELECT 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 via BatchExecuteStatementRequest.builder()

Parameters:

batchExecuteStatementRequest - A Consumer that will call methods on BatchExecuteStatementRequest.Builder to create a request.

Returns:

Result of the BatchExecuteStatement operation returned by the service.

See Also:

• AWS API Documentation

batchGetItem

default BatchGetItemResponse batchGetItem(BatchGetItemRequest batchGetItemRequest)
                                   throws ProvisionedThroughputExceededException,
ResourceNotFoundException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 for UnprocessedKeys. 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 a ValidationException 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 a ProvisionedThroughputExceededException. If at least one of the items is successfully processed, then BatchGetItem completes successfully, while returning the keys of the unread items in UnprocessedKeys.

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 set ConsistentRead to true 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 a BatchGetItem operation.

Returns:

Result of the BatchGetItem operation returned by the service.

See Also:

• AWS API Documentation

batchGetItem

default BatchGetItemResponse batchGetItem(Consumer<BatchGetItemRequest.Builder> batchGetItemRequest)
                                   throws ProvisionedThroughputExceededException,
ResourceNotFoundException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 for UnprocessedKeys. 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 a ValidationException 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 a ProvisionedThroughputExceededException. If at least one of the items is successfully processed, then BatchGetItem completes successfully, while returning the keys of the unread items in UnprocessedKeys.

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 set ConsistentRead to true 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 via BatchGetItemRequest.builder()

Parameters:

batchGetItemRequest - A Consumer that will call methods on BatchGetItemRequest.Builder to create a request. Represents the input of a BatchGetItem operation.

Returns:

Result of the BatchGetItem operation returned by the service.

See Also:

• AWS API Documentation

batchGetItemPaginator

default BatchGetItemIterable batchGetItemPaginator(BatchGetItemRequest batchGetItemRequest)
                                            throws ProvisionedThroughputExceededException,
ResourceNotFoundException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

This is a variant of batchGetItem(software.amazon.awssdk.services.dynamodb.model.BatchGetItemRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.dynamodb.paginators.BatchGetItemIterable responses = client.batchGetItemPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.dynamodb.paginators.BatchGetItemIterable responses = client.batchGetItemPaginator(request);
     for (software.amazon.awssdk.services.dynamodb.model.BatchGetItemResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.dynamodb.paginators.BatchGetItemIterable responses = client.batchGetItemPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 a BatchGetItem operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

batchGetItemPaginator

default BatchGetItemIterable batchGetItemPaginator(Consumer<BatchGetItemRequest.Builder> batchGetItemRequest)
                                            throws ProvisionedThroughputExceededException,
ResourceNotFoundException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

This is a variant of batchGetItem(software.amazon.awssdk.services.dynamodb.model.BatchGetItemRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.dynamodb.paginators.BatchGetItemIterable responses = client.batchGetItemPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.dynamodb.paginators.BatchGetItemIterable responses = client.batchGetItemPaginator(request);
     for (software.amazon.awssdk.services.dynamodb.model.BatchGetItemResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.dynamodb.paginators.BatchGetItemIterable responses = client.batchGetItemPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 via BatchGetItemRequest.builder()

Parameters:

batchGetItemRequest - A Consumer that will call methods on BatchGetItemRequest.Builder to create a request. Represents the input of a BatchGetItem operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

batchWriteItem

default BatchWriteItemResponse batchWriteItem(BatchWriteItemRequest batchWriteItemRequest)
                                       throws ProvisionedThroughputExceededException,
ResourceNotFoundException,
ItemCollectionSizeLimitExceededException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem 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 a BatchWriteItem 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 the UpdateItem action.

The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem 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 the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem 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 a ProvisionedThroughputExceededException.

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 individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem 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 same BatchWriteItem 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 a BatchWriteItem operation.

Returns:

Result of the BatchWriteItem operation returned by the service.

See Also:

• AWS API Documentation

batchWriteItem

default BatchWriteItemResponse batchWriteItem(Consumer<BatchWriteItemRequest.Builder> batchWriteItemRequest)
                                       throws ProvisionedThroughputExceededException,
ResourceNotFoundException,
ItemCollectionSizeLimitExceededException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem 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 a BatchWriteItem 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 the UpdateItem action.

The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem 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 the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem 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 a ProvisionedThroughputExceededException.

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 individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem 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 same BatchWriteItem 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 via BatchWriteItemRequest.builder()

Parameters:

batchWriteItemRequest - A Consumer that will call methods on BatchWriteItemRequest.Builder to create a request. Represents the input of a BatchWriteItem operation.

Returns:

Result of the BatchWriteItem operation returned by the service.

See Also:

• AWS API Documentation

createBackup

default CreateBackupResponse createBackup(CreateBackupRequest createBackupRequest)
                                   throws TableNotFoundException,
TableInUseException,
ContinuousBackupsUnavailableException,
BackupInUseException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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:

Result of the CreateBackup operation returned by the service.

See Also:

• AWS API Documentation

createBackup

default CreateBackupResponse createBackup(Consumer<CreateBackupRequest.Builder> createBackupRequest)
                                   throws TableNotFoundException,
TableInUseException,
ContinuousBackupsUnavailableException,
BackupInUseException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via CreateBackupRequest.builder()

Parameters:

createBackupRequest - A Consumer that will call methods on CreateBackupRequest.Builder to create a request.

Returns:

Result of the CreateBackup operation returned by the service.

See Also:

• AWS API Documentation

createGlobalTable

default CreateGlobalTableResponse createGlobalTable(CreateGlobalTableRequest createGlobalTableRequest)
                                             throws LimitExceededException,
InternalServerErrorException,
GlobalTableAlreadyExistsException,
TableNotFoundException,
AwsServiceException,
SdkClientException,
DynamoDbException

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:

Result of the CreateGlobalTable operation returned by the service.

See Also:

• AWS API Documentation

createGlobalTable

default CreateGlobalTableResponse createGlobalTable(Consumer<CreateGlobalTableRequest.Builder> createGlobalTableRequest)
                                             throws LimitExceededException,
InternalServerErrorException,
GlobalTableAlreadyExistsException,
TableNotFoundException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via CreateGlobalTableRequest.builder()

Parameters:

createGlobalTableRequest - A Consumer that will call methods on CreateGlobalTableRequest.Builder to create a request.

Returns:

Result of the CreateGlobalTable operation returned by the service.

See Also:

• AWS API Documentation

createTable

default CreateTableResponse createTable(CreateTableRequest createTableRequest)
                                 throws ResourceInUseException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 a CreateTable request, DynamoDB immediately returns a response with a TableStatus of CREATING. After the table is created, DynamoDB sets the TableStatus to ACTIVE. You can perform read and write operations only on an ACTIVE 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 the CREATING state at any given time.

You can use the DescribeTable action to check the table status.

Parameters:

createTableRequest - Represents the input of a CreateTable operation.

Returns:

Result of the CreateTable operation returned by the service.

See Also:

• AWS API Documentation

createTable

default CreateTableResponse createTable(Consumer<CreateTableRequest.Builder> createTableRequest)
                                 throws ResourceInUseException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 a CreateTable request, DynamoDB immediately returns a response with a TableStatus of CREATING. After the table is created, DynamoDB sets the TableStatus to ACTIVE. You can perform read and write operations only on an ACTIVE 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 the CREATING 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 via CreateTableRequest.builder()

Parameters:

createTableRequest - A Consumer that will call methods on CreateTableRequest.Builder to create a request. Represents the input of a CreateTable operation.

Returns:

Result of the CreateTable operation returned by the service.

See Also:

• AWS API Documentation

deleteBackup

default DeleteBackupResponse deleteBackup(DeleteBackupRequest deleteBackupRequest)
                                   throws BackupNotFoundException,
BackupInUseException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

Deletes an existing backup of a table.

You can call DeleteBackup at a maximum rate of 10 times per second.

Parameters:

deleteBackupRequest -

Returns:

Result of the DeleteBackup operation returned by the service.

See Also:

• AWS API Documentation

deleteBackup

default DeleteBackupResponse deleteBackup(Consumer<DeleteBackupRequest.Builder> deleteBackupRequest)
                                   throws BackupNotFoundException,
BackupInUseException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via DeleteBackupRequest.builder()

Parameters:

deleteBackupRequest - A Consumer that will call methods on DeleteBackupRequest.Builder to create a request.

Returns:

Result of the DeleteBackup operation returned by the service.

See Also:

• AWS API Documentation

deleteItem

default DeleteItemResponse deleteItem(DeleteItemRequest deleteItemRequest)
                               throws ConditionalCheckFailedException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ItemCollectionSizeLimitExceededException,
TransactionConflictException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 a DeleteItem operation.

Returns:

Result of the DeleteItem operation returned by the service.

See Also:

• AWS API Documentation

deleteItem

default DeleteItemResponse deleteItem(Consumer<DeleteItemRequest.Builder> deleteItemRequest)
                               throws ConditionalCheckFailedException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ItemCollectionSizeLimitExceededException,
TransactionConflictException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via DeleteItemRequest.builder()

Parameters:

deleteItemRequest - A Consumer that will call methods on DeleteItemRequest.Builder to create a request. Represents the input of a DeleteItem operation.

Returns:

Result of the DeleteItem operation returned by the service.

See Also:

• AWS API Documentation

deleteResourcePolicy

default DeleteResourcePolicyResponse deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
                                                   throws ResourceNotFoundException,
InternalServerErrorException,
PolicyNotFoundException,
ResourceInUseException,
LimitExceededException,
AwsServiceException,
SdkClientException,
DynamoDbException

Deletes the resource-based policy attached to the resource, which can be a table or stream.

DeleteResourcePolicy is an idempotent operation; running it multiple times on the same resource doesn't result in an error response, unless you specify an ExpectedRevisionId, which will then return a PolicyNotFoundException.

To make sure that you don't inadvertently lock yourself out of your own resources, the root principal in your Amazon Web Services account can perform DeleteResourcePolicy requests, even if your resource-based policy explicitly denies the root principal's access.

DeleteResourcePolicy is an asynchronous operation. If you issue a GetResourcePolicy request immediately after running the DeleteResourcePolicy request, DynamoDB might still return the deleted policy. This is because the policy for your resource might not have been deleted yet. Wait for a few seconds, and then try the GetResourcePolicy request again.

Parameters:

deleteResourcePolicyRequest -

Returns:

Result of the DeleteResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteResourcePolicy

default DeleteResourcePolicyResponse deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)
                                                   throws ResourceNotFoundException,
InternalServerErrorException,
PolicyNotFoundException,
ResourceInUseException,
LimitExceededException,
AwsServiceException,
SdkClientException,
DynamoDbException

Deletes the resource-based policy attached to the resource, which can be a table or stream.

DeleteResourcePolicy is an idempotent operation; running it multiple times on the same resource doesn't result in an error response, unless you specify an ExpectedRevisionId, which will then return a PolicyNotFoundException.

To make sure that you don't inadvertently lock yourself out of your own resources, the root principal in your Amazon Web Services account can perform DeleteResourcePolicy requests, even if your resource-based policy explicitly denies the root principal's access.

DeleteResourcePolicy is an asynchronous operation. If you issue a GetResourcePolicy request immediately after running the DeleteResourcePolicy request, DynamoDB might still return the deleted policy. This is because the policy for your resource might not have been deleted yet. Wait for a few seconds, and then try the GetResourcePolicy request again.

This is a convenience which creates an instance of the DeleteResourcePolicyRequest.Builder avoiding the need to create one manually via DeleteResourcePolicyRequest.builder()

Parameters:

deleteResourcePolicyRequest - A Consumer that will call methods on DeleteResourcePolicyRequest.Builder to create a request.

Returns:

Result of the DeleteResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteTable

default DeleteTableResponse deleteTable(DeleteTableRequest deleteTableRequest)
                                 throws ResourceInUseException,
ResourceNotFoundException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING 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 and PutItem, on a table in the DELETING 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 a DeleteTable operation.

Returns:

Result of the DeleteTable operation returned by the service.

See Also:

• AWS API Documentation

deleteTable

default DeleteTableResponse deleteTable(Consumer<DeleteTableRequest.Builder> deleteTableRequest)
                                 throws ResourceInUseException,
ResourceNotFoundException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING 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 and PutItem, on a table in the DELETING 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 via DeleteTableRequest.builder()

Parameters:

deleteTableRequest - A Consumer that will call methods on DeleteTableRequest.Builder to create a request. Represents the input of a DeleteTable operation.

Returns:

Result of the DeleteTable operation returned by the service.

See Also:

• AWS API Documentation

describeBackup

default DescribeBackupResponse describeBackup(DescribeBackupRequest describeBackupRequest)
                                       throws BackupNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

Describes an existing backup of a table.

You can call DescribeBackup at a maximum rate of 10 times per second.

Parameters:

describeBackupRequest -

Returns:

Result of the DescribeBackup operation returned by the service.

See Also:

• AWS API Documentation

describeBackup

default DescribeBackupResponse describeBackup(Consumer<DescribeBackupRequest.Builder> describeBackupRequest)
                                       throws BackupNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via DescribeBackupRequest.builder()

Parameters:

describeBackupRequest - A Consumer that will call methods on DescribeBackupRequest.Builder to create a request.

Returns:

Result of the DescribeBackup operation returned by the service.

See Also:

• AWS API Documentation

describeContinuousBackups

default DescribeContinuousBackupsResponse describeContinuousBackups(DescribeContinuousBackupsRequest describeContinuousBackupsRequest)
                                                             throws TableNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 and LatestRestorableDateTime.

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:

Result of the DescribeContinuousBackups operation returned by the service.

See Also:

• AWS API Documentation

describeContinuousBackups

default DescribeContinuousBackupsResponse describeContinuousBackups(Consumer<DescribeContinuousBackupsRequest.Builder> describeContinuousBackupsRequest)
                                                             throws TableNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 and LatestRestorableDateTime.

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 via DescribeContinuousBackupsRequest.builder()

Parameters:

describeContinuousBackupsRequest - A Consumer that will call methods on DescribeContinuousBackupsRequest.Builder to create a request.

Returns:

Result of the DescribeContinuousBackups operation returned by the service.

See Also:

• AWS API Documentation

describeContributorInsights

default DescribeContributorInsightsResponse describeContributorInsights(DescribeContributorInsightsRequest describeContributorInsightsRequest)
                                                                 throws ResourceNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

Returns information about contributor insights for a given table or global secondary index.

Parameters:

describeContributorInsightsRequest -

Returns:

Result of the DescribeContributorInsights operation returned by the service.

See Also:

• AWS API Documentation

describeContributorInsights

default DescribeContributorInsightsResponse describeContributorInsights(Consumer<DescribeContributorInsightsRequest.Builder> describeContributorInsightsRequest)
                                                                 throws ResourceNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via DescribeContributorInsightsRequest.builder()

Parameters:

describeContributorInsightsRequest - A Consumer that will call methods on DescribeContributorInsightsRequest.Builder to create a request.

Returns:

Result of the DescribeContributorInsights operation returned by the service.

See Also:

• AWS API Documentation

describeEndpoints

default DescribeEndpointsResponse describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest)
                                             throws AwsServiceException,
SdkClientException,
DynamoDbException

Returns the regional endpoint information. For more information on policy permissions, please see Internetwork traffic privacy.

Parameters:

describeEndpointsRequest -

Returns:

Result of the DescribeEndpoints operation returned by the service.

See Also:

• AWS API Documentation

describeEndpoints

default DescribeEndpointsResponse describeEndpoints(Consumer<DescribeEndpointsRequest.Builder> describeEndpointsRequest)
                                             throws AwsServiceException,
SdkClientException,
DynamoDbException

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 via DescribeEndpointsRequest.builder()

Parameters:

describeEndpointsRequest - A Consumer that will call methods on DescribeEndpointsRequest.Builder to create a request.

Returns:

Result of the DescribeEndpoints operation returned by the service.

See Also:

• AWS API Documentation

describeEndpoints

default DescribeEndpointsResponse describeEndpoints()
                                             throws AwsServiceException,
SdkClientException,
DynamoDbException

Returns the regional endpoint information. For more information on policy permissions, please see Internetwork traffic privacy.

Returns:

Result of the DescribeEndpoints operation returned by the service.

See Also:

• describeEndpoints(DescribeEndpointsRequest)
• AWS API Documentation

describeExport

default DescribeExportResponse describeExport(DescribeExportRequest describeExportRequest)
                                       throws ExportNotFoundException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

Describes an existing table export.

Parameters:

describeExportRequest -

Returns:

Result of the DescribeExport operation returned by the service.

See Also:

• AWS API Documentation

describeExport

default DescribeExportResponse describeExport(Consumer<DescribeExportRequest.Builder> describeExportRequest)
                                       throws ExportNotFoundException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

Describes an existing table export.

This is a convenience which creates an instance of the DescribeExportRequest.Builder avoiding the need to create one manually via DescribeExportRequest.builder()

Parameters:

describeExportRequest - A Consumer that will call methods on DescribeExportRequest.Builder to create a request.

Returns:

Result of the DescribeExport operation returned by the service.

See Also:

• AWS API Documentation

describeGlobalTable

default DescribeGlobalTableResponse describeGlobalTable(DescribeGlobalTableRequest describeGlobalTableRequest)
                                                 throws InternalServerErrorException,
GlobalTableNotFoundException,
AwsServiceException,
SdkClientException,
DynamoDbException

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:

Result of the DescribeGlobalTable operation returned by the service.

See Also:

• AWS API Documentation

describeGlobalTable

default DescribeGlobalTableResponse describeGlobalTable(Consumer<DescribeGlobalTableRequest.Builder> describeGlobalTableRequest)
                                                 throws InternalServerErrorException,
GlobalTableNotFoundException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via DescribeGlobalTableRequest.builder()

Parameters:

describeGlobalTableRequest - A Consumer that will call methods on DescribeGlobalTableRequest.Builder to create a request.

Returns:

Result of the DescribeGlobalTable operation returned by the service.

See Also:

• AWS API Documentation

describeGlobalTableSettings

default DescribeGlobalTableSettingsResponse describeGlobalTableSettings(DescribeGlobalTableSettingsRequest describeGlobalTableSettingsRequest)
                                                                 throws GlobalTableNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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:

Result of the DescribeGlobalTableSettings operation returned by the service.

See Also:

• AWS API Documentation

describeGlobalTableSettings

default DescribeGlobalTableSettingsResponse describeGlobalTableSettings(Consumer<DescribeGlobalTableSettingsRequest.Builder> describeGlobalTableSettingsRequest)
                                                                 throws GlobalTableNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via DescribeGlobalTableSettingsRequest.builder()

Parameters:

describeGlobalTableSettingsRequest - A Consumer that will call methods on DescribeGlobalTableSettingsRequest.Builder to create a request.

Returns:

Result of the DescribeGlobalTableSettings operation returned by the service.

See Also:

• AWS API Documentation

describeImport

default DescribeImportResponse describeImport(DescribeImportRequest describeImportRequest)
                                       throws ImportNotFoundException,
AwsServiceException,
SdkClientException,
DynamoDbException

Represents the properties of the import.

Parameters:

describeImportRequest -

Returns:

Result of the DescribeImport operation returned by the service.

See Also:

• AWS API Documentation

describeImport

default DescribeImportResponse describeImport(Consumer<DescribeImportRequest.Builder> describeImportRequest)
                                       throws ImportNotFoundException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via DescribeImportRequest.builder()

Parameters:

describeImportRequest - A Consumer that will call methods on DescribeImportRequest.Builder to create a request.

Returns:

Result of the DescribeImport operation returned by the service.

See Also:

• AWS API Documentation

describeKinesisStreamingDestination

default DescribeKinesisStreamingDestinationResponse describeKinesisStreamingDestination(DescribeKinesisStreamingDestinationRequest describeKinesisStreamingDestinationRequest)
                                                                                 throws ResourceNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

Returns information about the status of Kinesis streaming.

Parameters:

describeKinesisStreamingDestinationRequest -

Returns:

Result of the DescribeKinesisStreamingDestination operation returned by the service.

See Also:

• AWS API Documentation

describeKinesisStreamingDestination

default DescribeKinesisStreamingDestinationResponse describeKinesisStreamingDestination(Consumer<DescribeKinesisStreamingDestinationRequest.Builder> describeKinesisStreamingDestinationRequest)
                                                                                 throws ResourceNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via DescribeKinesisStreamingDestinationRequest.builder()

Parameters:

describeKinesisStreamingDestinationRequest - A Consumer that will call methods on DescribeKinesisStreamingDestinationRequest.Builder to create a request.

Returns:

Result of the DescribeKinesisStreamingDestination operation returned by the service.

See Also:

• AWS API Documentation

describeLimits

default DescribeLimitsResponse describeLimits(DescribeLimitsRequest describeLimitsRequest)
                                       throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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:

1. Call DescribeLimits for a particular Region to obtain your current account quotas on provisioned capacity there.

2. 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.

3. Call ListTables to obtain a list of all your DynamoDB tables.

4. 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.

5. 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 a DescribeLimits operation. Has no content.

Returns:

Result of the DescribeLimits operation returned by the service.

See Also:

• AWS API Documentation

describeLimits

default DescribeLimitsResponse describeLimits(Consumer<DescribeLimitsRequest.Builder> describeLimitsRequest)
                                       throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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:

1. Call DescribeLimits for a particular Region to obtain your current account quotas on provisioned capacity there.

2. 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.

3. Call ListTables to obtain a list of all your DynamoDB tables.

4. 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.

5. 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 via DescribeLimitsRequest.builder()

Parameters:

describeLimitsRequest - A Consumer that will call methods on DescribeLimitsRequest.Builder to create a request. Represents the input of a DescribeLimits operation. Has no content.

Returns:

Result of the DescribeLimits operation returned by the service.

See Also:

• AWS API Documentation

describeLimits

default DescribeLimitsResponse describeLimits()
                                       throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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:

1. Call DescribeLimits for a particular Region to obtain your current account quotas on provisioned capacity there.

2. 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.

3. Call ListTables to obtain a list of all your DynamoDB tables.

4. 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.

5. 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:

Result of the DescribeLimits operation returned by the service.

See Also:

• describeLimits(DescribeLimitsRequest)
• AWS API Documentation

describeTable

default DescribeTableResponse describeTable(DescribeTableRequest describeTableRequest)
                                     throws ResourceNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable 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 the DescribeTable request again.

Parameters:

describeTableRequest - Represents the input of a DescribeTable operation.

Returns:

Result of the DescribeTable operation returned by the service.

See Also:

• AWS API Documentation

describeTable

default DescribeTableResponse describeTable(Consumer<DescribeTableRequest.Builder> describeTableRequest)
                                     throws ResourceNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable 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 the DescribeTable request again.

This is a convenience which creates an instance of the DescribeTableRequest.Builder avoiding the need to create one manually via DescribeTableRequest.builder()

Parameters:

describeTableRequest - A Consumer that will call methods on DescribeTableRequest.Builder to create a request. Represents the input of a DescribeTable operation.

Returns:

Result of the DescribeTable operation returned by the service.

See Also:

• AWS API Documentation

describeTableReplicaAutoScaling

default DescribeTableReplicaAutoScalingResponse describeTableReplicaAutoScaling(DescribeTableReplicaAutoScalingRequest describeTableReplicaAutoScalingRequest)
                                                                         throws ResourceNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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:

Result of the DescribeTableReplicaAutoScaling operation returned by the service.

See Also:

• AWS API Documentation

describeTableReplicaAutoScaling

default DescribeTableReplicaAutoScalingResponse describeTableReplicaAutoScaling(Consumer<DescribeTableReplicaAutoScalingRequest.Builder> describeTableReplicaAutoScalingRequest)
                                                                         throws ResourceNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via DescribeTableReplicaAutoScalingRequest.builder()

Parameters:

describeTableReplicaAutoScalingRequest - A Consumer that will call methods on DescribeTableReplicaAutoScalingRequest.Builder to create a request.

Returns:

Result of the DescribeTableReplicaAutoScaling operation returned by the service.

See Also:

• AWS API Documentation

describeTimeToLive

default DescribeTimeToLiveResponse describeTimeToLive(DescribeTimeToLiveRequest describeTimeToLiveRequest)
                                               throws ResourceNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

Gives a description of the Time to Live (TTL) status on the specified table.

Parameters:

describeTimeToLiveRequest -

Returns:

Result of the DescribeTimeToLive operation returned by the service.

See Also:

• AWS API Documentation

describeTimeToLive

default DescribeTimeToLiveResponse describeTimeToLive(Consumer<DescribeTimeToLiveRequest.Builder> describeTimeToLiveRequest)
                                               throws ResourceNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via DescribeTimeToLiveRequest.builder()

Parameters:

describeTimeToLiveRequest - A Consumer that will call methods on DescribeTimeToLiveRequest.Builder to create a request.

Returns:

Result of the DescribeTimeToLive operation returned by the service.

See Also:

• AWS API Documentation

disableKinesisStreamingDestination

default DisableKinesisStreamingDestinationResponse disableKinesisStreamingDestination(DisableKinesisStreamingDestinationRequest disableKinesisStreamingDestinationRequest)
                                                                               throws InternalServerErrorException,
LimitExceededException,
ResourceInUseException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DynamoDbException

Stops replication from the DynamoDB table to the Kinesis data stream. This is done without deleting either of the resources.

Parameters:

disableKinesisStreamingDestinationRequest -

Returns:

Result of the DisableKinesisStreamingDestination operation returned by the service.

See Also:

• AWS API Documentation

disableKinesisStreamingDestination

default DisableKinesisStreamingDestinationResponse disableKinesisStreamingDestination(Consumer<DisableKinesisStreamingDestinationRequest.Builder> disableKinesisStreamingDestinationRequest)
                                                                               throws InternalServerErrorException,
LimitExceededException,
ResourceInUseException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via DisableKinesisStreamingDestinationRequest.builder()

Parameters:

disableKinesisStreamingDestinationRequest - A Consumer that will call methods on DisableKinesisStreamingDestinationRequest.Builder to create a request.

Returns:

Result of the DisableKinesisStreamingDestination operation returned by the service.

See Also:

• AWS API Documentation

enableKinesisStreamingDestination

default EnableKinesisStreamingDestinationResponse enableKinesisStreamingDestination(EnableKinesisStreamingDestinationRequest enableKinesisStreamingDestinationRequest)
                                                                             throws InternalServerErrorException,
LimitExceededException,
ResourceInUseException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DynamoDbException

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:

Result of the EnableKinesisStreamingDestination operation returned by the service.

See Also:

• AWS API Documentation

enableKinesisStreamingDestination

default EnableKinesisStreamingDestinationResponse enableKinesisStreamingDestination(Consumer<EnableKinesisStreamingDestinationRequest.Builder> enableKinesisStreamingDestinationRequest)
                                                                             throws InternalServerErrorException,
LimitExceededException,
ResourceInUseException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via EnableKinesisStreamingDestinationRequest.builder()

Parameters:

enableKinesisStreamingDestinationRequest - A Consumer that will call methods on EnableKinesisStreamingDestinationRequest.Builder to create a request.

Returns:

Result of the EnableKinesisStreamingDestination operation returned by the service.

See Also:

• AWS API Documentation

executeStatement

default ExecuteStatementResponse executeStatement(ExecuteStatementRequest executeStatementRequest)
                                           throws ConditionalCheckFailedException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ItemCollectionSizeLimitExceededException,
TransactionConflictException,
RequestLimitExceededException,
InternalServerErrorException,
DuplicateItemException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 a LastEvaluatedKey value to continue the read in a subsequent operation. If the filter criteria in WHERE 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 using WHERE clause). If LastEvaluatedKey is present in the response, you need to paginate the result set. If NextToken is present, you need to paginate the result set and include NextToken.

Parameters:

executeStatementRequest -

Returns:

Result of the ExecuteStatement operation returned by the service.

See Also:

• AWS API Documentation

executeStatement

default ExecuteStatementResponse executeStatement(Consumer<ExecuteStatementRequest.Builder> executeStatementRequest)
                                           throws ConditionalCheckFailedException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ItemCollectionSizeLimitExceededException,
TransactionConflictException,
RequestLimitExceededException,
InternalServerErrorException,
DuplicateItemException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 a LastEvaluatedKey value to continue the read in a subsequent operation. If the filter criteria in WHERE 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 using WHERE clause). If LastEvaluatedKey is present in the response, you need to paginate the result set. If NextToken is present, you need to paginate the result set and include NextToken.

This is a convenience which creates an instance of the ExecuteStatementRequest.Builder avoiding the need to create one manually via ExecuteStatementRequest.builder()

Parameters:

executeStatementRequest - A Consumer that will call methods on ExecuteStatementRequest.Builder to create a request.

Returns:

Result of the ExecuteStatement operation returned by the service.

See Also:

• AWS API Documentation

executeTransaction

default ExecuteTransactionResponse executeTransaction(ExecuteTransactionRequest executeTransactionRequest)
                                               throws ResourceNotFoundException,
TransactionCanceledException,
TransactionInProgressException,
IdempotentParameterMismatchException,
ProvisionedThroughputExceededException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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:

Result of the ExecuteTransaction operation returned by the service.

See Also:

• AWS API Documentation

executeTransaction

default ExecuteTransactionResponse executeTransaction(Consumer<ExecuteTransactionRequest.Builder> executeTransactionRequest)
                                               throws ResourceNotFoundException,
TransactionCanceledException,
TransactionInProgressException,
IdempotentParameterMismatchException,
ProvisionedThroughputExceededException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via ExecuteTransactionRequest.builder()

Parameters:

executeTransactionRequest - A Consumer that will call methods on ExecuteTransactionRequest.Builder to create a request.

Returns:

Result of the ExecuteTransaction operation returned by the service.

See Also:

• AWS API Documentation

exportTableToPointInTime

default ExportTableToPointInTimeResponse exportTableToPointInTime(ExportTableToPointInTimeRequest exportTableToPointInTimeRequest)
                                                           throws TableNotFoundException,
PointInTimeRecoveryUnavailableException,
LimitExceededException,
InvalidExportTimeException,
ExportConflictException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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:

Result of the ExportTableToPointInTime operation returned by the service.

See Also:

• AWS API Documentation

exportTableToPointInTime

default ExportTableToPointInTimeResponse exportTableToPointInTime(Consumer<ExportTableToPointInTimeRequest.Builder> exportTableToPointInTimeRequest)
                                                           throws TableNotFoundException,
PointInTimeRecoveryUnavailableException,
LimitExceededException,
InvalidExportTimeException,
ExportConflictException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via ExportTableToPointInTimeRequest.builder()

Parameters:

exportTableToPointInTimeRequest - A Consumer that will call methods on ExportTableToPointInTimeRequest.Builder to create a request.

Returns:

Result of the ExportTableToPointInTime operation returned by the service.

See Also:

• AWS API Documentation

getItem

default GetItemResponse getItem(GetItemRequest getItemRequest)
                         throws ProvisionedThroughputExceededException,
ResourceNotFoundException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 no Item element in the response.

GetItem provides an eventually consistent read by default. If your application requires a strongly consistent read, set ConsistentRead to true. 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 a GetItem operation.

Returns:

Result of the GetItem operation returned by the service.

See Also:

• AWS API Documentation

getItem

default GetItemResponse getItem(Consumer<GetItemRequest.Builder> getItemRequest)
                         throws ProvisionedThroughputExceededException,
ResourceNotFoundException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 no Item element in the response.

GetItem provides an eventually consistent read by default. If your application requires a strongly consistent read, set ConsistentRead to true. 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 via GetItemRequest.builder()

Parameters:

getItemRequest - A Consumer that will call methods on GetItemRequest.Builder to create a request. Represents the input of a GetItem operation.

Returns:

Result of the GetItem operation returned by the service.

See Also:

• AWS API Documentation

getResourcePolicy

default GetResourcePolicyResponse getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)
                                             throws ResourceNotFoundException,
InternalServerErrorException,
PolicyNotFoundException,
AwsServiceException,
SdkClientException,
DynamoDbException

Returns the resource-based policy document attached to the resource, which can be a table or stream, in JSON format.

GetResourcePolicy follows an eventually consistent model. The following list describes the outcomes when you issue the GetResourcePolicy request immediately after issuing another request:

• If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return a PolicyNotFoundException.

• If you issue a GetResourcePolicyrequest immediately after a DeleteResourcePolicy request, DynamoDB might return the policy that was present before the deletion request.

• If you issue a GetResourcePolicy request immediately after a CreateTable request, which includes a resource-based policy, DynamoDB might return a ResourceNotFoundException or a PolicyNotFoundException.

Because GetResourcePolicy uses an eventually consistent query, the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then retry the GetResourcePolicy request.

After a GetResourcePolicy request returns a policy created using the PutResourcePolicy request, you can assume the policy will start getting applied in the authorization of requests to the resource. Because this process is eventually consistent, it will take some time to apply the policy to all requests to a resource. Policies that you attach while creating a table using the CreateTable request will always be applied to all requests for that table.

Parameters:

getResourcePolicyRequest -

Returns:

Result of the GetResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

getResourcePolicy

default GetResourcePolicyResponse getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest)
                                             throws ResourceNotFoundException,
InternalServerErrorException,
PolicyNotFoundException,
AwsServiceException,
SdkClientException,
DynamoDbException

Returns the resource-based policy document attached to the resource, which can be a table or stream, in JSON format.

GetResourcePolicy follows an eventually consistent model. The following list describes the outcomes when you issue the GetResourcePolicy request immediately after issuing another request:

• If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return a PolicyNotFoundException.

• If you issue a GetResourcePolicyrequest immediately after a DeleteResourcePolicy request, DynamoDB might return the policy that was present before the deletion request.

• If you issue a GetResourcePolicy request immediately after a CreateTable request, which includes a resource-based policy, DynamoDB might return a ResourceNotFoundException or a PolicyNotFoundException.

Because GetResourcePolicy uses an eventually consistent query, the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then retry the GetResourcePolicy request.

After a GetResourcePolicy request returns a policy created using the PutResourcePolicy request, you can assume the policy will start getting applied in the authorization of requests to the resource. Because this process is eventually consistent, it will take some time to apply the policy to all requests to a resource. Policies that you attach while creating a table using the CreateTable request will always be applied to all requests for that table.

This is a convenience which creates an instance of the GetResourcePolicyRequest.Builder avoiding the need to create one manually via GetResourcePolicyRequest.builder()

Parameters:

getResourcePolicyRequest - A Consumer that will call methods on GetResourcePolicyRequest.Builder to create a request.

Returns:

Result of the GetResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

importTable

default ImportTableResponse importTable(ImportTableRequest importTableRequest)
                                 throws ResourceInUseException,
LimitExceededException,
ImportConflictException,
AwsServiceException,
SdkClientException,
DynamoDbException

Imports table data from an S3 bucket.

Parameters:

importTableRequest -

Returns:

Result of the ImportTable operation returned by the service.

See Also:

• AWS API Documentation

importTable

default ImportTableResponse importTable(Consumer<ImportTableRequest.Builder> importTableRequest)
                                 throws ResourceInUseException,
LimitExceededException,
ImportConflictException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via ImportTableRequest.builder()

Parameters:

importTableRequest - A Consumer that will call methods on ImportTableRequest.Builder to create a request.

Returns:

Result of the ImportTable operation returned by the service.

See Also:

• AWS API Documentation

listBackups

default ListBackupsResponse listBackups(ListBackupsRequest listBackupsRequest)
                                 throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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:

Result of the ListBackups operation returned by the service.

See Also:

• AWS API Documentation

listBackups

default ListBackupsResponse listBackups(Consumer<ListBackupsRequest.Builder> listBackupsRequest)
                                 throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via ListBackupsRequest.builder()

Parameters:

listBackupsRequest - A Consumer that will call methods on ListBackupsRequest.Builder to create a request.

Returns:

Result of the ListBackups operation returned by the service.

See Also:

• AWS API Documentation

listBackups

default ListBackupsResponse listBackups()
                                 throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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:

Result of the ListBackups operation returned by the service.

See Also:

• listBackups(ListBackupsRequest)
• AWS API Documentation

listContributorInsights

default ListContributorInsightsResponse listContributorInsights(ListContributorInsightsRequest listContributorInsightsRequest)
                                                         throws ResourceNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes.

Parameters:

listContributorInsightsRequest -

Returns:

Result of the ListContributorInsights operation returned by the service.

See Also:

• AWS API Documentation

listContributorInsights

default ListContributorInsightsResponse listContributorInsights(Consumer<ListContributorInsightsRequest.Builder> listContributorInsightsRequest)
                                                         throws ResourceNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via ListContributorInsightsRequest.builder()

Parameters:

listContributorInsightsRequest - A Consumer that will call methods on ListContributorInsightsRequest.Builder to create a request.

Returns:

Result of the ListContributorInsights operation returned by the service.

See Also:

• AWS API Documentation

listContributorInsightsPaginator

default ListContributorInsightsIterable listContributorInsightsPaginator(ListContributorInsightsRequest listContributorInsightsRequest)
                                                                  throws ResourceNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

This is a variant of listContributorInsights(software.amazon.awssdk.services.dynamodb.model.ListContributorInsightsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.dynamodb.paginators.ListContributorInsightsIterable responses = client.listContributorInsightsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.dynamodb.paginators.ListContributorInsightsIterable responses = client
             .listContributorInsightsPaginator(request);
     for (software.amazon.awssdk.services.dynamodb.model.ListContributorInsightsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.dynamodb.paginators.ListContributorInsightsIterable responses = client.listContributorInsightsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listContributorInsightsPaginator

default ListContributorInsightsIterable listContributorInsightsPaginator(Consumer<ListContributorInsightsRequest.Builder> listContributorInsightsRequest)
                                                                  throws ResourceNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

This is a variant of listContributorInsights(software.amazon.awssdk.services.dynamodb.model.ListContributorInsightsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.dynamodb.paginators.ListContributorInsightsIterable responses = client.listContributorInsightsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.dynamodb.paginators.ListContributorInsightsIterable responses = client
             .listContributorInsightsPaginator(request);
     for (software.amazon.awssdk.services.dynamodb.model.ListContributorInsightsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.dynamodb.paginators.ListContributorInsightsIterable responses = client.listContributorInsightsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 via ListContributorInsightsRequest.builder()

Parameters:

listContributorInsightsRequest - A Consumer that will call methods on ListContributorInsightsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listExports

default ListExportsResponse listExports(ListExportsRequest listExportsRequest)
                                 throws LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

Lists completed exports within the past 90 days.

Parameters:

listExportsRequest -

Returns:

Result of the ListExports operation returned by the service.

See Also:

• AWS API Documentation

listExports

default ListExportsResponse listExports(Consumer<ListExportsRequest.Builder> listExportsRequest)
                                 throws LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via ListExportsRequest.builder()

Parameters:

listExportsRequest - A Consumer that will call methods on ListExportsRequest.Builder to create a request.

Returns:

Result of the ListExports operation returned by the service.

See Also:

• AWS API Documentation

listExportsPaginator

default ListExportsIterable listExportsPaginator(ListExportsRequest listExportsRequest)
                                          throws LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

This is a variant of listExports(software.amazon.awssdk.services.dynamodb.model.ListExportsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.dynamodb.paginators.ListExportsIterable responses = client.listExportsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.dynamodb.paginators.ListExportsIterable responses = client.listExportsPaginator(request);
     for (software.amazon.awssdk.services.dynamodb.model.ListExportsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.dynamodb.paginators.ListExportsIterable responses = client.listExportsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listExportsPaginator

default ListExportsIterable listExportsPaginator(Consumer<ListExportsRequest.Builder> listExportsRequest)
                                          throws LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

This is a variant of listExports(software.amazon.awssdk.services.dynamodb.model.ListExportsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.dynamodb.paginators.ListExportsIterable responses = client.listExportsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.dynamodb.paginators.ListExportsIterable responses = client.listExportsPaginator(request);
     for (software.amazon.awssdk.services.dynamodb.model.ListExportsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.dynamodb.paginators.ListExportsIterable responses = client.listExportsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 via ListExportsRequest.builder()

Parameters:

listExportsRequest - A Consumer that will call methods on ListExportsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listGlobalTables

default ListGlobalTablesResponse listGlobalTables(ListGlobalTablesRequest listGlobalTablesRequest)
                                           throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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:

Result of the ListGlobalTables operation returned by the service.

See Also:

• AWS API Documentation

listGlobalTables

default ListGlobalTablesResponse listGlobalTables(Consumer<ListGlobalTablesRequest.Builder> listGlobalTablesRequest)
                                           throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via ListGlobalTablesRequest.builder()

Parameters:

listGlobalTablesRequest - A Consumer that will call methods on ListGlobalTablesRequest.Builder to create a request.

Returns:

Result of the ListGlobalTables operation returned by the service.

See Also:

• AWS API Documentation

listGlobalTables

default ListGlobalTablesResponse listGlobalTables()
                                           throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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:

Result of the ListGlobalTables operation returned by the service.

See Also:

• listGlobalTables(ListGlobalTablesRequest)
• AWS API Documentation

listImports

default ListImportsResponse listImports(ListImportsRequest listImportsRequest)
                                 throws LimitExceededException,
AwsServiceException,
SdkClientException,
DynamoDbException

Lists completed imports within the past 90 days.

Parameters:

listImportsRequest -

Returns:

Result of the ListImports operation returned by the service.

See Also:

• AWS API Documentation

listImports

default ListImportsResponse listImports(Consumer<ListImportsRequest.Builder> listImportsRequest)
                                 throws LimitExceededException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via ListImportsRequest.builder()

Parameters:

listImportsRequest - A Consumer that will call methods on ListImportsRequest.Builder to create a request.

Returns:

Result of the ListImports operation returned by the service.

See Also:

• AWS API Documentation

listImportsPaginator

default ListImportsIterable listImportsPaginator(ListImportsRequest listImportsRequest)
                                          throws LimitExceededException,
AwsServiceException,
SdkClientException,
DynamoDbException

This is a variant of listImports(software.amazon.awssdk.services.dynamodb.model.ListImportsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.dynamodb.paginators.ListImportsIterable responses = client.listImportsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.dynamodb.paginators.ListImportsIterable responses = client.listImportsPaginator(request);
     for (software.amazon.awssdk.services.dynamodb.model.ListImportsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.dynamodb.paginators.ListImportsIterable responses = client.listImportsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listImportsPaginator

default ListImportsIterable listImportsPaginator(Consumer<ListImportsRequest.Builder> listImportsRequest)
                                          throws LimitExceededException,
AwsServiceException,
SdkClientException,
DynamoDbException

This is a variant of listImports(software.amazon.awssdk.services.dynamodb.model.ListImportsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.dynamodb.paginators.ListImportsIterable responses = client.listImportsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.dynamodb.paginators.ListImportsIterable responses = client.listImportsPaginator(request);
     for (software.amazon.awssdk.services.dynamodb.model.ListImportsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.dynamodb.paginators.ListImportsIterable responses = client.listImportsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 via ListImportsRequest.builder()

Parameters:

listImportsRequest - A Consumer that will call methods on ListImportsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTables

default ListTablesResponse listTables(ListTablesRequest listTablesRequest)
                               throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 a ListTables operation.

Returns:

Result of the ListTables operation returned by the service.

See Also:

• AWS API Documentation

listTables

default ListTablesResponse listTables(Consumer<ListTablesRequest.Builder> listTablesRequest)
                               throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via ListTablesRequest.builder()

Parameters:

listTablesRequest - A Consumer that will call methods on ListTablesRequest.Builder to create a request. Represents the input of a ListTables operation.

Returns:

Result of the ListTables operation returned by the service.

See Also:

• AWS API Documentation

listTables

default ListTablesResponse listTables()
                               throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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:

Result of the ListTables operation returned by the service.

See Also:

• listTables(ListTablesRequest)
• AWS API Documentation

listTablesPaginator

default ListTablesIterable listTablesPaginator()
                                        throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

This is a variant of listTables(software.amazon.awssdk.services.dynamodb.model.ListTablesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.dynamodb.paginators.ListTablesIterable responses = client.listTablesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.dynamodb.paginators.ListTablesIterable responses = client.listTablesPaginator(request);
     for (software.amazon.awssdk.services.dynamodb.model.ListTablesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.dynamodb.paginators.ListTablesIterable responses = client.listTablesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• listTablesPaginator(ListTablesRequest)
• AWS API Documentation

listTablesPaginator

default ListTablesIterable listTablesPaginator(ListTablesRequest listTablesRequest)
                                        throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

This is a variant of listTables(software.amazon.awssdk.services.dynamodb.model.ListTablesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.dynamodb.paginators.ListTablesIterable responses = client.listTablesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.dynamodb.paginators.ListTablesIterable responses = client.listTablesPaginator(request);
     for (software.amazon.awssdk.services.dynamodb.model.ListTablesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.dynamodb.paginators.ListTablesIterable responses = client.listTablesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 a ListTables operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTablesPaginator

default ListTablesIterable listTablesPaginator(Consumer<ListTablesRequest.Builder> listTablesRequest)
                                        throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

This is a variant of listTables(software.amazon.awssdk.services.dynamodb.model.ListTablesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.dynamodb.paginators.ListTablesIterable responses = client.listTablesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.dynamodb.paginators.ListTablesIterable responses = client.listTablesPaginator(request);
     for (software.amazon.awssdk.services.dynamodb.model.ListTablesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.dynamodb.paginators.ListTablesIterable responses = client.listTablesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 via ListTablesRequest.builder()

Parameters:

listTablesRequest - A Consumer that will call methods on ListTablesRequest.Builder to create a request. Represents the input of a ListTables operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsOfResource

default ListTagsOfResourceResponse listTagsOfResource(ListTagsOfResourceRequest listTagsOfResourceRequest)
                                               throws ResourceNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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:

Result of the ListTagsOfResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsOfResource

default ListTagsOfResourceResponse listTagsOfResource(Consumer<ListTagsOfResourceRequest.Builder> listTagsOfResourceRequest)
                                               throws ResourceNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via ListTagsOfResourceRequest.builder()

Parameters:

listTagsOfResourceRequest - A Consumer that will call methods on ListTagsOfResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsOfResource operation returned by the service.

See Also:

• AWS API Documentation

putItem

default PutItemResponse putItem(PutItemRequest putItemRequest)
                         throws ConditionalCheckFailedException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ItemCollectionSizeLimitExceededException,
TransactionConflictException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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, the attribute_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 a PutItem operation.

Returns:

Result of the PutItem operation returned by the service.

See Also:

• AWS API Documentation

putItem

default PutItemResponse putItem(Consumer<PutItemRequest.Builder> putItemRequest)
                         throws ConditionalCheckFailedException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ItemCollectionSizeLimitExceededException,
TransactionConflictException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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, the attribute_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 via PutItemRequest.builder()

Parameters:

putItemRequest - A Consumer that will call methods on PutItemRequest.Builder to create a request. Represents the input of a PutItem operation.

Returns:

Result of the PutItem operation returned by the service.

See Also:

• AWS API Documentation

putResourcePolicy

default PutResourcePolicyResponse putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
                                             throws ResourceNotFoundException,
InternalServerErrorException,
LimitExceededException,
PolicyNotFoundException,
ResourceInUseException,
AwsServiceException,
SdkClientException,
DynamoDbException

Attaches a resource-based policy document to the resource, which can be a table or stream. When you attach a resource-based policy using this API, the policy application is eventually consistent .

PutResourcePolicy is an idempotent operation; running it multiple times on the same resource using the same policy document will return the same revision ID. If you specify an ExpectedRevisionId which doesn't match the current policy's RevisionId, the PolicyNotFoundException will be returned.

PutResourcePolicy is an asynchronous operation. If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return your previous policy, if there was one, or return the PolicyNotFoundException. This is because GetResourcePolicy uses an eventually consistent query, and the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then try the GetResourcePolicy request again.

Parameters:

putResourcePolicyRequest -

Returns:

Result of the PutResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

putResourcePolicy

default PutResourcePolicyResponse putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)
                                             throws ResourceNotFoundException,
InternalServerErrorException,
LimitExceededException,
PolicyNotFoundException,
ResourceInUseException,
AwsServiceException,
SdkClientException,
DynamoDbException

Attaches a resource-based policy document to the resource, which can be a table or stream. When you attach a resource-based policy using this API, the policy application is eventually consistent .

PutResourcePolicy is an idempotent operation; running it multiple times on the same resource using the same policy document will return the same revision ID. If you specify an ExpectedRevisionId which doesn't match the current policy's RevisionId, the PolicyNotFoundException will be returned.

PutResourcePolicy is an asynchronous operation. If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return your previous policy, if there was one, or return the PolicyNotFoundException. This is because GetResourcePolicy uses an eventually consistent query, and the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then try the GetResourcePolicy request again.

This is a convenience which creates an instance of the PutResourcePolicyRequest.Builder avoiding the need to create one manually via PutResourcePolicyRequest.builder()

Parameters:

putResourcePolicyRequest - A Consumer that will call methods on PutResourcePolicyRequest.Builder to create a request.

Returns:

Result of the PutResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

query

default QueryResponse query(QueryRequest queryRequest)
                     throws ProvisionedThroughputExceededException,
ResourceNotFoundException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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. The Query operation will return all of the items from the table or index with that partition key value. You can optionally narrow the scope of the Query operation by specifying a sort key value and a comparison operator in KeyConditionExpression. To further refine the Query results, you can optionally provide a FilterExpression. A FilterExpression 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 the ScanIndexForward parameter to false.

A single Query operation will read up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using FilterExpression. If LastEvaluatedKey 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 a Query finishes, but before the results are returned. A FilterExpression cannot contain partition key or sort key attributes. You need to specify those attributes in the KeyConditionExpression.

A Query operation can return an empty result set and a LastEvaluatedKey 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 to true and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify ConsistentRead when querying a global secondary index.

Parameters:

queryRequest - Represents the input of a Query operation.

Returns:

Result of the Query operation returned by the service.

See Also:

• AWS API Documentation

query

default QueryResponse query(Consumer<QueryRequest.Builder> queryRequest)
                     throws ProvisionedThroughputExceededException,
ResourceNotFoundException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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. The Query operation will return all of the items from the table or index with that partition key value. You can optionally narrow the scope of the Query operation by specifying a sort key value and a comparison operator in KeyConditionExpression. To further refine the Query results, you can optionally provide a FilterExpression. A FilterExpression 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 the ScanIndexForward parameter to false.

A single Query operation will read up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using FilterExpression. If LastEvaluatedKey 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 a Query finishes, but before the results are returned. A FilterExpression cannot contain partition key or sort key attributes. You need to specify those attributes in the KeyConditionExpression.

A Query operation can return an empty result set and a LastEvaluatedKey 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 to true and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify ConsistentRead 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 via QueryRequest.builder()

Parameters:

queryRequest - A Consumer that will call methods on QueryRequest.Builder to create a request. Represents the input of a Query operation.

Returns:

Result of the Query operation returned by the service.

See Also:

• AWS API Documentation

queryPaginator

default QueryIterable queryPaginator(QueryRequest queryRequest)
                              throws ProvisionedThroughputExceededException,
ResourceNotFoundException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

This is a variant of query(software.amazon.awssdk.services.dynamodb.model.QueryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.dynamodb.paginators.QueryIterable responses = client.queryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.dynamodb.paginators.QueryIterable responses = client.queryPaginator(request);
     for (software.amazon.awssdk.services.dynamodb.model.QueryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.dynamodb.paginators.QueryIterable responses = client.queryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 a Query operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

queryPaginator

default QueryIterable queryPaginator(Consumer<QueryRequest.Builder> queryRequest)
                              throws ProvisionedThroughputExceededException,
ResourceNotFoundException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

This is a variant of query(software.amazon.awssdk.services.dynamodb.model.QueryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.dynamodb.paginators.QueryIterable responses = client.queryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.dynamodb.paginators.QueryIterable responses = client.queryPaginator(request);
     for (software.amazon.awssdk.services.dynamodb.model.QueryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.dynamodb.paginators.QueryIterable responses = client.queryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 via QueryRequest.builder()

Parameters:

queryRequest - A Consumer that will call methods on QueryRequest.Builder to create a request. Represents the input of a Query operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

restoreTableFromBackup

default RestoreTableFromBackupResponse restoreTableFromBackup(RestoreTableFromBackupRequest restoreTableFromBackupRequest)
                                                       throws TableAlreadyExistsException,
TableInUseException,
BackupNotFoundException,
BackupInUseException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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:

Result of the RestoreTableFromBackup operation returned by the service.

See Also:

• AWS API Documentation

restoreTableFromBackup

default RestoreTableFromBackupResponse restoreTableFromBackup(Consumer<RestoreTableFromBackupRequest.Builder> restoreTableFromBackupRequest)
                                                       throws TableAlreadyExistsException,
TableInUseException,
BackupNotFoundException,
BackupInUseException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via RestoreTableFromBackupRequest.builder()

Parameters:

restoreTableFromBackupRequest - A Consumer that will call methods on RestoreTableFromBackupRequest.Builder to create a request.

Returns:

Result of the RestoreTableFromBackup operation returned by the service.

See Also:

• AWS API Documentation

restoreTableToPointInTime

default RestoreTableToPointInTimeResponse restoreTableToPointInTime(RestoreTableToPointInTimeRequest restoreTableToPointInTimeRequest)
                                                             throws TableAlreadyExistsException,
TableNotFoundException,
TableInUseException,
LimitExceededException,
InvalidRestoreTimeException,
PointInTimeRecoveryUnavailableException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

Restores the specified table to the specified point in time within EarliestRestorableDateTime and LatestRestorableDateTime. 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:

Result of the RestoreTableToPointInTime operation returned by the service.

See Also:

• AWS API Documentation

restoreTableToPointInTime

default RestoreTableToPointInTimeResponse restoreTableToPointInTime(Consumer<RestoreTableToPointInTimeRequest.Builder> restoreTableToPointInTimeRequest)
                                                             throws TableAlreadyExistsException,
TableNotFoundException,
TableInUseException,
LimitExceededException,
InvalidRestoreTimeException,
PointInTimeRecoveryUnavailableException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

Restores the specified table to the specified point in time within EarliestRestorableDateTime and LatestRestorableDateTime. 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 via RestoreTableToPointInTimeRequest.builder()

Parameters:

restoreTableToPointInTimeRequest - A Consumer that will call methods on RestoreTableToPointInTimeRequest.Builder to create a request.

Returns:

Result of the RestoreTableToPointInTime operation returned by the service.

See Also:

• AWS API Documentation

scan

default ScanResponse scan(ScanRequest scanRequest)
                   throws ProvisionedThroughputExceededException,
ResourceNotFoundException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 a FilterExpression 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 the LastEvaluatedKey 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 a FilterExpression , a scan result can result in no items meeting the criteria and the Count will result in zero. If you did not use a FilterExpression in the scan request, then Count is the same as ScannedCount.

Count and ScannedCount 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 the Limit parameter) or a maximum of 1 MB of data and then applies any filtering to the results if a FilterExpression is provided. If LastEvaluatedKey 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 parallel Scan operation by providing the Segment and TotalSegments 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 consistent Scan 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 the ConsistentRead 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 a Scan operation.

Returns:

Result of the Scan operation returned by the service.

See Also:

• AWS API Documentation

scan

default ScanResponse scan(Consumer<ScanRequest.Builder> scanRequest)
                   throws ProvisionedThroughputExceededException,
ResourceNotFoundException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 a FilterExpression 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 the LastEvaluatedKey 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 a FilterExpression , a scan result can result in no items meeting the criteria and the Count will result in zero. If you did not use a FilterExpression in the scan request, then Count is the same as ScannedCount.

Count and ScannedCount 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 the Limit parameter) or a maximum of 1 MB of data and then applies any filtering to the results if a FilterExpression is provided. If LastEvaluatedKey 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 parallel Scan operation by providing the Segment and TotalSegments 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 consistent Scan 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 the ConsistentRead 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 via ScanRequest.builder()

Parameters:

scanRequest - A Consumer that will call methods on ScanRequest.Builder to create a request. Represents the input of a Scan operation.

Returns:

Result of the Scan operation returned by the service.

See Also:

• AWS API Documentation

scanPaginator

default ScanIterable scanPaginator(ScanRequest scanRequest)
                            throws ProvisionedThroughputExceededException,
ResourceNotFoundException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

This is a variant of scan(software.amazon.awssdk.services.dynamodb.model.ScanRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.dynamodb.paginators.ScanIterable responses = client.scanPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.dynamodb.paginators.ScanIterable responses = client.scanPaginator(request);
     for (software.amazon.awssdk.services.dynamodb.model.ScanResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.dynamodb.paginators.ScanIterable responses = client.scanPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 a Scan operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

scanPaginator

default ScanIterable scanPaginator(Consumer<ScanRequest.Builder> scanRequest)
                            throws ProvisionedThroughputExceededException,
ResourceNotFoundException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

This is a variant of scan(software.amazon.awssdk.services.dynamodb.model.ScanRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.dynamodb.paginators.ScanIterable responses = client.scanPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.dynamodb.paginators.ScanIterable responses = client.scanPaginator(request);
     for (software.amazon.awssdk.services.dynamodb.model.ScanResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.dynamodb.paginators.ScanIterable responses = client.scanPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 via ScanRequest.builder()

Parameters:

scanRequest - A Consumer that will call methods on ScanRequest.Builder to create a request. Represents the input of a Scan operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws LimitExceededException,
ResourceNotFoundException,
InternalServerErrorException,
ResourceInUseException,
AwsServiceException,
SdkClientException,
DynamoDbException

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:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws LimitExceededException,
ResourceNotFoundException,
InternalServerErrorException,
ResourceInUseException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

transactGetItems

default TransactGetItemsResponse transactGetItems(TransactGetItemsRequest transactGetItemsRequest)
                                           throws ResourceNotFoundException,
TransactionCanceledException,
ProvisionedThroughputExceededException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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. A TransactGetItems call can contain up to 100 TransactGetItem objects, each of which contains a Get structure that specifies an item to retrieve from a table in the account and Region. A call to TransactGetItems 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:

Result of the TransactGetItems operation returned by the service.

See Also:

• AWS API Documentation

transactGetItems

default TransactGetItemsResponse transactGetItems(Consumer<TransactGetItemsRequest.Builder> transactGetItemsRequest)
                                           throws ResourceNotFoundException,
TransactionCanceledException,
ProvisionedThroughputExceededException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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. A TransactGetItems call can contain up to 100 TransactGetItem objects, each of which contains a Get structure that specifies an item to retrieve from a table in the account and Region. A call to TransactGetItems 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 via TransactGetItemsRequest.builder()

Parameters:

transactGetItemsRequest - A Consumer that will call methods on TransactGetItemsRequest.Builder to create a request.

Returns:

Result of the TransactGetItems operation returned by the service.

See Also:

• AWS API Documentation

transactWriteItems

default TransactWriteItemsResponse transactWriteItems(TransactWriteItemsRequest transactWriteItemsRequest)
                                               throws ResourceNotFoundException,
TransactionCanceledException,
TransactionInProgressException,
IdempotentParameterMismatchException,
ProvisionedThroughputExceededException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 both ConditionCheck and Update 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 a PutItem 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 an UpdateItem 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 a DeleteItem 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:

Result of the TransactWriteItems operation returned by the service.

See Also:

• AWS API Documentation

transactWriteItems

default TransactWriteItemsResponse transactWriteItems(Consumer<TransactWriteItemsRequest.Builder> transactWriteItemsRequest)
                                               throws ResourceNotFoundException,
TransactionCanceledException,
TransactionInProgressException,
IdempotentParameterMismatchException,
ProvisionedThroughputExceededException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 both ConditionCheck and Update 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 a PutItem 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 an UpdateItem 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 a DeleteItem 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 via TransactWriteItemsRequest.builder()

Parameters:

transactWriteItemsRequest - A Consumer that will call methods on TransactWriteItemsRequest.Builder to create a request.

Returns:

Result of the TransactWriteItems operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws LimitExceededException,
ResourceNotFoundException,
InternalServerErrorException,
ResourceInUseException,
AwsServiceException,
SdkClientException,
DynamoDbException

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:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws LimitExceededException,
ResourceNotFoundException,
InternalServerErrorException,
ResourceInUseException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateContinuousBackups

default UpdateContinuousBackupsResponse updateContinuousBackups(UpdateContinuousBackupsRequest updateContinuousBackupsRequest)
                                                         throws TableNotFoundException,
ContinuousBackupsUnavailableException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

UpdateContinuousBackups enables or disables point in time recovery for the specified table. A successful UpdateContinuousBackups call returns the current ContinuousBackupsDescription. Continuous backups are ENABLED 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 and LatestRestorableDateTime.

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:

Result of the UpdateContinuousBackups operation returned by the service.

See Also:

• AWS API Documentation

updateContinuousBackups

default UpdateContinuousBackupsResponse updateContinuousBackups(Consumer<UpdateContinuousBackupsRequest.Builder> updateContinuousBackupsRequest)
                                                         throws TableNotFoundException,
ContinuousBackupsUnavailableException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

UpdateContinuousBackups enables or disables point in time recovery for the specified table. A successful UpdateContinuousBackups call returns the current ContinuousBackupsDescription. Continuous backups are ENABLED 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 and LatestRestorableDateTime.

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 via UpdateContinuousBackupsRequest.builder()

Parameters:

updateContinuousBackupsRequest - A Consumer that will call methods on UpdateContinuousBackupsRequest.Builder to create a request.

Returns:

Result of the UpdateContinuousBackups operation returned by the service.

See Also:

• AWS API Documentation

updateContributorInsights

default UpdateContributorInsightsResponse updateContributorInsights(UpdateContributorInsightsRequest updateContributorInsightsRequest)
                                                             throws ResourceNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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:

Result of the UpdateContributorInsights operation returned by the service.

See Also:

• AWS API Documentation

updateContributorInsights

default UpdateContributorInsightsResponse updateContributorInsights(Consumer<UpdateContributorInsightsRequest.Builder> updateContributorInsightsRequest)
                                                             throws ResourceNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via UpdateContributorInsightsRequest.builder()

Parameters:

updateContributorInsightsRequest - A Consumer that will call methods on UpdateContributorInsightsRequest.Builder to create a request.

Returns:

Result of the UpdateContributorInsights operation returned by the service.

See Also:

• AWS API Documentation

updateGlobalTable

default UpdateGlobalTableResponse updateGlobalTable(UpdateGlobalTableRequest updateGlobalTableRequest)
                                             throws InternalServerErrorException,
GlobalTableNotFoundException,
ReplicaAlreadyExistsException,
ReplicaNotFoundException,
TableNotFoundException,
AwsServiceException,
SdkClientException,
DynamoDbException

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:

Result of the UpdateGlobalTable operation returned by the service.

See Also:

• AWS API Documentation

updateGlobalTable

default UpdateGlobalTableResponse updateGlobalTable(Consumer<UpdateGlobalTableRequest.Builder> updateGlobalTableRequest)
                                             throws InternalServerErrorException,
GlobalTableNotFoundException,
ReplicaAlreadyExistsException,
ReplicaNotFoundException,
TableNotFoundException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via UpdateGlobalTableRequest.builder()

Parameters:

updateGlobalTableRequest - A Consumer that will call methods on UpdateGlobalTableRequest.Builder to create a request.

Returns:

Result of the UpdateGlobalTable operation returned by the service.

See Also:

• AWS API Documentation

updateGlobalTableSettings

default UpdateGlobalTableSettingsResponse updateGlobalTableSettings(UpdateGlobalTableSettingsRequest updateGlobalTableSettingsRequest)
                                                             throws GlobalTableNotFoundException,
ReplicaNotFoundException,
IndexNotFoundException,
LimitExceededException,
ResourceInUseException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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:

Result of the UpdateGlobalTableSettings operation returned by the service.

See Also:

• AWS API Documentation

updateGlobalTableSettings

default UpdateGlobalTableSettingsResponse updateGlobalTableSettings(Consumer<UpdateGlobalTableSettingsRequest.Builder> updateGlobalTableSettingsRequest)
                                                             throws GlobalTableNotFoundException,
ReplicaNotFoundException,
IndexNotFoundException,
LimitExceededException,
ResourceInUseException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via UpdateGlobalTableSettingsRequest.builder()

Parameters:

updateGlobalTableSettingsRequest - A Consumer that will call methods on UpdateGlobalTableSettingsRequest.Builder to create a request.

Returns:

Result of the UpdateGlobalTableSettings operation returned by the service.

See Also:

• AWS API Documentation

updateItem

default UpdateItemResponse updateItem(UpdateItemRequest updateItemRequest)
                               throws ConditionalCheckFailedException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ItemCollectionSizeLimitExceededException,
TransactionConflictException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 the ReturnValues parameter.

Parameters:

updateItemRequest - Represents the input of an UpdateItem operation.

Returns:

Result of the UpdateItem operation returned by the service.

See Also:

• AWS API Documentation

updateItem

default UpdateItemResponse updateItem(Consumer<UpdateItemRequest.Builder> updateItemRequest)
                               throws ConditionalCheckFailedException,
ProvisionedThroughputExceededException,
ResourceNotFoundException,
ItemCollectionSizeLimitExceededException,
TransactionConflictException,
RequestLimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 the ReturnValues parameter.

This is a convenience which creates an instance of the UpdateItemRequest.Builder avoiding the need to create one manually via UpdateItemRequest.builder()

Parameters:

updateItemRequest - A Consumer that will call methods on UpdateItemRequest.Builder to create a request. Represents the input of an UpdateItem operation.

Returns:

Result of the UpdateItem operation returned by the service.

See Also:

• AWS API Documentation

updateKinesisStreamingDestination

default UpdateKinesisStreamingDestinationResponse updateKinesisStreamingDestination(UpdateKinesisStreamingDestinationRequest updateKinesisStreamingDestinationRequest)
                                                                             throws InternalServerErrorException,
LimitExceededException,
ResourceInUseException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DynamoDbException

The command to update the Kinesis stream destination.

Parameters:

updateKinesisStreamingDestinationRequest -

Returns:

Result of the UpdateKinesisStreamingDestination operation returned by the service.

See Also:

• AWS API Documentation

updateKinesisStreamingDestination

default UpdateKinesisStreamingDestinationResponse updateKinesisStreamingDestination(Consumer<UpdateKinesisStreamingDestinationRequest.Builder> updateKinesisStreamingDestinationRequest)
                                                                             throws InternalServerErrorException,
LimitExceededException,
ResourceInUseException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via UpdateKinesisStreamingDestinationRequest.builder()

Parameters:

updateKinesisStreamingDestinationRequest - A Consumer that will call methods on UpdateKinesisStreamingDestinationRequest.Builder to create a request.

Returns:

Result of the UpdateKinesisStreamingDestination operation returned by the service.

See Also:

• AWS API Documentation

updateTable

default UpdateTableResponse updateTable(UpdateTableRequest updateTableRequest)
                                 throws ResourceInUseException,
ResourceNotFoundException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 from ACTIVE to UPDATING. While it's UPDATING, you can't issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete.

Parameters:

updateTableRequest - Represents the input of an UpdateTable operation.

Returns:

Result of the UpdateTable operation returned by the service.

See Also:

• AWS API Documentation

updateTable

default UpdateTableResponse updateTable(Consumer<UpdateTableRequest.Builder> updateTableRequest)
                                 throws ResourceInUseException,
ResourceNotFoundException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 from ACTIVE to UPDATING. While it's UPDATING, you can't issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete.

This is a convenience which creates an instance of the UpdateTableRequest.Builder avoiding the need to create one manually via UpdateTableRequest.builder()

Parameters:

updateTableRequest - A Consumer that will call methods on UpdateTableRequest.Builder to create a request. Represents the input of an UpdateTable operation.

Returns:

Result of the UpdateTable operation returned by the service.

See Also:

• AWS API Documentation

updateTableReplicaAutoScaling

default UpdateTableReplicaAutoScalingResponse updateTableReplicaAutoScaling(UpdateTableReplicaAutoScalingRequest updateTableReplicaAutoScalingRequest)
                                                                     throws ResourceNotFoundException,
ResourceInUseException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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:

Result of the UpdateTableReplicaAutoScaling operation returned by the service.

See Also:

• AWS API Documentation

updateTableReplicaAutoScaling

default UpdateTableReplicaAutoScalingResponse updateTableReplicaAutoScaling(Consumer<UpdateTableReplicaAutoScalingRequest.Builder> updateTableReplicaAutoScalingRequest)
                                                                     throws ResourceNotFoundException,
ResourceInUseException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

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 via UpdateTableReplicaAutoScalingRequest.builder()

Parameters:

updateTableReplicaAutoScalingRequest - A Consumer that will call methods on UpdateTableReplicaAutoScalingRequest.Builder to create a request.

Returns:

Result of the UpdateTableReplicaAutoScaling operation returned by the service.

See Also:

• AWS API Documentation

updateTimeToLive

default UpdateTimeToLiveResponse updateTimeToLive(UpdateTimeToLiveRequest updateTimeToLiveRequest)
                                           throws ResourceInUseException,
ResourceNotFoundException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

The UpdateTimeToLive method enables or disables Time to Live (TTL) for the specified table. A successful UpdateTimeToLive call returns the current TimeToLiveSpecification. It can take up to one hour for the change to fully process. Any additional UpdateTimeToLive calls for the same table during this one hour duration result in a ValidationException.

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 an UpdateTimeToLive operation.

Returns:

Result of the UpdateTimeToLive operation returned by the service.

See Also:

• AWS API Documentation

updateTimeToLive

default UpdateTimeToLiveResponse updateTimeToLive(Consumer<UpdateTimeToLiveRequest.Builder> updateTimeToLiveRequest)
                                           throws ResourceInUseException,
ResourceNotFoundException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
DynamoDbException

The UpdateTimeToLive method enables or disables Time to Live (TTL) for the specified table. A successful UpdateTimeToLive call returns the current TimeToLiveSpecification. It can take up to one hour for the change to fully process. Any additional UpdateTimeToLive calls for the same table during this one hour duration result in a ValidationException.

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 via UpdateTimeToLiveRequest.builder()

Parameters:

updateTimeToLiveRequest - A Consumer that will call methods on UpdateTimeToLiveRequest.Builder to create a request. Represents the input of an UpdateTimeToLive operation.

Returns:

Result of the UpdateTimeToLive operation returned by the service.

See Also:

• AWS API Documentation

waiter

default DynamoDbWaiter waiter()

Create an instance of DynamoDbWaiter 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 DynamoDbWaiter

create

static DynamoDbClient create()

Create a DynamoDbClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static DynamoDbClientBuilder builder()

Create a builder that can be used to configure and create a DynamoDbClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default DynamoDbServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration