com.amazonaws.AmazonWebServiceClient
com.amazonaws.services.dynamodb.AmazonDynamoDBClient
|
|||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||
java.lang.Object
public class AmazonDynamoDBClient
Client for accessing AmazonDynamoDB. All service calls made using this client are blocking, and will not return until the service call completes.
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.
| Constructor Summary | |
|---|---|
AmazonDynamoDBClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on AmazonDynamoDB using the specified AWS account credentials. |
|
AmazonDynamoDBClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonDynamoDB using the specified AWS account credentials and client configuration options. |
|
AmazonDynamoDBClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on AmazonDynamoDB using the specified AWS account credentials provider. |
|
AmazonDynamoDBClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonDynamoDB using the specified AWS account credentials provider and client configuration options. |
|
| Method Summary | |
|---|---|
BatchGetItemResult |
batchGetItem(BatchGetItemRequest batchGetItemRequest)
The BatchGetItem operation returns the attributes for multiple items from multiple tables using their primary keys. |
CreateTableResult |
createTable(CreateTableRequest createTableRequest)
The CreateTable operation adds a new table to your account. |
DeleteItemResult |
deleteItem(DeleteItemRequest deleteItemRequest)
Deletes a single item in a table by primary key. |
DeleteTableResult |
deleteTable(DeleteTableRequest deleteTableRequest)
The DeleteTable operation deletes a table and all of its items. |
DescribeTableResult |
describeTable(DescribeTableRequest describeTableRequest)
Returns 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)
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)
The GetItem operation returns a set of Attributes for an item that matches the primary key. |
ListTablesResult |
listTables()
Returns a paginated list of table names created by the AWS Account of the caller in the AWS Region (e.g. |
ListTablesResult |
listTables(ListTablesRequest listTablesRequest)
Returns a paginated list of table names created by the AWS Account of the caller in the AWS Region (e.g. |
PutItemResult |
putItem(PutItemRequest putItemRequest)
Creates a new item, or replaces an old item with a new item (including all the attributes). |
QueryResult |
query(QueryRequest queryRequest)
The Query operation gets the values of one or more items and its attributes by primary key (composite primary key, only). |
ScanResult |
scan(ScanRequest scanRequest)
The Scan operation returns one or more items and its attributes by performing a full scan of a table. |
void |
setEndpoint(String endpoint)
Setting the endpoint will also change the session credentials provider, if it's being automatically managed. |
UpdateItemResult |
updateItem(UpdateItemRequest updateItemRequest)
Edits an existing item's attributes. |
UpdateTableResult |
updateTable(UpdateTableRequest updateTableRequest)
Updates the provisioned throughput for the given table. |
| Methods inherited from class com.amazonaws.AmazonWebServiceClient |
|---|
addRequestHandler, removeRequestHandler, setConfiguration, shutdown |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface com.amazonaws.services.dynamodb.AmazonDynamoDB |
|---|
shutdown |
| Constructor Detail |
|---|
public AmazonDynamoDBClient(AWSCredentials awsCredentials)
If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.
Automatically managed sessions will be shared among all clients that use
the same credentials and service endpoint. To opt out of this behavior,
explicitly provide an instance of AWSCredentialsProvider that
returns AWSSessionCredentials.
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)
If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.
Automatically managed sessions will be shared among all clients that use
the same credentials and service endpoint. To opt out of this behavior,
explicitly provide an instance of AWSCredentialsProvider that
returns AWSSessionCredentials.
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(AWSCredentialsProvider awsCredentialsProvider)
If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.
Automatically managed sessions will be shared among all clients that use
the same credentials and service endpoint. To opt out of this behavior,
explicitly provide an instance of AWSCredentialsProvider that
returns AWSSessionCredentials.
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)
If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.
Automatically managed sessions will be shared among all clients that use
the same credentials and service endpoint. To opt out of this behavior,
explicitly provide an instance of AWSCredentialsProvider that
returns AWSSessionCredentials.
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.).| Method Detail |
|---|
public ScanResult scan(ScanRequest scanRequest)
throws AmazonServiceException,
AmazonClientException
The Scan operation returns one or more items and its attributes by performing a full scan of a table. Limit the returned results by specifying a filter.
scan in interface AmazonDynamoDBscanRequest - Container for the necessary parameters to execute
the Scan service method on AmazonDynamoDB.
ProvisionedThroughputExceededException
InternalServerErrorException
ResourceNotFoundException
AmazonClientException - 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
The CreateTable operation 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.
ResourceInUseException
LimitExceededException
InternalServerErrorException
AmazonClientException - 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(ListTablesRequest listTablesRequest)
throws AmazonServiceException,
AmazonClientException
Returns 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.
InternalServerErrorException
AmazonClientException - 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
The Query operation 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.
ProvisionedThroughputExceededException
InternalServerErrorException
ResourceNotFoundException
AmazonClientException - 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.
ProvisionedThroughputExceededException
ConditionalCheckFailedException
InternalServerErrorException
ResourceNotFoundException
AmazonClientException - 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 Capacity feature of Amazon DynamoDB.
updateTable in interface AmazonDynamoDBupdateTableRequest - Container for the necessary parameters to
execute the UpdateTable service method on AmazonDynamoDB.
ResourceInUseException
LimitExceededException
InternalServerErrorException
ResourceNotFoundException
AmazonClientException - 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.
ProvisionedThroughputExceededException
ConditionalCheckFailedException
InternalServerErrorException
ResourceNotFoundException
AmazonClientException - 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
The DeleteTable operation 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 DeleteTable 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.
ResourceInUseException
LimitExceededException
InternalServerErrorException
ResourceNotFoundException
AmazonClientException - 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.
ProvisionedThroughputExceededException
ConditionalCheckFailedException
InternalServerErrorException
ResourceNotFoundException
AmazonClientException - 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
Returns 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, the server returns a ResourceNotFoundException.
describeTable in interface AmazonDynamoDBdescribeTableRequest - Container for the necessary parameters to
execute the DescribeTable service method on AmazonDynamoDB.
InternalServerErrorException
ResourceNotFoundException
AmazonClientException - 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
The GetItem operation returns 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.
ProvisionedThroughputExceededException
InternalServerErrorException
ResourceNotFoundException
AmazonClientException - 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
The BatchGetItem operation returns 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 50 KB 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.
ProvisionedThroughputExceededException
InternalServerErrorException
ResourceNotFoundException
AmazonClientException - 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
Returns 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 AmazonDynamoDBInternalServerErrorException
AmazonClientException - 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)
throws IllegalArgumentException
setEndpoint in interface AmazonDynamoDBsetEndpoint in class AmazonWebServiceClientendpoint - The endpoint (ex: "ec2.amazonaws.com") or a full URL,
including the protocol (ex: "https://ec2.amazonaws.com") of
the region specific AWS endpoint this client will communicate
with.
IllegalArgumentException - If any problems are detected with the specified endpoint.public 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 request
|
|||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||