Table of Contents
SimpleDB.Client¶A low-level client representing Amazon SimpleDB 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.
import boto3
client = boto3.client('sdb')
These are the available methods:
batch_delete_attributes()batch_put_attributes()can_paginate()close()create_domain()delete_attributes()delete_domain()domain_metadata()get_attributes()get_paginator()get_waiter()list_domains()put_attributes()select()batch_delete_attributes(**kwargs)¶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:
See also: AWS API Documentation
Request Syntax
response = client.batch_delete_attributes(
DomainName='string',
Items=[
{
'Name': 'string',
'Attributes': [
{
'Name': 'string',
'AlternateNameEncoding': 'string',
'Value': 'string',
'AlternateValueEncoding': 'string'
},
]
},
]
)
[REQUIRED] A list of items on which to perform the operation.
None
batch_put_attributes(**kwargs)¶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.
Warning
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:
BatchPutAttributes operationSee also: AWS API Documentation
Request Syntax
response = client.batch_put_attributes(
DomainName='string',
Items=[
{
'Name': 'string',
'Attributes': [
{
'Name': 'string',
'Value': 'string',
'Replace': True|False
},
]
},
]
)
[REQUIRED] A list of items on which to perform the operation.
false .None
Exceptions
SimpleDB.Client.exceptions.DuplicateItemNameSimpleDB.Client.exceptions.InvalidParameterValueSimpleDB.Client.exceptions.MissingParameterSimpleDB.Client.exceptions.NoSuchDomainSimpleDB.Client.exceptions.NumberItemAttributesExceededSimpleDB.Client.exceptions.NumberDomainAttributesExceededSimpleDB.Client.exceptions.NumberDomainBytesExceededSimpleDB.Client.exceptions.NumberSubmittedItemsExceededSimpleDB.Client.exceptions.NumberSubmittedAttributesExceededcan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_domain(**kwargs)¶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/ .
See also: AWS API Documentation
Request Syntax
response = client.create_domain(
DomainName='string'
)
Exceptions
SimpleDB.Client.exceptions.InvalidParameterValueSimpleDB.Client.exceptions.MissingParameterSimpleDB.Client.exceptions.NumberDomainsExceededdelete_attributes(**kwargs)¶Deletes one or more attributes associated with an item. If all attributes of the item are deleted, the item is deleted.
DeleteAttributesis 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.
See also: AWS API Documentation
Request Syntax
response = client.delete_attributes(
DomainName='string',
ItemName='string',
Attributes=[
{
'Name': 'string',
'AlternateNameEncoding': 'string',
'Value': 'string',
'AlternateValueEncoding': 'string'
},
],
Expected={
'Name': 'string',
'Value': 'string',
'Exists': True|False
}
)
A list of Attributes. Similar to columns on a spreadsheet, attributes represent categories of data that can be assigned to items.
The update condition which, if specified, determines whether the specified attributes will be deleted or not. The update condition must be satisfied in order for this request to be processed and the attributes to be deleted.
The name of the attribute involved in the condition.
The value of an attribute. This value can only be specified when the Exists parameter is equal to true .
A value specifying whether or not the specified attribute must exist with the specified value in order for the update condition to be satisfied. Specify true if the attribute must exist for the update condition to be satisfied. Specify false if the attribute should not exist in order for the update condition to be satisfied.
None
Exceptions
SimpleDB.Client.exceptions.InvalidParameterValueSimpleDB.Client.exceptions.MissingParameterSimpleDB.Client.exceptions.NoSuchDomainSimpleDB.Client.exceptions.AttributeDoesNotExistdelete_domain(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.delete_domain(
DomainName='string'
)
Exceptions
SimpleDB.Client.exceptions.MissingParameterdomain_metadata(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.domain_metadata(
DomainName='string'
)
{
'ItemCount': 123,
'ItemNamesSizeBytes': 123,
'AttributeNameCount': 123,
'AttributeNamesSizeBytes': 123,
'AttributeValueCount': 123,
'AttributeValuesSizeBytes': 123,
'Timestamp': 123
}
Response Structure
Exceptions
SimpleDB.Client.exceptions.MissingParameterSimpleDB.Client.exceptions.NoSuchDomainget_attributes(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.get_attributes(
DomainName='string',
ItemName='string',
AttributeNames=[
'string',
],
ConsistentRead=True|False
)
The names of the attributes.
true , any data previously written to SimpleDB will be returned. Otherwise, results will be consistent eventually, and the client may not see data that was written immediately before your read.dict
Response Syntax
{
'Attributes': [
{
'Name': 'string',
'AlternateNameEncoding': 'string',
'Value': 'string',
'AlternateValueEncoding': 'string'
},
]
}
Response Structure
Exceptions
SimpleDB.Client.exceptions.InvalidParameterValueSimpleDB.Client.exceptions.MissingParameterSimpleDB.Client.exceptions.NoSuchDomainget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_domains(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_domains(
MaxNumberOfDomains=123,
NextToken='string'
)
dict
Response Syntax
{
'DomainNames': [
'string',
],
'NextToken': 'string'
}
Response Structure
MaxNumberOfDomains still available.Exceptions
SimpleDB.Client.exceptions.InvalidParameterValueSimpleDB.Client.exceptions.InvalidNextTokenput_attributes(**kwargs)¶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:
See also: AWS API Documentation
Request Syntax
response = client.put_attributes(
DomainName='string',
ItemName='string',
Attributes=[
{
'Name': 'string',
'Value': 'string',
'Replace': True|False
},
],
Expected={
'Name': 'string',
'Value': 'string',
'Exists': True|False
}
)
[REQUIRED] The list of attributes.
false .The update condition which, if specified, determines whether the specified attributes will be updated or not. The update condition must be satisfied in order for this request to be processed and the attributes to be updated.
The name of the attribute involved in the condition.
The value of an attribute. This value can only be specified when the Exists parameter is equal to true .
A value specifying whether or not the specified attribute must exist with the specified value in order for the update condition to be satisfied. Specify true if the attribute must exist for the update condition to be satisfied. Specify false if the attribute should not exist in order for the update condition to be satisfied.
None
Exceptions
SimpleDB.Client.exceptions.InvalidParameterValueSimpleDB.Client.exceptions.MissingParameterSimpleDB.Client.exceptions.NoSuchDomainSimpleDB.Client.exceptions.NumberDomainAttributesExceededSimpleDB.Client.exceptions.NumberDomainBytesExceededSimpleDB.Client.exceptions.NumberItemAttributesExceededSimpleDB.Client.exceptions.AttributeDoesNotExistselect(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.select(
SelectExpression='string',
NextToken='string',
ConsistentRead=True|False
)
ItemNames .true , any data previously written to SimpleDB will be returned. Otherwise, results will be consistent eventually, and the client may not see data that was written immediately before your read.dict
Response Syntax
{
'Items': [
{
'Name': 'string',
'AlternateNameEncoding': 'string',
'Attributes': [
{
'Name': 'string',
'AlternateNameEncoding': 'string',
'Value': 'string',
'AlternateValueEncoding': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
MaxNumberOfItems were matched, the response size exceeded 1 megabyte, or the execution time exceeded 5 seconds.Exceptions
SimpleDB.Client.exceptions.InvalidParameterValueSimpleDB.Client.exceptions.InvalidNextTokenSimpleDB.Client.exceptions.InvalidNumberPredicatesSimpleDB.Client.exceptions.InvalidNumberValueTestsSimpleDB.Client.exceptions.InvalidQueryExpressionSimpleDB.Client.exceptions.MissingParameterSimpleDB.Client.exceptions.NoSuchDomainSimpleDB.Client.exceptions.RequestTimeoutSimpleDB.Client.exceptions.TooManyRequestedAttributesThe available paginators are:
SimpleDB.Paginator.ListDomains¶paginator = client.get_paginator('list_domains')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SimpleDB.Client.list_domains().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'DomainNames': [
'string',
],
}
Response Structure
SimpleDB.Paginator.Select¶paginator = client.get_paginator('select')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SimpleDB.Client.select().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
SelectExpression='string',
ConsistentRead=True|False,
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
true , any data previously written to SimpleDB will be returned. Otherwise, results will be consistent eventually, and the client may not see data that was written immediately before your read.A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Items': [
{
'Name': 'string',
'AlternateNameEncoding': 'string',
'Attributes': [
{
'Name': 'string',
'AlternateNameEncoding': 'string',
'Value': 'string',
'AlternateValueEncoding': 'string'
},
]
},
],
}
Response Structure