AWSDynamoDB

Objective-C

@interface AWSDynamoDB

Swift

class AWSDynamoDB

Amazon DynamoDB

Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. DynamoDB lets you offload the administrative burdens of operating and scaling a distributed database, so that you don’t have to worry about hardware provisioning, setup and configuration, replication, software patching, or cluster scaling.

With DynamoDB, you can create database tables that can store and retrieve any amount of data, and serve any level of request traffic. You can scale up or scale down your tables’ throughput capacity without downtime or performance degradation, and use the AWS Management Console to monitor resource utilization and performance metrics.

DynamoDB automatically spreads the data and traffic for your tables over a sufficient number of servers to handle your throughput and storage requirements, while maintaining consistent and fast performance. All of your data is stored on solid state disks (SSDs) and automatically replicated across multiple Availability Zones in an AWS region, providing built-in high availability and data durability.

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

    Objective-C

    AWSDynamoDB *DynamoDB = [AWSDynamoDB defaultDynamoDB];
    

    Declaration

    Objective-C

    + (nonnull instancetype)defaultDynamoDB;

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

    Declaration

    Objective-C

    + (void)registerDynamoDBWithConfiguration:(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 + registerDynamoDBWithConfiguration: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)
       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"];
    

    Declaration

    Objective-C

    + (nonnull instancetype)DynamoDBForKey:(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)removeDynamoDBForKey:(nonnull NSString *)key;

    Swift

    class func remove(forKey key: String)

    Parameters

    key

    A string to identify the service client.

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

    If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchGetItem returns 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 ProjectionExpression 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 Working with Tables in the Amazon DynamoDB Developer Guide.

    See

    AWSDynamoDBBatchGetItemInput

    See

    AWSDynamoDBBatchGetItemOutput

    Declaration

    Objective-C

    - (id)batchGetItem:(nonnull AWSDynamoDBBatchGetItemInput *)request;

    Swift

    func batchGetItem(_ request: AWSDynamoDBBatchGetItemInput) -> Any!

    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, AWSDynamoDBErrorRequestLimitExceeded, AWSDynamoDBErrorInternalServer.

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

    If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchGetItem returns 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 ProjectionExpression 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 Working with Tables in the Amazon DynamoDB Developer Guide.

    See

    AWSDynamoDBBatchGetItemInput

    See

    AWSDynamoDBBatchGetItemOutput

    Declaration

    Objective-C

    - (void)batchGetItem:(nonnull AWSDynamoDBBatchGetItemInput *)request
        completionHandler:
            (void (^_Nullable)(AWSDynamoDBBatchGetItemOutput *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func batchGetItem(_ request: AWSDynamoDBBatchGetItemInput, completionHandler: ((AWSDynamoDBBatchGetItemOutput?, Error?) -> Void)? = nil)

    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, AWSDynamoDBErrorRequestLimitExceeded, AWSDynamoDBErrorInternalServer.

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

    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.

    If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem returns 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 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 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.

    • Your request contains at least two items with identical hash and range keys (which essentially is two put operations).

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

    See

    AWSDynamoDBBatchWriteItemInput

    See

    AWSDynamoDBBatchWriteItemOutput

    Declaration

    Objective-C

    - (id)batchWriteItem:(nonnull AWSDynamoDBBatchWriteItemInput *)request;

    Swift

    func batchWriteItem(_ request: AWSDynamoDBBatchWriteItemInput) -> Any!

    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, AWSDynamoDBErrorRequestLimitExceeded, AWSDynamoDBErrorInternalServer.

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

    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.

    If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem returns 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 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 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.

    • Your request contains at least two items with identical hash and range keys (which essentially is two put operations).

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

    See

    AWSDynamoDBBatchWriteItemInput

    See

    AWSDynamoDBBatchWriteItemOutput

    Declaration

    Objective-C

    - (void)batchWriteItem:(nonnull AWSDynamoDBBatchWriteItemInput *)request
         completionHandler:
             (void (^_Nullable)(AWSDynamoDBBatchWriteItemOutput *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func batchWriteItem(_ request: AWSDynamoDBBatchWriteItemInput, completionHandler: ((AWSDynamoDBBatchWriteItemOutput?, Error?) -> Void)? = nil)

    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, AWSDynamoDBErrorRequestLimitExceeded, AWSDynamoDBErrorInternalServer.

  • Creates a backup for an existing table.

    Each time you create an on-demand backup, the entire table data is backed up. There is no limit to the number of on-demand backups that can be taken.

    When you create an on-demand backup, a time marker of the request is cataloged, and the backup is created asynchronously, by applying all changes until the time of the request to the last full table snapshot. Backup requests are processed instantaneously and become available for restore within minutes.

    You can call CreateBackup at a maximum rate of 50 times per second.

    All backups in DynamoDB work without consuming any provisioned throughput on the table.

    If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to contain all data committed to the table up to 14:24:00, and data committed after 14:26:00 will not be. The backup might contain data modifications made between 14:24:00 and 14:26:00. On-demand backup does not support causal consistency.

    Along with data, the following are also included on the backups:

    • Global secondary indexes (GSIs)

    • Local secondary indexes (LSIs)

    • Streams

    • Provisioned read and write capacity

    See

    AWSDynamoDBCreateBackupInput

    See

    AWSDynamoDBCreateBackupOutput

    Declaration

    Objective-C

    - (id)createBackup:(nonnull AWSDynamoDBCreateBackupInput *)request;

    Swift

    func createBackup(_ request: AWSDynamoDBCreateBackupInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • Creates a backup for an existing table.

    Each time you create an on-demand backup, the entire table data is backed up. There is no limit to the number of on-demand backups that can be taken.

    When you create an on-demand backup, a time marker of the request is cataloged, and the backup is created asynchronously, by applying all changes until the time of the request to the last full table snapshot. Backup requests are processed instantaneously and become available for restore within minutes.

    You can call CreateBackup at a maximum rate of 50 times per second.

    All backups in DynamoDB work without consuming any provisioned throughput on the table.

    If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to contain all data committed to the table up to 14:24:00, and data committed after 14:26:00 will not be. The backup might contain data modifications made between 14:24:00 and 14:26:00. On-demand backup does not support causal consistency.

    Along with data, the following are also included on the backups:

    • Global secondary indexes (GSIs)

    • Local secondary indexes (LSIs)

    • Streams

    • Provisioned read and write capacity

    See

    AWSDynamoDBCreateBackupInput

    See

    AWSDynamoDBCreateBackupOutput

    Declaration

    Objective-C

    - (void)createBackup:(nonnull AWSDynamoDBCreateBackupInput *)request
        completionHandler:
            (void (^_Nullable)(AWSDynamoDBCreateBackupOutput *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func createBackup(_ request: AWSDynamoDBCreateBackupInput, completionHandler: ((AWSDynamoDBCreateBackupOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the CreateBackup 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: AWSDynamoDBErrorTableNotFound, AWSDynamoDBErrorTableInUse, AWSDynamoDBErrorContinuousBackupsUnavailable, AWSDynamoDBErrorBackupInUse, AWSDynamoDBErrorLimitExceeded, AWSDynamoDBErrorInternalServer.

  • Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions.

    This method only applies to Version 2017.11.29 of global tables.

    If you want to add a new replica table to a global table, each of the following conditions must be true:

    • The table must have the same primary key as all of the other replicas.

    • The table must have the same name as all of the other replicas.

    • The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.

    • None of the replica tables in the global table can contain any data.

    If global secondary indexes are specified, then the following conditions must also be met:

    • The global secondary indexes must have the same name.

    • The global secondary indexes must have the same hash key and sort key (if present).

    Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes.

    If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table.

    See

    AWSDynamoDBCreateGlobalTableInput

    See

    AWSDynamoDBCreateGlobalTableOutput

    Declaration

    Objective-C

    - (id)createGlobalTable:(nonnull AWSDynamoDBCreateGlobalTableInput *)request;

    Swift

    func createGlobalTable(_ request: AWSDynamoDBCreateGlobalTableInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions.

    This method only applies to Version 2017.11.29 of global tables.

    If you want to add a new replica table to a global table, each of the following conditions must be true:

    • The table must have the same primary key as all of the other replicas.

    • The table must have the same name as all of the other replicas.

    • The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.

    • None of the replica tables in the global table can contain any data.

    If global secondary indexes are specified, then the following conditions must also be met:

    • The global secondary indexes must have the same name.

    • The global secondary indexes must have the same hash key and sort key (if present).

    Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes.

    If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table.

    See

    AWSDynamoDBCreateGlobalTableInput

    See

    AWSDynamoDBCreateGlobalTableOutput

    Declaration

    Objective-C

    - (void)createGlobalTable:(nonnull AWSDynamoDBCreateGlobalTableInput *)request
            completionHandler:
                (void (^_Nullable)(AWSDynamoDBCreateGlobalTableOutput *_Nullable,
                                   NSError *_Nullable))completionHandler;

    Swift

    func createGlobalTable(_ request: AWSDynamoDBCreateGlobalTableInput, completionHandler: ((AWSDynamoDBCreateGlobalTableOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the CreateGlobalTable 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: AWSDynamoDBErrorLimitExceeded, AWSDynamoDBErrorInternalServer, AWSDynamoDBErrorGlobalTableAlreadyExists, AWSDynamoDBErrorTableNotFound.

  • 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 action to check the table status.

    See

    AWSDynamoDBCreateTableInput

    See

    AWSDynamoDBCreateTableOutput

    Declaration

    Objective-C

    - (id)createTable:(nonnull AWSDynamoDBCreateTableInput *)request;

    Swift

    func createTable(_ request: AWSDynamoDBCreateTableInput) -> Any!

    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.

  • 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 action to check the table status.

    See

    AWSDynamoDBCreateTableInput

    See

    AWSDynamoDBCreateTableOutput

    Declaration

    Objective-C

    - (void)createTable:(nonnull AWSDynamoDBCreateTableInput *)request
        completionHandler:
            (void (^_Nullable)(AWSDynamoDBCreateTableOutput *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func createTable(_ request: AWSDynamoDBCreateTableInput, completionHandler: ((AWSDynamoDBCreateTableOutput?, Error?) -> Void)? = nil)

    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.

  • Deletes an existing backup of a table.

    You can call DeleteBackup at a maximum rate of 10 times per second.

    See

    AWSDynamoDBDeleteBackupInput

    See

    AWSDynamoDBDeleteBackupOutput

    Declaration

    Objective-C

    - (id)deleteBackup:(nonnull AWSDynamoDBDeleteBackupInput *)request;

    Swift

    func deleteBackup(_ request: AWSDynamoDBDeleteBackupInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • Deletes an existing backup of a table.

    You can call DeleteBackup at a maximum rate of 10 times per second.

    See

    AWSDynamoDBDeleteBackupInput

    See

    AWSDynamoDBDeleteBackupOutput

    Declaration

    Objective-C

    - (void)deleteBackup:(nonnull AWSDynamoDBDeleteBackupInput *)request
        completionHandler:
            (void (^_Nullable)(AWSDynamoDBDeleteBackupOutput *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func deleteBackup(_ request: AWSDynamoDBDeleteBackupInput, completionHandler: ((AWSDynamoDBDeleteBackupOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DeleteBackup 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: AWSDynamoDBErrorBackupNotFound, AWSDynamoDBErrorBackupInUse, AWSDynamoDBErrorLimitExceeded, AWSDynamoDBErrorInternalServer.

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

    See

    AWSDynamoDBDeleteItemInput

    See

    AWSDynamoDBDeleteItemOutput

    Declaration

    Objective-C

    - (id)deleteItem:(nonnull AWSDynamoDBDeleteItemInput *)request;

    Swift

    func deleteItem(_ request: AWSDynamoDBDeleteItemInput) -> Any!

    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, AWSDynamoDBErrorTransactionConflict, AWSDynamoDBErrorRequestLimitExceeded, AWSDynamoDBErrorInternalServer.

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

    See

    AWSDynamoDBDeleteItemInput

    See

    AWSDynamoDBDeleteItemOutput

    Declaration

    Objective-C

    - (void)deleteItem:(nonnull AWSDynamoDBDeleteItemInput *)request
        completionHandler:(void (^_Nullable)(AWSDynamoDBDeleteItemOutput *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func deleteItem(_ request: AWSDynamoDBDeleteItemInput, completionHandler: ((AWSDynamoDBDeleteItemOutput?, Error?) -> Void)? = nil)

    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, AWSDynamoDBErrorTransactionConflict, AWSDynamoDBErrorRequestLimitExceeded, AWSDynamoDBErrorInternalServer.

  • 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 action to check the status of the table.

    See

    AWSDynamoDBDeleteTableInput

    See

    AWSDynamoDBDeleteTableOutput

    Declaration

    Objective-C

    - (id)deleteTable:(nonnull AWSDynamoDBDeleteTableInput *)request;

    Swift

    func deleteTable(_ request: AWSDynamoDBDeleteTableInput) -> Any!

    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.

  • 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 action to check the status of the table.

    See

    AWSDynamoDBDeleteTableInput

    See

    AWSDynamoDBDeleteTableOutput

    Declaration

    Objective-C

    - (void)deleteTable:(nonnull AWSDynamoDBDeleteTableInput *)request
        completionHandler:
            (void (^_Nullable)(AWSDynamoDBDeleteTableOutput *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func deleteTable(_ request: AWSDynamoDBDeleteTableInput, completionHandler: ((AWSDynamoDBDeleteTableOutput?, Error?) -> Void)? = nil)

    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.

  • Describes an existing backup of a table.

    You can call DescribeBackup at a maximum rate of 10 times per second.

    See

    AWSDynamoDBDescribeBackupInput

    See

    AWSDynamoDBDescribeBackupOutput

    Declaration

    Objective-C

    - (id)describeBackup:(nonnull AWSDynamoDBDescribeBackupInput *)request;

    Swift

    func describeBackup(_ request: AWSDynamoDBDescribeBackupInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • Describes an existing backup of a table.

    You can call DescribeBackup at a maximum rate of 10 times per second.

    See

    AWSDynamoDBDescribeBackupInput

    See

    AWSDynamoDBDescribeBackupOutput

    Declaration

    Objective-C

    - (void)describeBackup:(nonnull AWSDynamoDBDescribeBackupInput *)request
         completionHandler:
             (void (^_Nullable)(AWSDynamoDBDescribeBackupOutput *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func describeBackup(_ request: AWSDynamoDBDescribeBackupInput, completionHandler: ((AWSDynamoDBDescribeBackupOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DescribeBackup 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: AWSDynamoDBErrorBackupNotFound, AWSDynamoDBErrorInternalServer.

  • Checks the status of continuous backups and point in time recovery on the specified table. Continuous backups are ENABLED on all tables at table creation. If point in time recovery is enabled, PointInTimeRecoveryStatus will be set to ENABLED.

    After continuous backups and point in time recovery are enabled, you can restore to any point in time within EarliestRestorableDateTime and LatestRestorableDateTime.

    LatestRestorableDateTime is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days.

    You can call DescribeContinuousBackups at a maximum rate of 10 times per second.

    See

    AWSDynamoDBDescribeContinuousBackupsInput

    See

    AWSDynamoDBDescribeContinuousBackupsOutput

    Declaration

    Objective-C

    - (id)describeContinuousBackups:
        (nonnull AWSDynamoDBDescribeContinuousBackupsInput *)request;

    Swift

    func describeContinuousBackups(_ request: AWSDynamoDBDescribeContinuousBackupsInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • Checks the status of continuous backups and point in time recovery on the specified table. Continuous backups are ENABLED on all tables at table creation. If point in time recovery is enabled, PointInTimeRecoveryStatus will be set to ENABLED.

    After continuous backups and point in time recovery are enabled, you can restore to any point in time within EarliestRestorableDateTime and LatestRestorableDateTime.

    LatestRestorableDateTime is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days.

    You can call DescribeContinuousBackups at a maximum rate of 10 times per second.

    See

    AWSDynamoDBDescribeContinuousBackupsInput

    See

    AWSDynamoDBDescribeContinuousBackupsOutput

    Declaration

    Objective-C

    - (void)describeContinuousBackups:
                (nonnull AWSDynamoDBDescribeContinuousBackupsInput *)request
                    completionHandler:
                        (void (^_Nullable)(
                            AWSDynamoDBDescribeContinuousBackupsOutput *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func describeContinuousBackups(_ request: AWSDynamoDBDescribeContinuousBackupsInput, completionHandler: ((AWSDynamoDBDescribeContinuousBackupsOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DescribeContinuousBackups 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: AWSDynamoDBErrorTableNotFound, AWSDynamoDBErrorInternalServer.

  • Returns information about contributor insights, for a given table or global secondary index.

    See

    AWSDynamoDBDescribeContributorInsightsInput

    See

    AWSDynamoDBDescribeContributorInsightsOutput

    Declaration

    Objective-C

    - (id)describeContributorInsights:
        (nonnull AWSDynamoDBDescribeContributorInsightsInput *)request;

    Swift

    func describeContributorInsights(_ request: AWSDynamoDBDescribeContributorInsightsInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns information about contributor insights, for a given table or global secondary index.

    See

    AWSDynamoDBDescribeContributorInsightsInput

    See

    AWSDynamoDBDescribeContributorInsightsOutput

    Declaration

    Objective-C

    - (void)
        describeContributorInsights:
            (nonnull AWSDynamoDBDescribeContributorInsightsInput *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSDynamoDBDescribeContributorInsightsOutput *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func describeContributorInsights(_ request: AWSDynamoDBDescribeContributorInsightsInput, completionHandler: ((AWSDynamoDBDescribeContributorInsightsOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DescribeContributorInsights 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.

  • Returns the regional endpoint information.

    See

    AWSDynamoDBDescribeEndpointsRequest

    See

    AWSDynamoDBDescribeEndpointsResponse

    Declaration

    Objective-C

    - (id)describeEndpoints:(nonnull AWSDynamoDBDescribeEndpointsRequest *)request;

    Swift

    func describeEndpoints(_ request: AWSDynamoDBDescribeEndpointsRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSDynamoDBDescribeEndpointsResponse.

  • Returns the regional endpoint information.

    See

    AWSDynamoDBDescribeEndpointsRequest

    See

    AWSDynamoDBDescribeEndpointsResponse

    Declaration

    Objective-C

    - (void)describeEndpoints:(nonnull AWSDynamoDBDescribeEndpointsRequest *)request
            completionHandler:
                (void (^_Nullable)(AWSDynamoDBDescribeEndpointsResponse *_Nullable,
                                   NSError *_Nullable))completionHandler;

    Swift

    func describeEndpoints(_ request: AWSDynamoDBDescribeEndpointsRequest, completionHandler: ((AWSDynamoDBDescribeEndpointsResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DescribeEndpoints 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.

  • Returns information about the specified global table.

    This method only applies to Version 2017.11.29 of global tables.

    See

    AWSDynamoDBDescribeGlobalTableInput

    See

    AWSDynamoDBDescribeGlobalTableOutput

    Declaration

    Objective-C

    - (id)describeGlobalTable:
        (nonnull AWSDynamoDBDescribeGlobalTableInput *)request;

    Swift

    func describeGlobalTable(_ request: AWSDynamoDBDescribeGlobalTableInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns information about the specified global table.

    This method only applies to Version 2017.11.29 of global tables.

    See

    AWSDynamoDBDescribeGlobalTableInput

    See

    AWSDynamoDBDescribeGlobalTableOutput

    Declaration

    Objective-C

    - (void)
        describeGlobalTable:(nonnull AWSDynamoDBDescribeGlobalTableInput *)request
          completionHandler:
              (void (^_Nullable)(AWSDynamoDBDescribeGlobalTableOutput *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func describeGlobalTable(_ request: AWSDynamoDBDescribeGlobalTableInput, completionHandler: ((AWSDynamoDBDescribeGlobalTableOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DescribeGlobalTable 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, AWSDynamoDBErrorGlobalTableNotFound.

  • Describes Region-specific settings for a global table.

    This method only applies to Version 2017.11.29 of global tables.

    See

    AWSDynamoDBDescribeGlobalTableSettingsInput

    See

    AWSDynamoDBDescribeGlobalTableSettingsOutput

    Declaration

    Objective-C

    - (id)describeGlobalTableSettings:
        (nonnull AWSDynamoDBDescribeGlobalTableSettingsInput *)request;

    Swift

    func describeGlobalTableSettings(_ request: AWSDynamoDBDescribeGlobalTableSettingsInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • Describes Region-specific settings for a global table.

    This method only applies to Version 2017.11.29 of global tables.

    See

    AWSDynamoDBDescribeGlobalTableSettingsInput

    See

    AWSDynamoDBDescribeGlobalTableSettingsOutput

    Declaration

    Objective-C

    - (void)
        describeGlobalTableSettings:
            (nonnull AWSDynamoDBDescribeGlobalTableSettingsInput *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSDynamoDBDescribeGlobalTableSettingsOutput *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func describeGlobalTableSettings(_ request: AWSDynamoDBDescribeGlobalTableSettingsInput, completionHandler: ((AWSDynamoDBDescribeGlobalTableSettingsOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DescribeGlobalTableSettings 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: AWSDynamoDBErrorGlobalTableNotFound, AWSDynamoDBErrorInternalServer.

  • 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 action 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 doesn’t 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.

    See

    AWSDynamoDBDescribeLimitsInput

    See

    AWSDynamoDBDescribeLimitsOutput

    Declaration

    Objective-C

    - (id)describeLimits:(nonnull AWSDynamoDBDescribeLimitsInput *)request;

    Swift

    func describeLimits(_ request: AWSDynamoDBDescribeLimitsInput) -> Any!

    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.

  • 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 action 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 doesn’t 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.

    See

    AWSDynamoDBDescribeLimitsInput

    See

    AWSDynamoDBDescribeLimitsOutput

    Declaration

    Objective-C

    - (void)describeLimits:(nonnull AWSDynamoDBDescribeLimitsInput *)request
         completionHandler:
             (void (^_Nullable)(AWSDynamoDBDescribeLimitsOutput *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func describeLimits(_ request: AWSDynamoDBDescribeLimitsInput, completionHandler: ((AWSDynamoDBDescribeLimitsOutput?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSDynamoDBDescribeTableInput

    See

    AWSDynamoDBDescribeTableOutput

    Declaration

    Objective-C

    - (id)describeTable:(nonnull AWSDynamoDBDescribeTableInput *)request;

    Swift

    func describeTable(_ request: AWSDynamoDBDescribeTableInput) -> Any!

    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.

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

    See

    AWSDynamoDBDescribeTableInput

    See

    AWSDynamoDBDescribeTableOutput

    Declaration

    Objective-C

    - (void)describeTable:(nonnull AWSDynamoDBDescribeTableInput *)request
        completionHandler:
            (void (^_Nullable)(AWSDynamoDBDescribeTableOutput *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func describeTable(_ request: AWSDynamoDBDescribeTableInput, completionHandler: ((AWSDynamoDBDescribeTableOutput?, Error?) -> Void)? = nil)

    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.

  • Describes auto scaling settings across replicas of the global table at once.

    This method only applies to Version 2019.11.21 of global tables.

    See

    AWSDynamoDBDescribeTableReplicaAutoScalingInput

    See

    AWSDynamoDBDescribeTableReplicaAutoScalingOutput

    Declaration

    Objective-C

    - (id)describeTableReplicaAutoScaling:
        (nonnull AWSDynamoDBDescribeTableReplicaAutoScalingInput *)request;

    Swift

    func describeTableReplicaAutoScaling(_ request: AWSDynamoDBDescribeTableReplicaAutoScalingInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • Describes auto scaling settings across replicas of the global table at once.

    This method only applies to Version 2019.11.21 of global tables.

    See

    AWSDynamoDBDescribeTableReplicaAutoScalingInput

    See

    AWSDynamoDBDescribeTableReplicaAutoScalingOutput

    Declaration

    Objective-C

    - (void)describeTableReplicaAutoScaling:
                (nonnull AWSDynamoDBDescribeTableReplicaAutoScalingInput *)request
                          completionHandler:
                              (void (^_Nullable)(
                                  AWSDynamoDBDescribeTableReplicaAutoScalingOutput
                                      *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func describeTableReplicaAutoScaling(_ request: AWSDynamoDBDescribeTableReplicaAutoScalingInput, completionHandler: ((AWSDynamoDBDescribeTableReplicaAutoScalingOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DescribeTableReplicaAutoScaling 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.

  • Gives a description of the Time to Live (TTL) status on the specified table.

    See

    AWSDynamoDBDescribeTimeToLiveInput

    See

    AWSDynamoDBDescribeTimeToLiveOutput

    Declaration

    Objective-C

    - (id)describeTimeToLive:(nonnull AWSDynamoDBDescribeTimeToLiveInput *)request;

    Swift

    func describeTime(toLive request: AWSDynamoDBDescribeTimeToLiveInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gives a description of the Time to Live (TTL) status on the specified table.

    See

    AWSDynamoDBDescribeTimeToLiveInput

    See

    AWSDynamoDBDescribeTimeToLiveOutput

    Declaration

    Objective-C

    - (void)describeTimeToLive:(nonnull AWSDynamoDBDescribeTimeToLiveInput *)request
             completionHandler:
                 (void (^_Nullable)(AWSDynamoDBDescribeTimeToLiveOutput *_Nullable,
                                    NSError *_Nullable))completionHandler;

    Swift

    func describeTime(toLive request: AWSDynamoDBDescribeTimeToLiveInput, completionHandler: ((AWSDynamoDBDescribeTimeToLiveOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DescribeTimeToLive 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.

  • 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 and there will be no Item element in the response.

    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.

    See

    AWSDynamoDBGetItemInput

    See

    AWSDynamoDBGetItemOutput

    Declaration

    Objective-C

    - (id)getItem:(nonnull AWSDynamoDBGetItemInput *)request;

    Swift

    func getItem(_ request: AWSDynamoDBGetItemInput) -> Any!

    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, AWSDynamoDBErrorRequestLimitExceeded, AWSDynamoDBErrorInternalServer.

  • 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 and there will be no Item element in the response.

    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.

    See

    AWSDynamoDBGetItemInput

    See

    AWSDynamoDBGetItemOutput

    Declaration

    Objective-C

    - (void)getItem:(nonnull AWSDynamoDBGetItemInput *)request
        completionHandler:(void (^_Nullable)(AWSDynamoDBGetItemOutput *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func getItem(_ request: AWSDynamoDBGetItemInput, completionHandler: ((AWSDynamoDBGetItemOutput?, Error?) -> Void)? = nil)

    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, AWSDynamoDBErrorRequestLimitExceeded, AWSDynamoDBErrorInternalServer.

  • List backups associated with an AWS account. To list backups for a given table, specify TableName. ListBackups returns a paginated list of results with at most 1 MB worth of items in a page. You can also specify a limit for the maximum number of entries to be returned in a page.

    In the request, start time is inclusive, but end time is exclusive. Note that these limits are for the time at which the original backup was requested.

    You can call ListBackups a maximum of five times per second.

    See

    AWSDynamoDBListBackupsInput

    See

    AWSDynamoDBListBackupsOutput

    Declaration

    Objective-C

    - (id)listBackups:(nonnull AWSDynamoDBListBackupsInput *)request;

    Swift

    func listBackups(_ request: AWSDynamoDBListBackupsInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • List backups associated with an AWS account. To list backups for a given table, specify TableName. ListBackups returns a paginated list of results with at most 1 MB worth of items in a page. You can also specify a limit for the maximum number of entries to be returned in a page.

    In the request, start time is inclusive, but end time is exclusive. Note that these limits are for the time at which the original backup was requested.

    You can call ListBackups a maximum of five times per second.

    See

    AWSDynamoDBListBackupsInput

    See

    AWSDynamoDBListBackupsOutput

    Declaration

    Objective-C

    - (void)listBackups:(nonnull AWSDynamoDBListBackupsInput *)request
        completionHandler:
            (void (^_Nullable)(AWSDynamoDBListBackupsOutput *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func listBackups(_ request: AWSDynamoDBListBackupsInput, completionHandler: ((AWSDynamoDBListBackupsOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ListBackups 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.

  • Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes.

    See

    AWSDynamoDBListContributorInsightsInput

    See

    AWSDynamoDBListContributorInsightsOutput

    Declaration

    Objective-C

    - (id)listContributorInsights:
        (nonnull AWSDynamoDBListContributorInsightsInput *)request;

    Swift

    func listContributorInsights(_ request: AWSDynamoDBListContributorInsightsInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes.

    See

    AWSDynamoDBListContributorInsightsInput

    See

    AWSDynamoDBListContributorInsightsOutput

    Declaration

    Objective-C

    - (void)listContributorInsights:
                (nonnull AWSDynamoDBListContributorInsightsInput *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSDynamoDBListContributorInsightsOutput *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func listContributorInsights(_ request: AWSDynamoDBListContributorInsightsInput, completionHandler: ((AWSDynamoDBListContributorInsightsOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ListContributorInsights 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.

  • Lists all global tables that have a replica in the specified Region.

    This method only applies to Version 2017.11.29 of global tables.

    See

    AWSDynamoDBListGlobalTablesInput

    See

    AWSDynamoDBListGlobalTablesOutput

    Declaration

    Objective-C

    - (id)listGlobalTables:(nonnull AWSDynamoDBListGlobalTablesInput *)request;

    Swift

    func listGlobalTables(_ request: AWSDynamoDBListGlobalTablesInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists all global tables that have a replica in the specified Region.

    This method only applies to Version 2017.11.29 of global tables.

    See

    AWSDynamoDBListGlobalTablesInput

    See

    AWSDynamoDBListGlobalTablesOutput

    Declaration

    Objective-C

    - (void)listGlobalTables:(nonnull AWSDynamoDBListGlobalTablesInput *)request
           completionHandler:
               (void (^_Nullable)(AWSDynamoDBListGlobalTablesOutput *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func listGlobalTables(_ request: AWSDynamoDBListGlobalTablesInput, completionHandler: ((AWSDynamoDBListGlobalTablesOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ListGlobalTables 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.

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

    See

    AWSDynamoDBListTablesInput

    See

    AWSDynamoDBListTablesOutput

    Declaration

    Objective-C

    - (id)listTables:(nonnull AWSDynamoDBListTablesInput *)request;

    Swift

    func listTables(_ request: AWSDynamoDBListTablesInput) -> Any!

    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.

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

    See

    AWSDynamoDBListTablesInput

    See

    AWSDynamoDBListTablesOutput

    Declaration

    Objective-C

    - (void)listTables:(nonnull AWSDynamoDBListTablesInput *)request
        completionHandler:(void (^_Nullable)(AWSDynamoDBListTablesOutput *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func listTables(_ request: AWSDynamoDBListTablesInput, completionHandler: ((AWSDynamoDBListTablesOutput?, Error?) -> Void)? = nil)

    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.

  • List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account.

    For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.

    See

    AWSDynamoDBListTagsOfResourceInput

    See

    AWSDynamoDBListTagsOfResourceOutput

    Declaration

    Objective-C

    - (id)listTagsOfResource:(nonnull AWSDynamoDBListTagsOfResourceInput *)request;

    Swift

    func listTags(ofResource request: AWSDynamoDBListTagsOfResourceInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account.

    For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.

    See

    AWSDynamoDBListTagsOfResourceInput

    See

    AWSDynamoDBListTagsOfResourceOutput

    Declaration

    Objective-C

    - (void)listTagsOfResource:(nonnull AWSDynamoDBListTagsOfResourceInput *)request
             completionHandler:
                 (void (^_Nullable)(AWSDynamoDBListTagsOfResourceOutput *_Nullable,
                                    NSError *_Nullable))completionHandler;

    Swift

    func listTags(ofResource request: AWSDynamoDBListTagsOfResourceInput, completionHandler: ((AWSDynamoDBListTagsOfResourceOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ListTagsOfResource 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.

  • 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. You can return the item’s attribute values in the same operation, using the ReturnValues parameter.

    This topic provides general information about the PutItem API.

    For information on how to call the PutItem API using the AWS SDK in specific languages, see the following:

    When you add an item, the primary key attributes 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.

    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 PutItem, see Working with Items in the Amazon DynamoDB Developer Guide.

    See

    AWSDynamoDBPutItemInput

    See

    AWSDynamoDBPutItemOutput

    Declaration

    Objective-C

    - (id)putItem:(nonnull AWSDynamoDBPutItemInput *)request;

    Swift

    func putItem(_ request: AWSDynamoDBPutItemInput) -> Any!

    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, AWSDynamoDBErrorTransactionConflict, AWSDynamoDBErrorRequestLimitExceeded, AWSDynamoDBErrorInternalServer.

  • 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. You can return the item’s attribute values in the same operation, using the ReturnValues parameter.

    This topic provides general information about the PutItem API.

    For information on how to call the PutItem API using the AWS SDK in specific languages, see the following:

    When you add an item, the primary key attributes 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.

    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 PutItem, see Working with Items in the Amazon DynamoDB Developer Guide.

    See

    AWSDynamoDBPutItemInput

    See

    AWSDynamoDBPutItemOutput

    Declaration

    Objective-C

    - (void)putItem:(nonnull AWSDynamoDBPutItemInput *)request
        completionHandler:(void (^_Nullable)(AWSDynamoDBPutItemOutput *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func putItem(_ request: AWSDynamoDBPutItemInput, completionHandler: ((AWSDynamoDBPutItemOutput?, Error?) -> Void)? = nil)

    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, AWSDynamoDBErrorTransactionConflict, AWSDynamoDBErrorRequestLimitExceeded, AWSDynamoDBErrorInternalServer.

  • The Query operation finds items based on primary key values. You can query any table or secondary index that has a composite primary key (a partition key and a sort key).

    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. To further refine the Query results, you can optionally provide a FilterExpression. A FilterExpression determines which items within the results should be returned to you. All of the other results are discarded.

    A Query operation always returns a result set. If no matching items are found, the result set will be empty. Queries that do not return results consume the minimum number of read capacity units for that type of read operation.

    DynamoDB calculates the number of read capacity units consumed based on item size, not on the amount of data that is returned to an application. The number of capacity units consumed will be the same whether you request all of the attributes (the default behavior) or just some of them (using a projection expression). The number will also be the same whether or not you use a FilterExpression.

    Query results are always sorted by the sort key value. If the data type of the sort key is Number, the results are returned in numeric order; otherwise, the results are returned in order of UTF-8 bytes. By default, the sort order is ascending. To reverse the order, set the ScanIndexForward parameter to false.

    A single Query operation will read up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using FilterExpression. If LastEvaluatedKey is present in the response, you will need to paginate the result set. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide.

    FilterExpression is applied after a Query finishes, but before the results are returned. A FilterExpression cannot contain partition key or sort key attributes. You need to specify those attributes in the KeyConditionExpression.

    A Query operation can return an empty result set and a LastEvaluatedKey if all the items read for the page of results are filtered out.

    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.

    See

    AWSDynamoDBQueryInput

    See

    AWSDynamoDBQueryOutput

    Declaration

    Objective-C

    - (id)query:(nonnull AWSDynamoDBQueryInput *)request;

    Swift

    func query(_ request: AWSDynamoDBQueryInput) -> Any!

    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, AWSDynamoDBErrorRequestLimitExceeded, AWSDynamoDBErrorInternalServer.

  • The Query operation finds items based on primary key values. You can query any table or secondary index that has a composite primary key (a partition key and a sort key).

    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. To further refine the Query results, you can optionally provide a FilterExpression. A FilterExpression determines which items within the results should be returned to you. All of the other results are discarded.

    A Query operation always returns a result set. If no matching items are found, the result set will be empty. Queries that do not return results consume the minimum number of read capacity units for that type of read operation.

    DynamoDB calculates the number of read capacity units consumed based on item size, not on the amount of data that is returned to an application. The number of capacity units consumed will be the same whether you request all of the attributes (the default behavior) or just some of them (using a projection expression). The number will also be the same whether or not you use a FilterExpression.

    Query results are always sorted by the sort key value. If the data type of the sort key is Number, the results are returned in numeric order; otherwise, the results are returned in order of UTF-8 bytes. By default, the sort order is ascending. To reverse the order, set the ScanIndexForward parameter to false.

    A single Query operation will read up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using FilterExpression. If LastEvaluatedKey is present in the response, you will need to paginate the result set. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide.

    FilterExpression is applied after a Query finishes, but before the results are returned. A FilterExpression cannot contain partition key or sort key attributes. You need to specify those attributes in the KeyConditionExpression.

    A Query operation can return an empty result set and a LastEvaluatedKey if all the items read for the page of results are filtered out.

    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.

    See

    AWSDynamoDBQueryInput

    See

    AWSDynamoDBQueryOutput

    Declaration

    Objective-C

    - (void)query:(nonnull AWSDynamoDBQueryInput *)request
        completionHandler:(void (^_Nullable)(AWSDynamoDBQueryOutput *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func query(_ request: AWSDynamoDBQueryInput, completionHandler: ((AWSDynamoDBQueryOutput?, Error?) -> Void)? = nil)

    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, AWSDynamoDBErrorRequestLimitExceeded, AWSDynamoDBErrorInternalServer.

  • Creates a new table from an existing backup. Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.

    You can call RestoreTableFromBackup at a maximum rate of 10 times per second.

    You must manually set up the following on the restored table:

    • Auto scaling policies

    • IAM policies

    • Amazon CloudWatch metrics and alarms

    • Tags

    • Stream settings

    • Time to Live (TTL) settings

    See

    AWSDynamoDBRestoreTableFromBackupInput

    See

    AWSDynamoDBRestoreTableFromBackupOutput

    Declaration

    Objective-C

    - (id)restoreTableFromBackup:
        (nonnull AWSDynamoDBRestoreTableFromBackupInput *)request;

    Swift

    func restoreTable(fromBackup request: AWSDynamoDBRestoreTableFromBackupInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • Creates a new table from an existing backup. Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.

    You can call RestoreTableFromBackup at a maximum rate of 10 times per second.

    You must manually set up the following on the restored table:

    • Auto scaling policies

    • IAM policies

    • Amazon CloudWatch metrics and alarms

    • Tags

    • Stream settings

    • Time to Live (TTL) settings

    See

    AWSDynamoDBRestoreTableFromBackupInput

    See

    AWSDynamoDBRestoreTableFromBackupOutput

    Declaration

    Objective-C

    - (void)restoreTableFromBackup:
                (nonnull AWSDynamoDBRestoreTableFromBackupInput *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSDynamoDBRestoreTableFromBackupOutput *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func restoreTable(fromBackup request: AWSDynamoDBRestoreTableFromBackupInput, completionHandler: ((AWSDynamoDBRestoreTableFromBackupOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the RestoreTableFromBackup 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: AWSDynamoDBErrorTableAlreadyExists, AWSDynamoDBErrorTableInUse, AWSDynamoDBErrorBackupNotFound, AWSDynamoDBErrorBackupInUse, AWSDynamoDBErrorLimitExceeded, AWSDynamoDBErrorInternalServer.

  • Restores the specified table to the specified point in time within EarliestRestorableDateTime and LatestRestorableDateTime. You can restore your table to any point in time during the last 35 days. Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.

    When you restore using point in time recovery, DynamoDB restores your table data to the state based on the selected date and time (day:hour:minute:second) to a new table.

    Along with data, the following are also included on the new restored table using point in time recovery:

    • Global secondary indexes (GSIs)

    • Local secondary indexes (LSIs)

    • Provisioned read and write capacity

    • Encryption settings

      All these settings come from the current settings of the source table at the time of restore.

    You must manually set up the following on the restored table:

    • Auto scaling policies

    • IAM policies

    • Amazon CloudWatch metrics and alarms

    • Tags

    • Stream settings

    • Time to Live (TTL) settings

    • Point in time recovery settings

    See

    AWSDynamoDBRestoreTableToPointInTimeInput

    See

    AWSDynamoDBRestoreTableToPointInTimeOutput

    Declaration

    Objective-C

    - (id)restoreTableToPointInTime:
        (nonnull AWSDynamoDBRestoreTableToPointInTimeInput *)request;

    Swift

    func restoreTableToPoint(inTime request: AWSDynamoDBRestoreTableToPointInTimeInput) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSDynamoDBRestoreTableToPointInTimeOutput. On failed execution, task.error may contain an NSError with AWSDynamoDBErrorDomain domain and the following error code: AWSDynamoDBErrorTableAlreadyExists, AWSDynamoDBErrorTableNotFound, AWSDynamoDBErrorTableInUse, AWSDynamoDBErrorLimitExceeded, AWSDynamoDBErrorInvalidRestoreTime, AWSDynamoDBErrorPointInTimeRecoveryUnavailable, AWSDynamoDBErrorInternalServer.

  • Restores the specified table to the specified point in time within EarliestRestorableDateTime and LatestRestorableDateTime. You can restore your table to any point in time during the last 35 days. Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.

    When you restore using point in time recovery, DynamoDB restores your table data to the state based on the selected date and time (day:hour:minute:second) to a new table.

    Along with data, the following are also included on the new restored table using point in time recovery:

    • Global secondary indexes (GSIs)

    • Local secondary indexes (LSIs)

    • Provisioned read and write capacity

    • Encryption settings

      All these settings come from the current settings of the source table at the time of restore.

    You must manually set up the following on the restored table:

    • Auto scaling policies

    • IAM policies

    • Amazon CloudWatch metrics and alarms

    • Tags

    • Stream settings

    • Time to Live (TTL) settings

    • Point in time recovery settings

    See

    AWSDynamoDBRestoreTableToPointInTimeInput

    See

    AWSDynamoDBRestoreTableToPointInTimeOutput

    Declaration

    Objective-C

    - (void)restoreTableToPointInTime:
                (nonnull AWSDynamoDBRestoreTableToPointInTimeInput *)request
                    completionHandler:
                        (void (^_Nullable)(
                            AWSDynamoDBRestoreTableToPointInTimeOutput *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func restoreTableToPoint(inTime request: AWSDynamoDBRestoreTableToPointInTimeInput, completionHandler: ((AWSDynamoDBRestoreTableToPointInTimeOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the RestoreTableToPointInTime 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: AWSDynamoDBErrorTableAlreadyExists, AWSDynamoDBErrorTableNotFound, AWSDynamoDBErrorTableInUse, AWSDynamoDBErrorLimitExceeded, AWSDynamoDBErrorInvalidRestoreTime, AWSDynamoDBErrorPointInTimeRecoveryUnavailable, AWSDynamoDBErrorInternalServer.

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

    If the total number of scanned items exceeds the maximum dataset 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.

    A single Scan operation reads up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using FilterExpression. If LastEvaluatedKey is present in the response, you need to paginate the result set. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide.

    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.

    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.

    See

    AWSDynamoDBScanInput

    See

    AWSDynamoDBScanOutput

    Declaration

    Objective-C

    - (id)scan:(nonnull AWSDynamoDBScanInput *)request;

    Swift

    func scan(_ request: AWSDynamoDBScanInput) -> Any!

    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, AWSDynamoDBErrorRequestLimitExceeded, AWSDynamoDBErrorInternalServer.

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

    If the total number of scanned items exceeds the maximum dataset 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.

    A single Scan operation reads up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using FilterExpression. If LastEvaluatedKey is present in the response, you need to paginate the result set. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide.

    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.

    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.

    See

    AWSDynamoDBScanInput

    See

    AWSDynamoDBScanOutput

    Declaration

    Objective-C

    - (void)scan:(nonnull AWSDynamoDBScanInput *)request
        completionHandler:(void (^_Nullable)(AWSDynamoDBScanOutput *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func scan(_ request: AWSDynamoDBScanInput, completionHandler: ((AWSDynamoDBScanOutput?, Error?) -> Void)? = nil)

    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, AWSDynamoDBErrorRequestLimitExceeded, AWSDynamoDBErrorInternalServer.

  • Associate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. You can call TagResource up to five times per second, per account.

    For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.

    See

    AWSDynamoDBTagResourceInput

    Declaration

    Objective-C

    - (id)tagResource:(nonnull AWSDynamoDBTagResourceInput *)request;

    Swift

    func tagResource(_ request: AWSDynamoDBTagResourceInput) -> Any!

    Parameters

    request

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

  • Associate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. You can call TagResource up to five times per second, per account.

    For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.

    See

    AWSDynamoDBTagResourceInput

    Declaration

    Objective-C

    - (void)tagResource:(nonnull AWSDynamoDBTagResourceInput *)request
        completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func tagResource(_ request: AWSDynamoDBTagResourceInput, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

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

  • TransactGetItems is a synchronous operation that atomically retrieves multiple items from one or more tables (but not from indexes) in a single account and Region. A TransactGetItems call can contain up to 25 TransactGetItem objects, each of which contains a Get structure that specifies an item to retrieve from a table in the account and Region. A call to TransactGetItems cannot retrieve items from tables in more than one AWS account or Region. The aggregate size of the items in the transaction cannot exceed 4 MB.

    DynamoDB rejects the entire TransactGetItems request if any of the following is true:

    • A conflicting operation is in the process of updating an item to be read.

    • There is insufficient provisioned capacity for the transaction to be completed.

    • There is a user error, such as an invalid data format.

    • The aggregate size of the items in the transaction cannot exceed 4 MB.

    See

    AWSDynamoDBTransactGetItemsInput

    See

    AWSDynamoDBTransactGetItemsOutput

    Declaration

    Objective-C

    - (id)transactGetItems:(nonnull AWSDynamoDBTransactGetItemsInput *)request;

    Swift

    func transactGetItems(_ request: AWSDynamoDBTransactGetItemsInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • TransactGetItems is a synchronous operation that atomically retrieves multiple items from one or more tables (but not from indexes) in a single account and Region. A TransactGetItems call can contain up to 25 TransactGetItem objects, each of which contains a Get structure that specifies an item to retrieve from a table in the account and Region. A call to TransactGetItems cannot retrieve items from tables in more than one AWS account or Region. The aggregate size of the items in the transaction cannot exceed 4 MB.

    DynamoDB rejects the entire TransactGetItems request if any of the following is true:

    • A conflicting operation is in the process of updating an item to be read.

    • There is insufficient provisioned capacity for the transaction to be completed.

    • There is a user error, such as an invalid data format.

    • The aggregate size of the items in the transaction cannot exceed 4 MB.

    See

    AWSDynamoDBTransactGetItemsInput

    See

    AWSDynamoDBTransactGetItemsOutput

    Declaration

    Objective-C

    - (void)transactGetItems:(nonnull AWSDynamoDBTransactGetItemsInput *)request
           completionHandler:
               (void (^_Nullable)(AWSDynamoDBTransactGetItemsOutput *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func transactGetItems(_ request: AWSDynamoDBTransactGetItemsInput, completionHandler: ((AWSDynamoDBTransactGetItemsOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the TransactGetItems 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, AWSDynamoDBErrorTransactionCanceled, AWSDynamoDBErrorProvisionedThroughputExceeded, AWSDynamoDBErrorRequestLimitExceeded, AWSDynamoDBErrorInternalServer.

  • TransactWriteItems is a synchronous write operation that groups up to 25 action requests. These actions can target items in different tables, but not in different AWS accounts or Regions, and no two actions can target the same item. For example, you cannot both ConditionCheck and Update the same item. The aggregate size of the items in the transaction cannot exceed 4 MB.

    The actions are completed atomically so that either all of them succeed, or all of them fail. They are defined by the following objects:

    • Put  —   Initiates a PutItem operation to write a new item. This structure specifies the primary key of the item to be written, the name of the table to write it in, an optional condition expression that must be satisfied for the write to succeed, a list of the item’s attributes, and a field indicating whether to retrieve the item’s attributes if the condition is not met.

    • Update  —   Initiates an UpdateItem operation to update an existing item. This structure specifies the primary key of the item to be updated, the name of the table where it resides, an optional condition expression that must be satisfied for the update to succeed, an expression that defines one or more attributes to be updated, and a field indicating whether to retrieve the item’s attributes if the condition is not met.

    • Delete  —   Initiates a DeleteItem operation to delete an existing item. This structure specifies the primary key of the item to be deleted, the name of the table where it resides, an optional condition expression that must be satisfied for the deletion to succeed, and a field indicating whether to retrieve the item’s attributes if the condition is not met.

    • ConditionCheck  —   Applies a condition to an item that is not being modified by the transaction. This structure specifies the primary key of the item to be checked, the name of the table where it resides, a condition expression that must be satisfied for the transaction to succeed, and a field indicating whether to retrieve the item’s attributes if the condition is not met.

    DynamoDB rejects the entire TransactWriteItems request if any of the following is true:

    • A condition in one of the condition expressions is not met.

    • An ongoing operation is in the process of updating the same item.

    • There is insufficient provisioned capacity for the transaction to be completed.

    • An item size becomes too large (bigger than 400 KB), a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.

    • The aggregate size of the items in the transaction exceeds 4 MB.

    • There is a user error, such as an invalid data format.

    See

    AWSDynamoDBTransactWriteItemsInput

    See

    AWSDynamoDBTransactWriteItemsOutput

    Declaration

    Objective-C

    - (id)transactWriteItems:(nonnull AWSDynamoDBTransactWriteItemsInput *)request;

    Swift

    func transactWriteItems(_ request: AWSDynamoDBTransactWriteItemsInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • TransactWriteItems is a synchronous write operation that groups up to 25 action requests. These actions can target items in different tables, but not in different AWS accounts or Regions, and no two actions can target the same item. For example, you cannot both ConditionCheck and Update the same item. The aggregate size of the items in the transaction cannot exceed 4 MB.

    The actions are completed atomically so that either all of them succeed, or all of them fail. They are defined by the following objects:

    • Put  —   Initiates a PutItem operation to write a new item. This structure specifies the primary key of the item to be written, the name of the table to write it in, an optional condition expression that must be satisfied for the write to succeed, a list of the item’s attributes, and a field indicating whether to retrieve the item’s attributes if the condition is not met.

    • Update  —   Initiates an UpdateItem operation to update an existing item. This structure specifies the primary key of the item to be updated, the name of the table where it resides, an optional condition expression that must be satisfied for the update to succeed, an expression that defines one or more attributes to be updated, and a field indicating whether to retrieve the item’s attributes if the condition is not met.

    • Delete  —   Initiates a DeleteItem operation to delete an existing item. This structure specifies the primary key of the item to be deleted, the name of the table where it resides, an optional condition expression that must be satisfied for the deletion to succeed, and a field indicating whether to retrieve the item’s attributes if the condition is not met.

    • ConditionCheck  —   Applies a condition to an item that is not being modified by the transaction. This structure specifies the primary key of the item to be checked, the name of the table where it resides, a condition expression that must be satisfied for the transaction to succeed, and a field indicating whether to retrieve the item’s attributes if the condition is not met.

    DynamoDB rejects the entire TransactWriteItems request if any of the following is true:

    • A condition in one of the condition expressions is not met.

    • An ongoing operation is in the process of updating the same item.

    • There is insufficient provisioned capacity for the transaction to be completed.

    • An item size becomes too large (bigger than 400 KB), a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.

    • The aggregate size of the items in the transaction exceeds 4 MB.

    • There is a user error, such as an invalid data format.

    See

    AWSDynamoDBTransactWriteItemsInput

    See

    AWSDynamoDBTransactWriteItemsOutput

    Declaration

    Objective-C

    - (void)transactWriteItems:(nonnull AWSDynamoDBTransactWriteItemsInput *)request
             completionHandler:
                 (void (^_Nullable)(AWSDynamoDBTransactWriteItemsOutput *_Nullable,
                                    NSError *_Nullable))completionHandler;

    Swift

    func transactWriteItems(_ request: AWSDynamoDBTransactWriteItemsInput, completionHandler: ((AWSDynamoDBTransactWriteItemsOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the TransactWriteItems 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, AWSDynamoDBErrorTransactionCanceled, AWSDynamoDBErrorTransactionInProgress, AWSDynamoDBErrorIdempotentParameterMismatch, AWSDynamoDBErrorProvisionedThroughputExceeded, AWSDynamoDBErrorRequestLimitExceeded, AWSDynamoDBErrorInternalServer.

  • Removes the association of tags from an Amazon DynamoDB resource. You can call UntagResource up to five times per second, per account.

    For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.

    See

    AWSDynamoDBUntagResourceInput

    Declaration

    Objective-C

    - (id)untagResource:(nonnull AWSDynamoDBUntagResourceInput *)request;

    Swift

    func untagResource(_ request: AWSDynamoDBUntagResourceInput) -> Any!

    Parameters

    request

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

  • Removes the association of tags from an Amazon DynamoDB resource. You can call UntagResource up to five times per second, per account.

    For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.

    See

    AWSDynamoDBUntagResourceInput

    Declaration

    Objective-C

    - (void)untagResource:(nonnull AWSDynamoDBUntagResourceInput *)request
        completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func untagResource(_ request: AWSDynamoDBUntagResourceInput, completionHandler: ((Error?) -> Void)? = nil)

    Parameters

    request

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

  • UpdateContinuousBackups enables or disables point in time recovery for the specified table. A successful UpdateContinuousBackups call returns the current ContinuousBackupsDescription. Continuous backups are ENABLED on all tables at table creation. If point in time recovery is enabled, PointInTimeRecoveryStatus will be set to ENABLED.

    Once continuous backups and point in time recovery are enabled, you can restore to any point in time within EarliestRestorableDateTime and LatestRestorableDateTime.

    LatestRestorableDateTime is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days.

    See

    AWSDynamoDBUpdateContinuousBackupsInput

    See

    AWSDynamoDBUpdateContinuousBackupsOutput

    Declaration

    Objective-C

    - (id)updateContinuousBackups:
        (nonnull AWSDynamoDBUpdateContinuousBackupsInput *)request;

    Swift

    func updateContinuousBackups(_ request: AWSDynamoDBUpdateContinuousBackupsInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • UpdateContinuousBackups enables or disables point in time recovery for the specified table. A successful UpdateContinuousBackups call returns the current ContinuousBackupsDescription. Continuous backups are ENABLED on all tables at table creation. If point in time recovery is enabled, PointInTimeRecoveryStatus will be set to ENABLED.

    Once continuous backups and point in time recovery are enabled, you can restore to any point in time within EarliestRestorableDateTime and LatestRestorableDateTime.

    LatestRestorableDateTime is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days.

    See

    AWSDynamoDBUpdateContinuousBackupsInput

    See

    AWSDynamoDBUpdateContinuousBackupsOutput

    Declaration

    Objective-C

    - (void)updateContinuousBackups:
                (nonnull AWSDynamoDBUpdateContinuousBackupsInput *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSDynamoDBUpdateContinuousBackupsOutput *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func updateContinuousBackups(_ request: AWSDynamoDBUpdateContinuousBackupsInput, completionHandler: ((AWSDynamoDBUpdateContinuousBackupsOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the UpdateContinuousBackups 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: AWSDynamoDBErrorTableNotFound, AWSDynamoDBErrorContinuousBackupsUnavailable, AWSDynamoDBErrorInternalServer.

  • Updates the status for contributor insights for a specific table or index.

    See

    AWSDynamoDBUpdateContributorInsightsInput

    See

    AWSDynamoDBUpdateContributorInsightsOutput

    Declaration

    Objective-C

    - (id)updateContributorInsights:
        (nonnull AWSDynamoDBUpdateContributorInsightsInput *)request;

    Swift

    func updateContributorInsights(_ request: AWSDynamoDBUpdateContributorInsightsInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates the status for contributor insights for a specific table or index.

    See

    AWSDynamoDBUpdateContributorInsightsInput

    See

    AWSDynamoDBUpdateContributorInsightsOutput

    Declaration

    Objective-C

    - (void)updateContributorInsights:
                (nonnull AWSDynamoDBUpdateContributorInsightsInput *)request
                    completionHandler:
                        (void (^_Nullable)(
                            AWSDynamoDBUpdateContributorInsightsOutput *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func updateContributorInsights(_ request: AWSDynamoDBUpdateContributorInsightsInput, completionHandler: ((AWSDynamoDBUpdateContributorInsightsOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the UpdateContributorInsights 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.

  • Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, have the same name as the global table, have the same key schema, have DynamoDB Streams enabled, and have the same provisioned and maximum write capacity units.

    Although you can use UpdateGlobalTable to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas.

    If global secondary indexes are specified, then the following conditions must also be met:

    • The global secondary indexes must have the same name.

    • The global secondary indexes must have the same hash key and sort key (if present).

    • The global secondary indexes must have the same provisioned and maximum write capacity units.

    See

    AWSDynamoDBUpdateGlobalTableInput

    See

    AWSDynamoDBUpdateGlobalTableOutput

    Declaration

    Objective-C

    - (id)updateGlobalTable:(nonnull AWSDynamoDBUpdateGlobalTableInput *)request;

    Swift

    func updateGlobalTable(_ request: AWSDynamoDBUpdateGlobalTableInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, have the same name as the global table, have the same key schema, have DynamoDB Streams enabled, and have the same provisioned and maximum write capacity units.

    Although you can use UpdateGlobalTable to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas.

    If global secondary indexes are specified, then the following conditions must also be met:

    • The global secondary indexes must have the same name.

    • The global secondary indexes must have the same hash key and sort key (if present).

    • The global secondary indexes must have the same provisioned and maximum write capacity units.

    See

    AWSDynamoDBUpdateGlobalTableInput

    See

    AWSDynamoDBUpdateGlobalTableOutput

    Declaration

    Objective-C

    - (void)updateGlobalTable:(nonnull AWSDynamoDBUpdateGlobalTableInput *)request
            completionHandler:
                (void (^_Nullable)(AWSDynamoDBUpdateGlobalTableOutput *_Nullable,
                                   NSError *_Nullable))completionHandler;

    Swift

    func updateGlobalTable(_ request: AWSDynamoDBUpdateGlobalTableInput, completionHandler: ((AWSDynamoDBUpdateGlobalTableOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the UpdateGlobalTable 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, AWSDynamoDBErrorGlobalTableNotFound, AWSDynamoDBErrorReplicaAlreadyExists, AWSDynamoDBErrorReplicaNotFound, AWSDynamoDBErrorTableNotFound.

  • Updates settings for a global table.

    See

    AWSDynamoDBUpdateGlobalTableSettingsInput

    See

    AWSDynamoDBUpdateGlobalTableSettingsOutput

    Declaration

    Objective-C

    - (id)updateGlobalTableSettings:
        (nonnull AWSDynamoDBUpdateGlobalTableSettingsInput *)request;

    Swift

    func updateGlobalTableSettings(_ request: AWSDynamoDBUpdateGlobalTableSettingsInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates settings for a global table.

    See

    AWSDynamoDBUpdateGlobalTableSettingsInput

    See

    AWSDynamoDBUpdateGlobalTableSettingsOutput

    Declaration

    Objective-C

    - (void)updateGlobalTableSettings:
                (nonnull AWSDynamoDBUpdateGlobalTableSettingsInput *)request
                    completionHandler:
                        (void (^_Nullable)(
                            AWSDynamoDBUpdateGlobalTableSettingsOutput *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func updateGlobalTableSettings(_ request: AWSDynamoDBUpdateGlobalTableSettingsInput, completionHandler: ((AWSDynamoDBUpdateGlobalTableSettingsOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the UpdateGlobalTableSettings 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: AWSDynamoDBErrorGlobalTableNotFound, AWSDynamoDBErrorReplicaNotFound, AWSDynamoDBErrorIndexNotFound, AWSDynamoDBErrorLimitExceeded, AWSDynamoDBErrorResourceInUse, AWSDynamoDBErrorInternalServer.

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

    See

    AWSDynamoDBUpdateItemInput

    See

    AWSDynamoDBUpdateItemOutput

    Declaration

    Objective-C

    - (id)updateItem:(nonnull AWSDynamoDBUpdateItemInput *)request;

    Swift

    func updateItem(_ request: AWSDynamoDBUpdateItemInput) -> Any!

    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, AWSDynamoDBErrorTransactionConflict, AWSDynamoDBErrorRequestLimitExceeded, AWSDynamoDBErrorInternalServer.

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

    See

    AWSDynamoDBUpdateItemInput

    See

    AWSDynamoDBUpdateItemOutput

    Declaration

    Objective-C

    - (void)updateItem:(nonnull AWSDynamoDBUpdateItemInput *)request
        completionHandler:(void (^_Nullable)(AWSDynamoDBUpdateItemOutput *_Nullable,
                                             NSError *_Nullable))completionHandler;

    Swift

    func updateItem(_ request: AWSDynamoDBUpdateItemInput, completionHandler: ((AWSDynamoDBUpdateItemOutput?, Error?) -> Void)? = nil)

    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, AWSDynamoDBErrorTransactionConflict, AWSDynamoDBErrorRequestLimitExceeded, AWSDynamoDBErrorInternalServer.

  • 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 DynamoDB Streams on the table.

    • Remove a global secondary index from the table.

    • Create a new global secondary index on the table. After 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.

    See

    AWSDynamoDBUpdateTableInput

    See

    AWSDynamoDBUpdateTableOutput

    Declaration

    Objective-C

    - (id)updateTable:(nonnull AWSDynamoDBUpdateTableInput *)request;

    Swift

    func updateTable(_ request: AWSDynamoDBUpdateTableInput) -> Any!

    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.

  • 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 DynamoDB Streams on the table.

    • Remove a global secondary index from the table.

    • Create a new global secondary index on the table. After 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.

    See

    AWSDynamoDBUpdateTableInput

    See

    AWSDynamoDBUpdateTableOutput

    Declaration

    Objective-C

    - (void)updateTable:(nonnull AWSDynamoDBUpdateTableInput *)request
        completionHandler:
            (void (^_Nullable)(AWSDynamoDBUpdateTableOutput *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func updateTable(_ request: AWSDynamoDBUpdateTableInput, completionHandler: ((AWSDynamoDBUpdateTableOutput?, Error?) -> Void)? = nil)

    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.

  • Updates auto scaling settings on your global tables at once.

    This method only applies to Version 2019.11.21 of global tables.

    See

    AWSDynamoDBUpdateTableReplicaAutoScalingInput

    See

    AWSDynamoDBUpdateTableReplicaAutoScalingOutput

    Declaration

    Objective-C

    - (id)updateTableReplicaAutoScaling:
        (nonnull AWSDynamoDBUpdateTableReplicaAutoScalingInput *)request;

    Swift

    func updateTableReplicaAutoScaling(_ request: AWSDynamoDBUpdateTableReplicaAutoScalingInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates auto scaling settings on your global tables at once.

    This method only applies to Version 2019.11.21 of global tables.

    See

    AWSDynamoDBUpdateTableReplicaAutoScalingInput

    See

    AWSDynamoDBUpdateTableReplicaAutoScalingOutput

    Declaration

    Objective-C

    - (void)updateTableReplicaAutoScaling:
                (nonnull AWSDynamoDBUpdateTableReplicaAutoScalingInput *)request
                        completionHandler:
                            (void (^_Nullable)(
                                AWSDynamoDBUpdateTableReplicaAutoScalingOutput
                                    *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func updateTableReplicaAutoScaling(_ request: AWSDynamoDBUpdateTableReplicaAutoScalingInput, completionHandler: ((AWSDynamoDBUpdateTableReplicaAutoScalingOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the UpdateTableReplicaAutoScaling 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, AWSDynamoDBErrorResourceInUse, AWSDynamoDBErrorLimitExceeded, AWSDynamoDBErrorInternalServer.

  • The UpdateTimeToLive method enables or disables Time to Live (TTL) for the specified table. A successful UpdateTimeToLive call returns the current TimeToLiveSpecification. It can take up to one hour for the change to fully process. Any additional UpdateTimeToLive calls for the same table during this one hour duration result in a ValidationException.

    TTL compares the current time in epoch time format to the time stored in the TTL attribute of an item. If the epoch time value stored in the attribute is less than the current time, the item is marked as expired and subsequently deleted.

    The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.

    DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations.

    DynamoDB typically deletes expired items within two days of expiration. The exact duration within which an item gets deleted after expiration is specific to the nature of the workload. Items that have expired and not been deleted will still show up in reads, queries, and scans.

    As items are deleted, they are removed from any local secondary index and global secondary index immediately in the same eventually consistent way as a standard delete operation.

    For more information, see Time To Live in the Amazon DynamoDB Developer Guide.

    See

    AWSDynamoDBUpdateTimeToLiveInput

    See

    AWSDynamoDBUpdateTimeToLiveOutput

    Declaration

    Objective-C

    - (id)updateTimeToLive:(nonnull AWSDynamoDBUpdateTimeToLiveInput *)request;

    Swift

    func updateTime(toLive request: AWSDynamoDBUpdateTimeToLiveInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • The UpdateTimeToLive method enables or disables Time to Live (TTL) for the specified table. A successful UpdateTimeToLive call returns the current TimeToLiveSpecification. It can take up to one hour for the change to fully process. Any additional UpdateTimeToLive calls for the same table during this one hour duration result in a ValidationException.

    TTL compares the current time in epoch time format to the time stored in the TTL attribute of an item. If the epoch time value stored in the attribute is less than the current time, the item is marked as expired and subsequently deleted.

    The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.

    DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations.

    DynamoDB typically deletes expired items within two days of expiration. The exact duration within which an item gets deleted after expiration is specific to the nature of the workload. Items that have expired and not been deleted will still show up in reads, queries, and scans.

    As items are deleted, they are removed from any local secondary index and global secondary index immediately in the same eventually consistent way as a standard delete operation.

    For more information, see Time To Live in the Amazon DynamoDB Developer Guide.

    See

    AWSDynamoDBUpdateTimeToLiveInput

    See

    AWSDynamoDBUpdateTimeToLiveOutput

    Declaration

    Objective-C

    - (void)updateTimeToLive:(nonnull AWSDynamoDBUpdateTimeToLiveInput *)request
           completionHandler:
               (void (^_Nullable)(AWSDynamoDBUpdateTimeToLiveOutput *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func updateTime(toLive request: AWSDynamoDBUpdateTimeToLiveInput, completionHandler: ((AWSDynamoDBUpdateTimeToLiveOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the UpdateTimeToLive 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.