AWSDynamoDB Class Reference

Inherits from AWSService : NSObject
Declared in AWSDynamoDBService.h
AWSDynamoDBService.m

Overview

Amazon DynamoDB

This is the Amazon DynamoDB API Reference. This guide provides descriptions of the low-level DynamoDB API.

This guide is intended for use with the following DynamoDB documentation:

Instead of making the requests to the low-level DynamoDB API directly from your application, we recommend that you use the AWS Software Development Kits (SDKs). The easy-to-use libraries in the AWS SDKs make it unnecessary to call the low-level DynamoDB API directly from your application. The libraries take care of request authentication, serialization, and connection management. For more information, see Using the AWS SDKs with DynamoDB in the Amazon DynamoDB Developer Guide.

If you decide to code against the low-level DynamoDB API directly, you will need to write the necessary code to authenticate your requests. For more information on signing your requests, see Using the DynamoDB API in the Amazon DynamoDB Developer Guide.

The following are short descriptions of each low-level API action, organized by function.

Managing Tables

  • CreateTable - Creates a table with user-specified provisioned throughput settings. You must define a primary key for the table - either a simple primary key (partition key), or a composite primary key (partition key and sort key). Optionally, you can create one or more secondary indexes, which provide fast data access using non-key attributes.

  • DescribeTable - Returns metadata for a table, such as table size, status, and index information.

  • UpdateTable - Modifies the provisioned throughput settings for a table. Optionally, you can modify the provisioned throughput settings for global secondary indexes on the table.

  • ListTables - Returns a list of all tables associated with the current AWS account and endpoint.

  • DeleteTable - Deletes a table and all of its indexes.

For conceptual information about managing tables, see Working with Tables in the Amazon DynamoDB Developer Guide.

Reading Data

  • GetItem - Returns a set of attributes for the item that has a given primary key. By default, GetItem performs an eventually consistent read; however, applications can request a strongly consistent read instead.

  • BatchGetItem - Performs multiple GetItem requests for data items using their primary keys, from one table or multiple tables. The response from BatchGetItem has a size limit of 16 MB and returns a maximum of 100 items. Both eventually consistent and strongly consistent reads can be used.

  • Query - Returns one or more items from a table or a secondary index. You must provide a specific value for the partition key. You can narrow the scope of the query using comparison operators against a sort key value, or on the index key. Query supports either eventual or strong consistency. A single response has a size limit of 1 MB.

  • Scan - Reads every item in a table; the result set is eventually consistent. You can limit the number of items returned by filtering the data attributes, using conditional expressions. Scan can be used to enable ad-hoc querying of a table against non-key attributes; however, since this is a full table scan without using an index, Scan should not be used for any application query use case that requires predictable performance.

For conceptual information about reading data, see Working with Items and Query and Scan Operations in the Amazon DynamoDB Developer Guide.

Modifying Data

  • PutItem - Creates a new item, or replaces an existing item with a new item (including all the attributes). By default, if an item in the table already exists with the same primary key, the new item completely replaces the existing item. You can use conditional operators to replace an item only if its attribute values match certain conditions, or to insert a new item only if that item doesn’t already exist.

  • UpdateItem - Modifies the attributes of an existing item. You can also use conditional operators to perform an update only if the item’s attribute values match certain conditions.

  • DeleteItem - Deletes an item in a table by primary key. You can use conditional operators to perform a delete an item only if the item’s attribute values match certain conditions.

  • BatchWriteItem - Performs multiple PutItem and DeleteItem requests across multiple tables in a single request. A failure of any request(s) in the batch will not cause the entire BatchWriteItem operation to fail. Supports batches of up to 25 items to put or delete, with a maximum total request size of 16 MB.

For conceptual information about modifying data, see Working with Items and Query and Scan Operations in the Amazon DynamoDB Developer Guide.

  configuration

The service configuration used to instantiate this service client.

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

Discussion

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

Declared In

AWSDynamoDBService.h

+ defaultDynamoDB

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.

+ (instancetype)defaultDynamoDB

Return Value

The default service client.

Discussion

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 DynamoDB = AWSDynamoDB.default()

Objective-C

 AWSDynamoDB *DynamoDB = [AWSDynamoDB defaultDynamoDB];

Declared In

AWSDynamoDBService.h

+ registerDynamoDBWithConfiguration:forKey:

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

+ (void)registerDynamoDBWithConfiguration:(AWSServiceConfiguration *)configuration forKey:(NSString *)key

Parameters

configuration

A service configuration object.

key

A string to identify the service client.

Discussion

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)
    AWSDynamoDB.register(with: configuration!, forKey: "USWest2DynamoDB")

    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];

     [AWSDynamoDB registerDynamoDBWithConfiguration:configuration forKey:@"USWest2DynamoDB"];

     return YES;
 }

Then call the following to get the service client:

Swift

 let DynamoDB = AWSDynamoDB(forKey: "USWest2DynamoDB")

Objective-C

 AWSDynamoDB *DynamoDB = [AWSDynamoDB DynamoDBForKey:@"USWest2DynamoDB"];

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

Declared In

AWSDynamoDBService.h

+ DynamoDBForKey:

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

+ (instancetype)DynamoDBForKey:(NSString *)key

Parameters

key

A string to identify the service client.

Return Value

An instance of the service client.

Discussion

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)
    AWSDynamoDB.register(with: configuration!, forKey: "USWest2DynamoDB")

    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];

     [AWSDynamoDB registerDynamoDBWithConfiguration:configuration forKey:@"USWest2DynamoDB"];

     return YES;
 }

Then call the following to get the service client:

Swift

 let DynamoDB = AWSDynamoDB(forKey: "USWest2DynamoDB")

Objective-C

 AWSDynamoDB *DynamoDB = [AWSDynamoDB DynamoDBForKey:@"USWest2DynamoDB"];

Declared In

AWSDynamoDBService.h

+ removeDynamoDBForKey:

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

+ (void)removeDynamoDBForKey:(NSString *)key

Parameters

key

A string to identify the service client.

Discussion

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

Declared In

AWSDynamoDBService.h

– batchGetItem:

The BatchGetItem operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key.

A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. BatchGetItem will return a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for UnprocessedKeys. You can use this value to retry the operation starting with the next item to get.

If you request more than 100 items BatchGetItem will return a ValidationException with the message “Too many items requested for the BatchGetItem call”.

For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate UnprocessedKeys value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one data set.

If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchGetItem will return a ProvisionedThroughputExceededException. If at least one of the items is successfully processed, then BatchGetItem completes successfully, while returning the keys of the unread items in UnprocessedKeys.

If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.

By default, BatchGetItem performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set ConsistentRead to true for any or all tables.

In order to minimize response latency, BatchGetItem retrieves items in parallel.

When designing your application, keep in mind that DynamoDB does not return items in any particular order. To help parse the response by item, include the primary key values for the items in your request in the AttributesToGet parameter.

If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see Capacity Units Calculations in the Amazon DynamoDB Developer Guide.

- (AWSTask<AWSDynamoDBBatchGetItemOutput*> *)batchGetItem:(AWSDynamoDBBatchGetItemInput *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSDynamoDBBatchGetItemOutput. On failed execution, task.error may contain an NSError with AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorProvisionedThroughputExceeded, AWSDynamoDBErrorResourceNotFound, AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h

– batchGetItem:completionHandler:

The BatchGetItem operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key.

A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. BatchGetItem will return a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for UnprocessedKeys. You can use this value to retry the operation starting with the next item to get.

If you request more than 100 items BatchGetItem will return a ValidationException with the message “Too many items requested for the BatchGetItem call”.

For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate UnprocessedKeys value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one data set.

If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchGetItem will return a ProvisionedThroughputExceededException. If at least one of the items is successfully processed, then BatchGetItem completes successfully, while returning the keys of the unread items in UnprocessedKeys.

If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.

By default, BatchGetItem performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set ConsistentRead to true for any or all tables.

In order to minimize response latency, BatchGetItem retrieves items in parallel.

When designing your application, keep in mind that DynamoDB does not return items in any particular order. To help parse the response by item, include the primary key values for the items in your request in the AttributesToGet parameter.

If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see Capacity Units Calculations in the Amazon DynamoDB Developer Guide.

- (void)batchGetItem:(AWSDynamoDBBatchGetItemInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSDynamoDBBatchGetItemOutput *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the BatchGetItem 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 AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorProvisionedThroughputExceeded, AWSDynamoDBErrorResourceNotFound, AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h

– batchWriteItem:

The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can write up to 16 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 400 KB.

BatchWriteItem cannot update items. To update items, use the UpdateItem API.

The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table’s provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed.

Note that if none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem will return a ProvisionedThroughputExceededException.

If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.

With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon Elastic MapReduce (EMR), or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response.

If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don’t support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem provides an alternative where the API performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.

Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.

If one or more of the following is true, DynamoDB rejects the entire batch write operation:

  • One or more tables specified in the BatchWriteItem request does not exist.

  • Primary key attributes specified on an item in the request do not match those in the corresponding table’s primary key schema.

  • You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request.

  • There are more than 25 requests in the batch.

  • Any individual item in a batch exceeds 400 KB.

  • The total request size exceeds 16 MB.

- (AWSTask<AWSDynamoDBBatchWriteItemOutput*> *)batchWriteItem:(AWSDynamoDBBatchWriteItemInput *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSDynamoDBBatchWriteItemOutput. On failed execution, task.error may contain an NSError with AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorProvisionedThroughputExceeded, AWSDynamoDBErrorResourceNotFound, AWSDynamoDBErrorItemCollectionSizeLimitExceeded, AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h

– batchWriteItem:completionHandler:

The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can write up to 16 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 400 KB.

BatchWriteItem cannot update items. To update items, use the UpdateItem API.

The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table’s provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed.

Note that if none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem will return a ProvisionedThroughputExceededException.

If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.

With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon Elastic MapReduce (EMR), or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response.

If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don’t support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem provides an alternative where the API performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.

Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.

If one or more of the following is true, DynamoDB rejects the entire batch write operation:

  • One or more tables specified in the BatchWriteItem request does not exist.

  • Primary key attributes specified on an item in the request do not match those in the corresponding table’s primary key schema.

  • You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request.

  • There are more than 25 requests in the batch.

  • Any individual item in a batch exceeds 400 KB.

  • The total request size exceeds 16 MB.

- (void)batchWriteItem:(AWSDynamoDBBatchWriteItemInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSDynamoDBBatchWriteItemOutput *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the BatchWriteItem 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 AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorProvisionedThroughputExceeded, AWSDynamoDBErrorResourceNotFound, AWSDynamoDBErrorItemCollectionSizeLimitExceeded, AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h

– createTable:

The CreateTable operation adds a new table to your account. In an AWS account, table names must be unique within each region. That is, you can have two tables with same name if you create the tables in different regions.

CreateTable is an asynchronous operation. Upon receiving a CreateTable request, DynamoDB immediately returns a response with a TableStatus of CREATING. After the table is created, DynamoDB sets the TableStatus to ACTIVE. You can perform read and write operations only on an ACTIVE table.

You can optionally define secondary indexes on the new table, as part of the CreateTable operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the CREATING state at any given time.

You can use the DescribeTable API to check the table status.

- (AWSTask<AWSDynamoDBCreateTableOutput*> *)createTable:(AWSDynamoDBCreateTableInput *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSDynamoDBCreateTableOutput. On failed execution, task.error may contain an NSError with AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorResourceInUse, AWSDynamoDBErrorLimitExceeded, AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h

– createTable:completionHandler:

The CreateTable operation adds a new table to your account. In an AWS account, table names must be unique within each region. That is, you can have two tables with same name if you create the tables in different regions.

CreateTable is an asynchronous operation. Upon receiving a CreateTable request, DynamoDB immediately returns a response with a TableStatus of CREATING. After the table is created, DynamoDB sets the TableStatus to ACTIVE. You can perform read and write operations only on an ACTIVE table.

You can optionally define secondary indexes on the new table, as part of the CreateTable operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the CREATING state at any given time.

You can use the DescribeTable API to check the table status.

- (void)createTable:(AWSDynamoDBCreateTableInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSDynamoDBCreateTableOutput *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreateTable 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 AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorResourceInUse, AWSDynamoDBErrorLimitExceeded, AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h

– deleteItem:

Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.

In addition to deleting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.

Unless you specify conditions, the DeleteItem is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.

Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.

- (AWSTask<AWSDynamoDBDeleteItemOutput*> *)deleteItem:(AWSDynamoDBDeleteItemInput *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSDynamoDBDeleteItemOutput. On failed execution, task.error may contain an NSError with AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorConditionalCheckFailed, AWSDynamoDBErrorProvisionedThroughputExceeded, AWSDynamoDBErrorResourceNotFound, AWSDynamoDBErrorItemCollectionSizeLimitExceeded, AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h

– deleteItem:completionHandler:

Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.

In addition to deleting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.

Unless you specify conditions, the DeleteItem is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.

Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.

- (void)deleteItem:(AWSDynamoDBDeleteItemInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSDynamoDBDeleteItemOutput *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteItem 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 AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorConditionalCheckFailed, AWSDynamoDBErrorProvisionedThroughputExceeded, AWSDynamoDBErrorResourceNotFound, AWSDynamoDBErrorItemCollectionSizeLimitExceeded, AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h

– deleteTable:

The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned.

DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete.

When you delete a table, any indexes on that table are also deleted.

If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours.

Use the DescribeTable API to check the status of the table.

- (AWSTask<AWSDynamoDBDeleteTableOutput*> *)deleteTable:(AWSDynamoDBDeleteTableInput *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSDynamoDBDeleteTableOutput. On failed execution, task.error may contain an NSError with AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorResourceInUse, AWSDynamoDBErrorResourceNotFound, AWSDynamoDBErrorLimitExceeded, AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h

– deleteTable:completionHandler:

The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned.

DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete.

When you delete a table, any indexes on that table are also deleted.

If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours.

Use the DescribeTable API to check the status of the table.

- (void)deleteTable:(AWSDynamoDBDeleteTableInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSDynamoDBDeleteTableOutput *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteTable 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 AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorResourceInUse, AWSDynamoDBErrorResourceNotFound, AWSDynamoDBErrorLimitExceeded, AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h

– describeLimits:

Returns the current provisioned-capacity limits for your AWS account in a region, both for the region as a whole and for any one DynamoDB table that you create there.

When you establish an AWS account, the account has initial limits on the maximum read capacity units and write capacity units that you can provision across all of your DynamoDB tables in a given region. Also, there are per-table limits that apply when you create a table there. For more information, see Limits page in the Amazon DynamoDB Developer Guide.

Although you can increase these limits by filing a case at AWS Support Center, obtaining the increase is not instantaneous. The DescribeLimits API lets you write code to compare the capacity you are currently using to those limits imposed by your account so that you have enough time to apply for an increase before you hit a limit.

For example, you could use one of the AWS SDKs to do the following:

  1. Call DescribeLimits for a particular region to obtain your current account limits on provisioned capacity there.

  2. Create a variable to hold the aggregate read capacity units provisioned for all your tables in that region, and one to hold the aggregate write capacity units. Zero them both.

  3. Call ListTables to obtain a list of all your DynamoDB tables.

  4. For each table name listed by ListTables, do the following:

    • Call DescribeTable with the table name.

    • Use the data returned by DescribeTable to add the read capacity units and write capacity units provisioned for the table itself to your variables.

    • If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well.

  5. Report the account limits for that region returned by DescribeLimits, along with the total current provisioned capacity levels you have calculated.

This will let you see whether you are getting close to your account-level limits.

The per-table limits apply only when you are creating a new table. They restrict the sum of the provisioned capacity of the new table itself and all its global secondary indexes.

For existing tables and their GSIs, DynamoDB will not let you increase provisioned capacity extremely rapidly, but the only upper limit that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account limits.

DescribeLimits should only be called periodically. You can expect throttling errors if you call it more than once in a minute.

The DescribeLimits Request element has no content.

- (AWSTask<AWSDynamoDBDescribeLimitsOutput*> *)describeLimits:(AWSDynamoDBDescribeLimitsInput *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSDynamoDBDescribeLimitsOutput. On failed execution, task.error may contain an NSError with AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h

– describeLimits:completionHandler:

Returns the current provisioned-capacity limits for your AWS account in a region, both for the region as a whole and for any one DynamoDB table that you create there.

When you establish an AWS account, the account has initial limits on the maximum read capacity units and write capacity units that you can provision across all of your DynamoDB tables in a given region. Also, there are per-table limits that apply when you create a table there. For more information, see Limits page in the Amazon DynamoDB Developer Guide.

Although you can increase these limits by filing a case at AWS Support Center, obtaining the increase is not instantaneous. The DescribeLimits API lets you write code to compare the capacity you are currently using to those limits imposed by your account so that you have enough time to apply for an increase before you hit a limit.

For example, you could use one of the AWS SDKs to do the following:

  1. Call DescribeLimits for a particular region to obtain your current account limits on provisioned capacity there.

  2. Create a variable to hold the aggregate read capacity units provisioned for all your tables in that region, and one to hold the aggregate write capacity units. Zero them both.

  3. Call ListTables to obtain a list of all your DynamoDB tables.

  4. For each table name listed by ListTables, do the following:

    • Call DescribeTable with the table name.

    • Use the data returned by DescribeTable to add the read capacity units and write capacity units provisioned for the table itself to your variables.

    • If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well.

  5. Report the account limits for that region returned by DescribeLimits, along with the total current provisioned capacity levels you have calculated.

This will let you see whether you are getting close to your account-level limits.

The per-table limits apply only when you are creating a new table. They restrict the sum of the provisioned capacity of the new table itself and all its global secondary indexes.

For existing tables and their GSIs, DynamoDB will not let you increase provisioned capacity extremely rapidly, but the only upper limit that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account limits.

DescribeLimits should only be called periodically. You can expect throttling errors if you call it more than once in a minute.

The DescribeLimits Request element has no content.

- (void)describeLimits:(AWSDynamoDBDescribeLimitsInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSDynamoDBDescribeLimitsOutput *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeLimits 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 AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h

– describeTable:

Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.

If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again.

- (AWSTask<AWSDynamoDBDescribeTableOutput*> *)describeTable:(AWSDynamoDBDescribeTableInput *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSDynamoDBDescribeTableOutput. On failed execution, task.error may contain an NSError with AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorResourceNotFound, AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h

– describeTable:completionHandler:

Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.

If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again.

- (void)describeTable:(AWSDynamoDBDescribeTableInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSDynamoDBDescribeTableOutput *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeTable 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 AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorResourceNotFound, AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h

– getItem:

The GetItem operation returns a set of attributes for the item with the given primary key. If there is no matching item, GetItem does not return any data.

GetItem provides an eventually consistent read by default. If your application requires a strongly consistent read, set ConsistentRead to true. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value.

- (AWSTask<AWSDynamoDBGetItemOutput*> *)getItem:(AWSDynamoDBGetItemInput *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSDynamoDBGetItemOutput. On failed execution, task.error may contain an NSError with AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorProvisionedThroughputExceeded, AWSDynamoDBErrorResourceNotFound, AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h

– getItem:completionHandler:

The GetItem operation returns a set of attributes for the item with the given primary key. If there is no matching item, GetItem does not return any data.

GetItem provides an eventually consistent read by default. If your application requires a strongly consistent read, set ConsistentRead to true. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value.

- (void)getItem:(AWSDynamoDBGetItemInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSDynamoDBGetItemOutput *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetItem 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 AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorProvisionedThroughputExceeded, AWSDynamoDBErrorResourceNotFound, AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h

– listTables:

Returns an array of table names associated with the current account and endpoint. The output from ListTables is paginated, with each page returning a maximum of 100 table names.

- (AWSTask<AWSDynamoDBListTablesOutput*> *)listTables:(AWSDynamoDBListTablesInput *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSDynamoDBListTablesOutput. On failed execution, task.error may contain an NSError with AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h

– listTables:completionHandler:

Returns an array of table names associated with the current account and endpoint. The output from ListTables is paginated, with each page returning a maximum of 100 table names.

- (void)listTables:(AWSDynamoDBListTablesInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSDynamoDBListTablesOutput *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListTables 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 AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h

– putItem:

Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values.

In addition to putting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.

When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a ValidationException exception.

You can request that PutItem return either a copy of the original item (before the update) or a copy of the updated item (after the update). For more information, see the ReturnValues description below.

To prevent a new item from replacing an existing item, use a conditional expression that contains the attribute_not_exists function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the attribute_not_exists function will only succeed if no matching item exists.

For more information about using this API, see Working with Items in the Amazon DynamoDB Developer Guide.

- (AWSTask<AWSDynamoDBPutItemOutput*> *)putItem:(AWSDynamoDBPutItemInput *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSDynamoDBPutItemOutput. On failed execution, task.error may contain an NSError with AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorConditionalCheckFailed, AWSDynamoDBErrorProvisionedThroughputExceeded, AWSDynamoDBErrorResourceNotFound, AWSDynamoDBErrorItemCollectionSizeLimitExceeded, AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h

– putItem:completionHandler:

Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values.

In addition to putting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.

When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a ValidationException exception.

You can request that PutItem return either a copy of the original item (before the update) or a copy of the updated item (after the update). For more information, see the ReturnValues description below.

To prevent a new item from replacing an existing item, use a conditional expression that contains the attribute_not_exists function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the attribute_not_exists function will only succeed if no matching item exists.

For more information about using this API, see Working with Items in the Amazon DynamoDB Developer Guide.

- (void)putItem:(AWSDynamoDBPutItemInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSDynamoDBPutItemOutput *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the PutItem 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 AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorConditionalCheckFailed, AWSDynamoDBErrorProvisionedThroughputExceeded, AWSDynamoDBErrorResourceNotFound, AWSDynamoDBErrorItemCollectionSizeLimitExceeded, AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h

– query:

A Query operation uses the primary key of a table or a secondary index to directly access items from that table or index.

Use the KeyConditionExpression parameter to provide a specific value for the partition key. The Query operation will return all of the items from the table or index with that partition key value. You can optionally narrow the scope of the Query operation by specifying a sort key value and a comparison operator in KeyConditionExpression. You can use the ScanIndexForward parameter to get results in forward or reverse order, by sort key.

Queries that do not return results consume the minimum number of read capacity units for that type of read operation.

If the total number of items meeting the query criteria exceeds the result set size limit of 1 MB, the query stops and results are returned to the user with the LastEvaluatedKey element to continue the query in a subsequent operation. Unlike a Scan operation, a Query operation never returns both an empty result set and a LastEvaluatedKey value. LastEvaluatedKey is only provided if you have used the Limit parameter, or if the result set exceeds 1 MB (prior to applying a filter).

You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local secondary index, you can set the ConsistentRead parameter to true and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify ConsistentRead when querying a global secondary index.

- (AWSTask<AWSDynamoDBQueryOutput*> *)query:(AWSDynamoDBQueryInput *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSDynamoDBQueryOutput. On failed execution, task.error may contain an NSError with AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorProvisionedThroughputExceeded, AWSDynamoDBErrorResourceNotFound, AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h

– query:completionHandler:

A Query operation uses the primary key of a table or a secondary index to directly access items from that table or index.

Use the KeyConditionExpression parameter to provide a specific value for the partition key. The Query operation will return all of the items from the table or index with that partition key value. You can optionally narrow the scope of the Query operation by specifying a sort key value and a comparison operator in KeyConditionExpression. You can use the ScanIndexForward parameter to get results in forward or reverse order, by sort key.

Queries that do not return results consume the minimum number of read capacity units for that type of read operation.

If the total number of items meeting the query criteria exceeds the result set size limit of 1 MB, the query stops and results are returned to the user with the LastEvaluatedKey element to continue the query in a subsequent operation. Unlike a Scan operation, a Query operation never returns both an empty result set and a LastEvaluatedKey value. LastEvaluatedKey is only provided if you have used the Limit parameter, or if the result set exceeds 1 MB (prior to applying a filter).

You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local secondary index, you can set the ConsistentRead parameter to true and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify ConsistentRead when querying a global secondary index.

- (void)query:(AWSDynamoDBQueryInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSDynamoDBQueryOutput *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the Query 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 AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorProvisionedThroughputExceeded, AWSDynamoDBErrorResourceNotFound, AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h

– scan:

The Scan operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a ScanFilter operation.

If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a LastEvaluatedKey value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria.

By default, Scan operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel Scan operation by providing the Segment and TotalSegments parameters. For more information, see Parallel Scan in the Amazon DynamoDB Developer Guide.

By default, Scan uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the ConsistentRead parameter to true.

- (AWSTask<AWSDynamoDBScanOutput*> *)scan:(AWSDynamoDBScanInput *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSDynamoDBScanOutput. On failed execution, task.error may contain an NSError with AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorProvisionedThroughputExceeded, AWSDynamoDBErrorResourceNotFound, AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h

– scan:completionHandler:

The Scan operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a ScanFilter operation.

If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a LastEvaluatedKey value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria.

By default, Scan operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel Scan operation by providing the Segment and TotalSegments parameters. For more information, see Parallel Scan in the Amazon DynamoDB Developer Guide.

By default, Scan uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the ConsistentRead parameter to true.

- (void)scan:(AWSDynamoDBScanInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSDynamoDBScanOutput *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the Scan 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 AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorProvisionedThroughputExceeded, AWSDynamoDBErrorResourceNotFound, AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h

– updateItem:

Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values).

You can also return the item's attribute values in the same UpdateItem operation using the ReturnValues parameter.

- (AWSTask<AWSDynamoDBUpdateItemOutput*> *)updateItem:(AWSDynamoDBUpdateItemInput *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSDynamoDBUpdateItemOutput. On failed execution, task.error may contain an NSError with AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorConditionalCheckFailed, AWSDynamoDBErrorProvisionedThroughputExceeded, AWSDynamoDBErrorResourceNotFound, AWSDynamoDBErrorItemCollectionSizeLimitExceeded, AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h

– updateItem:completionHandler:

Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values).

You can also return the item's attribute values in the same UpdateItem operation using the ReturnValues parameter.

- (void)updateItem:(AWSDynamoDBUpdateItemInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSDynamoDBUpdateItemOutput *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the UpdateItem 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 AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorConditionalCheckFailed, AWSDynamoDBErrorProvisionedThroughputExceeded, AWSDynamoDBErrorResourceNotFound, AWSDynamoDBErrorItemCollectionSizeLimitExceeded, AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h

– updateTable:

Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.

You can only perform one of the following operations at once:

  • Modify the provisioned throughput settings of the table.

  • Enable or disable Streams on the table.

  • Remove a global secondary index from the table.

  • Create a new global secondary index on the table. Once the index begins backfilling, you can use UpdateTable to perform other operations.

UpdateTable is an asynchronous operation; while it is executing, the table status changes from ACTIVE to UPDATING. While it is UPDATING, you cannot issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete.

- (AWSTask<AWSDynamoDBUpdateTableOutput*> *)updateTable:(AWSDynamoDBUpdateTableInput *)request

Parameters

request

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

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSDynamoDBUpdateTableOutput. On failed execution, task.error may contain an NSError with AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorResourceInUse, AWSDynamoDBErrorResourceNotFound, AWSDynamoDBErrorLimitExceeded, AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h

– updateTable:completionHandler:

Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.

You can only perform one of the following operations at once:

  • Modify the provisioned throughput settings of the table.

  • Enable or disable Streams on the table.

  • Remove a global secondary index from the table.

  • Create a new global secondary index on the table. Once the index begins backfilling, you can use UpdateTable to perform other operations.

UpdateTable is an asynchronous operation; while it is executing, the table status changes from ACTIVE to UPDATING. While it is UPDATING, you cannot issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete.

- (void)updateTable:(AWSDynamoDBUpdateTableInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSDynamoDBUpdateTableOutput *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the UpdateTable 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 AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorResourceInUse, AWSDynamoDBErrorResourceNotFound, AWSDynamoDBErrorLimitExceeded, AWSDynamoDBErrorInternalServer.

Declared In

AWSDynamoDBService.h