software.amazon.awssdk.services.simpledb

Interface SimpleDbClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface SimpleDbClient
extends SdkClient

Service client for accessing null. This can be created using the static builder() method. 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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
default BatchDeleteAttributesResponse	batchDeleteAttributes(BatchDeleteAttributesRequest batchDeleteAttributesRequest) Performs multiple DeleteAttributes operations in a single call, which reduces round trips and latencies.
default BatchDeleteAttributesResponse	batchDeleteAttributes(Consumer<BatchDeleteAttributesRequest.Builder> batchDeleteAttributesRequest) Performs multiple DeleteAttributes operations in a single call, which reduces round trips and latencies.
default BatchPutAttributesResponse	batchPutAttributes(BatchPutAttributesRequest batchPutAttributesRequest) The BatchPutAttributes operation creates or replaces attributes within one or more items.
default BatchPutAttributesResponse	batchPutAttributes(Consumer<BatchPutAttributesRequest.Builder> batchPutAttributesRequest) The BatchPutAttributes operation creates or replaces attributes within one or more items.
static SimpleDbClientBuilder	builder() Create a builder that can be used to configure and create a SimpleDbClient.
static SimpleDbClient	create() Create a SimpleDbClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateDomainResponse	createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest) The CreateDomain operation creates a new domain.
default CreateDomainResponse	createDomain(CreateDomainRequest createDomainRequest) The CreateDomain operation creates a new domain.
default DeleteAttributesResponse	deleteAttributes(Consumer<DeleteAttributesRequest.Builder> deleteAttributesRequest) Deletes one or more attributes associated with an item.
default DeleteAttributesResponse	deleteAttributes(DeleteAttributesRequest deleteAttributesRequest) Deletes one or more attributes associated with an item.
default DeleteDomainResponse	deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest) The DeleteDomain operation deletes a domain.
default DeleteDomainResponse	deleteDomain(DeleteDomainRequest deleteDomainRequest) The DeleteDomain operation deletes a domain.
default DomainMetadataResponse	domainMetadata(Consumer<DomainMetadataRequest.Builder> domainMetadataRequest) Returns information about the domain, including when the domain was created, the number of items and attributes in the domain, and the size of the attribute names and values.
default DomainMetadataResponse	domainMetadata(DomainMetadataRequest domainMetadataRequest) Returns information about the domain, including when the domain was created, the number of items and attributes in the domain, and the size of the attribute names and values.
default GetAttributesResponse	getAttributes(Consumer<GetAttributesRequest.Builder> getAttributesRequest) Returns all of the attributes associated with the specified item.
default GetAttributesResponse	getAttributes(GetAttributesRequest getAttributesRequest) Returns all of the attributes associated with the specified item.
default ListDomainsResponse	listDomains() The ListDomains operation lists all domains associated with the Access Key ID.
default ListDomainsResponse	listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest) The ListDomains operation lists all domains associated with the Access Key ID.
default ListDomainsResponse	listDomains(ListDomainsRequest listDomainsRequest) The ListDomains operation lists all domains associated with the Access Key ID.
default PutAttributesResponse	putAttributes(Consumer<PutAttributesRequest.Builder> putAttributesRequest) The PutAttributes operation creates or replaces attributes in an item.
default PutAttributesResponse	putAttributes(PutAttributesRequest putAttributesRequest) The PutAttributes operation creates or replaces attributes in an item.
default SelectResponse	select(Consumer<SelectRequest.Builder> selectRequest) The Select operation returns a set of attributes for ItemNames that match the select expression.
default SelectResponse	select(SelectRequest selectRequest) The Select operation returns a set of attributes for ItemNames that match the select expression.
static ServiceMetadata	serviceMetadata()

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

serviceName

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

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static SimpleDbClient create()

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

builder

static SimpleDbClientBuilder builder()

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

batchDeleteAttributes

default BatchDeleteAttributesResponse batchDeleteAttributes(BatchDeleteAttributesRequest batchDeleteAttributesRequest)
                                                     throws AwsServiceException,
                                                            SdkClientException,
                                                            SimpleDbException

Performs multiple DeleteAttributes operations in a single call, which reduces round trips and latencies. This enables Amazon SimpleDB to optimize requests, which generally yields better throughput.

The following limitations are enforced for this operation:

• 1 MB request size
• 25 item limit per BatchDeleteAttributes operation

Parameters:

batchDeleteAttributesRequest -

Returns:

Result of the BatchDeleteAttributes operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SimpleDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

batchDeleteAttributes

default BatchDeleteAttributesResponse batchDeleteAttributes(Consumer<BatchDeleteAttributesRequest.Builder> batchDeleteAttributesRequest)
                                                     throws AwsServiceException,
                                                            SdkClientException,
                                                            SimpleDbException

Performs multiple DeleteAttributes operations in a single call, which reduces round trips and latencies. This enables Amazon SimpleDB to optimize requests, which generally yields better throughput.

The following limitations are enforced for this operation:

• 1 MB request size
• 25 item limit per BatchDeleteAttributes operation

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

Parameters:

batchDeleteAttributesRequest - A Consumer that will call methods on BatchDeleteAttributesRequest.Builder to create a request.

Returns:

Result of the BatchDeleteAttributes operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SimpleDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

batchPutAttributes

default BatchPutAttributesResponse batchPutAttributes(BatchPutAttributesRequest batchPutAttributesRequest)
                                               throws DuplicateItemNameException,
                                                      InvalidParameterValueException,
                                                      MissingParameterException,
                                                      NoSuchDomainException,
                                                      NumberItemAttributesExceededException,
                                                      NumberDomainAttributesExceededException,
                                                      NumberDomainBytesExceededException,
                                                      NumberSubmittedItemsExceededException,
                                                      NumberSubmittedAttributesExceededException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      SimpleDbException

The BatchPutAttributes operation creates or replaces attributes within one or more items. By using this operation, the client can perform multiple PutAttribute operation with a single call. This helps yield savings in round trips and latencies, enabling Amazon SimpleDB to optimize requests and generally produce better throughput.

The client may specify the item name with the Item.X.ItemName parameter. The client may specify new attributes using a combination of the Item.X.Attribute.Y.Name and Item.X.Attribute.Y.Value parameters. The client may specify the first attribute for the first item using the parameters Item.0.Attribute.0.Name and Item.0.Attribute.0.Value, and for 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 values to replace the existing attribute values. 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.

This operation is vulnerable to exceeding the maximum URL size when making a REST request using the HTTP GET method. This operation does not support conditions using Expected.X.Name, Expected.X.Value, or Expected.X.Exists.

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

Parameters:

batchPutAttributesRequest -

Returns:

Result of the BatchPutAttributes operation returned by the service.

Throws:

DuplicateItemNameException - The item name was specified more than once.

InvalidParameterValueException - The value for a parameter is invalid.

MissingParameterException - The request must contain the specified missing parameter.

NoSuchDomainException - The specified domain does not exist.

NumberItemAttributesExceededException - Too many attributes in this item.

NumberDomainAttributesExceededException - Too many attributes in this domain.

NumberDomainBytesExceededException - Too many bytes in this domain.

NumberSubmittedItemsExceededException - Too many items exist in a single call.

NumberSubmittedAttributesExceededException - Too many attributes exist in a single call.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SimpleDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

batchPutAttributes

default BatchPutAttributesResponse batchPutAttributes(Consumer<BatchPutAttributesRequest.Builder> batchPutAttributesRequest)
                                               throws DuplicateItemNameException,
                                                      InvalidParameterValueException,
                                                      MissingParameterException,
                                                      NoSuchDomainException,
                                                      NumberItemAttributesExceededException,
                                                      NumberDomainAttributesExceededException,
                                                      NumberDomainBytesExceededException,
                                                      NumberSubmittedItemsExceededException,
                                                      NumberSubmittedAttributesExceededException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      SimpleDbException

The BatchPutAttributes operation creates or replaces attributes within one or more items. By using this operation, the client can perform multiple PutAttribute operation with a single call. This helps yield savings in round trips and latencies, enabling Amazon SimpleDB to optimize requests and generally produce better throughput.

The client may specify the item name with the Item.X.ItemName parameter. The client may specify new attributes using a combination of the Item.X.Attribute.Y.Name and Item.X.Attribute.Y.Value parameters. The client may specify the first attribute for the first item using the parameters Item.0.Attribute.0.Name and Item.0.Attribute.0.Value, and for 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 values to replace the existing attribute values. 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.

This operation is vulnerable to exceeding the maximum URL size when making a REST request using the HTTP GET method. This operation does not support conditions using Expected.X.Name, Expected.X.Value, or Expected.X.Exists.

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

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

Parameters:

batchPutAttributesRequest - A Consumer that will call methods on BatchPutAttributesRequest.Builder to create a request.

Returns:

Result of the BatchPutAttributes operation returned by the service.

Throws:

DuplicateItemNameException - The item name was specified more than once.

InvalidParameterValueException - The value for a parameter is invalid.

MissingParameterException - The request must contain the specified missing parameter.

NoSuchDomainException - The specified domain does not exist.

NumberItemAttributesExceededException - Too many attributes in this item.

NumberDomainAttributesExceededException - Too many attributes in this domain.

NumberDomainBytesExceededException - Too many bytes in this domain.

NumberSubmittedItemsExceededException - Too many items exist in a single call.

NumberSubmittedAttributesExceededException - Too many attributes exist in a single call.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SimpleDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

createDomain

default CreateDomainResponse createDomain(CreateDomainRequest createDomainRequest)
                                   throws InvalidParameterValueException,
                                          MissingParameterException,
                                          NumberDomainsExceededException,
                                          AwsServiceException,
                                          SdkClientException,
                                          SimpleDbException

The CreateDomain operation creates a new domain. The domain name should 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.

The client can create up to 100 domains per account.

If the client requires additional domains, go to http://aws.amazon.com/contact-us/simpledb-limit-request/.

Parameters:

createDomainRequest -

Returns:

Result of the CreateDomain operation returned by the service.

Throws:

InvalidParameterValueException - The value for a parameter is invalid.

MissingParameterException - The request must contain the specified missing parameter.

NumberDomainsExceededException - Too many domains exist per this account.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SimpleDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

createDomain

default CreateDomainResponse createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest)
                                   throws InvalidParameterValueException,
                                          MissingParameterException,
                                          NumberDomainsExceededException,
                                          AwsServiceException,
                                          SdkClientException,
                                          SimpleDbException

The CreateDomain operation creates a new domain. The domain name should 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.

The client can create up to 100 domains per account.

If the client requires additional domains, go to http://aws.amazon.com/contact-us/simpledb-limit-request/.

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

Parameters:

createDomainRequest - A Consumer that will call methods on CreateDomainRequest.Builder to create a request.

Returns:

Result of the CreateDomain operation returned by the service.

Throws:

InvalidParameterValueException - The value for a parameter is invalid.

MissingParameterException - The request must contain the specified missing parameter.

NumberDomainsExceededException - Too many domains exist per this account.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SimpleDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

deleteAttributes

default DeleteAttributesResponse deleteAttributes(DeleteAttributesRequest deleteAttributesRequest)
                                           throws InvalidParameterValueException,
                                                  MissingParameterException,
                                                  NoSuchDomainException,
                                                  AttributeDoesNotExistException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  SimpleDbException

Deletes one or more attributes associated with an item. If all attributes of the item are deleted, the item is 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 item data and uses an eventual consistency update model, performing a GetAttributes or Select operation (read) immediately after a DeleteAttributes or PutAttributes operation (write) might not return updated item data.

Parameters:

deleteAttributesRequest -

Returns:

Result of the DeleteAttributes operation returned by the service.

Throws:

InvalidParameterValueException - The value for a parameter is invalid.

MissingParameterException - The request must contain the specified missing parameter.

NoSuchDomainException - The specified domain does not exist.

AttributeDoesNotExistException - The specified attribute does not exist.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SimpleDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

deleteAttributes

default DeleteAttributesResponse deleteAttributes(Consumer<DeleteAttributesRequest.Builder> deleteAttributesRequest)
                                           throws InvalidParameterValueException,
                                                  MissingParameterException,
                                                  NoSuchDomainException,
                                                  AttributeDoesNotExistException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  SimpleDbException

Deletes one or more attributes associated with an item. If all attributes of the item are deleted, the item is 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 item data and uses an eventual consistency update model, performing a GetAttributes or Select operation (read) immediately after a DeleteAttributes or PutAttributes operation (write) might not return updated item data.

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

Parameters:

deleteAttributesRequest - A Consumer that will call methods on DeleteAttributesRequest.Builder to create a request.

Returns:

Result of the DeleteAttributes operation returned by the service.

Throws:

InvalidParameterValueException - The value for a parameter is invalid.

MissingParameterException - The request must contain the specified missing parameter.

NoSuchDomainException - The specified domain does not exist.

AttributeDoesNotExistException - The specified attribute does not exist.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SimpleDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

deleteDomain

default DeleteDomainResponse deleteDomain(DeleteDomainRequest deleteDomainRequest)
                                   throws MissingParameterException,
                                          AwsServiceException,
                                          SdkClientException,
                                          SimpleDbException

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.

Parameters:

deleteDomainRequest -

Returns:

Result of the DeleteDomain operation returned by the service.

Throws:

MissingParameterException - The request must contain the specified missing parameter.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SimpleDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

deleteDomain

default DeleteDomainResponse deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest)
                                   throws MissingParameterException,
                                          AwsServiceException,
                                          SdkClientException,
                                          SimpleDbException

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.

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

Parameters:

deleteDomainRequest - A Consumer that will call methods on DeleteDomainRequest.Builder to create a request.

Returns:

Result of the DeleteDomain operation returned by the service.

Throws:

MissingParameterException - The request must contain the specified missing parameter.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SimpleDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

domainMetadata

default DomainMetadataResponse domainMetadata(DomainMetadataRequest domainMetadataRequest)
                                       throws MissingParameterException,
                                              NoSuchDomainException,
                                              AwsServiceException,
                                              SdkClientException,
                                              SimpleDbException

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

Parameters:

domainMetadataRequest -

Returns:

Result of the DomainMetadata operation returned by the service.

Throws:

MissingParameterException - The request must contain the specified missing parameter.

NoSuchDomainException - The specified domain does not exist.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SimpleDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

domainMetadata

default DomainMetadataResponse domainMetadata(Consumer<DomainMetadataRequest.Builder> domainMetadataRequest)
                                       throws MissingParameterException,
                                              NoSuchDomainException,
                                              AwsServiceException,
                                              SdkClientException,
                                              SimpleDbException

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

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

Parameters:

domainMetadataRequest - A Consumer that will call methods on DomainMetadataRequest.Builder to create a request.

Returns:

Result of the DomainMetadata operation returned by the service.

Throws:

MissingParameterException - The request must contain the specified missing parameter.

NoSuchDomainException - The specified domain does not exist.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SimpleDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

getAttributes

default GetAttributesResponse getAttributes(GetAttributesRequest getAttributesRequest)
                                     throws InvalidParameterValueException,
                                            MissingParameterException,
                                            NoSuchDomainException,
                                            AwsServiceException,
                                            SdkClientException,
                                            SimpleDbException

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

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.

Parameters:

getAttributesRequest -

Returns:

Result of the GetAttributes operation returned by the service.

Throws:

InvalidParameterValueException - The value for a parameter is invalid.

MissingParameterException - The request must contain the specified missing parameter.

NoSuchDomainException - The specified domain does not exist.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SimpleDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

getAttributes

default GetAttributesResponse getAttributes(Consumer<GetAttributesRequest.Builder> getAttributesRequest)
                                     throws InvalidParameterValueException,
                                            MissingParameterException,
                                            NoSuchDomainException,
                                            AwsServiceException,
                                            SdkClientException,
                                            SimpleDbException

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

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.

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

Parameters:

getAttributesRequest - A Consumer that will call methods on GetAttributesRequest.Builder to create a request.

Returns:

Result of the GetAttributes operation returned by the service.

Throws:

InvalidParameterValueException - The value for a parameter is invalid.

MissingParameterException - The request must contain the specified missing parameter.

NoSuchDomainException - The specified domain does not exist.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SimpleDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

listDomains

default ListDomainsResponse listDomains()
                                 throws InvalidParameterValueException,
                                        InvalidNextTokenException,
                                        AwsServiceException,
                                        SdkClientException,
                                        SimpleDbException

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 provided by the operation returns up to MaxNumberOfDomains more domain names with each successive operation call.

Returns:

Result of the ListDomains operation returned by the service.

Throws:

InvalidParameterValueException - The value for a parameter is invalid.

InvalidNextTokenException - The specified NextToken is not valid.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SimpleDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

listDomains(ListDomainsRequest)

listDomains

default ListDomainsResponse listDomains(ListDomainsRequest listDomainsRequest)
                                 throws InvalidParameterValueException,
                                        InvalidNextTokenException,
                                        AwsServiceException,
                                        SdkClientException,
                                        SimpleDbException

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 provided by the operation returns up to MaxNumberOfDomains more domain names with each successive operation call.

Parameters:

listDomainsRequest -

Returns:

Result of the ListDomains operation returned by the service.

Throws:

InvalidParameterValueException - The value for a parameter is invalid.

InvalidNextTokenException - The specified NextToken is not valid.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SimpleDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

listDomains

default ListDomainsResponse listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest)
                                 throws InvalidParameterValueException,
                                        InvalidNextTokenException,
                                        AwsServiceException,
                                        SdkClientException,
                                        SimpleDbException

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 provided by the operation returns up to MaxNumberOfDomains more domain names with each successive operation call.

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

Parameters:

listDomainsRequest - A Consumer that will call methods on ListDomainsRequest.Builder to create a request.

Returns:

Result of the ListDomains operation returned by the service.

Throws:

InvalidParameterValueException - The value for a parameter is invalid.

InvalidNextTokenException - The specified NextToken is not valid.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SimpleDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

putAttributes

default PutAttributesResponse putAttributes(PutAttributesRequest putAttributesRequest)
                                     throws InvalidParameterValueException,
                                            MissingParameterException,
                                            NoSuchDomainException,
                                            NumberDomainAttributesExceededException,
                                            NumberDomainBytesExceededException,
                                            NumberItemAttributesExceededException,
                                            AttributeDoesNotExistException,
                                            AwsServiceException,
                                            SdkClientException,
                                            SimpleDbException

The PutAttributes operation creates or replaces attributes in an item. The client may specify new attributes using a combination of the Attribute.X.Name and Attribute.X.Value parameters. The client specifies 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.

You cannot specify an empty string as an attribute name.

Because Amazon SimpleDB makes multiple copies of client data and uses an eventual consistency update model, an immediate GetAttributes or Select operation (read) immediately after a PutAttributes or DeleteAttributes operation (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

Parameters:

putAttributesRequest -

Returns:

Result of the PutAttributes operation returned by the service.

Throws:

InvalidParameterValueException - The value for a parameter is invalid.

MissingParameterException - The request must contain the specified missing parameter.

NoSuchDomainException - The specified domain does not exist.

NumberDomainAttributesExceededException - Too many attributes in this domain.

NumberDomainBytesExceededException - Too many bytes in this domain.

NumberItemAttributesExceededException - Too many attributes in this item.

AttributeDoesNotExistException - The specified attribute does not exist.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SimpleDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

putAttributes

default PutAttributesResponse putAttributes(Consumer<PutAttributesRequest.Builder> putAttributesRequest)
                                     throws InvalidParameterValueException,
                                            MissingParameterException,
                                            NoSuchDomainException,
                                            NumberDomainAttributesExceededException,
                                            NumberDomainBytesExceededException,
                                            NumberItemAttributesExceededException,
                                            AttributeDoesNotExistException,
                                            AwsServiceException,
                                            SdkClientException,
                                            SimpleDbException

The PutAttributes operation creates or replaces attributes in an item. The client may specify new attributes using a combination of the Attribute.X.Name and Attribute.X.Value parameters. The client specifies 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.

You cannot specify an empty string as an attribute name.

Because Amazon SimpleDB makes multiple copies of client data and uses an eventual consistency update model, an immediate GetAttributes or Select operation (read) immediately after a PutAttributes or DeleteAttributes operation (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

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

Parameters:

putAttributesRequest - A Consumer that will call methods on PutAttributesRequest.Builder to create a request.

Returns:

Result of the PutAttributes operation returned by the service.

Throws:

InvalidParameterValueException - The value for a parameter is invalid.

MissingParameterException - The request must contain the specified missing parameter.

NoSuchDomainException - The specified domain does not exist.

NumberDomainAttributesExceededException - Too many attributes in this domain.

NumberDomainBytesExceededException - Too many bytes in this domain.

NumberItemAttributesExceededException - Too many attributes in this item.

AttributeDoesNotExistException - The specified attribute does not exist.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SimpleDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

select

default SelectResponse select(SelectRequest selectRequest)
                       throws InvalidParameterValueException,
                              InvalidNextTokenException,
                              InvalidNumberPredicatesException,
                              InvalidNumberValueTestsException,
                              InvalidQueryExpressionException,
                              MissingParameterException,
                              NoSuchDomainException,
                              RequestTimeoutException,
                              TooManyRequestedAttributesException,
                              AwsServiceException,
                              SdkClientException,
                              SimpleDbException

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, if the client asks to retrieve 2500 items, but each individual item is 10 kB in size, the system returns 100 items and an appropriate NextToken so the client can access 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.

Parameters:

selectRequest -

Returns:

Result of the Select operation returned by the service.

Throws:

InvalidParameterValueException - The value for a parameter is invalid.

InvalidNextTokenException - The specified NextToken is not valid.

InvalidNumberPredicatesException - Too many predicates exist in the query expression.

InvalidNumberValueTestsException - Too many predicates exist in the query expression.

InvalidQueryExpressionException - The specified query expression syntax is not valid.

MissingParameterException - The request must contain the specified missing parameter.

NoSuchDomainException - The specified domain does not exist.

RequestTimeoutException - A timeout occurred when attempting to query the specified domain with specified query expression.

TooManyRequestedAttributesException - Too many attributes requested.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SimpleDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

select

default SelectResponse select(Consumer<SelectRequest.Builder> selectRequest)
                       throws InvalidParameterValueException,
                              InvalidNextTokenException,
                              InvalidNumberPredicatesException,
                              InvalidNumberValueTestsException,
                              InvalidQueryExpressionException,
                              MissingParameterException,
                              NoSuchDomainException,
                              RequestTimeoutException,
                              TooManyRequestedAttributesException,
                              AwsServiceException,
                              SdkClientException,
                              SimpleDbException

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, if the client asks to retrieve 2500 items, but each individual item is 10 kB in size, the system returns 100 items and an appropriate NextToken so the client can access 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.

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

Parameters:

selectRequest - A Consumer that will call methods on SelectRequest.Builder to create a request.

Returns:

Result of the Select operation returned by the service.

Throws:

InvalidParameterValueException - The value for a parameter is invalid.

InvalidNextTokenException - The specified NextToken is not valid.

InvalidNumberPredicatesException - Too many predicates exist in the query expression.

InvalidNumberValueTestsException - Too many predicates exist in the query expression.

InvalidQueryExpressionException - The specified query expression syntax is not valid.

MissingParameterException - The request must contain the specified missing parameter.

NoSuchDomainException - The specified domain does not exist.

RequestTimeoutException - A timeout occurred when attempting to query the specified domain with specified query expression.

TooManyRequestedAttributesException - Too many attributes requested.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

SimpleDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

serviceMetadata

static ServiceMetadata serviceMetadata()