com.amazonaws.services.simpledb
Class AmazonSimpleDBClient

java.lang.Object
  com.amazonaws.AmazonWebServiceClient
      com.amazonaws.services.simpledb.AmazonSimpleDBClient

All Implemented Interfaces:

AmazonSimpleDB

Direct Known Subclasses:

AmazonSimpleDBAsyncClient

public class AmazonSimpleDBClient
extends AmazonWebServiceClient
implements AmazonSimpleDB

Client for accessing AmazonSimpleDB. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon SimpleDB is a web service providing the core database functions of data indexing and querying in the cloud. By offloading the time and effort associated with building and operating a web-scale database, SimpleDB provides developers the freedom to focus on application development.

A traditional, clustered relational database requires a sizable upfront capital outlay, is complex to design, and often requires extensive and repetitive database administration. Amazon SimpleDB is dramatically simpler, requiring no schema, automatically indexing your data and providing a simple API for storage and access. This approach eliminates the administrative burden of data modeling, index maintenance, and performance tuning. Developers gain access to this functionality within Amazon's proven computing environment, are able to scale instantly, and pay only for what they use.

Visit http://aws.amazon.com/simpledb/ for more information.

Constructor Summary

AmazonSimpleDBClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on AmazonSimpleDB using the specified AWS account credentials.

AmazonSimpleDBClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonSimpleDB using the specified AWS account credentials and client configuration options.

Method Summary

void	batchPutAttributes(BatchPutAttributesRequest batchPutAttributesRequest) The BatchPutAttributes operation creates or replaces attributes within one or more items.
void	createDomain(CreateDomainRequest createDomainRequest) The CreateDomain operation creates a new domain.
void	deleteAttributes(DeleteAttributesRequest deleteAttributesRequest) Deletes one or more attributes associated with the item.
void	deleteDomain(DeleteDomainRequest deleteDomainRequest) The DeleteDomain operation deletes a domain.
DomainMetadataResult	domainMetadata(DomainMetadataRequest domainMetadataRequest) Returns information about the domain, including when the domain was created, the number of items and attributes, and the size of attribute names and values.
GetAttributesResult	getAttributes(GetAttributesRequest getAttributesRequest) Returns all of the attributes associated with the item.
ListDomainsResult	listDomains() The ListDomains operation lists all domains associated with the Access Key ID.
ListDomainsResult	listDomains(ListDomainsRequest listDomainsRequest) The ListDomains operation lists all domains associated with the Access Key ID.
void	putAttributes(PutAttributesRequest putAttributesRequest) The PutAttributes operation creates or replaces attributes in an item.
SelectResult	select(SelectRequest selectRequest) The Select operation returns a set of Attributes for ItemNames that match the select expression.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

setEndpoint

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.simpledb.AmazonSimpleDB

setEndpoint

Constructor Detail

AmazonSimpleDBClient

public AmazonSimpleDBClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AmazonSimpleDB using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonSimpleDBClient

public AmazonSimpleDBClient(AWSCredentials awsCredentials,
                            ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonSimpleDB using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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 AmazonSimpleDB (ex: proxy settings, retry counts, etc.).

Method Detail

select

public SelectResult select(SelectRequest selectRequest)
                    throws AmazonServiceException,
                           AmazonClientException

The Select operation returns a set of Attributes for ItemNames that match the select expression. Select is similar to the standard SQL SELECT statement.

The total size of the response cannot exceed 1 MB in total size. Amazon SimpleDB automatically adjusts the number of items returned per page to enforce this limit. For example, even if you ask to retrieve 2500 items, but each individual item is 10 kB in size, the system returns 100 items and an appropriate next token so you can get the next page of results.

For information on how to construct select expressions, see Using Select to Create Amazon SimpleDB Queries in the Developer Guide.

Specified by:

select in interface AmazonSimpleDB

Parameters:

selectRequest - Container for the necessary parameters to execute the Select service method on AmazonSimpleDB.

Returns:

The response from the Select service method, as returned by AmazonSimpleDB.

Throws:

InvalidParameterValueException

InvalidQueryExpressionException

RequestTimeoutException

InvalidNumberPredicatesException

NoSuchDomainException

InvalidNextTokenException

TooManyRequestedAttributesException

MissingParameterException

InvalidNumberValueTestsException

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 AmazonSimpleDB indicating either a problem with the data in the request, or a server side issue.

putAttributes

public void putAttributes(PutAttributesRequest putAttributesRequest)
                   throws AmazonServiceException,
                          AmazonClientException

The PutAttributes operation creates or replaces attributes in an item. You specify new attributes using a combination of the Attribute.X.Name and Attribute.X.Value parameters. You specify the first attribute by the parameters Attribute.0.Name and Attribute.0.Value , the second attribute by the parameters Attribute.1.Name and Attribute.1.Value , and so on.

Attributes are uniquely identified in an item by their name/value combination. For example, a single item can have the attributes { "first_name", "first_value" } and { "first_name", second_value" } . However, it cannot have two attribute instances where both the Attribute.X.Name and Attribute.X.Value are the same.

Optionally, the requestor can supply the Replace parameter for each individual attribute. Setting this value to true causes the new attribute value to replace the existing attribute value(s). For example, if an item has the attributes { 'a', '1' } , { 'b', '2'} and { 'b', '3' } and the requestor calls PutAttributes using the attributes { 'b', '4' } with the Replace parameter set to true, the final attributes of the item are changed to { 'a', '1' } and { 'b', '4' } , which replaces the previous values of the 'b' attribute with the new value.

NOTE: Using PutAttributes to replace attribute values that do not exist will not result in an error response.

You cannot specify an empty string as an attribute name.

Because Amazon SimpleDB makes multiple copies of your data and uses an eventual consistency update model, an immediate GetAttributes or Select request (read) immediately after a DeleteAttributes request (write) might not return the updated data.

The following limitations are enforced for this operation:

• 256 total attribute name-value pairs per item
• One billion attributes per domain
• 10 GB of total user data storage per domain

Specified by:

putAttributes in interface AmazonSimpleDB

Parameters:

putAttributesRequest - Container for the necessary parameters to execute the PutAttributes service method on AmazonSimpleDB.

Throws:

InvalidParameterValueException

NumberDomainBytesExceededException

NumberDomainAttributesExceededException

NoSuchDomainException

NumberItemAttributesExceededException

AttributeDoesNotExistException

MissingParameterException

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 AmazonSimpleDB indicating either a problem with the data in the request, or a server side issue.

deleteDomain

public void deleteDomain(DeleteDomainRequest deleteDomainRequest)
                  throws AmazonServiceException,
                         AmazonClientException

The DeleteDomain operation deletes a domain. Any items (and their attributes) in the domain are deleted as well. The DeleteDomain operation might take 10 or more seconds to complete.

NOTE: Running DeleteDomain on a domain that does not exist or running the function multiple times using the same domain name will not result in an error response.

Specified by:

deleteDomain in interface AmazonSimpleDB

Parameters:

deleteDomainRequest - Container for the necessary parameters to execute the DeleteDomain service method on AmazonSimpleDB.

Throws:

MissingParameterException

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 AmazonSimpleDB indicating either a problem with the data in the request, or a server side issue.

createDomain

public void createDomain(CreateDomainRequest createDomainRequest)
                  throws AmazonServiceException,
                         AmazonClientException

The CreateDomain operation creates a new domain. The domain name must be unique among the domains associated with the Access Key ID provided in the request. The CreateDomain operation may take 10 or more seconds to complete.

NOTE: CreateDomain is an idempotent operation; running it multiple times using the same domain name will not result in an error response.

You can create up to 100 domains per account.

If you require additional domains, go to http://aws.amazon.com/contact-us/simpledb-limit-request/ .

Specified by:

createDomain in interface AmazonSimpleDB

Parameters:

createDomainRequest - Container for the necessary parameters to execute the CreateDomain service method on AmazonSimpleDB.

Throws:

InvalidParameterValueException

NumberDomainsExceededException

MissingParameterException

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 AmazonSimpleDB indicating either a problem with the data in the request, or a server side issue.

deleteAttributes

public void deleteAttributes(DeleteAttributesRequest deleteAttributesRequest)
                      throws AmazonServiceException,
                             AmazonClientException

Deletes one or more attributes associated with the item. If all attributes of an item are deleted, the item is deleted.

NOTE: If you specify DeleteAttributes without attributes or values, all the attributes for the item are deleted.

DeleteAttributes is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.

Because Amazon SimpleDB makes multiple copies of your data and uses an eventual consistency update model, performing a GetAttributes or Select request (read) immediately after a DeleteAttributes or PutAttributes request (write) might not return the updated data.

Specified by:

deleteAttributes in interface AmazonSimpleDB

Parameters:

deleteAttributesRequest - Container for the necessary parameters to execute the DeleteAttributes service method on AmazonSimpleDB.

Throws:

InvalidParameterValueException

NoSuchDomainException

AttributeDoesNotExistException

MissingParameterException

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 AmazonSimpleDB indicating either a problem with the data in the request, or a server side issue.

listDomains

public ListDomainsResult listDomains(ListDomainsRequest listDomainsRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

The ListDomains operation lists all domains associated with the Access Key ID. It returns domain names up to the limit set by MaxNumberOfDomains. A NextToken is returned if there are more than MaxNumberOfDomains domains. Calling ListDomains successive times with the NextToken returns up to MaxNumberOfDomains more domain names each time.

Specified by:

listDomains in interface AmazonSimpleDB

Parameters:

listDomainsRequest - Container for the necessary parameters to execute the ListDomains service method on AmazonSimpleDB.

Returns:

The response from the ListDomains service method, as returned by AmazonSimpleDB.

Throws:

InvalidParameterValueException

InvalidNextTokenException

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 AmazonSimpleDB indicating either a problem with the data in the request, or a server side issue.

getAttributes

public GetAttributesResult getAttributes(GetAttributesRequest getAttributesRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Returns all of the attributes associated with the item. Optionally, the attributes returned can be limited to one or more specified attribute name parameters.

If the item does not exist on the replica that was accessed for this operation, an empty set is returned. The system does not return an error as it cannot guarantee the item does not exist on other replicas.

NOTE: If you specify GetAttributes without any attribute names, all the attributes for the item are returned.

Specified by:

getAttributes in interface AmazonSimpleDB

Parameters:

getAttributesRequest - Container for the necessary parameters to execute the GetAttributes service method on AmazonSimpleDB.

Returns:

The response from the GetAttributes service method, as returned by AmazonSimpleDB.

Throws:

InvalidParameterValueException

NoSuchDomainException

MissingParameterException

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 AmazonSimpleDB indicating either a problem with the data in the request, or a server side issue.

batchPutAttributes

public void batchPutAttributes(BatchPutAttributesRequest batchPutAttributesRequest)
                        throws AmazonServiceException,
                               AmazonClientException

The BatchPutAttributes operation creates or replaces attributes within one or more items.

You specify the item name with the Item.X.ItemName parameter. You specify new attributes using a combination of the Item.X.Attribute.Y.Name and Item.X.Attribute.Y.Value parameters. You specify the first attribute for the first item by the parameters Item.0.Attribute.0.Name and Item.0.Attribute.0.Value , the second attribute for the first item by the parameters Item.0.Attribute.1.Name and Item.0.Attribute.1.Value , and so on.

Attributes are uniquely identified within an item by their name/value combination. For example, a single item can have the attributes { "first_name", "first_value" } and { "first_name", "second_value" } . However, it cannot have two attribute instances where both the Item.X.Attribute.Y.Name and Item.X.Attribute.Y.Value are the same.

Optionally, the requester can supply the Replace parameter for each individual value. Setting this value to true will cause the new attribute value to replace the existing attribute value(s). For example, if an item I has the attributes { 'a', '1' }, { 'b', '2'} and { 'b', '3' } and the requester does a BatchPutAttributes of {'I', 'b', '4' } with the Replace parameter set to true, the final attributes of the item will be { 'a', '1' } and { 'b', '4' } , replacing the previous values of the 'b' attribute with the new value.

NOTE: You cannot specify an empty string as an item or attribute name. The BatchPutAttributes operation succeeds or fails in its entirety. There are no partial puts.

You can execute multiple BatchPutAttributes operations and other operations in parallel. However, large numbers of concurrent BatchPutAttributes calls can result in Service Unavailable (503) responses.

The following limitations are enforced for this operation:

• 256 attribute name-value pairs per item
• 1 MB request size
• 1 billion attributes per domain
• 10 GB of total user data storage per domain
• 25 item limit per BatchPutAttributes operation

Specified by:

batchPutAttributes in interface AmazonSimpleDB

Parameters:

batchPutAttributesRequest - Container for the necessary parameters to execute the BatchPutAttributes service method on AmazonSimpleDB.

Throws:

DuplicateItemNameException

InvalidParameterValueException

NumberDomainBytesExceededException

NumberSubmittedItemsExceededException

NumberSubmittedAttributesExceededException

NumberDomainAttributesExceededException

NoSuchDomainException

NumberItemAttributesExceededException

MissingParameterException

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 AmazonSimpleDB indicating either a problem with the data in the request, or a server side issue.

domainMetadata

public DomainMetadataResult domainMetadata(DomainMetadataRequest domainMetadataRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Returns information about the domain, including when the domain was created, the number of items and attributes, and the size of attribute names and values.

Specified by:

domainMetadata in interface AmazonSimpleDB

Parameters:

domainMetadataRequest - Container for the necessary parameters to execute the DomainMetadata service method on AmazonSimpleDB.

Returns:

The response from the DomainMetadata service method, as returned by AmazonSimpleDB.

Throws:

NoSuchDomainException

MissingParameterException

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 AmazonSimpleDB indicating either a problem with the data in the request, or a server side issue.

listDomains

public ListDomainsResult listDomains()
                              throws AmazonServiceException,
                                     AmazonClientException

The ListDomains operation lists all domains associated with the Access Key ID. It returns domain names up to the limit set by MaxNumberOfDomains. A NextToken is returned if there are more than MaxNumberOfDomains domains. Calling ListDomains successive times with the NextToken returns up to MaxNumberOfDomains more domain names each time.

Specified by:

listDomains in interface AmazonSimpleDB

Returns:

The response from the ListDomains service method, as returned by AmazonSimpleDB.

Throws:

InvalidParameterValueException

InvalidNextTokenException

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 AmazonSimpleDB indicating either a problem with the data in the request, or a server side issue.