AWSSimpleDB

@interface AWSSimpleDB

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.

  • The service configuration used to instantiate this service client.

    Warning

    Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration

    Swift

    var configuration: UnsafeMutablePointer<Int32> { get }
  • Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with defaultServiceConfiguration from [AWSServiceManager defaultServiceManager]. The reference to this object is maintained by the SDK, and you do not need to retain it manually.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
       let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
       let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider)
       AWSServiceManager.default().defaultServiceConfiguration = configuration
    
       return true
    

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
         AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                         identityPoolId:@"YourIdentityPoolId"];
         AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1
                                                                              credentialsProvider:credentialsProvider];
         [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration;
    
         return YES;
     }
    

    Then call the following to get the default service client:

    Swift

    let SimpleDB = AWSSimpleDB.default()
    

    Objective-C

    AWSSimpleDB *SimpleDB = [AWSSimpleDB defaultSimpleDB];
    

    Declaration

    Objective-C

    + (nonnull instancetype)defaultSimpleDB;

    Swift

    class func `default`() -> Self

    Return Value

    The default service client.

  • Creates a service client with the given service configuration and registers it for the key.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
       let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
       let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
       AWSSimpleDB.register(with: configuration!, forKey: "USWest2SimpleDB")
    
       return true
    

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
        AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                        identityPoolId:@"YourIdentityPoolId"];
        AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                             credentialsProvider:credentialsProvider];
    
        [AWSSimpleDB registerSimpleDBWithConfiguration:configuration forKey:@"USWest2SimpleDB"];
    
        return YES;
    }
    

    Then call the following to get the service client:

    Swift

    let SimpleDB = AWSSimpleDB(forKey: "USWest2SimpleDB")
    

    Objective-C

    AWSSimpleDB *SimpleDB = [AWSSimpleDB SimpleDBForKey:@"USWest2SimpleDB"];
    

    Warning

    After calling this method, do not modify the configuration object. It may cause unspecified behaviors.

    Declaration

    Objective-C

    + (void)registerSimpleDBWithConfiguration:(id)configuration
                                       forKey:(nonnull NSString *)key;

    Swift

    class func register(withConfiguration configuration: Any!, forKey key: String)

    Parameters

    configuration

    A service configuration object.

    key

    A string to identify the service client.

  • Retrieves the service client associated with the key. You need to call + registerSimpleDBWithConfiguration:forKey: before invoking this method.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
       let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
       let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
       AWSSimpleDB.register(with: configuration!, forKey: "USWest2SimpleDB")
    
       return true
    

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
        AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                        identityPoolId:@"YourIdentityPoolId"];
        AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                             credentialsProvider:credentialsProvider];
    
        [AWSSimpleDB registerSimpleDBWithConfiguration:configuration forKey:@"USWest2SimpleDB"];
    
        return YES;
    }
    

    Then call the following to get the service client:

    Swift

    let SimpleDB = AWSSimpleDB(forKey: "USWest2SimpleDB")
    

    Objective-C

    AWSSimpleDB *SimpleDB = [AWSSimpleDB SimpleDBForKey:@"USWest2SimpleDB"];
    

    Declaration

    Objective-C

    + (nonnull instancetype)SimpleDBForKey:(nonnull NSString *)key;

    Swift

    convenience init(forKey key: String)

    Parameters

    key

    A string to identify the service client.

    Return Value

    An instance of the service client.

  • Removes the service client associated with the key and release it.

    Warning

    Before calling this method, make sure no method is running on this client.

    Declaration

    Objective-C

    + (void)removeSimpleDBForKey:(nonnull NSString *)key;

    Swift

    class func remove(forKey key: String)

    Parameters

    key

    A string to identify the service client.

  • 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

    See

    AWSSimpleDBBatchDeleteAttributesRequest

    Declaration

    Objective-C

    - (id)batchDeleteAttributes:
        (nonnull AWSSimpleDBBatchDeleteAttributesRequest *)request;

    Swift

    func batchDeleteAttributes(_ request: AWSSimpleDBBatchDeleteAttributesRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the BatchDeleteAttributes service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil.

  • 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

    See

    AWSSimpleDBBatchDeleteAttributesRequest

    Declaration

    Objective-C

    - (void)batchDeleteAttributes:
                (nonnull AWSSimpleDBBatchDeleteAttributesRequest *)request
                completionHandler:
                    (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func batchDeleteAttributes(_ request: AWSSimpleDBBatchDeleteAttributesRequest, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the BatchDeleteAttributes service method.

    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful.

  • 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

    See

    AWSSimpleDBBatchPutAttributesRequest

    Declaration

    Objective-C

    - (id)batchPutAttributes:
        (nonnull AWSSimpleDBBatchPutAttributesRequest *)request;

    Swift

    func batchPutAttributes(_ request: AWSSimpleDBBatchPutAttributesRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the BatchPutAttributes service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSSimpleDBErrorDomain domain and the following error code: AWSSimpleDBErrorDuplicateItemName, AWSSimpleDBErrorInvalidParameterValue, AWSSimpleDBErrorMissingParameter, AWSSimpleDBErrorNoSuchDomain, AWSSimpleDBErrorNumberItemAttributesExceeded, AWSSimpleDBErrorNumberDomainAttributesExceeded, AWSSimpleDBErrorNumberDomainBytesExceeded, AWSSimpleDBErrorNumberSubmittedItemsExceeded, AWSSimpleDBErrorNumberSubmittedAttributesExceeded.

  • 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

    See

    AWSSimpleDBBatchPutAttributesRequest

    Declaration

    Objective-C

    - (void)
        batchPutAttributes:(nonnull AWSSimpleDBBatchPutAttributesRequest *)request
         completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func batchPutAttributes(_ request: AWSSimpleDBBatchPutAttributesRequest, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the BatchPutAttributes service method.

    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSimpleDBErrorDomain domain and the following error code: AWSSimpleDBErrorDuplicateItemName, AWSSimpleDBErrorInvalidParameterValue, AWSSimpleDBErrorMissingParameter, AWSSimpleDBErrorNoSuchDomain, AWSSimpleDBErrorNumberItemAttributesExceeded, AWSSimpleDBErrorNumberDomainAttributesExceeded, AWSSimpleDBErrorNumberDomainBytesExceeded, AWSSimpleDBErrorNumberSubmittedItemsExceeded, AWSSimpleDBErrorNumberSubmittedAttributesExceeded.

  • 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

    AWSSimpleDBCreateDomainRequest

    Declaration

    Objective-C

    - (id)createDomain:(nonnull AWSSimpleDBCreateDomainRequest *)request;

    Swift

    func createDomain(_ request: AWSSimpleDBCreateDomainRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateDomain service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSSimpleDBErrorDomain domain and the following error code: AWSSimpleDBErrorInvalidParameterValue, AWSSimpleDBErrorMissingParameter, AWSSimpleDBErrorNumberDomainsExceeded.

  • 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

    AWSSimpleDBCreateDomainRequest

    Declaration

    Objective-C

    - (void)createDomain:(nonnull AWSSimpleDBCreateDomainRequest *)request
        completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func createDomain(_ request: AWSSimpleDBCreateDomainRequest, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the CreateDomain service method.

    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSimpleDBErrorDomain domain and the following error code: AWSSimpleDBErrorInvalidParameterValue, AWSSimpleDBErrorMissingParameter, AWSSimpleDBErrorNumberDomainsExceeded.

  • 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.

    See

    AWSSimpleDBDeleteAttributesRequest

    Declaration

    Objective-C

    - (id)deleteAttributes:(nonnull AWSSimpleDBDeleteAttributesRequest *)request;

    Swift

    func deleteAttributes(_ request: AWSSimpleDBDeleteAttributesRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteAttributes service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSSimpleDBErrorDomain domain and the following error code: AWSSimpleDBErrorInvalidParameterValue, AWSSimpleDBErrorMissingParameter, AWSSimpleDBErrorNoSuchDomain, AWSSimpleDBErrorAttributeDoesNotExist.

  • 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.

    See

    AWSSimpleDBDeleteAttributesRequest

    Declaration

    Objective-C

    - (void)deleteAttributes:(nonnull AWSSimpleDBDeleteAttributesRequest *)request
           completionHandler:
               (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteAttributes(_ request: AWSSimpleDBDeleteAttributesRequest, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DeleteAttributes service method.

    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSimpleDBErrorDomain domain and the following error code: AWSSimpleDBErrorInvalidParameterValue, AWSSimpleDBErrorMissingParameter, AWSSimpleDBErrorNoSuchDomain, AWSSimpleDBErrorAttributeDoesNotExist.

  • 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

    AWSSimpleDBDeleteDomainRequest

    Declaration

    Objective-C

    - (id)deleteDomain:(nonnull AWSSimpleDBDeleteDomainRequest *)request;

    Swift

    func deleteDomain(_ request: AWSSimpleDBDeleteDomainRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteDomain service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSSimpleDBErrorDomain domain and the following error code: AWSSimpleDBErrorMissingParameter.

  • 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

    AWSSimpleDBDeleteDomainRequest

    Declaration

    Objective-C

    - (void)deleteDomain:(nonnull AWSSimpleDBDeleteDomainRequest *)request
        completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func deleteDomain(_ request: AWSSimpleDBDeleteDomainRequest, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DeleteDomain service method.

    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSimpleDBErrorDomain domain and the following error code: AWSSimpleDBErrorMissingParameter.

  • 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

    AWSSimpleDBDomainMetadataRequest

    See

    AWSSimpleDBDomainMetadataResult

    Declaration

    Objective-C

    - (id)domainMetadata:(nonnull AWSSimpleDBDomainMetadataRequest *)request;

    Swift

    func domainMetadata(_ request: AWSSimpleDBDomainMetadataRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DomainMetadata service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSimpleDBDomainMetadataResult. On failed execution, task.error may contain an NSError with AWSSimpleDBErrorDomain domain and the following error code: AWSSimpleDBErrorMissingParameter, AWSSimpleDBErrorNoSuchDomain.

  • 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

    AWSSimpleDBDomainMetadataRequest

    See

    AWSSimpleDBDomainMetadataResult

    Declaration

    Objective-C

    - (void)domainMetadata:(nonnull AWSSimpleDBDomainMetadataRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSSimpleDBDomainMetadataResult *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func domainMetadata(_ request: AWSSimpleDBDomainMetadataRequest, completionHandler: ((AWSSimpleDBDomainMetadataResult?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DomainMetadata service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSimpleDBErrorDomain domain and the following error code: AWSSimpleDBErrorMissingParameter, AWSSimpleDBErrorNoSuchDomain.

  • 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

    AWSSimpleDBGetAttributesRequest

    See

    AWSSimpleDBGetAttributesResult

    Declaration

    Objective-C

    - (id)getAttributes:(nonnull AWSSimpleDBGetAttributesRequest *)request;

    Swift

    func getAttributes(_ request: AWSSimpleDBGetAttributesRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetAttributes service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSimpleDBGetAttributesResult. On failed execution, task.error may contain an NSError with AWSSimpleDBErrorDomain domain and the following error code: AWSSimpleDBErrorInvalidParameterValue, AWSSimpleDBErrorMissingParameter, AWSSimpleDBErrorNoSuchDomain.

  • 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

    AWSSimpleDBGetAttributesRequest

    See

    AWSSimpleDBGetAttributesResult

    Declaration

    Objective-C

    - (void)getAttributes:(nonnull AWSSimpleDBGetAttributesRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSSimpleDBGetAttributesResult *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func getAttributes(_ request: AWSSimpleDBGetAttributesRequest, completionHandler: ((AWSSimpleDBGetAttributesResult?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the GetAttributes service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSimpleDBErrorDomain domain and the following error code: AWSSimpleDBErrorInvalidParameterValue, AWSSimpleDBErrorMissingParameter, AWSSimpleDBErrorNoSuchDomain.

  • 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

    AWSSimpleDBListDomainsRequest

    See

    AWSSimpleDBListDomainsResult

    Declaration

    Objective-C

    - (id)listDomains:(nonnull AWSSimpleDBListDomainsRequest *)request;

    Swift

    func listDomains(_ request: AWSSimpleDBListDomainsRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListDomains service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSimpleDBListDomainsResult. On failed execution, task.error may contain an NSError with AWSSimpleDBErrorDomain domain and the following error code: AWSSimpleDBErrorInvalidParameterValue, AWSSimpleDBErrorInvalidNextToken.

  • 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

    AWSSimpleDBListDomainsRequest

    See

    AWSSimpleDBListDomainsResult

    Declaration

    Objective-C

    - (void)listDomains:(nonnull AWSSimpleDBListDomainsRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSSimpleDBListDomainsResult *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func listDomains(_ request: AWSSimpleDBListDomainsRequest, completionHandler: ((AWSSimpleDBListDomainsResult?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ListDomains service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSimpleDBErrorDomain domain and the following error code: AWSSimpleDBErrorInvalidParameterValue, AWSSimpleDBErrorInvalidNextToken.

  • 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

    See

    AWSSimpleDBPutAttributesRequest

    Declaration

    Objective-C

    - (id)putAttributes:(nonnull AWSSimpleDBPutAttributesRequest *)request;

    Swift

    func putAttributes(_ request: AWSSimpleDBPutAttributesRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the PutAttributes service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSSimpleDBErrorDomain domain and the following error code: AWSSimpleDBErrorInvalidParameterValue, AWSSimpleDBErrorMissingParameter, AWSSimpleDBErrorNoSuchDomain, AWSSimpleDBErrorNumberDomainAttributesExceeded, AWSSimpleDBErrorNumberDomainBytesExceeded, AWSSimpleDBErrorNumberItemAttributesExceeded, AWSSimpleDBErrorAttributeDoesNotExist.

  • 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

    See

    AWSSimpleDBPutAttributesRequest

    Declaration

    Objective-C

    - (void)putAttributes:(nonnull AWSSimpleDBPutAttributesRequest *)request
        completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func putAttributes(_ request: AWSSimpleDBPutAttributesRequest, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the PutAttributes service method.

    completionHandler

    The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSimpleDBErrorDomain domain and the following error code: AWSSimpleDBErrorInvalidParameterValue, AWSSimpleDBErrorMissingParameter, AWSSimpleDBErrorNoSuchDomain, AWSSimpleDBErrorNumberDomainAttributesExceeded, AWSSimpleDBErrorNumberDomainBytesExceeded, AWSSimpleDBErrorNumberItemAttributesExceeded, AWSSimpleDBErrorAttributeDoesNotExist.

  • 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

    AWSSimpleDBSelectRequest

    See

    AWSSimpleDBSelectResult

    Declaration

    Objective-C

    - (id)select:(nonnull AWSSimpleDBSelectRequest *)request;

    Swift

    func select(_ request: AWSSimpleDBSelectRequest) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the Select service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSimpleDBSelectResult. On failed execution, task.error may contain an NSError with AWSSimpleDBErrorDomain domain and the following error code: AWSSimpleDBErrorInvalidParameterValue, AWSSimpleDBErrorInvalidNextToken, AWSSimpleDBErrorInvalidNumberPredicates, AWSSimpleDBErrorInvalidNumberValueTests, AWSSimpleDBErrorInvalidQueryExpression, AWSSimpleDBErrorMissingParameter, AWSSimpleDBErrorNoSuchDomain, AWSSimpleDBErrorRequestTimeout, AWSSimpleDBErrorTooManyRequestedAttributes.

  • 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

    AWSSimpleDBSelectRequest

    See

    AWSSimpleDBSelectResult

    Declaration

    Objective-C

    - (void)select:(nonnull AWSSimpleDBSelectRequest *)request
        completionHandler:(void (^_Nullable)(AWSSimpleDBSelectResult *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func select(_ request: AWSSimpleDBSelectRequest, completionHandler: ((AWSSimpleDBSelectResult?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the Select service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSimpleDBErrorDomain domain and the following error code: AWSSimpleDBErrorInvalidParameterValue, AWSSimpleDBErrorInvalidNextToken, AWSSimpleDBErrorInvalidNumberPredicates, AWSSimpleDBErrorInvalidNumberValueTests, AWSSimpleDBErrorInvalidQueryExpression, AWSSimpleDBErrorMissingParameter, AWSSimpleDBErrorNoSuchDomain, AWSSimpleDBErrorRequestTimeout, AWSSimpleDBErrorTooManyRequestedAttributes.