@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonSimpleDB extends Object implements AmazonSimpleDB
AmazonSimpleDB
. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
BatchDeleteAttributesResult |
batchDeleteAttributes(BatchDeleteAttributesRequest request)
Performs multiple DeleteAttributes operations in a single call, which reduces round trips and latencies.
|
BatchPutAttributesResult |
batchPutAttributes(BatchPutAttributesRequest request)
The
BatchPutAttributes operation creates or replaces attributes within one or more items. |
CreateDomainResult |
createDomain(CreateDomainRequest request)
The
CreateDomain operation creates a new domain. |
DeleteAttributesResult |
deleteAttributes(DeleteAttributesRequest request)
Deletes one or more attributes associated with an item.
|
DeleteDomainResult |
deleteDomain(DeleteDomainRequest request)
The
DeleteDomain operation deletes a domain. |
DomainMetadataResult |
domainMetadata(DomainMetadataRequest request)
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.
|
GetAttributesResult |
getAttributes(GetAttributesRequest request)
Returns all of the attributes associated with the specified item.
|
ListDomainsResult |
listDomains()
Simplified method form for invoking the ListDomains operation.
|
ListDomainsResult |
listDomains(ListDomainsRequest request)
The
ListDomains operation lists all domains associated with the Access Key ID. |
PutAttributesResult |
putAttributes(PutAttributesRequest request)
The PutAttributes operation creates or replaces attributes in an item.
|
SelectResult |
select(SelectRequest request)
The
Select operation returns a set of attributes for ItemNames that match the select
expression. |
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("sdb.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AmazonSimpleDB.setEndpoint(String) , sets the regional endpoint for this client's
service calls. |
public void setEndpoint(String endpoint)
AmazonSimpleDB
Callers can pass in just the endpoint (ex: "sdb.amazonaws.com") or a full URL, including the protocol (ex:
"sdb.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint
in interface AmazonSimpleDB
endpoint
- The endpoint (ex: "sdb.amazonaws.com") or a full URL, including the protocol (ex: "sdb.amazonaws.com") of
the region specific AWS endpoint this client will communicate with.public void setRegion(Region region)
AmazonSimpleDB
AmazonSimpleDB.setEndpoint(String)
, sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion
in interface AmazonSimpleDB
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public BatchDeleteAttributesResult batchDeleteAttributes(BatchDeleteAttributesRequest request)
AmazonSimpleDB
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:
batchDeleteAttributes
in interface AmazonSimpleDB
public BatchPutAttributesResult batchPutAttributes(BatchPutAttributesRequest request)
AmazonSimpleDB
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.
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:
BatchPutAttributes
operationbatchPutAttributes
in interface AmazonSimpleDB
public CreateDomainResult createDomain(CreateDomainRequest request)
AmazonSimpleDB
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/.
createDomain
in interface AmazonSimpleDB
public DeleteAttributesResult deleteAttributes(DeleteAttributesRequest request)
AmazonSimpleDB
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.
deleteAttributes
in interface AmazonSimpleDB
public DeleteDomainResult deleteDomain(DeleteDomainRequest request)
AmazonSimpleDB
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.
deleteDomain
in interface AmazonSimpleDB
public DomainMetadataResult domainMetadata(DomainMetadataRequest request)
AmazonSimpleDB
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.
domainMetadata
in interface AmazonSimpleDB
public GetAttributesResult getAttributes(GetAttributesRequest request)
AmazonSimpleDB
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.
getAttributes
in interface AmazonSimpleDB
public ListDomainsResult listDomains(ListDomainsRequest request)
AmazonSimpleDB
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.
listDomains
in interface AmazonSimpleDB
public ListDomainsResult listDomains()
AmazonSimpleDB
listDomains
in interface AmazonSimpleDB
AmazonSimpleDB.listDomains(ListDomainsRequest)
public PutAttributesResult putAttributes(PutAttributesRequest request)
AmazonSimpleDB
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:
putAttributes
in interface AmazonSimpleDB
public SelectResult select(SelectRequest request)
AmazonSimpleDB
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.
select
in interface AmazonSimpleDB