AmazonDynamoDBClient instead.@Deprecated public class AmazonDynamoDBClient extends AmazonWebServiceClient implements AmazonDynamoDB
Amazon DynamoDB is a fast, highly scalable, highly available, cost-effective non-relational database service.
Amazon DynamoDB removes traditional scalability limitations on data storage while maintaining low latency and predictable performance.
| Modifier and Type | Field and Description |
|---|---|
protected List<com.amazonaws.transform.JsonErrorUnmarshaller> |
exceptionUnmarshallers
Deprecated.
List of exception unmarshallers for all AmazonDynamoDB exceptions.
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset| Constructor and Description |
|---|
AmazonDynamoDBClient()
Deprecated.
Constructs a new client to invoke service methods on
AmazonDynamoDB.
|
AmazonDynamoDBClient(AWSCredentials awsCredentials)
Deprecated.
Constructs a new client to invoke service methods on
AmazonDynamoDB using the specified AWS account credentials.
|
AmazonDynamoDBClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Deprecated.
Constructs a new client to invoke service methods on
AmazonDynamoDB using the specified AWS account credentials
and client configuration options.
|
AmazonDynamoDBClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Deprecated.
Constructs a new client to invoke service methods on AmazonDynamoDB using
the specified AWS account credentials, client configuration options and
request metric collector.
|
AmazonDynamoDBClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
Constructs a new client to invoke service methods on
AmazonDynamoDB using the specified AWS account credentials provider.
|
AmazonDynamoDBClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Deprecated.
Constructs a new client to invoke service methods on
AmazonDynamoDB using the specified AWS account credentials
provider and client configuration options.
|
AmazonDynamoDBClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Deprecated.
Constructs a new client to invoke service methods on
AmazonDynamoDB using the specified AWS account credentials
provider and client configuration options.
|
AmazonDynamoDBClient(ClientConfiguration clientConfiguration)
Deprecated.
Constructs a new client to invoke service methods on
AmazonDynamoDB.
|
| Modifier and Type | Method and Description |
|---|---|
BatchGetItemResult |
batchGetItem(BatchGetItemRequest batchGetItemRequest)
Deprecated.
Retrieves the attributes for multiple items from multiple tables using
their primary keys.
|
BatchWriteItemResult |
batchWriteItem(BatchWriteItemRequest batchWriteItemRequest)
Deprecated.
Allows to execute a batch of Put and/or Delete Requests for many
tables in a single call.
|
CreateTableResult |
createTable(CreateTableRequest createTableRequest)
Deprecated.
Adds a new table to your account.
|
DeleteItemResult |
deleteItem(DeleteItemRequest deleteItemRequest)
Deprecated.
Deletes a single item in a table by primary key.
|
DeleteTableResult |
deleteTable(DeleteTableRequest deleteTableRequest)
Deprecated.
Deletes a table and all of its items.
|
DescribeTableResult |
describeTable(DescribeTableRequest describeTableRequest)
Deprecated.
Retrieves information about the table, including the current status of
the table, the primary key schema and when the table was created.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Deprecated.
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 getItemRequest)
Deprecated.
Retrieves a set of Attributes for an item that matches the primary
key.
|
protected String |
getServiceAbbreviation()
Deprecated.
|
ListTablesResult |
listTables()
Deprecated.
Retrieves a paginated list of table names created by the AWS Account
of the caller in the AWS Region (e.g.
|
ListTablesResult |
listTables(ListTablesRequest listTablesRequest)
Deprecated.
Retrieves a paginated list of table names created by the AWS Account
of the caller in the AWS Region (e.g.
|
PutItemResult |
putItem(PutItemRequest putItemRequest)
Deprecated.
Creates a new item, or replaces an old item with a new item (including
all the attributes).
|
QueryResult |
query(QueryRequest queryRequest)
Deprecated.
Gets the values of one or more items and its attributes by primary key
(composite primary key, only).
|
ScanResult |
scan(ScanRequest scanRequest)
Deprecated.
Retrieves one or more items and its attributes by performing a full
scan of a table.
|
void |
setEndpoint(String endpoint,
String serviceName,
String regionId)
Deprecated.
Overrides the default endpoint for this client ("http://dynamodb.us-east-1.amazonaws.com/") and explicitly provides
an AWS region ID and AWS service name to use when the client calculates a signature
for requests.
|
UpdateItemResult |
updateItem(UpdateItemRequest updateItemRequest)
Deprecated.
Edits an existing item's attributes.
|
UpdateTableResult |
updateTable(UpdateTableRequest updateTableRequest)
Deprecated.
Updates the provisioned throughput for the given table.
|
addRequestHandler, addRequestHandler, configSigner, configSigner, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdownprotected List<com.amazonaws.transform.JsonErrorUnmarshaller> exceptionUnmarshallers
public AmazonDynamoDBClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChainpublic AmazonDynamoDBClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this
client connects to AmazonDynamoDB
(ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChainpublic AmazonDynamoDBClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.public AmazonDynamoDBClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this
client connects to AmazonDynamoDB
(ex: proxy settings, retry counts, etc.).public AmazonDynamoDBClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client
connects to AmazonDynamoDB (ex: proxy settings, retry counts,
etc.).requestMetricCollector - optional request metric collector to be used at the http
client level; can be null.public AmazonDynamoDBClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.public AmazonDynamoDBClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this
client connects to AmazonDynamoDB
(ex: proxy settings, retry counts, etc.).public AmazonDynamoDBClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this
client connects to AmazonDynamoDB
(ex: proxy settings, retry counts, etc.).requestMetricCollector - optional request metric collector to be used at the http
client level; can be null.public ListTablesResult listTables(ListTablesRequest listTablesRequest) throws AmazonServiceException, AmazonClientException
Retrieves a paginated list of table names created by the AWS Account
of the caller in the AWS Region (e.g. us-east-1 ).
listTables in interface AmazonDynamoDBlistTablesRequest - Container for the necessary parameters to
execute the ListTables service method on AmazonDynamoDB.InternalServerErrorExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonDynamoDB indicating
either a problem with the data in the request, or a server side issue.public QueryResult query(QueryRequest queryRequest) throws AmazonServiceException, AmazonClientException
Gets the values of one or more items and its attributes by primary key (composite primary key, only).
Narrow the scope of the query using comparison operators on the
RangeKeyValue of the composite key. Use the
ScanIndexForward parameter to get results in forward or
reverse order by range key.
query in interface AmazonDynamoDBqueryRequest - Container for the necessary parameters to execute
the Query service method on AmazonDynamoDB.ProvisionedThroughputExceededExceptionInternalServerErrorExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonDynamoDB indicating
either a problem with the data in the request, or a server side issue.public BatchWriteItemResult batchWriteItem(BatchWriteItemRequest batchWriteItemRequest) throws AmazonServiceException, AmazonClientException
Allows to execute a batch of Put and/or Delete Requests for many tables in a single call. A total of 25 requests are allowed.
There are no transaction guarantees provided by this API. It does not allow conditional puts nor does it support return values.
batchWriteItem in interface AmazonDynamoDBbatchWriteItemRequest - Container for the necessary parameters to
execute the BatchWriteItem service method on AmazonDynamoDB.LimitExceededExceptionProvisionedThroughputExceededExceptionInternalServerErrorExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonDynamoDB indicating
either a problem with the data in the request, or a server side issue.public UpdateItemResult updateItem(UpdateItemRequest updateItemRequest) throws AmazonServiceException, AmazonClientException
Edits an existing item's attributes.
You can perform a conditional update (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).
updateItem in interface AmazonDynamoDBupdateItemRequest - Container for the necessary parameters to
execute the UpdateItem service method on AmazonDynamoDB.LimitExceededExceptionProvisionedThroughputExceededExceptionConditionalCheckFailedExceptionInternalServerErrorExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonDynamoDB indicating
either a problem with the data in the request, or a server side issue.public PutItemResult putItem(PutItemRequest putItemRequest) throws AmazonServiceException, AmazonClientException
Creates a new item, or replaces an old item with a new item (including all the attributes).
If an item already exists in the specified table with the same primary key, the new item completely replaces the existing item. You can perform a conditional put (insert a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values.
putItem in interface AmazonDynamoDBputItemRequest - Container for the necessary parameters to
execute the PutItem service method on AmazonDynamoDB.LimitExceededExceptionProvisionedThroughputExceededExceptionConditionalCheckFailedExceptionInternalServerErrorExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonDynamoDB indicating
either a problem with the data in the request, or a server side issue.public DescribeTableResult describeTable(DescribeTableRequest describeTableRequest) throws AmazonServiceException, AmazonClientException
Retrieves information about the table, including the current status of the table, the primary key schema and when the table was created.
If the table does not exist, Amazon DynamoDB returns a
ResourceNotFoundException .
describeTable in interface AmazonDynamoDBdescribeTableRequest - Container for the necessary parameters to
execute the DescribeTable service method on AmazonDynamoDB.InternalServerErrorExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonDynamoDB indicating
either a problem with the data in the request, or a server side issue.public ScanResult scan(ScanRequest scanRequest) throws AmazonServiceException, AmazonClientException
Retrieves one or more items and its attributes by performing a full scan of a table.
Provide a ScanFilter to get more specific results.
scan in interface AmazonDynamoDBscanRequest - Container for the necessary parameters to execute
the Scan service method on AmazonDynamoDB.ProvisionedThroughputExceededExceptionInternalServerErrorExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonDynamoDB indicating
either a problem with the data in the request, or a server side issue.public CreateTableResult createTable(CreateTableRequest createTableRequest) throws AmazonServiceException, AmazonClientException
Adds a new table to your account.
The table name must be unique among those associated with the AWS
Account issuing the request, and the AWS Region that receives the
request (e.g. us-east-1 ).
The CreateTable operation triggers an asynchronous
workflow to begin creating the table. Amazon DynamoDB immediately
returns the state of the table ( CREATING ) until the
table is in the ACTIVE state. Once the table is in the
ACTIVE state, you can perform data plane operations.
createTable in interface AmazonDynamoDBcreateTableRequest - Container for the necessary parameters to
execute the CreateTable service method on AmazonDynamoDB.ResourceInUseExceptionLimitExceededExceptionInternalServerErrorExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonDynamoDB indicating
either a problem with the data in the request, or a server side issue.public UpdateTableResult updateTable(UpdateTableRequest updateTableRequest) throws AmazonServiceException, AmazonClientException
Updates the provisioned throughput for the given table.
Setting the throughput for a table helps you manage performance and is part of the Provisioned Throughput feature of Amazon DynamoDB.
updateTable in interface AmazonDynamoDBupdateTableRequest - Container for the necessary parameters to
execute the UpdateTable service method on AmazonDynamoDB.ResourceInUseExceptionLimitExceededExceptionInternalServerErrorExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonDynamoDB indicating
either a problem with the data in the request, or a server side issue.public DeleteTableResult deleteTable(DeleteTableRequest deleteTableRequest) throws AmazonServiceException, AmazonClientException
Deletes a table and all of its items.
If the table is in the ACTIVE state, you can delete it.
If a table is in CREATING or UPDATING states
then Amazon DynamoDB returns a ResourceInUseException .
If the specified table does not exist, Amazon DynamoDB returns a
ResourceNotFoundException .
deleteTable in interface AmazonDynamoDBdeleteTableRequest - Container for the necessary parameters to
execute the DeleteTable service method on AmazonDynamoDB.ResourceInUseExceptionLimitExceededExceptionInternalServerErrorExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonDynamoDB indicating
either a problem with the data in the request, or a server side issue.public DeleteItemResult deleteItem(DeleteItemRequest deleteItemRequest) throws AmazonServiceException, AmazonClientException
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.
deleteItem in interface AmazonDynamoDBdeleteItemRequest - Container for the necessary parameters to
execute the DeleteItem service method on AmazonDynamoDB.LimitExceededExceptionProvisionedThroughputExceededExceptionConditionalCheckFailedExceptionInternalServerErrorExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonDynamoDB indicating
either a problem with the data in the request, or a server side issue.public GetItemResult getItem(GetItemRequest getItemRequest) throws AmazonServiceException, AmazonClientException
Retrieves a set of Attributes for an item that matches the primary key.
The GetItem operation provides an eventually-consistent
read by default. If eventually-consistent reads are not acceptable for
your application, use ConsistentRead . Although this
operation might take longer than a standard read, it always returns
the last updated value.
getItem in interface AmazonDynamoDBgetItemRequest - Container for the necessary parameters to
execute the GetItem service method on AmazonDynamoDB.ProvisionedThroughputExceededExceptionInternalServerErrorExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonDynamoDB indicating
either a problem with the data in the request, or a server side issue.public BatchGetItemResult batchGetItem(BatchGetItemRequest batchGetItemRequest) throws AmazonServiceException, AmazonClientException
Retrieves the attributes for multiple items from multiple tables using their primary keys.
The maximum number of item attributes that can be retrieved for a
single operation is 100. Also, the number of items retrieved is
constrained by a 1 MB the size limit. If the response size limit is
exceeded or a partial result is returned due to an internal processing
failure, Amazon DynamoDB returns an UnprocessedKeys value
so you can retry the operation starting with the next item to get.
Amazon DynamoDB automatically adjusts the number of items returned per
page to enforce this limit. For example, even if you ask to retrieve
100 items, but each individual item is 50k in size, the system returns
20 items and an appropriate UnprocessedKeys value so you
can get the next page of results. If necessary, your application needs
its own logic to assemble the pages of results into one set.
batchGetItem in interface AmazonDynamoDBbatchGetItemRequest - Container for the necessary parameters to
execute the BatchGetItem service method on AmazonDynamoDB.ProvisionedThroughputExceededExceptionInternalServerErrorExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonDynamoDB indicating
either a problem with the data in the request, or a server side issue.public ListTablesResult listTables() throws AmazonServiceException, AmazonClientException
Retrieves a paginated list of table names created by the AWS Account
of the caller in the AWS Region (e.g. us-east-1 ).
listTables in interface AmazonDynamoDBInternalServerErrorExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonDynamoDB indicating
either a problem with the data in the request, or a server side issue.public void setEndpoint(String endpoint, String serviceName, String regionId) throws IllegalArgumentException
This method is not threadsafe. Endpoints 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.
Callers can pass in just the endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full
URL, including the protocol (ex: "http://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: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
setEndpoint in class AmazonWebServiceClientendpoint - The endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full URL,
including the protocol (ex: "http://dynamodb.us-east-1.amazonaws.com/") of
the region specific AWS endpoint this client will communicate
with.serviceName - The name of the AWS service to use when signing requests.regionId - The ID of the region in which this service resides.IllegalArgumentException - If any problems are detected with the specified endpoint.AmazonDynamoDB.setRegion(Region)protected String getServiceAbbreviation()
getServiceAbbreviation in class AmazonWebServiceClientpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response 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 the request.
getCachedResponseMetadata in interface AmazonDynamoDBrequest - The originally executed requestCopyright © 2014. All rights reserved.