@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonDynamoDB extends Object implements AmazonDynamoDB
AmazonDynamoDB. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
BatchExecuteStatementResult |
batchExecuteStatement(BatchExecuteStatementRequest request)
This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL.
|
BatchGetItemResult |
batchGetItem(BatchGetItemRequest request)
The
BatchGetItem operation returns the attributes of one or more items from one or more tables. |
BatchGetItemResult |
batchGetItem(Map<String,KeysAndAttributes> requestItems)
Simplified method form for invoking the BatchGetItem operation.
|
BatchGetItemResult |
batchGetItem(Map<String,KeysAndAttributes> requestItems,
String returnConsumedCapacity)
Simplified method form for invoking the BatchGetItem operation.
|
BatchWriteItemResult |
batchWriteItem(BatchWriteItemRequest request)
The
BatchWriteItem operation puts or deletes multiple items in one or more tables. |
BatchWriteItemResult |
batchWriteItem(Map<String,List<WriteRequest>> requestItems)
Simplified method form for invoking the BatchWriteItem operation.
|
CreateBackupResult |
createBackup(CreateBackupRequest request)
Creates a backup for an existing table.
|
CreateGlobalTableResult |
createGlobalTable(CreateGlobalTableRequest request)
Creates a global table from an existing table.
|
CreateTableResult |
createTable(CreateTableRequest request)
The
CreateTable operation adds a new table to your account. |
CreateTableResult |
createTable(List<AttributeDefinition> attributeDefinitions,
String tableName,
List<KeySchemaElement> keySchema,
ProvisionedThroughput provisionedThroughput)
Simplified method form for invoking the CreateTable operation.
|
DeleteBackupResult |
deleteBackup(DeleteBackupRequest request)
Deletes an existing backup of a table.
|
DeleteItemResult |
deleteItem(DeleteItemRequest request)
Deletes a single item in a table by primary key.
|
DeleteItemResult |
deleteItem(String tableName,
Map<String,AttributeValue> key)
Simplified method form for invoking the DeleteItem operation.
|
DeleteItemResult |
deleteItem(String tableName,
Map<String,AttributeValue> key,
String returnValues)
Simplified method form for invoking the DeleteItem operation.
|
DeleteTableResult |
deleteTable(DeleteTableRequest request)
The
DeleteTable operation deletes a table and all of its items. |
DeleteTableResult |
deleteTable(String tableName)
Simplified method form for invoking the DeleteTable operation.
|
DescribeBackupResult |
describeBackup(DescribeBackupRequest request)
Describes an existing backup of a table.
|
DescribeContinuousBackupsResult |
describeContinuousBackups(DescribeContinuousBackupsRequest request)
Checks the status of continuous backups and point in time recovery on the specified table.
|
DescribeContributorInsightsResult |
describeContributorInsights(DescribeContributorInsightsRequest request)
Returns information about contributor insights for a given table or global secondary index.
|
DescribeEndpointsResult |
describeEndpoints(DescribeEndpointsRequest request)
Returns the regional endpoint information.
|
DescribeExportResult |
describeExport(DescribeExportRequest request)
Describes an existing table export.
|
DescribeGlobalTableResult |
describeGlobalTable(DescribeGlobalTableRequest request)
Returns information about the specified global table.
|
DescribeGlobalTableSettingsResult |
describeGlobalTableSettings(DescribeGlobalTableSettingsRequest request)
Describes Region-specific settings for a global table.
|
DescribeImportResult |
describeImport(DescribeImportRequest request)
Represents the properties of the import.
|
DescribeKinesisStreamingDestinationResult |
describeKinesisStreamingDestination(DescribeKinesisStreamingDestinationRequest request)
Returns information about the status of Kinesis streaming.
|
DescribeLimitsResult |
describeLimits(DescribeLimitsRequest request)
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.
|
DescribeTableResult |
describeTable(DescribeTableRequest request)
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.
|
DescribeTableResult |
describeTable(String tableName)
Simplified method form for invoking the DescribeTable operation.
|
DescribeTableReplicaAutoScalingResult |
describeTableReplicaAutoScaling(DescribeTableReplicaAutoScalingRequest request)
Describes auto scaling settings across replicas of the global table at once.
|
DescribeTimeToLiveResult |
describeTimeToLive(DescribeTimeToLiveRequest request)
Gives a description of the Time to Live (TTL) status on the specified table.
|
DisableKinesisStreamingDestinationResult |
disableKinesisStreamingDestination(DisableKinesisStreamingDestinationRequest request)
Stops replication from the DynamoDB table to the Kinesis data stream.
|
EnableKinesisStreamingDestinationResult |
enableKinesisStreamingDestination(EnableKinesisStreamingDestinationRequest request)
Starts table data replication to the specified Kinesis data stream at a timestamp chosen during the enable
workflow.
|
ExecuteStatementResult |
executeStatement(ExecuteStatementRequest request)
This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL.
|
ExecuteTransactionResult |
executeTransaction(ExecuteTransactionRequest request)
This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL.
|
ExportTableToPointInTimeResult |
exportTableToPointInTime(ExportTableToPointInTimeRequest request)
Exports table data to an S3 bucket.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetItemResult |
getItem(GetItemRequest request)
The
GetItem operation returns a set of attributes for the item with the given primary key. |
GetItemResult |
getItem(String tableName,
Map<String,AttributeValue> key)
Simplified method form for invoking the GetItem operation.
|
GetItemResult |
getItem(String tableName,
Map<String,AttributeValue> key,
Boolean consistentRead)
Simplified method form for invoking the GetItem operation.
|
ImportTableResult |
importTable(ImportTableRequest request)
Imports table data from an S3 bucket.
|
ListBackupsResult |
listBackups(ListBackupsRequest request)
List DynamoDB backups that are associated with an Amazon Web Services account and weren't made with Amazon Web
Services Backup.
|
ListContributorInsightsResult |
listContributorInsights(ListContributorInsightsRequest request)
Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes.
|
ListExportsResult |
listExports(ListExportsRequest request)
Lists completed exports within the past 90 days.
|
ListGlobalTablesResult |
listGlobalTables(ListGlobalTablesRequest request)
Lists all global tables that have a replica in the specified Region.
|
ListImportsResult |
listImports(ListImportsRequest request)
Lists completed imports within the past 90 days.
|
ListTablesResult |
listTables()
Simplified method form for invoking the ListTables operation.
|
ListTablesResult |
listTables(Integer limit)
Simplified method form for invoking the ListTables operation.
|
ListTablesResult |
listTables(ListTablesRequest request)
Returns an array of table names associated with the current account and endpoint.
|
ListTablesResult |
listTables(String exclusiveStartTableName)
Simplified method form for invoking the ListTables operation.
|
ListTablesResult |
listTables(String exclusiveStartTableName,
Integer limit)
Simplified method form for invoking the ListTables operation.
|
ListTagsOfResourceResult |
listTagsOfResource(ListTagsOfResourceRequest request)
List all tags on an Amazon DynamoDB resource.
|
PutItemResult |
putItem(PutItemRequest request)
Creates a new item, or replaces an old item with a new item.
|
PutItemResult |
putItem(String tableName,
Map<String,AttributeValue> item)
Simplified method form for invoking the PutItem operation.
|
PutItemResult |
putItem(String tableName,
Map<String,AttributeValue> item,
String returnValues)
Simplified method form for invoking the PutItem operation.
|
QueryResult |
query(QueryRequest request)
You must provide the name of the partition key attribute and a single value for that attribute.
|
RestoreTableFromBackupResult |
restoreTableFromBackup(RestoreTableFromBackupRequest request)
Creates a new table from an existing backup.
|
RestoreTableToPointInTimeResult |
restoreTableToPointInTime(RestoreTableToPointInTimeRequest request)
Restores the specified table to the specified point in time within
EarliestRestorableDateTime and
LatestRestorableDateTime. |
ScanResult |
scan(ScanRequest request)
The
Scan operation returns one or more items and item attributes by accessing every item in a table
or a secondary index. |
ScanResult |
scan(String tableName,
List<String> attributesToGet)
Simplified method form for invoking the Scan operation.
|
ScanResult |
scan(String tableName,
List<String> attributesToGet,
Map<String,Condition> scanFilter)
Simplified method form for invoking the Scan operation.
|
ScanResult |
scan(String tableName,
Map<String,Condition> scanFilter)
Simplified method form for invoking the Scan operation.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://dynamodb.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AmazonDynamoDB.setEndpoint(String), sets the regional endpoint for this client's
service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Associate a set of tags with an Amazon DynamoDB resource.
|
TransactGetItemsResult |
transactGetItems(TransactGetItemsRequest request)
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. |
TransactWriteItemsResult |
transactWriteItems(TransactWriteItemsRequest request)
TransactWriteItems is a synchronous write operation that groups up to 100 action requests. |
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes the association of tags from an Amazon DynamoDB resource.
|
UpdateContinuousBackupsResult |
updateContinuousBackups(UpdateContinuousBackupsRequest request)
UpdateContinuousBackups enables or disables point in time recovery for the specified table. |
UpdateContributorInsightsResult |
updateContributorInsights(UpdateContributorInsightsRequest request)
Updates the status for contributor insights for a specific table or index.
|
UpdateGlobalTableResult |
updateGlobalTable(UpdateGlobalTableRequest request)
Adds or removes replicas in the specified global table.
|
UpdateGlobalTableSettingsResult |
updateGlobalTableSettings(UpdateGlobalTableSettingsRequest request)
Updates settings for a global table.
|
UpdateItemResult |
updateItem(String tableName,
Map<String,AttributeValue> key,
Map<String,AttributeValueUpdate> attributeUpdates)
Simplified method form for invoking the UpdateItem operation.
|
UpdateItemResult |
updateItem(String tableName,
Map<String,AttributeValue> key,
Map<String,AttributeValueUpdate> attributeUpdates,
String returnValues)
Simplified method form for invoking the UpdateItem operation.
|
UpdateItemResult |
updateItem(UpdateItemRequest request)
Edits an existing item's attributes, or adds a new item to the table if it does not already exist.
|
UpdateTableResult |
updateTable(String tableName,
ProvisionedThroughput provisionedThroughput)
Simplified method form for invoking the UpdateTable operation.
|
UpdateTableResult |
updateTable(UpdateTableRequest request)
Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given
table.
|
UpdateTableReplicaAutoScalingResult |
updateTableReplicaAutoScaling(UpdateTableReplicaAutoScalingRequest request)
Updates auto scaling settings on your global tables at once.
|
UpdateTimeToLiveResult |
updateTimeToLive(UpdateTimeToLiveRequest request)
The
UpdateTimeToLive method enables or disables Time to Live (TTL) for the specified table. |
AmazonDynamoDBWaiters |
waiters() |
public void setEndpoint(String endpoint)
AmazonDynamoDB
Callers can pass in just the endpoint (ex: "dynamodb.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "https://dynamodb.us-east-1.amazonaws.com"). If the protocol is not specified here, the default
protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint in interface AmazonDynamoDBendpoint - The endpoint (ex: "dynamodb.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://dynamodb.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will
communicate with.public void setRegion(Region region)
AmazonDynamoDBAmazonDynamoDB.setEndpoint(String), sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion in interface AmazonDynamoDBregion - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)public BatchExecuteStatementResult batchExecuteStatement(BatchExecuteStatementRequest request)
AmazonDynamoDB
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.
batchExecuteStatement in interface AmazonDynamoDBpublic BatchGetItemResult batchGetItem(BatchGetItemRequest request)
AmazonDynamoDB
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.
batchGetItem in interface AmazonDynamoDBrequest - Represents the input of a BatchGetItem operation.public BatchGetItemResult batchGetItem(Map<String,KeysAndAttributes> requestItems, String returnConsumedCapacity)
AmazonDynamoDBbatchGetItem in interface AmazonDynamoDBAmazonDynamoDB.batchGetItem(BatchGetItemRequest)public BatchGetItemResult batchGetItem(Map<String,KeysAndAttributes> requestItems)
AmazonDynamoDBbatchGetItem in interface AmazonDynamoDBAmazonDynamoDB.batchGetItem(BatchGetItemRequest)public BatchWriteItemResult batchWriteItem(BatchWriteItemRequest request)
AmazonDynamoDB
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.
batchWriteItem in interface AmazonDynamoDBrequest - Represents the input of a BatchWriteItem operation.public BatchWriteItemResult batchWriteItem(Map<String,List<WriteRequest>> requestItems)
AmazonDynamoDBbatchWriteItem in interface AmazonDynamoDBAmazonDynamoDB.batchWriteItem(BatchWriteItemRequest)public CreateBackupResult createBackup(CreateBackupRequest request)
AmazonDynamoDBCreates 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
createBackup in interface AmazonDynamoDBpublic CreateGlobalTableResult createGlobalTable(CreateGlobalTableRequest request)
AmazonDynamoDBCreates 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.
createGlobalTable in interface AmazonDynamoDBpublic CreateTableResult createTable(CreateTableRequest request)
AmazonDynamoDB
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.
createTable in interface AmazonDynamoDBrequest - Represents the input of a CreateTable operation.public CreateTableResult createTable(List<AttributeDefinition> attributeDefinitions, String tableName, List<KeySchemaElement> keySchema, ProvisionedThroughput provisionedThroughput)
AmazonDynamoDBcreateTable in interface AmazonDynamoDBAmazonDynamoDB.createTable(CreateTableRequest)public DeleteBackupResult deleteBackup(DeleteBackupRequest request)
AmazonDynamoDBDeletes an existing backup of a table.
You can call DeleteBackup at a maximum rate of 10 times per second.
deleteBackup in interface AmazonDynamoDBpublic DeleteItemResult deleteItem(DeleteItemRequest request)
AmazonDynamoDBDeletes 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.
deleteItem in interface AmazonDynamoDBrequest - Represents the input of a DeleteItem operation.public DeleteItemResult deleteItem(String tableName, Map<String,AttributeValue> key)
AmazonDynamoDBdeleteItem in interface AmazonDynamoDBAmazonDynamoDB.deleteItem(DeleteItemRequest)public DeleteItemResult deleteItem(String tableName, Map<String,AttributeValue> key, String returnValues)
AmazonDynamoDBdeleteItem in interface AmazonDynamoDBAmazonDynamoDB.deleteItem(DeleteItemRequest)public DeleteTableResult deleteTable(DeleteTableRequest request)
AmazonDynamoDB
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.
deleteTable in interface AmazonDynamoDBrequest - Represents the input of a DeleteTable operation.public DeleteTableResult deleteTable(String tableName)
AmazonDynamoDBdeleteTable in interface AmazonDynamoDBAmazonDynamoDB.deleteTable(DeleteTableRequest)public DescribeBackupResult describeBackup(DescribeBackupRequest request)
AmazonDynamoDBDescribes an existing backup of a table.
You can call DescribeBackup at a maximum rate of 10 times per second.
describeBackup in interface AmazonDynamoDBpublic DescribeContinuousBackupsResult describeContinuousBackups(DescribeContinuousBackupsRequest request)
AmazonDynamoDB
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.
describeContinuousBackups in interface AmazonDynamoDBpublic DescribeContributorInsightsResult describeContributorInsights(DescribeContributorInsightsRequest request)
AmazonDynamoDBReturns information about contributor insights for a given table or global secondary index.
describeContributorInsights in interface AmazonDynamoDBpublic DescribeEndpointsResult describeEndpoints(DescribeEndpointsRequest request)
AmazonDynamoDBReturns the regional endpoint information. For more information on policy permissions, please see Internetwork traffic privacy.
describeEndpoints in interface AmazonDynamoDBpublic DescribeExportResult describeExport(DescribeExportRequest request)
AmazonDynamoDBDescribes an existing table export.
describeExport in interface AmazonDynamoDBpublic DescribeGlobalTableResult describeGlobalTable(DescribeGlobalTableRequest request)
AmazonDynamoDBReturns 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.
describeGlobalTable in interface AmazonDynamoDBpublic DescribeGlobalTableSettingsResult describeGlobalTableSettings(DescribeGlobalTableSettingsRequest request)
AmazonDynamoDBDescribes 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.
describeGlobalTableSettings in interface AmazonDynamoDBpublic DescribeImportResult describeImport(DescribeImportRequest request)
AmazonDynamoDBRepresents the properties of the import.
describeImport in interface AmazonDynamoDBpublic DescribeKinesisStreamingDestinationResult describeKinesisStreamingDestination(DescribeKinesisStreamingDestinationRequest request)
AmazonDynamoDBReturns information about the status of Kinesis streaming.
describeKinesisStreamingDestination in interface AmazonDynamoDBpublic DescribeLimitsResult describeLimits(DescribeLimitsRequest request)
AmazonDynamoDBReturns the current provisioned-capacity quotas for your Amazon Web Services account in a Region, both for the Region as a whole and for any one DynamoDB table that you create there.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum read capacity units and write capacity units that you can provision across all of your DynamoDB tables in a given Region. Also, there are per-table quotas that apply when you create a table there. For more information, see Service, Account, and Table Quotas page in the Amazon DynamoDB Developer Guide.
Although you can increase these quotas by filing a case at Amazon Web Services Support Center, obtaining the
increase is not instantaneous. The DescribeLimits action lets you write code to compare the capacity
you are currently using to those quotas imposed by your account so that you have enough time to apply for an
increase before you hit a quota.
For example, you could use one of the Amazon Web Services SDKs to do the following:
Call DescribeLimits for a particular Region to obtain your current account quotas on provisioned
capacity there.
Create a variable to hold the aggregate read capacity units provisioned for all your tables in that Region, and one to hold the aggregate write capacity units. Zero them both.
Call ListTables to obtain a list of all your DynamoDB tables.
For each table name listed by ListTables, do the following:
Call DescribeTable with the table name.
Use the data returned by DescribeTable to add the read capacity units and write capacity units
provisioned for the table itself to your variables.
If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well.
Report the account quotas for that Region returned by DescribeLimits, along with the total current
provisioned capacity levels you have calculated.
This will let you see whether you are getting close to your account-level quotas.
The per-table quotas apply only when you are creating a new table. They restrict the sum of the provisioned capacity of the new table itself and all its global secondary indexes.
For existing tables and their GSIs, DynamoDB doesn't let you increase provisioned capacity extremely rapidly, but the only quota that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account quotas.
DescribeLimits should only be called periodically. You can expect throttling errors if you call it
more than once in a minute.
The DescribeLimits Request element has no content.
describeLimits in interface AmazonDynamoDBrequest - Represents the input of a DescribeLimits operation. Has no content.public DescribeTableResult describeTable(DescribeTableRequest request)
AmazonDynamoDBReturns 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.
describeTable in interface AmazonDynamoDBrequest - Represents the input of a DescribeTable operation.public DescribeTableResult describeTable(String tableName)
AmazonDynamoDBdescribeTable in interface AmazonDynamoDBAmazonDynamoDB.describeTable(DescribeTableRequest)public DescribeTableReplicaAutoScalingResult describeTableReplicaAutoScaling(DescribeTableReplicaAutoScalingRequest request)
AmazonDynamoDBDescribes auto scaling settings across replicas of the global table at once.
This operation only applies to Version 2019.11.21 (Current) of global tables.
describeTableReplicaAutoScaling in interface AmazonDynamoDBpublic DescribeTimeToLiveResult describeTimeToLive(DescribeTimeToLiveRequest request)
AmazonDynamoDBGives a description of the Time to Live (TTL) status on the specified table.
describeTimeToLive in interface AmazonDynamoDBpublic DisableKinesisStreamingDestinationResult disableKinesisStreamingDestination(DisableKinesisStreamingDestinationRequest request)
AmazonDynamoDBStops replication from the DynamoDB table to the Kinesis data stream. This is done without deleting either of the resources.
disableKinesisStreamingDestination in interface AmazonDynamoDBpublic EnableKinesisStreamingDestinationResult enableKinesisStreamingDestination(EnableKinesisStreamingDestinationRequest request)
AmazonDynamoDBStarts 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.
enableKinesisStreamingDestination in interface AmazonDynamoDBpublic ExecuteStatementResult executeStatement(ExecuteStatementRequest request)
AmazonDynamoDBThis 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.
executeStatement in interface AmazonDynamoDBpublic ExecuteTransactionResult executeTransaction(ExecuteTransactionRequest request)
AmazonDynamoDBThis 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.
executeTransaction in interface AmazonDynamoDBpublic ExportTableToPointInTimeResult exportTableToPointInTime(ExportTableToPointInTimeRequest request)
AmazonDynamoDBExports 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.
exportTableToPointInTime in interface AmazonDynamoDBpublic GetItemResult getItem(GetItemRequest request)
AmazonDynamoDB
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.
getItem in interface AmazonDynamoDBrequest - Represents the input of a GetItem operation.public GetItemResult getItem(String tableName, Map<String,AttributeValue> key)
AmazonDynamoDBgetItem in interface AmazonDynamoDBAmazonDynamoDB.getItem(GetItemRequest)public GetItemResult getItem(String tableName, Map<String,AttributeValue> key, Boolean consistentRead)
AmazonDynamoDBgetItem in interface AmazonDynamoDBAmazonDynamoDB.getItem(GetItemRequest)public ImportTableResult importTable(ImportTableRequest request)
AmazonDynamoDBImports table data from an S3 bucket.
importTable in interface AmazonDynamoDBpublic ListBackupsResult listBackups(ListBackupsRequest request)
AmazonDynamoDB
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.
listBackups in interface AmazonDynamoDBpublic ListContributorInsightsResult listContributorInsights(ListContributorInsightsRequest request)
AmazonDynamoDBReturns a list of ContributorInsightsSummary for a table and all its global secondary indexes.
listContributorInsights in interface AmazonDynamoDBpublic ListExportsResult listExports(ListExportsRequest request)
AmazonDynamoDBLists completed exports within the past 90 days.
listExports in interface AmazonDynamoDBpublic ListGlobalTablesResult listGlobalTables(ListGlobalTablesRequest request)
AmazonDynamoDBLists 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.
listGlobalTables in interface AmazonDynamoDBpublic ListImportsResult listImports(ListImportsRequest request)
AmazonDynamoDBLists completed imports within the past 90 days.
listImports in interface AmazonDynamoDBpublic ListTablesResult listTables(ListTablesRequest request)
AmazonDynamoDB
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.
listTables in interface AmazonDynamoDBrequest - Represents the input of a ListTables operation.public ListTablesResult listTables()
AmazonDynamoDBlistTables in interface AmazonDynamoDBAmazonDynamoDB.listTables(ListTablesRequest)public ListTablesResult listTables(String exclusiveStartTableName)
AmazonDynamoDBlistTables in interface AmazonDynamoDBAmazonDynamoDB.listTables(ListTablesRequest)public ListTablesResult listTables(String exclusiveStartTableName, Integer limit)
AmazonDynamoDBlistTables in interface AmazonDynamoDBAmazonDynamoDB.listTables(ListTablesRequest)public ListTablesResult listTables(Integer limit)
AmazonDynamoDBlistTables in interface AmazonDynamoDBAmazonDynamoDB.listTables(ListTablesRequest)public ListTagsOfResourceResult listTagsOfResource(ListTagsOfResourceRequest request)
AmazonDynamoDBList 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.
listTagsOfResource in interface AmazonDynamoDBpublic PutItemResult putItem(PutItemRequest request)
AmazonDynamoDB
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.
putItem in interface AmazonDynamoDBrequest - Represents the input of a PutItem operation.public PutItemResult putItem(String tableName, Map<String,AttributeValue> item)
AmazonDynamoDBputItem in interface AmazonDynamoDBAmazonDynamoDB.putItem(PutItemRequest)public PutItemResult putItem(String tableName, Map<String,AttributeValue> item, String returnValues)
AmazonDynamoDBputItem in interface AmazonDynamoDBAmazonDynamoDB.putItem(PutItemRequest)public QueryResult query(QueryRequest request)
AmazonDynamoDB
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.
query in interface AmazonDynamoDBrequest - Represents the input of a Query operation.public RestoreTableFromBackupResult restoreTableFromBackup(RestoreTableFromBackupRequest request)
AmazonDynamoDBCreates 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
restoreTableFromBackup in interface AmazonDynamoDBpublic RestoreTableToPointInTimeResult restoreTableToPointInTime(RestoreTableToPointInTimeRequest request)
AmazonDynamoDB
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 4 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
restoreTableToPointInTime in interface AmazonDynamoDBpublic ScanResult scan(ScanRequest request)
AmazonDynamoDB
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.
scan in interface AmazonDynamoDBrequest - Represents the input of a Scan operation.public ScanResult scan(String tableName, List<String> attributesToGet)
AmazonDynamoDBscan in interface AmazonDynamoDBAmazonDynamoDB.scan(ScanRequest)public ScanResult scan(String tableName, Map<String,Condition> scanFilter)
AmazonDynamoDBscan in interface AmazonDynamoDBAmazonDynamoDB.scan(ScanRequest)public ScanResult scan(String tableName, List<String> attributesToGet, Map<String,Condition> scanFilter)
AmazonDynamoDBscan in interface AmazonDynamoDBAmazonDynamoDB.scan(ScanRequest)public TagResourceResult tagResource(TagResourceRequest request)
AmazonDynamoDBAssociate 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.
tagResource in interface AmazonDynamoDBpublic TransactGetItemsResult transactGetItems(TransactGetItemsRequest request)
AmazonDynamoDB
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.
transactGetItems in interface AmazonDynamoDBpublic TransactWriteItemsResult transactWriteItems(TransactWriteItemsRequest request)
AmazonDynamoDB
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.
transactWriteItems in interface AmazonDynamoDBpublic UntagResourceResult untagResource(UntagResourceRequest request)
AmazonDynamoDB
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.
untagResource in interface AmazonDynamoDBpublic UpdateContinuousBackupsResult updateContinuousBackups(UpdateContinuousBackupsRequest request)
AmazonDynamoDB
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.
updateContinuousBackups in interface AmazonDynamoDBpublic UpdateContributorInsightsResult updateContributorInsights(UpdateContributorInsightsRequest request)
AmazonDynamoDBUpdates 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.
updateContributorInsights in interface AmazonDynamoDBpublic UpdateGlobalTableResult updateGlobalTable(UpdateGlobalTableRequest request)
AmazonDynamoDBAdds 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 DescribeTable 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.
updateGlobalTable in interface AmazonDynamoDBpublic UpdateGlobalTableSettingsResult updateGlobalTableSettings(UpdateGlobalTableSettingsRequest request)
AmazonDynamoDBUpdates 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.
updateGlobalTableSettings in interface AmazonDynamoDBpublic UpdateItemResult updateItem(UpdateItemRequest request)
AmazonDynamoDBEdits 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.
updateItem in interface AmazonDynamoDBrequest - Represents the input of an UpdateItem operation.public UpdateItemResult updateItem(String tableName, Map<String,AttributeValue> key, Map<String,AttributeValueUpdate> attributeUpdates)
AmazonDynamoDBupdateItem in interface AmazonDynamoDBAmazonDynamoDB.updateItem(UpdateItemRequest)public UpdateItemResult updateItem(String tableName, Map<String,AttributeValue> key, Map<String,AttributeValueUpdate> attributeUpdates, String returnValues)
AmazonDynamoDBupdateItem in interface AmazonDynamoDBAmazonDynamoDB.updateItem(UpdateItemRequest)public UpdateTableResult updateTable(UpdateTableRequest request)
AmazonDynamoDBModifies 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 is executing, the table status changes from
ACTIVE to UPDATING. While it is UPDATING, you cannot issue another
UpdateTable request. When the table returns to the ACTIVE state, the
UpdateTable operation is complete.
updateTable in interface AmazonDynamoDBrequest - Represents the input of an UpdateTable operation.public UpdateTableResult updateTable(String tableName, ProvisionedThroughput provisionedThroughput)
AmazonDynamoDBupdateTable in interface AmazonDynamoDBAmazonDynamoDB.updateTable(UpdateTableRequest)public UpdateTableReplicaAutoScalingResult updateTableReplicaAutoScaling(UpdateTableReplicaAutoScalingRequest request)
AmazonDynamoDBUpdates auto scaling settings on your global tables at once.
This operation only applies to Version 2019.11.21 (Current) of global tables.
updateTableReplicaAutoScaling in interface AmazonDynamoDBpublic UpdateTimeToLiveResult updateTimeToLive(UpdateTimeToLiveRequest request)
AmazonDynamoDB
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.
updateTimeToLive in interface AmazonDynamoDBrequest - Represents the input of an UpdateTimeToLive operation.public void shutdown()
AmazonDynamoDBshutdown in interface AmazonDynamoDBpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonDynamoDBResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AmazonDynamoDBrequest - The originally executed request.public AmazonDynamoDBWaiters waiters()
waiters in interface AmazonDynamoDB