Class: Aws::SimpleDB::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SimpleDB::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-simpledb/lib/aws-sdk-simpledb/client.rb
Overview
An API client for SimpleDB. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::SimpleDB::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#batch_delete_attributes(params = {}) ⇒ Struct
Performs multiple DeleteAttributes operations in a single call, which reduces round trips and latencies.
-
#batch_put_attributes(params = {}) ⇒ Struct
The
BatchPutAttributes
operation creates or replaces attributes within one or more items. -
#create_domain(params = {}) ⇒ Struct
The
CreateDomain
operation creates a new domain. -
#delete_attributes(params = {}) ⇒ Struct
Deletes one or more attributes associated with an item.
-
#delete_domain(params = {}) ⇒ Struct
The
DeleteDomain
operation deletes a domain. -
#domain_metadata(params = {}) ⇒ Types::DomainMetadataResult
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.
-
#get_attributes(params = {}) ⇒ Types::GetAttributesResult
Returns all of the attributes associated with the specified item.
-
#list_domains(params = {}) ⇒ Types::ListDomainsResult
The
ListDomains
operation lists all domains associated with the Access Key ID. -
#put_attributes(params = {}) ⇒ Struct
The PutAttributes operation creates or replaces attributes in an item.
-
#select(params = {}) ⇒ Types::SelectResult
The
Select
operation returns a set of attributes forItemNames
that match the select expression.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
418 419 420 |
# File 'gems/aws-sdk-simpledb/lib/aws-sdk-simpledb/client.rb', line 418 def initialize(*args) super end |
Instance Method Details
#batch_delete_attributes(params = {}) ⇒ Struct
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
461 462 463 464 |
# File 'gems/aws-sdk-simpledb/lib/aws-sdk-simpledb/client.rb', line 461 def batch_delete_attributes(params = {}, = {}) req = build_request(:batch_delete_attributes, params) req.send_request() end |
#batch_put_attributes(params = {}) ⇒ Struct
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
542 543 544 545 |
# File 'gems/aws-sdk-simpledb/lib/aws-sdk-simpledb/client.rb', line 542 def batch_put_attributes(params = {}, = {}) req = build_request(:batch_put_attributes, params) req.send_request() end |
#create_domain(params = {}) ⇒ Struct
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/.
576 577 578 579 |
# File 'gems/aws-sdk-simpledb/lib/aws-sdk-simpledb/client.rb', line 576 def create_domain(params = {}, = {}) req = build_request(:create_domain, params) req.send_request() end |
#delete_attributes(params = {}) ⇒ Struct
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.
635 636 637 638 |
# File 'gems/aws-sdk-simpledb/lib/aws-sdk-simpledb/client.rb', line 635 def delete_attributes(params = {}, = {}) req = build_request(:delete_attributes, params) req.send_request() end |
#delete_domain(params = {}) ⇒ Struct
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.
657 658 659 660 |
# File 'gems/aws-sdk-simpledb/lib/aws-sdk-simpledb/client.rb', line 657 def delete_domain(params = {}, = {}) req = build_request(:delete_domain, params) req.send_request() end |
#domain_metadata(params = {}) ⇒ Types::DomainMetadataResult
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.
697 698 699 700 |
# File 'gems/aws-sdk-simpledb/lib/aws-sdk-simpledb/client.rb', line 697 def (params = {}, = {}) req = build_request(:domain_metadata, params) req.send_request() end |
#get_attributes(params = {}) ⇒ Types::GetAttributesResult
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.
746 747 748 749 |
# File 'gems/aws-sdk-simpledb/lib/aws-sdk-simpledb/client.rb', line 746 def get_attributes(params = {}, = {}) req = build_request(:get_attributes, params) req.send_request() end |
#list_domains(params = {}) ⇒ Types::ListDomainsResult
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
789 790 791 792 |
# File 'gems/aws-sdk-simpledb/lib/aws-sdk-simpledb/client.rb', line 789 def list_domains(params = {}, = {}) req = build_request(:list_domains, params) req.send_request() end |
#put_attributes(params = {}) ⇒ Struct
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
867 868 869 870 |
# File 'gems/aws-sdk-simpledb/lib/aws-sdk-simpledb/client.rb', line 867 def put_attributes(params = {}, = {}) req = build_request(:put_attributes, params) req.send_request() end |
#select(params = {}) ⇒ Types::SelectResult
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
924 925 926 927 |
# File 'gems/aws-sdk-simpledb/lib/aws-sdk-simpledb/client.rb', line 924 def select(params = {}, = {}) req = build_request(:select, params) req.send_request() end |