NAME

Paws::SDB - Perl Interface to AWS Amazon SimpleDB

SYNOPSIS

  use Paws;

  my $obj = Paws->service('SDB');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

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/ (http://aws.amazon.com/simpledb/) for more information.

For the AWS API documentation, see https://docs.aws.amazon.com/simpledb/

METHODS

BatchDeleteAttributes

DomainName => Str
Items => ArrayRef[Paws::SDB::DeletableItem]

Each argument is described in detail in: Paws::SDB::BatchDeleteAttributes

Returns: nothing

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

BatchPutAttributes

DomainName => Str
Items => ArrayRef[Paws::SDB::ReplaceableItem]

Each argument is described in detail in: Paws::SDB::BatchPutAttributes

Returns: nothing

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

CreateDomain

DomainName => Str

Each argument is described in detail in: Paws::SDB::CreateDomain

Returns: nothing

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/ (http://aws.amazon.com/contact-us/simpledb-limit-request/).

DeleteAttributes

DomainName => Str
ItemName => Str
[Attributes => ArrayRef[Paws::SDB::DeletableAttribute]]
[Expected => Paws::SDB::UpdateCondition]

Each argument is described in detail in: Paws::SDB::DeleteAttributes

Returns: nothing

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.

DeleteDomain

DomainName => Str

Each argument is described in detail in: Paws::SDB::DeleteDomain

Returns: nothing

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.

DomainMetadata

DomainName => Str

Each argument is described in detail in: Paws::SDB::DomainMetadata

Returns: a Paws::SDB::DomainMetadataResult instance

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.

GetAttributes

DomainName => Str
ItemName => Str
[AttributeName => Str]
[ConsistentRead => Bool]

Each argument is described in detail in: Paws::SDB::GetAttributes

Returns: a Paws::SDB::GetAttributesResult instance

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.

ListDomains

[MaxNumberOfDomains => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SDB::ListDomains

Returns: a Paws::SDB::ListDomainsResult instance

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.

PutAttributes

Attributes => ArrayRef[Paws::SDB::ReplaceableAttribute]
DomainName => Str
ItemName => Str
[Expected => Paws::SDB::UpdateCondition]

Each argument is described in detail in: Paws::SDB::PutAttributes

Returns: nothing

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

Select

SelectExpression => Str
[ConsistentRead => Bool]
[NextToken => Str]

Each argument is described in detail in: Paws::SDB::Select

Returns: a Paws::SDB::SelectResult instance

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.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllDomains(sub { },[MaxNumberOfDomains => Int, NextToken => Str])

ListAllDomains([MaxNumberOfDomains => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - DomainNames, passing the object as the first parameter, and the string 'DomainNames' as the second parameter 

If not, it will return a a Paws::SDB::ListDomainsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SelectAll(sub { },SelectExpression => Str, [ConsistentRead => Bool, NextToken => Str])

SelectAll(SelectExpression => Str, [ConsistentRead => Bool, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Items, passing the object as the first parameter, and the string 'Items' as the second parameter 

If not, it will return a a Paws::SDB::SelectResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues