Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DynamoDB

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 Amazon Web Services 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 Amazon Web Services Region, providing built-in high availability and data durability.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly config

The resolved configuration of DynamoDBClient class. This is resolved and normalized from the constructor configuration interface.

middlewareStack

Methods

batchExecuteStatement

  • This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL. Each read statement in a BatchExecuteStatement must specify an equality condition on all key attributes. This enforces that each SELECT statement in a batch returns at most a single item.

    The entire batch must consist of either read statements or write statements, you cannot mix both in one batch.

    A HTTP 200 response does not mean that all statements in the BatchExecuteStatement succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each statement.

    Parameters

    Returns Promise<BatchExecuteStatementCommandOutput>

  • This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL. Each read statement in a BatchExecuteStatement must specify an equality condition on all key attributes. This enforces that each SELECT statement in a batch returns at most a single item.

    The entire batch must consist of either read statements or write statements, you cannot mix both in one batch.

    A HTTP 200 response does not mean that all statements in the BatchExecuteStatement succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each statement.

    Parameters

    Returns void

  • This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL. Each read statement in a BatchExecuteStatement must specify an equality condition on all key attributes. This enforces that each SELECT statement in a batch returns at most a single item.

    The entire batch must consist of either read statements or write statements, you cannot mix both in one batch.

    A HTTP 200 response does not mean that all statements in the BatchExecuteStatement succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each statement.

    Parameters

    Returns void

  • This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL. Each read statement in a BatchExecuteStatement must specify an equality condition on all key attributes. This enforces that each SELECT statement in a batch returns at most a single item.

    The entire batch must consist of either read statements or write statements, you cannot mix both in one batch.

    A HTTP 200 response does not mean that all statements in the BatchExecuteStatement succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each statement.

    Parameters

    • args: BatchExecuteStatementCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<BatchExecuteStatementCommandOutput>

  • This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL. Each read statement in a BatchExecuteStatement must specify an equality condition on all key attributes. This enforces that each SELECT statement in a batch returns at most a single item.

    The entire batch must consist of either read statements or write statements, you cannot mix both in one batch.

    A HTTP 200 response does not mean that all statements in the BatchExecuteStatement succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each statement.

    Parameters

    Returns void

  • This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL. Each read statement in a BatchExecuteStatement must specify an equality condition on all key attributes. This enforces that each SELECT statement in a batch returns at most a single item.

    The entire batch must consist of either read statements or write statements, you cannot mix both in one batch.

    A HTTP 200 response does not mean that all statements in the BatchExecuteStatement succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each statement.

    Parameters

    Returns void

batchGetItem

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

    A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. BatchGetItem 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.

    Parameters

    Returns Promise<BatchGetItemCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: BatchGetItemCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<BatchGetItemCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

batchWriteItem

  • The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types.

    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.

        <p>With <code>BatchWriteItem</code>, 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,
                <code>BatchWriteItem</code> does not behave in the same way as individual
                <code>PutItem</code> and <code>DeleteItem</code> calls would. For example, you
            cannot specify conditions on individual put and delete requests, and
                <code>BatchWriteItem</code> does not return deleted items in the response.</p>
        <p>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, <code>BatchWriteItem</code> 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.</p>
        <p>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.</p>
        <p>If one or more of the following is true, DynamoDB rejects the entire batch write
            operation:</p>
        <ul>
            <li>
                <p>One or more tables specified in the <code>BatchWriteItem</code> request does
                    not exist.</p>
            </li>
            <li>
                <p>Primary key attributes specified on an item in the request do not match those
                    in the corresponding table's primary key schema.</p>
            </li>
            <li>
                <p>You try to perform multiple operations on the same item in the same
                        <code>BatchWriteItem</code> request. For example, you cannot put and delete
                    the same item in the same <code>BatchWriteItem</code> request. </p>
            </li>
            <li>
                <p> Your request contains at least two items with identical hash and range keys
                    (which essentially is two put operations). </p>
            </li>
            <li>
                <p>There are more than 25 requests in the batch.</p>
            </li>
            <li>
                <p>Any individual item in a batch exceeds 400 KB.</p>
            </li>
            <li>
                <p>The total request size exceeds 16 MB.</p>
            </li>
         </ul>
    

    Parameters

    Returns Promise<BatchWriteItemCommandOutput>

  • The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types.

    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.

    Parameters

    Returns void

  • The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types.

    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.

    Parameters

    Returns void

  • The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types.

    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.

        <p>With <code>BatchWriteItem</code>, 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,
                <code>BatchWriteItem</code> does not behave in the same way as individual
                <code>PutItem</code> and <code>DeleteItem</code> calls would. For example, you
            cannot specify conditions on individual put and delete requests, and
                <code>BatchWriteItem</code> does not return deleted items in the response.</p>
        <p>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, <code>BatchWriteItem</code> 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.</p>
        <p>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.</p>
        <p>If one or more of the following is true, DynamoDB rejects the entire batch write
            operation:</p>
        <ul>
            <li>
                <p>One or more tables specified in the <code>BatchWriteItem</code> request does
                    not exist.</p>
            </li>
            <li>
                <p>Primary key attributes specified on an item in the request do not match those
                    in the corresponding table's primary key schema.</p>
            </li>
            <li>
                <p>You try to perform multiple operations on the same item in the same
                        <code>BatchWriteItem</code> request. For example, you cannot put and delete
                    the same item in the same <code>BatchWriteItem</code> request. </p>
            </li>
            <li>
                <p> Your request contains at least two items with identical hash and range keys
                    (which essentially is two put operations). </p>
            </li>
            <li>
                <p>There are more than 25 requests in the batch.</p>
            </li>
            <li>
                <p>Any individual item in a batch exceeds 400 KB.</p>
            </li>
            <li>
                <p>The total request size exceeds 16 MB.</p>
            </li>
         </ul>
    

    Parameters

    • args: BatchWriteItemCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<BatchWriteItemCommandOutput>

  • The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types.

    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.

    Parameters

    Returns void

  • The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types.

    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.

    Parameters

    Returns void

createBackup

  • 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

    Parameters

    Returns Promise<CreateBackupCommandOutput>

  • 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

    Parameters

    Returns void

  • 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

    Parameters

    Returns void

  • 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

    Parameters

    • args: CreateBackupCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<CreateBackupCommandOutput>

  • 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

    Parameters

    Returns void

  • 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

    Parameters

    Returns void

createGlobalTable

  • 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 operation only applies to Version 2017.11.29 of global tables.

        <p>If you want to add a new replica table to a global table, each of the following
            conditions must be true:</p>
        <ul>
            <li>
                <p>The table must have the same primary key as all of the other replicas.</p>
            </li>
            <li>
                <p>The table must have the same name as all of the other replicas.</p>
            </li>
            <li>
                <p>The table must have DynamoDB Streams enabled, with the stream containing both
                    the new and the old images of the item.</p>
            </li>
            <li>
                <p>None of the replica tables in the global table can contain any data.</p>
            </li>
         </ul>
        <p> If global secondary indexes are specified, then the following conditions must also be
            met: </p>
        <ul>
            <li>
                <p> The global secondary indexes must have the same name. </p>
            </li>
            <li>
                <p> The global secondary indexes must have the same hash key and sort key (if
                    present). </p>
            </li>
         </ul>
        <p> If local secondary indexes are specified, then the following conditions must also be
            met: </p>
        <ul>
            <li>
                <p> The local secondary indexes must have the same name. </p>
            </li>
            <li>
                <p> The local secondary indexes must have the same hash key and sort key (if
                    present). </p>
            </li>
         </ul>
    
        <important>
            <p> 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. </p>
            <p> 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. </p>
        </important>
    

    Parameters

    Returns Promise<CreateGlobalTableCommandOutput>

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

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

    • The local secondary indexes must have the same name.

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

    Parameters

    Returns void

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

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

    • The local secondary indexes must have the same name.

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

    Parameters

    Returns void

  • 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 operation only applies to Version 2017.11.29 of global tables.

        <p>If you want to add a new replica table to a global table, each of the following
            conditions must be true:</p>
        <ul>
            <li>
                <p>The table must have the same primary key as all of the other replicas.</p>
            </li>
            <li>
                <p>The table must have the same name as all of the other replicas.</p>
            </li>
            <li>
                <p>The table must have DynamoDB Streams enabled, with the stream containing both
                    the new and the old images of the item.</p>
            </li>
            <li>
                <p>None of the replica tables in the global table can contain any data.</p>
            </li>
         </ul>
        <p> If global secondary indexes are specified, then the following conditions must also be
            met: </p>
        <ul>
            <li>
                <p> The global secondary indexes must have the same name. </p>
            </li>
            <li>
                <p> The global secondary indexes must have the same hash key and sort key (if
                    present). </p>
            </li>
         </ul>
        <p> If local secondary indexes are specified, then the following conditions must also be
            met: </p>
        <ul>
            <li>
                <p> The local secondary indexes must have the same name. </p>
            </li>
            <li>
                <p> The local secondary indexes must have the same hash key and sort key (if
                    present). </p>
            </li>
         </ul>
    
        <important>
            <p> 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. </p>
            <p> 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. </p>
        </important>
    

    Parameters

    • args: CreateGlobalTableCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<CreateGlobalTableCommandOutput>

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

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

    • The local secondary indexes must have the same name.

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

    Parameters

    Returns void

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

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

    • The local secondary indexes must have the same name.

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

    Parameters

    Returns void

createTable

  • The CreateTable operation adds a new table to your account. In an Amazon Web Services 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.

    Parameters

    Returns Promise<CreateTableCommandOutput>

  • The CreateTable operation adds a new table to your account. In an Amazon Web Services 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.

    Parameters

    Returns void

  • The CreateTable operation adds a new table to your account. In an Amazon Web Services 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.

    Parameters

    Returns void

  • The CreateTable operation adds a new table to your account. In an Amazon Web Services 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.

    Parameters

    • args: CreateTableCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<CreateTableCommandOutput>

  • The CreateTable operation adds a new table to your account. In an Amazon Web Services 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.

    Parameters

    Returns void

  • The CreateTable operation adds a new table to your account. In an Amazon Web Services 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.

    Parameters

    Returns void

deleteBackup

deleteItem

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

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

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

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

    Parameters

    Returns Promise<DeleteItemCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: DeleteItemCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DeleteItemCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

deleteTable

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

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

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

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

        <p>Use the <code>DescribeTable</code> action to check the status of the table. </p>
    

    Parameters

    Returns Promise<DeleteTableCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

        <p>Use the <code>DescribeTable</code> action to check the status of the table. </p>
    

    Parameters

    • args: DeleteTableCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DeleteTableCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

describeBackup

describeContinuousBackups

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

    Parameters

    Returns Promise<DescribeContinuousBackupsCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: DescribeContinuousBackupsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DescribeContinuousBackupsCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

describeContributorInsights

describeEndpoints

describeExport

describeGlobalTable

describeGlobalTableSettings

describeImport

describeKinesisStreamingDestination

describeLimits

  • Returns the current provisioned-capacity quotas for your Amazon Web Services 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 Amazon Web Services account, the account has initial quotas 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 quotas that apply when you create a table there. For more information, see Service, Account, and Table Quotas page in the Amazon DynamoDB Developer Guide.

        <p>Although you can increase these quotas by filing a case at <a href="https://console.aws.amazon.com/support/home#/">Amazon Web Services Support Center</a>, obtaining the
            increase is not instantaneous. The <code>DescribeLimits</code> action lets you write
            code to compare the capacity you are currently using to those quotas imposed by your
            account so that you have enough time to apply for an increase before you hit a
            quota.</p>
    
        <p>For example, you could use one of the Amazon Web Services SDKs to do the
            following:</p>
    
        <ol>
            <li>
                <p>Call <code>DescribeLimits</code> for a particular Region to obtain your
                    current account quotas on provisioned capacity there.</p>
            </li>
            <li>
                <p>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.</p>
            </li>
            <li>
                <p>Call <code>ListTables</code> to obtain a list of all your DynamoDB
                    tables.</p>
            </li>
            <li>
                <p>For each table name listed by <code>ListTables</code>, do the
                    following:</p>
                <ul>
                  <li>
                        <p>Call <code>DescribeTable</code> with the table name.</p>
                    </li>
                  <li>
                        <p>Use the data returned by <code>DescribeTable</code> to add the read
                            capacity units and write capacity units provisioned for the table itself
                            to your variables.</p>
                    </li>
                  <li>
                        <p>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.</p>
                    </li>
               </ul>
            </li>
            <li>
                <p>Report the account quotas for that Region returned by
                        <code>DescribeLimits</code>, along with the total current provisioned
                    capacity levels you have calculated.</p>
            </li>
         </ol>
    
        <p>This will let you see whether you are getting close to your account-level
            quotas.</p>
        <p>The per-table quotas 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.</p>
        <p>For existing tables and their GSIs, DynamoDB doesn't let you increase provisioned
            capacity extremely rapidly, but the only quota that applies is that the aggregate
            provisioned capacity over all your tables and GSIs cannot exceed either of the
            per-account quotas.</p>
        <note>
            <p>
                <code>DescribeLimits</code> should only be called periodically. You can expect
                throttling errors if you call it more than once in a minute.</p>
        </note>
        <p>The <code>DescribeLimits</code> Request element has no content.</p>
    

    Parameters

    Returns Promise<DescribeLimitsCommandOutput>

  • Returns the current provisioned-capacity quotas for your Amazon Web Services 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 Amazon Web Services account, the account has initial quotas 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 quotas that apply when you create a table there. For more information, see Service, Account, and Table Quotas page in the Amazon DynamoDB Developer Guide.

    Although you can increase these quotas by filing a case at Amazon Web Services 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 quotas imposed by your account so that you have enough time to apply for an increase before you hit a quota.

    For example, you could use one of the Amazon Web Services SDKs to do the following:

    1. Call DescribeLimits for a particular Region to obtain your current account quotas 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 quotas 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 quotas.

    The per-table quotas 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 quota that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account quotas.

    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.

    Parameters

    Returns void

  • Returns the current provisioned-capacity quotas for your Amazon Web Services 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 Amazon Web Services account, the account has initial quotas 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 quotas that apply when you create a table there. For more information, see Service, Account, and Table Quotas page in the Amazon DynamoDB Developer Guide.

    Although you can increase these quotas by filing a case at Amazon Web Services 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 quotas imposed by your account so that you have enough time to apply for an increase before you hit a quota.

    For example, you could use one of the Amazon Web Services SDKs to do the following:

    1. Call DescribeLimits for a particular Region to obtain your current account quotas 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 quotas 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 quotas.

    The per-table quotas 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 quota that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account quotas.

    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.

    Parameters

    Returns void

  • Returns the current provisioned-capacity quotas for your Amazon Web Services 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 Amazon Web Services account, the account has initial quotas 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 quotas that apply when you create a table there. For more information, see Service, Account, and Table Quotas page in the Amazon DynamoDB Developer Guide.

        <p>Although you can increase these quotas by filing a case at <a href="https://console.aws.amazon.com/support/home#/">Amazon Web Services Support Center</a>, obtaining the
            increase is not instantaneous. The <code>DescribeLimits</code> action lets you write
            code to compare the capacity you are currently using to those quotas imposed by your
            account so that you have enough time to apply for an increase before you hit a
            quota.</p>
    
        <p>For example, you could use one of the Amazon Web Services SDKs to do the
            following:</p>
    
        <ol>
            <li>
                <p>Call <code>DescribeLimits</code> for a particular Region to obtain your
                    current account quotas on provisioned capacity there.</p>
            </li>
            <li>
                <p>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.</p>
            </li>
            <li>
                <p>Call <code>ListTables</code> to obtain a list of all your DynamoDB
                    tables.</p>
            </li>
            <li>
                <p>For each table name listed by <code>ListTables</code>, do the
                    following:</p>
                <ul>
                  <li>
                        <p>Call <code>DescribeTable</code> with the table name.</p>
                    </li>
                  <li>
                        <p>Use the data returned by <code>DescribeTable</code> to add the read
                            capacity units and write capacity units provisioned for the table itself
                            to your variables.</p>
                    </li>
                  <li>
                        <p>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.</p>
                    </li>
               </ul>
            </li>
            <li>
                <p>Report the account quotas for that Region returned by
                        <code>DescribeLimits</code>, along with the total current provisioned
                    capacity levels you have calculated.</p>
            </li>
         </ol>
    
        <p>This will let you see whether you are getting close to your account-level
            quotas.</p>
        <p>The per-table quotas 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.</p>
        <p>For existing tables and their GSIs, DynamoDB doesn't let you increase provisioned
            capacity extremely rapidly, but the only quota that applies is that the aggregate
            provisioned capacity over all your tables and GSIs cannot exceed either of the
            per-account quotas.</p>
        <note>
            <p>
                <code>DescribeLimits</code> should only be called periodically. You can expect
                throttling errors if you call it more than once in a minute.</p>
        </note>
        <p>The <code>DescribeLimits</code> Request element has no content.</p>
    

    Parameters

    • args: DescribeLimitsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DescribeLimitsCommandOutput>

  • Returns the current provisioned-capacity quotas for your Amazon Web Services 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 Amazon Web Services account, the account has initial quotas 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 quotas that apply when you create a table there. For more information, see Service, Account, and Table Quotas page in the Amazon DynamoDB Developer Guide.

    Although you can increase these quotas by filing a case at Amazon Web Services 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 quotas imposed by your account so that you have enough time to apply for an increase before you hit a quota.

    For example, you could use one of the Amazon Web Services SDKs to do the following:

    1. Call DescribeLimits for a particular Region to obtain your current account quotas 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 quotas 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 quotas.

    The per-table quotas 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 quota that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account quotas.

    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.

    Parameters

    Returns void

  • Returns the current provisioned-capacity quotas for your Amazon Web Services 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 Amazon Web Services account, the account has initial quotas 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 quotas that apply when you create a table there. For more information, see Service, Account, and Table Quotas page in the Amazon DynamoDB Developer Guide.

    Although you can increase these quotas by filing a case at Amazon Web Services 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 quotas imposed by your account so that you have enough time to apply for an increase before you hit a quota.

    For example, you could use one of the Amazon Web Services SDKs to do the following:

    1. Call DescribeLimits for a particular Region to obtain your current account quotas 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 quotas 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 quotas.

    The per-table quotas 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 quota that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account quotas.

    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.

    Parameters

    Returns void

describeTable

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

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

    Parameters

    Returns Promise<DescribeTableCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: DescribeTableCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DescribeTableCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

describeTableReplicaAutoScaling

describeTimeToLive

destroy

  • destroy(): void
  • Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

    Returns void

disableKinesisStreamingDestination

enableKinesisStreamingDestination

executeStatement

  • This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL.

    For PartiQL reads (SELECT statement), if the total number of processed items exceeds the maximum dataset size limit of 1 MB, the read stops and results are returned to the user as a LastEvaluatedKey value to continue the read in a subsequent operation. If the filter criteria in WHERE clause does not match any data, the read will return an empty result set.

    A single SELECT statement response can return up to the maximum number of items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any filtering to the results using WHERE clause). If LastEvaluatedKey is present in the response, you need to paginate the result set.

    Parameters

    Returns Promise<ExecuteStatementCommandOutput>

  • This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL.

    For PartiQL reads (SELECT statement), if the total number of processed items exceeds the maximum dataset size limit of 1 MB, the read stops and results are returned to the user as a LastEvaluatedKey value to continue the read in a subsequent operation. If the filter criteria in WHERE clause does not match any data, the read will return an empty result set.

    A single SELECT statement response can return up to the maximum number of items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any filtering to the results using WHERE clause). If LastEvaluatedKey is present in the response, you need to paginate the result set.

    Parameters

    Returns void

  • This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL.

    For PartiQL reads (SELECT statement), if the total number of processed items exceeds the maximum dataset size limit of 1 MB, the read stops and results are returned to the user as a LastEvaluatedKey value to continue the read in a subsequent operation. If the filter criteria in WHERE clause does not match any data, the read will return an empty result set.

    A single SELECT statement response can return up to the maximum number of items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any filtering to the results using WHERE clause). If LastEvaluatedKey is present in the response, you need to paginate the result set.

    Parameters

    Returns void

  • This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL.

    For PartiQL reads (SELECT statement), if the total number of processed items exceeds the maximum dataset size limit of 1 MB, the read stops and results are returned to the user as a LastEvaluatedKey value to continue the read in a subsequent operation. If the filter criteria in WHERE clause does not match any data, the read will return an empty result set.

    A single SELECT statement response can return up to the maximum number of items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any filtering to the results using WHERE clause). If LastEvaluatedKey is present in the response, you need to paginate the result set.

    Parameters

    • args: ExecuteStatementCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<ExecuteStatementCommandOutput>

  • This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL.

    For PartiQL reads (SELECT statement), if the total number of processed items exceeds the maximum dataset size limit of 1 MB, the read stops and results are returned to the user as a LastEvaluatedKey value to continue the read in a subsequent operation. If the filter criteria in WHERE clause does not match any data, the read will return an empty result set.

    A single SELECT statement response can return up to the maximum number of items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any filtering to the results using WHERE clause). If LastEvaluatedKey is present in the response, you need to paginate the result set.

    Parameters

    Returns void

  • This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL.

    For PartiQL reads (SELECT statement), if the total number of processed items exceeds the maximum dataset size limit of 1 MB, the read stops and results are returned to the user as a LastEvaluatedKey value to continue the read in a subsequent operation. If the filter criteria in WHERE clause does not match any data, the read will return an empty result set.

    A single SELECT statement response can return up to the maximum number of items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any filtering to the results using WHERE clause). If LastEvaluatedKey is present in the response, you need to paginate the result set.

    Parameters

    Returns void

executeTransaction

  • This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL.

    The entire transaction must consist of either read statements or write statements, you cannot mix both in one transaction. The EXISTS function is an exception and can be used to check the condition of specific attributes of the item in a similar manner to ConditionCheck in the TransactWriteItems API.

    Parameters

    Returns Promise<ExecuteTransactionCommandOutput>

  • This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL.

    The entire transaction must consist of either read statements or write statements, you cannot mix both in one transaction. The EXISTS function is an exception and can be used to check the condition of specific attributes of the item in a similar manner to ConditionCheck in the TransactWriteItems API.

    Parameters

    Returns void

  • This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL.

    The entire transaction must consist of either read statements or write statements, you cannot mix both in one transaction. The EXISTS function is an exception and can be used to check the condition of specific attributes of the item in a similar manner to ConditionCheck in the TransactWriteItems API.

    Parameters

    Returns void

  • This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL.

    The entire transaction must consist of either read statements or write statements, you cannot mix both in one transaction. The EXISTS function is an exception and can be used to check the condition of specific attributes of the item in a similar manner to ConditionCheck in the TransactWriteItems API.

    Parameters

    • args: ExecuteTransactionCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<ExecuteTransactionCommandOutput>

  • This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL.

    The entire transaction must consist of either read statements or write statements, you cannot mix both in one transaction. The EXISTS function is an exception and can be used to check the condition of specific attributes of the item in a similar manner to ConditionCheck in the TransactWriteItems API.

    Parameters

    Returns void

  • This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL.

    The entire transaction must consist of either read statements or write statements, you cannot mix both in one transaction. The EXISTS function is an exception and can be used to check the condition of specific attributes of the item in a similar manner to ConditionCheck in the TransactWriteItems API.

    Parameters

    Returns void

exportTableToPointInTime

getItem

  • The GetItem operation returns a set of attributes for the item with the given primary key. If there is no matching item, GetItem does not return any data 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.

    Parameters

    Returns Promise<GetItemCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: GetItemCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<GetItemCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

importTable

listBackups

  • List backups associated with an Amazon Web Services 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 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 boundaries are for the time at which the original backup was requested.

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

    Parameters

    Returns Promise<ListBackupsCommandOutput>

  • List backups associated with an Amazon Web Services 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 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 boundaries are for the time at which the original backup was requested.

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

    Parameters

    Returns void

  • List backups associated with an Amazon Web Services 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 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 boundaries are for the time at which the original backup was requested.

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

    Parameters

    Returns void

  • List backups associated with an Amazon Web Services 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 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 boundaries are for the time at which the original backup was requested.

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

    Parameters

    • args: ListBackupsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<ListBackupsCommandOutput>

  • List backups associated with an Amazon Web Services 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 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 boundaries are for the time at which the original backup was requested.

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

    Parameters

    Returns void

  • List backups associated with an Amazon Web Services 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 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 boundaries are for the time at which the original backup was requested.

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

    Parameters

    Returns void

listContributorInsights

listExports

listGlobalTables

listImports

listTables

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

    Parameters

    Returns Promise<ListTablesCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: ListTablesCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<ListTablesCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

listTagsOfResource

putItem

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

        <p>When you add an item, the primary key attributes are the only required attributes.
            Attribute values cannot be null.</p>
        <p>Empty String and Binary attribute values are allowed. Attribute values of type String
            and Binary must have a length greater than zero if the attribute is used as a key
            attribute for a table or index. Set type attributes cannot be empty. </p>
        <p>Invalid Requests with empty values will be rejected with a
                <code>ValidationException</code> exception.</p>
        <note>
            <p>To prevent a new item from replacing an existing item, use a conditional
                expression that contains the <code>attribute_not_exists</code> function with the
                name of the attribute being used as the partition key for the table. Since every
                record must contain that attribute, the <code>attribute_not_exists</code> function
                will only succeed if no matching item exists.</p>
        </note>
        <p>For more information about <code>PutItem</code>, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html">Working with
                Items</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
    

    Parameters

    Returns Promise<PutItemCommandOutput>

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

    When you add an item, the primary key attributes are the only required attributes. Attribute values cannot be null.

    Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index. Set type attributes cannot be empty.

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

    Parameters

    Returns void

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

    When you add an item, the primary key attributes are the only required attributes. Attribute values cannot be null.

    Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index. Set type attributes cannot be empty.

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

    Parameters

    Returns void

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

        <p>When you add an item, the primary key attributes are the only required attributes.
            Attribute values cannot be null.</p>
        <p>Empty String and Binary attribute values are allowed. Attribute values of type String
            and Binary must have a length greater than zero if the attribute is used as a key
            attribute for a table or index. Set type attributes cannot be empty. </p>
        <p>Invalid Requests with empty values will be rejected with a
                <code>ValidationException</code> exception.</p>
        <note>
            <p>To prevent a new item from replacing an existing item, use a conditional
                expression that contains the <code>attribute_not_exists</code> function with the
                name of the attribute being used as the partition key for the table. Since every
                record must contain that attribute, the <code>attribute_not_exists</code> function
                will only succeed if no matching item exists.</p>
        </note>
        <p>For more information about <code>PutItem</code>, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html">Working with
                Items</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
    

    Parameters

    • args: PutItemCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<PutItemCommandOutput>

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

    When you add an item, the primary key attributes are the only required attributes. Attribute values cannot be null.

    Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index. Set type attributes cannot be empty.

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

    Parameters

    Returns void

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

    When you add an item, the primary key attributes are the only required attributes. Attribute values cannot be null.

    Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index. Set type attributes cannot be empty.

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

    Parameters

    Returns void

query

  • You must provide the name of the partition key attribute and a single value for that attribute. Query returns all items with that partition key value. Optionally, you can provide a sort key attribute and use a comparison operator to refine the search results.

        <p>Use the <code>KeyConditionExpression</code> parameter to provide a specific value for
            the partition key. The <code>Query</code> 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 <code>Query</code> operation by specifying a sort key value and a comparison
            operator in <code>KeyConditionExpression</code>. To further refine the
                <code>Query</code> results, you can optionally provide a
                <code>FilterExpression</code>. A <code>FilterExpression</code> determines which
            items within the results should be returned to you. All of the other results are
            discarded. </p>
        <p> A <code>Query</code> 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. </p>
        <note>
            <p> 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 <code>FilterExpression</code>.
            </p>
        </note>
        <p>
            <code>Query</code> 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 <code>ScanIndexForward</code> parameter to false. </p>
        <p> A single <code>Query</code> operation will read up to the maximum number of items set
            (if using the <code>Limit</code> parameter) or a maximum of 1 MB of data and then apply
            any filtering to the results using <code>FilterExpression</code>. If
                <code>LastEvaluatedKey</code> is present in the response, you will need to paginate
            the result set. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.Pagination">Paginating
                the Results</a> in the <i>Amazon DynamoDB Developer Guide</i>. </p>
        <p>
            <code>FilterExpression</code> is applied after a <code>Query</code> finishes, but before
            the results are returned. A <code>FilterExpression</code> cannot contain partition key
            or sort key attributes. You need to specify those attributes in the
                <code>KeyConditionExpression</code>. </p>
        <note>
            <p> A <code>Query</code> operation can return an empty result set and a
                    <code>LastEvaluatedKey</code> if all the items read for the page of results are
                filtered out. </p>
        </note>
        <p>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
                <code>ConsistentRead</code> parameter to <code>true</code> and obtain a strongly
            consistent result. Global secondary indexes support eventually consistent reads only, so
            do not specify <code>ConsistentRead</code> when querying a global secondary
            index.</p>
    

    Parameters

    Returns Promise<QueryCommandOutput>

  • You must provide the name of the partition key attribute and a single value for that attribute. Query returns all items with that partition key value. Optionally, you can provide a sort key attribute and use a comparison operator to refine the search results.

    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.

    Parameters

    Returns void

  • You must provide the name of the partition key attribute and a single value for that attribute. Query returns all items with that partition key value. Optionally, you can provide a sort key attribute and use a comparison operator to refine the search results.

    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.

    Parameters

    Returns void

  • You must provide the name of the partition key attribute and a single value for that attribute. Query returns all items with that partition key value. Optionally, you can provide a sort key attribute and use a comparison operator to refine the search results.

        <p>Use the <code>KeyConditionExpression</code> parameter to provide a specific value for
            the partition key. The <code>Query</code> 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 <code>Query</code> operation by specifying a sort key value and a comparison
            operator in <code>KeyConditionExpression</code>. To further refine the
                <code>Query</code> results, you can optionally provide a
                <code>FilterExpression</code>. A <code>FilterExpression</code> determines which
            items within the results should be returned to you. All of the other results are
            discarded. </p>
        <p> A <code>Query</code> 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. </p>
        <note>
            <p> 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 <code>FilterExpression</code>.
            </p>
        </note>
        <p>
            <code>Query</code> 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 <code>ScanIndexForward</code> parameter to false. </p>
        <p> A single <code>Query</code> operation will read up to the maximum number of items set
            (if using the <code>Limit</code> parameter) or a maximum of 1 MB of data and then apply
            any filtering to the results using <code>FilterExpression</code>. If
                <code>LastEvaluatedKey</code> is present in the response, you will need to paginate
            the result set. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.Pagination">Paginating
                the Results</a> in the <i>Amazon DynamoDB Developer Guide</i>. </p>
        <p>
            <code>FilterExpression</code> is applied after a <code>Query</code> finishes, but before
            the results are returned. A <code>FilterExpression</code> cannot contain partition key
            or sort key attributes. You need to specify those attributes in the
                <code>KeyConditionExpression</code>. </p>
        <note>
            <p> A <code>Query</code> operation can return an empty result set and a
                    <code>LastEvaluatedKey</code> if all the items read for the page of results are
                filtered out. </p>
        </note>
        <p>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
                <code>ConsistentRead</code> parameter to <code>true</code> and obtain a strongly
            consistent result. Global secondary indexes support eventually consistent reads only, so
            do not specify <code>ConsistentRead</code> when querying a global secondary
            index.</p>
    

    Parameters

    • args: QueryCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<QueryCommandOutput>

  • You must provide the name of the partition key attribute and a single value for that attribute. Query returns all items with that partition key value. Optionally, you can provide a sort key attribute and use a comparison operator to refine the search results.

    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.

    Parameters

    Returns void

  • You must provide the name of the partition key attribute and a single value for that attribute. Query returns all items with that partition key value. Optionally, you can provide a sort key attribute and use a comparison operator to refine the search results.

    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.

    Parameters

    Returns void

restoreTableFromBackup

  • 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

    Parameters

    Returns Promise<RestoreTableFromBackupCommandOutput>

  • 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

    Parameters

    Returns void

  • 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

    Parameters

    Returns void

  • 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

    Parameters

    • args: RestoreTableFromBackupCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<RestoreTableFromBackupCommandOutput>

  • 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

    Parameters

    Returns void

  • 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

    Parameters

    Returns void

restoreTableToPointInTime

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

        <p>You must manually set up the following on the restored table:</p>
        <ul>
            <li>
                <p>Auto scaling policies</p>
            </li>
            <li>
                <p>IAM policies</p>
            </li>
            <li>
                <p>Amazon CloudWatch metrics and alarms</p>
            </li>
            <li>
                <p>Tags</p>
            </li>
            <li>
                <p>Stream settings</p>
            </li>
            <li>
                <p>Time to Live (TTL) settings</p>
            </li>
            <li>
                <p>Point in time recovery settings</p>
            </li>
         </ul>
    

    Parameters

    Returns Promise<RestoreTableToPointInTimeCommandOutput>

  • 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

    Parameters

    Returns void

  • 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

    Parameters

    Returns void

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

        <p>You must manually set up the following on the restored table:</p>
        <ul>
            <li>
                <p>Auto scaling policies</p>
            </li>
            <li>
                <p>IAM policies</p>
            </li>
            <li>
                <p>Amazon CloudWatch metrics and alarms</p>
            </li>
            <li>
                <p>Tags</p>
            </li>
            <li>
                <p>Stream settings</p>
            </li>
            <li>
                <p>Time to Live (TTL) settings</p>
            </li>
            <li>
                <p>Point in time recovery settings</p>
            </li>
         </ul>
    

    Parameters

    • args: RestoreTableToPointInTimeCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<RestoreTableToPointInTimeCommandOutput>

  • 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

    Parameters

    Returns void

  • 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

    Parameters

    Returns void

scan

  • The Scan operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a 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.

    Parameters

    Returns Promise<ScanCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: ScanCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<ScanCommandOutput>

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

    Parameters

    Returns void