Class: AWS.DynamoDB

Inherits:
AWS.Service show all
Identifier:
dynamodb
API Version:
2012-08-10
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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

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

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

Sending a Request Using DynamoDB

var dynamodb = new AWS.DynamoDB();
dynamodb.batchGetItem(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the DynamoDB object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var dynamodb = new AWS.DynamoDB({apiVersion: '2012-08-10'});

You can also set the API version globally in AWS.config.apiVersions using the dynamodb service identifier:

AWS.config.apiVersions = {
  dynamodb: '2012-08-10',
  // other service API versions
};

var dynamodb = new AWS.DynamoDB();

Version:

  • 2012-08-10

Defined Under Namespace

Modules: Converter Classes: DocumentClient

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

tableExists, tableNotExists

Constructor Summary

Property Summary

Properties inherited from AWS.Service

apiVersions

Method Summary

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, defineService

Constructor Details

new AWS.DynamoDB(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a DynamoDB object

var dynamodb = new AWS.DynamoDB({apiVersion: '2012-08-10'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.DynamoDB.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.DynamoDB.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.DynamoDB.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean) —

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

batchGetItem(params = {}, callback) ⇒ AWS.Request

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

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

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

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

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

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

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

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

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

When designing your application, keep in mind that DynamoDB does not return items in any particular order. To help parse the response by item, include the primary key values for the items in your request in the 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 Capacity Units Calculations in the Amazon DynamoDB Developer Guide.

Service Reference:

Examples:

To retrieve multiple items from a table


/* This example reads multiple items from the Music table using a batch of three GetItem requests.  Only the AlbumTitle attribute is returned. */

 var params = {
  RequestItems: {
   "Music": {
     Keys: [
        {
       "Artist": {
         S: "No One You Know"
        }, 
       "SongTitle": {
         S: "Call Me Today"
        }
      }, 
        {
       "Artist": {
         S: "Acme Band"
        }, 
       "SongTitle": {
         S: "Happy Day"
        }
      }, 
        {
       "Artist": {
         S: "No One You Know"
        }, 
       "SongTitle": {
         S: "Scared of My Shadow"
        }
      }
     ], 
     ProjectionExpression: "AlbumTitle"
    }
  }
 };
 dynamodb.batchGetItem(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Responses: {
     "Music": [
         {
        "AlbumTitle": {
          S: "Somewhat Famous"
         }
       }, 
         {
        "AlbumTitle": {
          S: "Blue Sky Blues"
         }
       }, 
         {
        "AlbumTitle": {
          S: "Louder Than Ever"
         }
       }
      ]
    }
   }
   */
 });

Calling the batchGetItem operation

var params = {
  RequestItems: { /* required */
    '<TableName>': {
      Keys: [ /* required */
        {
          '<AttributeName>': { /* AttributeValue */
            B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
            BOOL: true || false,
            BS: [
              new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
              /* more items */
            ],
            L: [
              /* recursive AttributeValue */,
              /* more items */
            ],
            M: {
              '<AttributeName>': /* recursive AttributeValue */,
              /* '<AttributeName>': ... */
            },
            N: 'STRING_VALUE',
            NS: [
              'STRING_VALUE',
              /* more items */
            ],
            NULL: true || false,
            S: 'STRING_VALUE',
            SS: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          /* '<AttributeName>': ... */
        },
        /* more items */
      ],
      AttributesToGet: [
        'STRING_VALUE',
        /* more items */
      ],
      ConsistentRead: true || false,
      ExpressionAttributeNames: {
        '<ExpressionAttributeNameVariable>': 'STRING_VALUE',
        /* '<ExpressionAttributeNameVariable>': ... */
      },
      ProjectionExpression: 'STRING_VALUE'
    },
    /* '<TableName>': ... */
  },
  ReturnConsumedCapacity: INDEXES | TOTAL | NONE
};
dynamodb.batchGetItem(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • RequestItems — (map<map>)

      A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per BatchGetItem request.

      Each element in the map of items to retrieve consists of the following:

      • ConsistentRead - If true, a strongly consistent read is used; if false (the default), an eventually consistent read is used.

      • ExpressionAttributeNames - One or more substitution tokens for attribute names in the ProjectionExpression parameter. The following are some use cases for using ExpressionAttributeNames:

        • To access an attribute whose name conflicts with a DynamoDB reserved word.

        • To create a placeholder for repeating occurrences of an attribute name in an expression.

        • To prevent special characters in an attribute name from being misinterpreted in an expression.

        Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

        • Percentile

        The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

        • {"#P":"Percentile"}

        You could then use this substitution in an expression, as in this example:

        • #P = :val

        Note: Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

        For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

      • Keys - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide both the partition key value and the sort key value.

      • ProjectionExpression - A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

        If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

        For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

      • AttributesToGet - This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

      • Keys — required — (Array<map<map>>)

        The primary key attribute values that define the items and the attributes associated with the items.

        • S — (String)

          An attribute of type String. For example:

          "S": "Hello"

        • N — (String)

          An attribute of type Number. For example:

          "N": "123.45"

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • B — (Buffer, Typed Array, Blob, String)

          An attribute of type Binary. For example:

          "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

        • SS — (Array<String>)

          An attribute of type String Set. For example:

          "SS": ["Giraffe", "Hippo" ,"Zebra"]

        • NS — (Array<String>)

          An attribute of type Number Set. For example:

          "NS": ["42.2", "-19", "7.5", "3.14"]

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • BS — (Array<Buffer, Typed Array, Blob, String>)

          An attribute of type Binary Set. For example:

          "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

        • M — (map<map>)

          An attribute of type Map. For example:

          "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

        • L — (Array<map>)

          An attribute of type List. For example:

          "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

        • NULL — (Boolean)

          An attribute of type Null. For example:

          "NULL": true

        • BOOL — (Boolean)

          An attribute of type Boolean. For example:

          "BOOL": true

      • AttributesToGet — (Array<String>)

        This is a legacy parameter. Use ProjectionExpression instead. For more information, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.

      • ConsistentRead — (Boolean)

        The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

      • ProjectionExpression — (String)

        A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the ProjectionExpression must be separated by commas.

        If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

        For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

      • ExpressionAttributeNames — (map<String>)

        One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

        • To access an attribute whose name conflicts with a DynamoDB reserved word.

        • To create a placeholder for repeating occurrences of an attribute name in an expression.

        • To prevent special characters in an attribute name from being misinterpreted in an expression.

        Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

        • Percentile

        The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

        • {"#P":"Percentile"}

        You could then use this substitution in an expression, as in this example:

        • #P = :val

        Note: Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

        For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

    • ReturnConsumedCapacity — (String)

      Determines the level of detail about provisioned throughput consumption that is returned in the response:

      • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

        Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

      • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

      • NONE - No ConsumedCapacity details are included in the response.

      Possible values include:
      • "INDEXES"
      • "TOTAL"
      • "NONE"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Responses — (map<Array<map<map>>>)

        A map of table name to a list of items. Each object in Responses consists of a table name, along with a map of attribute data consisting of the data type and attribute value.

        • S — (String)

          An attribute of type String. For example:

          "S": "Hello"

        • N — (String)

          An attribute of type Number. For example:

          "N": "123.45"

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • B — (Buffer, Typed Array, Blob, String)

          An attribute of type Binary. For example:

          "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

        • SS — (Array<String>)

          An attribute of type String Set. For example:

          "SS": ["Giraffe", "Hippo" ,"Zebra"]

        • NS — (Array<String>)

          An attribute of type Number Set. For example:

          "NS": ["42.2", "-19", "7.5", "3.14"]

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • BS — (Array<Buffer, Typed Array, Blob, String>)

          An attribute of type Binary Set. For example:

          "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

        • M — (map<map>)

          An attribute of type Map. For example:

          "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

        • L — (Array<map>)

          An attribute of type List. For example:

          "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

        • NULL — (Boolean)

          An attribute of type Null. For example:

          "NULL": true

        • BOOL — (Boolean)

          An attribute of type Boolean. For example:

          "BOOL": true

      • UnprocessedKeys — (map<map>)

        A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

        Each element consists of:

        • Keys - An array of primary key attribute values that define specific items in the table.

        • ProjectionExpression - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.

        • ConsistentRead - The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

        If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.

        • Keys — required — (Array<map<map>>)

          The primary key attribute values that define the items and the attributes associated with the items.

          • S — (String)

            An attribute of type String. For example:

            "S": "Hello"

          • N — (String)

            An attribute of type Number. For example:

            "N": "123.45"

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • B — (Buffer, Typed Array, Blob, String)

            An attribute of type Binary. For example:

            "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

          • SS — (Array<String>)

            An attribute of type String Set. For example:

            "SS": ["Giraffe", "Hippo" ,"Zebra"]

          • NS — (Array<String>)

            An attribute of type Number Set. For example:

            "NS": ["42.2", "-19", "7.5", "3.14"]

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • BS — (Array<Buffer, Typed Array, Blob, String>)

            An attribute of type Binary Set. For example:

            "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

          • M — (map<map>)

            An attribute of type Map. For example:

            "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

          • L — (Array<map>)

            An attribute of type List. For example:

            "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

          • NULL — (Boolean)

            An attribute of type Null. For example:

            "NULL": true

          • BOOL — (Boolean)

            An attribute of type Boolean. For example:

            "BOOL": true

        • AttributesToGet — (Array<String>)

          This is a legacy parameter. Use ProjectionExpression instead. For more information, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.

        • ConsistentRead — (Boolean)

          The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

        • ProjectionExpression — (String)

          A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the ProjectionExpression must be separated by commas.

          If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

          For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

        • ExpressionAttributeNames — (map<String>)

          One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

          • To access an attribute whose name conflicts with a DynamoDB reserved word.

          • To create a placeholder for repeating occurrences of an attribute name in an expression.

          • To prevent special characters in an attribute name from being misinterpreted in an expression.

          Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

          • Percentile

          The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

          • {"#P":"Percentile"}

          You could then use this substitution in an expression, as in this example:

          • #P = :val

          Note: Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

          For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

      • ConsumedCapacity — (Array<map>)

        The read capacity units consumed by the entire BatchGetItem operation.

        Each element consists of:

        • TableName - The table that consumed the provisioned throughput.

        • CapacityUnits - The total number of capacity units consumed.

        • TableName — (String)

          The name of the table that was affected by the operation.

        • CapacityUnits — (Float)

          The total number of capacity units consumed by the operation.

        • ReadCapacityUnits — (Float)

          The total number of read capacity units consumed by the operation.

        • WriteCapacityUnits — (Float)

          The total number of write capacity units consumed by the operation.

        • Table — (map)

          The amount of throughput consumed on the table affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

        • LocalSecondaryIndexes — (map<map>)

          The amount of throughput consumed on each local index affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

        • GlobalSecondaryIndexes — (map<map>)

          The amount of throughput consumed on each global index affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

batchWriteItem(params = {}, callback) ⇒ AWS.Request

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

Note: 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.

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

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

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

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

If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem 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.

Service Reference:

Examples:

To add multiple items to a table


/* This example adds three new items to the Music table using a batch of three PutItem requests. */

 var params = {
  RequestItems: {
   "Music": [
       {
      PutRequest: {
       Item: {
        "AlbumTitle": {
          S: "Somewhat Famous"
         }, 
        "Artist": {
          S: "No One You Know"
         }, 
        "SongTitle": {
          S: "Call Me Today"
         }
       }
      }
     }, 
       {
      PutRequest: {
       Item: {
        "AlbumTitle": {
          S: "Songs About Life"
         }, 
        "Artist": {
          S: "Acme Band"
         }, 
        "SongTitle": {
          S: "Happy Day"
         }
       }
      }
     }, 
       {
      PutRequest: {
       Item: {
        "AlbumTitle": {
          S: "Blue Sky Blues"
         }, 
        "Artist": {
          S: "No One You Know"
         }, 
        "SongTitle": {
          S: "Scared of My Shadow"
         }
       }
      }
     }
    ]
  }
 };
 dynamodb.batchWriteItem(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the batchWriteItem operation

var params = {
  RequestItems: { /* required */
    '<TableName>': [
      {
        DeleteRequest: {
          Key: { /* required */
            '<AttributeName>': { /* AttributeValue */
              B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
              BOOL: true || false,
              BS: [
                new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
                /* more items */
              ],
              L: [
                /* recursive AttributeValue */,
                /* more items */
              ],
              M: {
                '<AttributeName>': /* recursive AttributeValue */,
                /* '<AttributeName>': ... */
              },
              N: 'STRING_VALUE',
              NS: [
                'STRING_VALUE',
                /* more items */
              ],
              NULL: true || false,
              S: 'STRING_VALUE',
              SS: [
                'STRING_VALUE',
                /* more items */
              ]
            },
            /* '<AttributeName>': ... */
          }
        },
        PutRequest: {
          Item: { /* required */
            '<AttributeName>': { /* AttributeValue */
              B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
              BOOL: true || false,
              BS: [
                new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
                /* more items */
              ],
              L: [
                /* recursive AttributeValue */,
                /* more items */
              ],
              M: {
                '<AttributeName>': /* recursive AttributeValue */,
                /* '<AttributeName>': ... */
              },
              N: 'STRING_VALUE',
              NS: [
                'STRING_VALUE',
                /* more items */
              ],
              NULL: true || false,
              S: 'STRING_VALUE',
              SS: [
                'STRING_VALUE',
                /* more items */
              ]
            },
            /* '<AttributeName>': ... */
          }
        }
      },
      /* more items */
    ],
    /* '<TableName>': ... */
  },
  ReturnConsumedCapacity: INDEXES | TOTAL | NONE,
  ReturnItemCollectionMetrics: SIZE | NONE
};
dynamodb.batchWriteItem(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • RequestItems — (map<Array<map>>)

      A map of one or more table names and, for each table, a list of operations to be performed (DeleteRequest or PutRequest). Each element in the map consists of the following:

      • DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:

        • Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

      • PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:

        • Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception.

          If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

      • PutRequest — (map)

        A request to perform a PutItem operation.

        • Item — required — (map<map>)

          A map of attribute name to attribute values, representing the primary key of an item to be processed by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item which are part of an index key schema for the table, their types must match the index key schema.

          • S — (String)

            An attribute of type String. For example:

            "S": "Hello"

          • N — (String)

            An attribute of type Number. For example:

            "N": "123.45"

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • B — (Buffer, Typed Array, Blob, String)

            An attribute of type Binary. For example:

            "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

          • SS — (Array<String>)

            An attribute of type String Set. For example:

            "SS": ["Giraffe", "Hippo" ,"Zebra"]

          • NS — (Array<String>)

            An attribute of type Number Set. For example:

            "NS": ["42.2", "-19", "7.5", "3.14"]

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • BS — (Array<Buffer, Typed Array, Blob, String>)

            An attribute of type Binary Set. For example:

            "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

          • M — (map<map>)

            An attribute of type Map. For example:

            "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

          • L — (Array<map>)

            An attribute of type List. For example:

            "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

          • NULL — (Boolean)

            An attribute of type Null. For example:

            "NULL": true

          • BOOL — (Boolean)

            An attribute of type Boolean. For example:

            "BOOL": true

      • DeleteRequest — (map)

        A request to perform a DeleteItem operation.

        • Key — required — (map<map>)

          A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.

          • S — (String)

            An attribute of type String. For example:

            "S": "Hello"

          • N — (String)

            An attribute of type Number. For example:

            "N": "123.45"

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • B — (Buffer, Typed Array, Blob, String)

            An attribute of type Binary. For example:

            "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

          • SS — (Array<String>)

            An attribute of type String Set. For example:

            "SS": ["Giraffe", "Hippo" ,"Zebra"]

          • NS — (Array<String>)

            An attribute of type Number Set. For example:

            "NS": ["42.2", "-19", "7.5", "3.14"]

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • BS — (Array<Buffer, Typed Array, Blob, String>)

            An attribute of type Binary Set. For example:

            "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

          • M — (map<map>)

            An attribute of type Map. For example:

            "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

          • L — (Array<map>)

            An attribute of type List. For example:

            "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

          • NULL — (Boolean)

            An attribute of type Null. For example:

            "NULL": true

          • BOOL — (Boolean)

            An attribute of type Boolean. For example:

            "BOOL": true

    • ReturnConsumedCapacity — (String)

      Determines the level of detail about provisioned throughput consumption that is returned in the response:

      • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

        Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

      • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

      • NONE - No ConsumedCapacity details are included in the response.

      Possible values include:
      • "INDEXES"
      • "TOTAL"
      • "NONE"
    • ReturnItemCollectionMetrics — (String)

      Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

      Possible values include:
      • "SIZE"
      • "NONE"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • UnprocessedItems — (map<Array<map>>)

        A map of tables and requests against those tables that were not processed. The UnprocessedItems value is in the same form as RequestItems, so you can provide this value directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

        Each UnprocessedItems entry consists of a table name and, for that table, a list of operations to perform (DeleteRequest or PutRequest).

        • DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:

          • Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.

        • PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:

          • Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception.

            If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

        If there are no unprocessed items remaining, the response contains an empty UnprocessedItems map.

        • PutRequest — (map)

          A request to perform a PutItem operation.

          • Item — required — (map<map>)

            A map of attribute name to attribute values, representing the primary key of an item to be processed by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item which are part of an index key schema for the table, their types must match the index key schema.

            • S — (String)

              An attribute of type String. For example:

              "S": "Hello"

            • N — (String)

              An attribute of type Number. For example:

              "N": "123.45"

              Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

            • B — (Buffer, Typed Array, Blob, String)

              An attribute of type Binary. For example:

              "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

            • SS — (Array<String>)

              An attribute of type String Set. For example:

              "SS": ["Giraffe", "Hippo" ,"Zebra"]

            • NS — (Array<String>)

              An attribute of type Number Set. For example:

              "NS": ["42.2", "-19", "7.5", "3.14"]

              Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

            • BS — (Array<Buffer, Typed Array, Blob, String>)

              An attribute of type Binary Set. For example:

              "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

            • M — (map<map>)

              An attribute of type Map. For example:

              "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

            • L — (Array<map>)

              An attribute of type List. For example:

              "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

            • NULL — (Boolean)

              An attribute of type Null. For example:

              "NULL": true

            • BOOL — (Boolean)

              An attribute of type Boolean. For example:

              "BOOL": true

        • DeleteRequest — (map)

          A request to perform a DeleteItem operation.

          • Key — required — (map<map>)

            A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.

            • S — (String)

              An attribute of type String. For example:

              "S": "Hello"

            • N — (String)

              An attribute of type Number. For example:

              "N": "123.45"

              Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

            • B — (Buffer, Typed Array, Blob, String)

              An attribute of type Binary. For example:

              "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

            • SS — (Array<String>)

              An attribute of type String Set. For example:

              "SS": ["Giraffe", "Hippo" ,"Zebra"]

            • NS — (Array<String>)

              An attribute of type Number Set. For example:

              "NS": ["42.2", "-19", "7.5", "3.14"]

              Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

            • BS — (Array<Buffer, Typed Array, Blob, String>)

              An attribute of type Binary Set. For example:

              "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

            • M — (map<map>)

              An attribute of type Map. For example:

              "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

            • L — (Array<map>)

              An attribute of type List. For example:

              "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

            • NULL — (Boolean)

              An attribute of type Null. For example:

              "NULL": true

            • BOOL — (Boolean)

              An attribute of type Boolean. For example:

              "BOOL": true

      • ItemCollectionMetrics — (map<Array<map>>)

        A list of tables that were processed by BatchWriteItem and, for each table, information about any item collections that were affected by individual DeleteItem or PutItem operations.

        Each entry consists of the following subelements:

        • ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item.

        • SizeEstimateRangeGB - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on the table. Use this estimate to measure whether a local secondary index is approaching its size limit.

          The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

        • ItemCollectionKey — (map<map>)

          The partition key value of the item collection. This value is the same as the partition key value of the item.

          • S — (String)

            An attribute of type String. For example:

            "S": "Hello"

          • N — (String)

            An attribute of type Number. For example:

            "N": "123.45"

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • B — (Buffer, Typed Array, Blob, String)

            An attribute of type Binary. For example:

            "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

          • SS — (Array<String>)

            An attribute of type String Set. For example:

            "SS": ["Giraffe", "Hippo" ,"Zebra"]

          • NS — (Array<String>)

            An attribute of type Number Set. For example:

            "NS": ["42.2", "-19", "7.5", "3.14"]

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • BS — (Array<Buffer, Typed Array, Blob, String>)

            An attribute of type Binary Set. For example:

            "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

          • M — (map<map>)

            An attribute of type Map. For example:

            "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

          • L — (Array<map>)

            An attribute of type List. For example:

            "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

          • NULL — (Boolean)

            An attribute of type Null. For example:

            "NULL": true

          • BOOL — (Boolean)

            An attribute of type Boolean. For example:

            "BOOL": true

        • SizeEstimateRangeGB — (Array<Float>)

          An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

          The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

      • ConsumedCapacity — (Array<map>)

        The capacity units consumed by the entire BatchWriteItem operation.

        Each element consists of:

        • TableName - The table that consumed the provisioned throughput.

        • CapacityUnits - The total number of capacity units consumed.

        • TableName — (String)

          The name of the table that was affected by the operation.

        • CapacityUnits — (Float)

          The total number of capacity units consumed by the operation.

        • ReadCapacityUnits — (Float)

          The total number of read capacity units consumed by the operation.

        • WriteCapacityUnits — (Float)

          The total number of write capacity units consumed by the operation.

        • Table — (map)

          The amount of throughput consumed on the table affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

        • LocalSecondaryIndexes — (map<map>)

          The amount of throughput consumed on each local index affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

        • GlobalSecondaryIndexes — (map<map>)

          The amount of throughput consumed on each global index affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createBackup(params = {}, callback) ⇒ AWS.Request

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 may or may not 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

Service Reference:

Examples:

Calling the createBackup operation

var params = {
  BackupName: 'STRING_VALUE', /* required */
  TableName: 'STRING_VALUE' /* required */
};
dynamodb.createBackup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TableName — (String)

      The name of the table.

    • BackupName — (String)

      Specified name for the backup.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupDetails — (map)

        Contains the details of the backup created for the table.

        • BackupArn — required — (String)

          ARN associated with the backup.

        • BackupName — required — (String)

          Name of the requested backup.

        • BackupSizeBytes — (Integer)

          Size of the backup in bytes.

        • BackupStatus — required — (String)

          Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

          Possible values include:
          • "CREATING"
          • "DELETED"
          • "AVAILABLE"
        • BackupType — required — (String)

          BackupType:

          • USER - You create and manage these using the on-demand backup feature.

          • SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion.

          • AWS_BACKUP - On-demand backup created by you from AWS Backup service.

          Possible values include:
          • "USER"
          • "SYSTEM"
          • "AWS_BACKUP"
        • BackupCreationDateTime — required — (Date)

          Time at which the backup was created. This is the request time of the backup.

        • BackupExpiryDateTime — (Date)

          Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createGlobalTable(params = {}, callback) ⇒ AWS.Request

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.

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

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

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

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

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

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

  • The global secondary indexes must have the same name.

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

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

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

Service Reference:

Examples:

Calling the createGlobalTable operation

var params = {
  GlobalTableName: 'STRING_VALUE', /* required */
  ReplicationGroup: [ /* required */
    {
      RegionName: 'STRING_VALUE'
    },
    /* more items */
  ]
};
dynamodb.createGlobalTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalTableName — (String)

      The global table name.

    • ReplicationGroup — (Array<map>)

      The regions where the global table needs to be created.

      • RegionName — (String)

        The region where the replica needs to be created.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GlobalTableDescription — (map)

        Contains the details of the global table.

        • ReplicationGroup — (Array<map>)

          The regions where the global table has replicas.

          • RegionName — (String)

            The name of the region.

        • GlobalTableArn — (String)

          The unique identifier of the global table.

        • CreationDateTime — (Date)

          The creation time of the global table.

        • GlobalTableStatus — (String)

          The current state of the global table:

          • CREATING - The global table is being created.

          • UPDATING - The global table is being updated.

          • DELETING - The global table is being deleted.

          • ACTIVE - The global table is ready for use.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "DELETING"
          • "UPDATING"
        • GlobalTableName — (String)

          The global table name.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createTable(params = {}, callback) ⇒ AWS.Request

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

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

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

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

Service Reference:

Examples:

To create a table


/* This example creates a table named Music. */

 var params = {
  AttributeDefinitions: [
     {
    AttributeName: "Artist", 
    AttributeType: "S"
   }, 
     {
    AttributeName: "SongTitle", 
    AttributeType: "S"
   }
  ], 
  KeySchema: [
     {
    AttributeName: "Artist", 
    KeyType: "HASH"
   }, 
     {
    AttributeName: "SongTitle", 
    KeyType: "RANGE"
   }
  ], 
  ProvisionedThroughput: {
   ReadCapacityUnits: 5, 
   WriteCapacityUnits: 5
  }, 
  TableName: "Music"
 };
 dynamodb.createTable(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    TableDescription: {
     AttributeDefinitions: [
        {
       AttributeName: "Artist", 
       AttributeType: "S"
      }, 
        {
       AttributeName: "SongTitle", 
       AttributeType: "S"
      }
     ], 
     CreationDateTime: <Date Representation>, 
     ItemCount: 0, 
     KeySchema: [
        {
       AttributeName: "Artist", 
       KeyType: "HASH"
      }, 
        {
       AttributeName: "SongTitle", 
       KeyType: "RANGE"
      }
     ], 
     ProvisionedThroughput: {
      ReadCapacityUnits: 5, 
      WriteCapacityUnits: 5
     }, 
     TableName: "Music", 
     TableSizeBytes: 0, 
     TableStatus: "CREATING"
    }
   }
   */
 });

Calling the createTable operation

var params = {
  AttributeDefinitions: [ /* required */
    {
      AttributeName: 'STRING_VALUE', /* required */
      AttributeType: S | N | B /* required */
    },
    /* more items */
  ],
  KeySchema: [ /* required */
    {
      AttributeName: 'STRING_VALUE', /* required */
      KeyType: HASH | RANGE /* required */
    },
    /* more items */
  ],
  TableName: 'STRING_VALUE', /* required */
  BillingMode: PROVISIONED | PAY_PER_REQUEST,
  GlobalSecondaryIndexes: [
    {
      IndexName: 'STRING_VALUE', /* required */
      KeySchema: [ /* required */
        {
          AttributeName: 'STRING_VALUE', /* required */
          KeyType: HASH | RANGE /* required */
        },
        /* more items */
      ],
      Projection: { /* required */
        NonKeyAttributes: [
          'STRING_VALUE',
          /* more items */
        ],
        ProjectionType: ALL | KEYS_ONLY | INCLUDE
      },
      ProvisionedThroughput: {
        ReadCapacityUnits: 'NUMBER_VALUE', /* required */
        WriteCapacityUnits: 'NUMBER_VALUE' /* required */
      }
    },
    /* more items */
  ],
  LocalSecondaryIndexes: [
    {
      IndexName: 'STRING_VALUE', /* required */
      KeySchema: [ /* required */
        {
          AttributeName: 'STRING_VALUE', /* required */
          KeyType: HASH | RANGE /* required */
        },
        /* more items */
      ],
      Projection: { /* required */
        NonKeyAttributes: [
          'STRING_VALUE',
          /* more items */
        ],
        ProjectionType: ALL | KEYS_ONLY | INCLUDE
      }
    },
    /* more items */
  ],
  ProvisionedThroughput: {
    ReadCapacityUnits: 'NUMBER_VALUE', /* required */
    WriteCapacityUnits: 'NUMBER_VALUE' /* required */
  },
  SSESpecification: {
    Enabled: true || false,
    KMSMasterKeyId: 'STRING_VALUE',
    SSEType: AES256 | KMS
  },
  StreamSpecification: {
    StreamEnabled: true || false,
    StreamViewType: NEW_IMAGE | OLD_IMAGE | NEW_AND_OLD_IMAGES | KEYS_ONLY
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
dynamodb.createTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AttributeDefinitions — (Array<map>)

      An array of attributes that describe the key schema for the table and indexes.

      • AttributeName — required — (String)

        A name for the attribute.

      • AttributeType — required — (String)

        The data type for the attribute, where:

        • S - the attribute is of type String

        • N - the attribute is of type Number

        • B - the attribute is of type Binary

        Possible values include:
        • "S"
        • "N"
        • "B"
    • TableName — (String)

      The name of the table to create.

    • KeySchema — (Array<map>)

      Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide.

      Each KeySchemaElement in the array is composed of:

      • AttributeName - The name of this key attribute.

      • KeyType - The role that the key attribute will assume:

        • HASH - partition key

        • RANGE - sort key

      Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

      For a simple primary key (partition key), you must provide exactly one element with a KeyType of HASH.

      For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a KeyType of HASH, and the second element must have a KeyType of RANGE.

      For more information, see Specifying the Primary Key in the Amazon DynamoDB Developer Guide.

      • AttributeName — required — (String)

        The name of a key attribute.

      • KeyType — required — (String)

        The role that this key attribute will assume:

        • HASH - partition key

        • RANGE - sort key

        Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
        Possible values include:
        • "HASH"
        • "RANGE"
    • LocalSecondaryIndexes — (Array<map>)

      One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.

      Each local secondary index in the array includes the following:

      • IndexName - The name of the local secondary index. Must be unique only for this table.

      • KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table.

      • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

        • ProjectionType - One of the following:

          • KEYS_ONLY - Only the index and primary keys are projected into the index.

          • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

          • ALL - All of the table attributes are projected into the index.

        • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

      • IndexName — required — (String)

        The name of the local secondary index. The name must be unique among all other indexes on this table.

      • KeySchema — required — (Array<map>)

        The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

        • HASH - partition key

        • RANGE - sort key

        Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
        • AttributeName — required — (String)

          The name of a key attribute.

        • KeyType — required — (String)

          The role that this key attribute will assume:

          • HASH - partition key

          • RANGE - sort key

          Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
          Possible values include:
          • "HASH"
          • "RANGE"
      • Projection — required — (map)

        Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

        • ProjectionType — (String)

          The set of attributes that are projected into the index:

          • KEYS_ONLY - Only the index and primary keys are projected into the index.

          • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

          • ALL - All of the table attributes are projected into the index.

          Possible values include:
          • "ALL"
          • "KEYS_ONLY"
          • "INCLUDE"
        • NonKeyAttributes — (Array<String>)

          Represents the non-key attribute names which will be projected into the index.

          For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

    • GlobalSecondaryIndexes — (Array<map>)

      One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:

      • IndexName - The name of the global secondary index. Must be unique only for this table.

      • KeySchema - Specifies the key schema for the global secondary index.

      • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

        • ProjectionType - One of the following:

          • KEYS_ONLY - Only the index and primary keys are projected into the index.

          • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

          • ALL - All of the table attributes are projected into the index.

        • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

      • ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.

      • IndexName — required — (String)

        The name of the global secondary index. The name must be unique among all other indexes on this table.

      • KeySchema — required — (Array<map>)

        The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

        • HASH - partition key

        • RANGE - sort key

        Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
        • AttributeName — required — (String)

          The name of a key attribute.

        • KeyType — required — (String)

          The role that this key attribute will assume:

          • HASH - partition key

          • RANGE - sort key

          Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
          Possible values include:
          • "HASH"
          • "RANGE"
      • Projection — required — (map)

        Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

        • ProjectionType — (String)

          The set of attributes that are projected into the index:

          • KEYS_ONLY - Only the index and primary keys are projected into the index.

          • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

          • ALL - All of the table attributes are projected into the index.

          Possible values include:
          • "ALL"
          • "KEYS_ONLY"
          • "INCLUDE"
        • NonKeyAttributes — (Array<String>)

          Represents the non-key attribute names which will be projected into the index.

          For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

      • ProvisionedThroughput — (map)

        Represents the provisioned throughput settings for the specified global secondary index.

        For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

        • ReadCapacityUnits — required — (Integer)

          The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

          If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

        • WriteCapacityUnits — required — (Integer)

          The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

          If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

    • BillingMode — (String)

      Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

      • PROVISIONED - Sets the billing mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

      • PAY_PER_REQUEST - Sets the billing mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

      Possible values include:
      • "PROVISIONED"
      • "PAY_PER_REQUEST"
    • ProvisionedThroughput — (map)

      Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

      If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as PAY_PER_REQUEST, you cannot specify this property.

      For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

      • ReadCapacityUnits — required — (Integer)

        The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

        If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

      • WriteCapacityUnits — required — (Integer)

        The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

        If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

    • StreamSpecification — (map)

      The settings for DynamoDB Streams on the table. These settings consist of:

      • StreamEnabled - Indicates whether Streams is to be enabled (true) or disabled (false).

      • StreamViewType - When an item in the table is modified, StreamViewType determines what information is written to the table's stream. Valid values for StreamViewType are:

        • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

        • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

        • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

        • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

      • StreamEnabled — (Boolean)

        Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

      • StreamViewType — (String)

        When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

        • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

        • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

        • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

        • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

        Possible values include:
        • "NEW_IMAGE"
        • "OLD_IMAGE"
        • "NEW_AND_OLD_IMAGES"
        • "KEYS_ONLY"
    • SSESpecification — (map)

      Represents the settings used to enable server-side encryption.

      • Enabled — (Boolean)

        Indicates whether server-side encryption is enabled (true) or disabled (false) on the table. If enabled (true), server-side encryption type is set to KMS. If disabled (false) or not specified, server-side encryption is set to AWS owned CMK.

      • SSEType — (String)

        Server-side encryption type:

        • AES256 - Server-side encryption which uses the AES256 algorithm (not applicable).

        • KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).

        Possible values include:
        • "AES256"
        • "KMS"
      • KMSMasterKeyId — (String)

        The KMS Master Key (CMK) which should be used for the KMS encryption. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB KMS Master Key alias/aws/dynamodb.

    • Tags — (Array<map>)

      A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.

      • Key — required — (String)

        The key of the tag.Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.

      • Value — required — (String)

        The value of the tag. Tag values are case-sensitive and can be null.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TableDescription — (map)

        Represents the properties of the table.

        • AttributeDefinitions — (Array<map>)

          An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.

          Each AttributeDefinition object in this array is composed of:

          • AttributeName - The name of the attribute.

          • AttributeType - The data type for the attribute.

          • AttributeName — required — (String)

            A name for the attribute.

          • AttributeType — required — (String)

            The data type for the attribute, where:

            • S - the attribute is of type String

            • N - the attribute is of type Number

            • B - the attribute is of type Binary

            Possible values include:
            • "S"
            • "N"
            • "B"
        • TableName — (String)

          The name of the table.

        • KeySchema — (Array<map>)

          The primary key structure for the table. Each KeySchemaElement consists of:

          • AttributeName - The name of the attribute.

          • KeyType - The role of the attribute:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

          For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

          • AttributeName — required — (String)

            The name of a key attribute.

          • KeyType — required — (String)

            The role that this key attribute will assume:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            Possible values include:
            • "HASH"
            • "RANGE"
        • TableStatus — (String)

          The current state of the table:

          • CREATING - The table is being created.

          • UPDATING - The table is being updated.

          • DELETING - The table is being deleted.

          • ACTIVE - The table is ready for use.

          Possible values include:
          • "CREATING"
          • "UPDATING"
          • "DELETING"
          • "ACTIVE"
        • CreationDateTime — (Date)

          The date and time when the table was created, in UNIX epoch time format.

        • ProvisionedThroughput — (map)

          The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

          • LastIncreaseDateTime — (Date)

            The date and time of the last provisioned throughput increase for this table.

          • LastDecreaseDateTime — (Date)

            The date and time of the last provisioned throughput decrease for this table.

          • NumberOfDecreasesToday — (Integer)

            The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

          • ReadCapacityUnits — (Integer)

            The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.

          • WriteCapacityUnits — (Integer)

            The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

        • TableSizeBytes — (Integer)

          The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • ItemCount — (Integer)

          The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • TableArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the table.

        • TableId — (String)

          Unique identifier for the table for which the backup was created.

        • BillingModeSummary — (map)

          Contains the details for the read/write capacity mode.

          • BillingMode — (String)

            Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

            • PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

            • PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

            Possible values include:
            • "PROVISIONED"
            • "PAY_PER_REQUEST"
          • LastUpdateToPayPerRequestDateTime — (Date)

            Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.

        • LocalSecondaryIndexes — (Array<map>)

          Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:

          • IndexName - The name of the local secondary index.

          • KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

          • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

            • ProjectionType - One of the following:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

            • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          If the table is in the DELETING state, no information about indexes will be returned.

          • IndexName — (String)

            Represents the name of the local secondary index.

          • KeySchema — (Array<map>)

            The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            • AttributeName — required — (String)

              The name of a key attribute.

            • KeyType — required — (String)

              The role that this key attribute will assume:

              • HASH - partition key

              • RANGE - sort key

              Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
              Possible values include:
              • "HASH"
              • "RANGE"
          • Projection — (map)

            Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

            • ProjectionType — (String)

              The set of attributes that are projected into the index:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

              Possible values include:
              • "ALL"
              • "KEYS_ONLY"
              • "INCLUDE"
            • NonKeyAttributes — (Array<String>)

              Represents the non-key attribute names which will be projected into the index.

              For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • IndexSizeBytes — (Integer)

            The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • ItemCount — (Integer)

            The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • IndexArn — (String)

            The Amazon Resource Name (ARN) that uniquely identifies the index.

        • GlobalSecondaryIndexes — (Array<map>)

          The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:

          • Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table; it is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.)

          • IndexName - The name of the global secondary index.

          • IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • IndexStatus - The current status of the global secondary index:

            • CREATING - The index is being created.

            • UPDATING - The index is being updated.

            • DELETING - The index is being deleted.

            • ACTIVE - The index is ready for use.

          • ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

          • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

            • ProjectionType - One of the following:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

            • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.

          If the table is in the DELETING state, no information about indexes will be returned.

          • IndexName — (String)

            The name of the global secondary index.

          • KeySchema — (Array<map>)

            The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            • AttributeName — required — (String)

              The name of a key attribute.

            • KeyType — required — (String)

              The role that this key attribute will assume:

              • HASH - partition key

              • RANGE - sort key

              Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
              Possible values include:
              • "HASH"
              • "RANGE"
          • Projection — (map)

            Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

            • ProjectionType — (String)

              The set of attributes that are projected into the index:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

              Possible values include:
              • "ALL"
              • "KEYS_ONLY"
              • "INCLUDE"
            • NonKeyAttributes — (Array<String>)

              Represents the non-key attribute names which will be projected into the index.

              For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • IndexStatus — (String)

            The current state of the global secondary index:

            • CREATING - The index is being created.

            • UPDATING - The index is being updated.

            • DELETING - The index is being deleted.

            • ACTIVE - The index is ready for use.

            Possible values include:
            • "CREATING"
            • "UPDATING"
            • "DELETING"
            • "ACTIVE"
          • Backfilling — (Boolean)

            Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.

            Note: For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
          • ProvisionedThroughput — (map)

            Represents the provisioned throughput settings for the specified global secondary index.

            For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

            • LastIncreaseDateTime — (Date)

              The date and time of the last provisioned throughput increase for this table.

            • LastDecreaseDateTime — (Date)

              The date and time of the last provisioned throughput decrease for this table.

            • NumberOfDecreasesToday — (Integer)

              The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

            • ReadCapacityUnits — (Integer)

              The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.

            • WriteCapacityUnits — (Integer)

              The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

          • IndexSizeBytes — (Integer)

            The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • ItemCount — (Integer)

            The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • IndexArn — (String)

            The Amazon Resource Name (ARN) that uniquely identifies the index.

        • StreamSpecification — (map)

          The current DynamoDB Streams configuration for the table.

          • StreamEnabled — (Boolean)

            Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

          • StreamViewType — (String)

            When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

            • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

            • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

            • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

            • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

            Possible values include:
            • "NEW_IMAGE"
            • "OLD_IMAGE"
            • "NEW_AND_OLD_IMAGES"
            • "KEYS_ONLY"
        • LatestStreamLabel — (String)

          A timestamp, in ISO 8601 format, for this stream.

          Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

          • the AWS customer ID.

          • the table name.

          • the StreamLabel.

        • LatestStreamArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.

        • RestoreSummary — (map)

          Contains details for the restore.

          • SourceBackupArn — (String)

            ARN of the backup from which the table was restored.

          • SourceTableArn — (String)

            ARN of the source table of the backup that is being restored.

          • RestoreDateTime — required — (Date)

            Point in time or source backup time.

          • RestoreInProgress — required — (Boolean)

            Indicates if a restore is in progress or not.

        • SSEDescription — (map)

          The description of the server-side encryption status on the specified table.

          • Status — (String)

            The current state of server-side encryption:

            • ENABLING - Server-side encryption is being enabled.

            • ENABLED - Server-side encryption is enabled.

            • DISABLING - Server-side encryption is being disabled.

            • DISABLED - Server-side encryption is disabled.

            • UPDATING - Server-side encryption is being updated.

            Possible values include:
            • "ENABLING"
            • "ENABLED"
            • "DISABLING"
            • "DISABLED"
            • "UPDATING"
          • SSEType — (String)

            Server-side encryption type:

            • AES256 - Server-side encryption which uses the AES256 algorithm (not applicable).

            • KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).

            Possible values include:
            • "AES256"
            • "KMS"
          • KMSMasterKeyArn — (String)

            The KMS master key ARN used for the KMS encryption.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteBackup(params = {}, callback) ⇒ AWS.Request

Deletes an existing backup of a table.

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

Service Reference:

Examples:

Calling the deleteBackup operation

var params = {
  BackupArn: 'STRING_VALUE' /* required */
};
dynamodb.deleteBackup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupArn — (String)

      The ARN associated with the backup.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupDescription — (map)

        Contains the description of the backup created for the table.

        • BackupDetails — (map)

          Contains the details of the backup created for the table.

          • BackupArn — required — (String)

            ARN associated with the backup.

          • BackupName — required — (String)

            Name of the requested backup.

          • BackupSizeBytes — (Integer)

            Size of the backup in bytes.

          • BackupStatus — required — (String)

            Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

            Possible values include:
            • "CREATING"
            • "DELETED"
            • "AVAILABLE"
          • BackupType — required — (String)

            BackupType:

            • USER - You create and manage these using the on-demand backup feature.

            • SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion.

            • AWS_BACKUP - On-demand backup created by you from AWS Backup service.

            Possible values include:
            • "USER"
            • "SYSTEM"
            • "AWS_BACKUP"
          • BackupCreationDateTime — required — (Date)

            Time at which the backup was created. This is the request time of the backup.

          • BackupExpiryDateTime — (Date)

            Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation.

        • SourceTableDetails — (map)

          Contains the details of the table when the backup was created.

          • TableName — required — (String)

            The name of the table for which the backup was created.

          • TableId — required — (String)

            Unique identifier for the table for which the backup was created.

          • TableArn — (String)

            ARN of the table for which backup was created.

          • TableSizeBytes — (Integer)

            Size of the table in bytes. Please note this is an approximate value.

          • KeySchema — required — (Array<map>)

            Schema of the table.

            • AttributeName — required — (String)

              The name of a key attribute.

            • KeyType — required — (String)

              The role that this key attribute will assume:

              • HASH - partition key

              • RANGE - sort key

              Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
              Possible values include:
              • "HASH"
              • "RANGE"
          • TableCreationDateTime — required — (Date)

            Time when the source table was created.

          • ProvisionedThroughput — required — (map)

            Read IOPs and Write IOPS on the table when the backup was created.

            • ReadCapacityUnits — required — (Integer)

              The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

              If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

            • WriteCapacityUnits — required — (Integer)

              The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

              If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

          • ItemCount — (Integer)

            Number of items in the table. Please note this is an approximate value.

          • BillingMode — (String)

            Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

            • PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

            • PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

            Possible values include:
            • "PROVISIONED"
            • "PAY_PER_REQUEST"
        • SourceTableFeatureDetails — (map)

          Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.

          • LocalSecondaryIndexes — (Array<map>)

            Represents the LSI properties for the table when the backup was created. It includes the IndexName, KeySchema and Projection for the LSIs on the table at the time of backup.

            • IndexName — (String)

              Represents the name of the local secondary index.

            • KeySchema — (Array<map>)

              The complete key schema for a local secondary index, which consists of one or more pairs of attribute names and key types:

              • HASH - partition key

              • RANGE - sort key

              Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
              • AttributeName — required — (String)

                The name of a key attribute.

              • KeyType — required — (String)

                The role that this key attribute will assume:

                • HASH - partition key

                • RANGE - sort key

                Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
                Possible values include:
                • "HASH"
                • "RANGE"
            • Projection — (map)

              Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

              • ProjectionType — (String)

                The set of attributes that are projected into the index:

                • KEYS_ONLY - Only the index and primary keys are projected into the index.

                • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

                • ALL - All of the table attributes are projected into the index.

                Possible values include:
                • "ALL"
                • "KEYS_ONLY"
                • "INCLUDE"
              • NonKeyAttributes — (Array<String>)

                Represents the non-key attribute names which will be projected into the index.

                For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • GlobalSecondaryIndexes — (Array<map>)

            Represents the GSI properties for the table when the backup was created. It includes the IndexName, KeySchema, Projection and ProvisionedThroughput for the GSIs on the table at the time of backup.

            • IndexName — (String)

              The name of the global secondary index.

            • KeySchema — (Array<map>)

              The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

              • HASH - partition key

              • RANGE - sort key

              Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
              • AttributeName — required — (String)

                The name of a key attribute.

              • KeyType — required — (String)

                The role that this key attribute will assume:

                • HASH - partition key

                • RANGE - sort key

                Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
                Possible values include:
                • "HASH"
                • "RANGE"
            • Projection — (map)

              Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

              • ProjectionType — (String)

                The set of attributes that are projected into the index:

                • KEYS_ONLY - Only the index and primary keys are projected into the index.

                • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

                • ALL - All of the table attributes are projected into the index.

                Possible values include:
                • "ALL"
                • "KEYS_ONLY"
                • "INCLUDE"
              • NonKeyAttributes — (Array<String>)

                Represents the non-key attribute names which will be projected into the index.

                For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

            • ProvisionedThroughput — (map)

              Represents the provisioned throughput settings for the specified global secondary index.

              • ReadCapacityUnits — required — (Integer)

                The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

                If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

              • WriteCapacityUnits — required — (Integer)

                The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

                If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

          • StreamDescription — (map)

            Stream settings on the table when the backup was created.

            • StreamEnabled — (Boolean)

              Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

            • StreamViewType — (String)

              When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

              • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

              • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

              • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

              • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

              Possible values include:
              • "NEW_IMAGE"
              • "OLD_IMAGE"
              • "NEW_AND_OLD_IMAGES"
              • "KEYS_ONLY"
          • TimeToLiveDescription — (map)

            Time to Live settings on the table when the backup was created.

            • TimeToLiveStatus — (String)

              The Time to Live status for the table.

              Possible values include:
              • "ENABLING"
              • "DISABLING"
              • "ENABLED"
              • "DISABLED"
            • AttributeName — (String)

              The name of the Time to Live attribute for items in the table.

          • SSEDescription — (map)

            The description of the server-side encryption status on the table when the backup was created.

            • Status — (String)

              The current state of server-side encryption:

              • ENABLING - Server-side encryption is being enabled.

              • ENABLED - Server-side encryption is enabled.

              • DISABLING - Server-side encryption is being disabled.

              • DISABLED - Server-side encryption is disabled.

              • UPDATING - Server-side encryption is being updated.

              Possible values include:
              • "ENABLING"
              • "ENABLED"
              • "DISABLING"
              • "DISABLED"
              • "UPDATING"
            • SSEType — (String)

              Server-side encryption type:

              • AES256 - Server-side encryption which uses the AES256 algorithm (not applicable).

              • KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).

              Possible values include:
              • "AES256"
              • "KMS"
            • KMSMasterKeyArn — (String)

              The KMS master key ARN used for the KMS encryption.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteItem(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To delete an item


/* This example deletes an item from the Music table. */

 var params = {
  Key: {
   "Artist": {
     S: "No One You Know"
    }, 
   "SongTitle": {
     S: "Scared of My Shadow"
    }
  }, 
  TableName: "Music"
 };
 dynamodb.deleteItem(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ConsumedCapacity: {
     CapacityUnits: 1, 
     TableName: "Music"
    }
   }
   */
 });

Calling the deleteItem operation

var params = {
  Key: { /* required */
    '<AttributeName>': { /* AttributeValue */
      B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
      BOOL: true || false,
      BS: [
        new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
        /* more items */
      ],
      L: [
        /* recursive AttributeValue */,
        /* more items */
      ],
      M: {
        '<AttributeName>': /* recursive AttributeValue */,
        /* '<AttributeName>': ... */
      },
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      NULL: true || false,
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* '<AttributeName>': ... */
  },
  TableName: 'STRING_VALUE', /* required */
  ConditionExpression: 'STRING_VALUE',
  ConditionalOperator: AND | OR,
  Expected: {
    '<AttributeName>': {
      AttributeValueList: [
        { /* AttributeValue */
          B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
          BOOL: true || false,
          BS: [
            new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
            /* more items */
          ],
          L: [
            /* recursive AttributeValue */,
            /* more items */
          ],
          M: {
            '<AttributeName>': /* recursive AttributeValue */,
            /* '<AttributeName>': ... */
          },
          N: 'STRING_VALUE',
          NS: [
            'STRING_VALUE',
            /* more items */
          ],
          NULL: true || false,
          S: 'STRING_VALUE',
          SS: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ],
      ComparisonOperator: EQ | NE | IN | LE | LT | GE | GT | BETWEEN | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH,
      Exists: true || false,
      Value: { /* AttributeValue */
        B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
        BOOL: true || false,
        BS: [
          new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
          /* more items */
        ],
        L: [
          /* recursive AttributeValue */,
          /* more items */
        ],
        M: {
          '<AttributeName>': /* recursive AttributeValue */,
          /* '<AttributeName>': ... */
        },
        N: 'STRING_VALUE',
        NS: [
          'STRING_VALUE',
          /* more items */
        ],
        NULL: true || false,
        S: 'STRING_VALUE',
        SS: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    /* '<AttributeName>': ... */
  },
  ExpressionAttributeNames: {
    '<ExpressionAttributeNameVariable>': 'STRING_VALUE',
    /* '<ExpressionAttributeNameVariable>': ... */
  },
  ExpressionAttributeValues: {
    '<ExpressionAttributeValueVariable>': { /* AttributeValue */
      B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
      BOOL: true || false,
      BS: [
        new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
        /* more items */
      ],
      L: [
        /* recursive AttributeValue */,
        /* more items */
      ],
      M: {
        '<AttributeName>': /* recursive AttributeValue */,
        /* '<AttributeName>': ... */
      },
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      NULL: true || false,
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* '<ExpressionAttributeValueVariable>': ... */
  },
  ReturnConsumedCapacity: INDEXES | TOTAL | NONE,
  ReturnItemCollectionMetrics: SIZE | NONE,
  ReturnValues: NONE | ALL_OLD | UPDATED_OLD | ALL_NEW | UPDATED_NEW
};
dynamodb.deleteItem(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TableName — (String)

      The name of the table from which to delete the item.

    • Key — (map<map>)

      A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

      For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

      • S — (String)

        An attribute of type String. For example:

        "S": "Hello"

      • N — (String)

        An attribute of type Number. For example:

        "N": "123.45"

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • B — (Buffer, Typed Array, Blob, String)

        An attribute of type Binary. For example:

        "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

      • SS — (Array<String>)

        An attribute of type String Set. For example:

        "SS": ["Giraffe", "Hippo" ,"Zebra"]

      • NS — (Array<String>)

        An attribute of type Number Set. For example:

        "NS": ["42.2", "-19", "7.5", "3.14"]

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • BS — (Array<Buffer, Typed Array, Blob, String>)

        An attribute of type Binary Set. For example:

        "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

      • M — (map<map>)

        An attribute of type Map. For example:

        "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

      • L — (Array<map>)

        An attribute of type List. For example:

        "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

      • NULL — (Boolean)

        An attribute of type Null. For example:

        "NULL": true

      • BOOL — (Boolean)

        An attribute of type Boolean. For example:

        "BOOL": true

    • Expected — (map<map>)

      This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

      • Value — (map)

        Represents the data for the expected attribute.

        Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

        For more information, see Data Types in the Amazon DynamoDB Developer Guide.

        • S — (String)

          An attribute of type String. For example:

          "S": "Hello"

        • N — (String)

          An attribute of type Number. For example:

          "N": "123.45"

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • B — (Buffer, Typed Array, Blob, String)

          An attribute of type Binary. For example:

          "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

        • SS — (Array<String>)

          An attribute of type String Set. For example:

          "SS": ["Giraffe", "Hippo" ,"Zebra"]

        • NS — (Array<String>)

          An attribute of type Number Set. For example:

          "NS": ["42.2", "-19", "7.5", "3.14"]

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • BS — (Array<Buffer, Typed Array, Blob, String>)

          An attribute of type Binary Set. For example:

          "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

        • M — (map<map>)

          An attribute of type Map. For example:

          "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

        • L — (Array<map>)

          An attribute of type List. For example:

          "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

        • NULL — (Boolean)

          An attribute of type Null. For example:

          "NULL": true

        • BOOL — (Boolean)

          An attribute of type Boolean. For example:

          "BOOL": true

      • Exists — (Boolean)

        Causes DynamoDB to evaluate the value before attempting a conditional operation:

        • If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a ConditionCheckFailedException.

        • If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a ConditionCheckFailedException.

        The default setting for Exists is true. If you supply a Value all by itself, DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied.

        DynamoDB returns a ValidationException if:

        • Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.)

        • Exists is false but you also provide a Value. (You cannot expect an attribute to have a value, while also expecting it not to exist.)

      • ComparisonOperator — (String)

        A comparator for evaluating attributes in the AttributeValueList. For example, equals, greater than, less than, etc.

        The following comparison operators are available:

        EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN

        The following are descriptions of each comparison operator.

        • EQ : Equal. EQ is supported for all data types, including lists and maps.

          AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

        • NE : Not equal. NE is supported for all data types, including lists and maps.

          AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

        • LE : Less than or equal.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

        • LT : Less than.

          AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

        • GE : Greater than or equal.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

        • GT : Greater than.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

        • NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including lists and maps.

          Note: This operator tests for the existence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute "a" exists; its data type is not relevant to the NOT_NULL comparison operator.

        • NULL : The attribute does not exist. NULL is supported for all data types, including lists and maps.

          Note: This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute "a" exists; its data type is not relevant to the NULL comparison operator.

        • CONTAINS : Checks for a subsequence, or value in a set.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it finds an exact match with any member of the set.

          CONTAINS is supported for lists: When evaluating "a CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list.

        • NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it does not find an exact match with any member of the set.

          NOT_CONTAINS is supported for lists: When evaluating "a NOT CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list.

        • BEGINS_WITH : Checks for a prefix.

          AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).

        • IN : Checks for matching elements in a list.

          AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true.

        • BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.

          AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}

        Possible values include:
        • "EQ"
        • "NE"
        • "IN"
        • "LE"
        • "LT"
        • "GE"
        • "GT"
        • "BETWEEN"
        • "NOT_NULL"
        • "NULL"
        • "CONTAINS"
        • "NOT_CONTAINS"
        • "BEGINS_WITH"
      • AttributeValueList — (Array<map>)

        One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.

        For type Number, value comparisons are numeric.

        String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

        For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

        For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.

        • S — (String)

          An attribute of type String. For example:

          "S": "Hello"

        • N — (String)

          An attribute of type Number. For example:

          "N": "123.45"

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • B — (Buffer, Typed Array, Blob, String)

          An attribute of type Binary. For example:

          "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

        • SS — (Array<String>)

          An attribute of type String Set. For example:

          "SS": ["Giraffe", "Hippo" ,"Zebra"]

        • NS — (Array<String>)

          An attribute of type Number Set. For example:

          "NS": ["42.2", "-19", "7.5", "3.14"]

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • BS — (Array<Buffer, Typed Array, Blob, String>)

          An attribute of type Binary Set. For example:

          "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

        • M — (map<map>)

          An attribute of type Map. For example:

          "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

        • L — (Array<map>)

          An attribute of type List. For example:

          "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

        • NULL — (Boolean)

          An attribute of type Null. For example:

          "NULL": true

        • BOOL — (Boolean)

          An attribute of type Boolean. For example:

          "BOOL": true

    • ConditionalOperator — (String)

      This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

      Possible values include:
      • "AND"
      • "OR"
    • ReturnValues — (String)

      Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are:

      • NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

      • ALL_OLD - The content of the old item is returned.

      Note: The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD.
      Possible values include:
      • "NONE"
      • "ALL_OLD"
      • "UPDATED_OLD"
      • "ALL_NEW"
      • "UPDATED_NEW"
    • ReturnConsumedCapacity — (String)

      Determines the level of detail about provisioned throughput consumption that is returned in the response:

      • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

        Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

      • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

      • NONE - No ConsumedCapacity details are included in the response.

      Possible values include:
      • "INDEXES"
      • "TOTAL"
      • "NONE"
    • ReturnItemCollectionMetrics — (String)

      Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

      Possible values include:
      • "SIZE"
      • "NONE"
    • ConditionExpression — (String)

      A condition that must be satisfied in order for a conditional DeleteItem to succeed.

      An expression can contain any of the following:

      • Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

        These function names are case-sensitive.

      • Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

      • Logical operators: AND | OR | NOT

      For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

    • ExpressionAttributeNames — (map<String>)

      One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

      • To access an attribute whose name conflicts with a DynamoDB reserved word.

      • To create a placeholder for repeating occurrences of an attribute name in an expression.

      • To prevent special characters in an attribute name from being misinterpreted in an expression.

      Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

      • Percentile

      The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

      • {"#P":"Percentile"}

      You could then use this substitution in an expression, as in this example:

      • #P = :val

      Note: Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

      For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

    • ExpressionAttributeValues — (map<map>)

      One or more values that can be substituted in an expression.

      Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

      Available | Backordered | Discontinued

      You would first need to specify ExpressionAttributeValues as follows:

      { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

      You could then use these values in an expression, such as this:

      ProductStatus IN (:avail, :back, :disc)

      For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

      • S — (String)

        An attribute of type String. For example:

        "S": "Hello"

      • N — (String)

        An attribute of type Number. For example:

        "N": "123.45"

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • B — (Buffer, Typed Array, Blob, String)

        An attribute of type Binary. For example:

        "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

      • SS — (Array<String>)

        An attribute of type String Set. For example:

        "SS": ["Giraffe", "Hippo" ,"Zebra"]

      • NS — (Array<String>)

        An attribute of type Number Set. For example:

        "NS": ["42.2", "-19", "7.5", "3.14"]

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • BS — (Array<Buffer, Typed Array, Blob, String>)

        An attribute of type Binary Set. For example:

        "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

      • M — (map<map>)

        An attribute of type Map. For example:

        "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

      • L — (Array<map>)

        An attribute of type List. For example:

        "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

      • NULL — (Boolean)

        An attribute of type Null. For example:

        "NULL": true

      • BOOL — (Boolean)

        An attribute of type Boolean. For example:

        "BOOL": true

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Attributes — (map<map>)

        A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation. This map appears in the response only if ReturnValues was specified as ALL_OLD in the request.

        • S — (String)

          An attribute of type String. For example:

          "S": "Hello"

        • N — (String)

          An attribute of type Number. For example:

          "N": "123.45"

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • B — (Buffer, Typed Array, Blob, String)

          An attribute of type Binary. For example:

          "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

        • SS — (Array<String>)

          An attribute of type String Set. For example:

          "SS": ["Giraffe", "Hippo" ,"Zebra"]

        • NS — (Array<String>)

          An attribute of type Number Set. For example:

          "NS": ["42.2", "-19", "7.5", "3.14"]

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • BS — (Array<Buffer, Typed Array, Blob, String>)

          An attribute of type Binary Set. For example:

          "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

        • M — (map<map>)

          An attribute of type Map. For example:

          "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

        • L — (Array<map>)

          An attribute of type List. For example:

          "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

        • NULL — (Boolean)

          An attribute of type Null. For example:

          "NULL": true

        • BOOL — (Boolean)

          An attribute of type Boolean. For example:

          "BOOL": true

      • ConsumedCapacity — (map)

        The capacity units consumed by the DeleteItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

        • TableName — (String)

          The name of the table that was affected by the operation.

        • CapacityUnits — (Float)

          The total number of capacity units consumed by the operation.

        • ReadCapacityUnits — (Float)

          The total number of read capacity units consumed by the operation.

        • WriteCapacityUnits — (Float)

          The total number of write capacity units consumed by the operation.

        • Table — (map)

          The amount of throughput consumed on the table affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

        • LocalSecondaryIndexes — (map<map>)

          The amount of throughput consumed on each local index affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

        • GlobalSecondaryIndexes — (map<map>)

          The amount of throughput consumed on each global index affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

      • ItemCollectionMetrics — (map)

        Information about item collections, if any, that were affected by the DeleteItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.

        Each ItemCollectionMetrics element consists of:

        • ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.

        • SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

          The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

        • ItemCollectionKey — (map<map>)

          The partition key value of the item collection. This value is the same as the partition key value of the item.

          • S — (String)

            An attribute of type String. For example:

            "S": "Hello"

          • N — (String)

            An attribute of type Number. For example:

            "N": "123.45"

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • B — (Buffer, Typed Array, Blob, String)

            An attribute of type Binary. For example:

            "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

          • SS — (Array<String>)

            An attribute of type String Set. For example:

            "SS": ["Giraffe", "Hippo" ,"Zebra"]

          • NS — (Array<String>)

            An attribute of type Number Set. For example:

            "NS": ["42.2", "-19", "7.5", "3.14"]

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • BS — (Array<Buffer, Typed Array, Blob, String>)

            An attribute of type Binary Set. For example:

            "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

          • M — (map<map>)

            An attribute of type Map. For example:

            "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

          • L — (Array<map>)

            An attribute of type List. For example:

            "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

          • NULL — (Boolean)

            An attribute of type Null. For example:

            "NULL": true

          • BOOL — (Boolean)

            An attribute of type Boolean. For example:

            "BOOL": true

        • SizeEstimateRangeGB — (Array<Float>)

          An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

          The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteTable(params = {}, callback) ⇒ AWS.Request

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.

Note: 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.

Service Reference:

Examples:

To delete a table


/* This example deletes the Music table. */

 var params = {
  TableName: "Music"
 };
 dynamodb.deleteTable(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    TableDescription: {
     ItemCount: 0, 
     ProvisionedThroughput: {
      NumberOfDecreasesToday: 1, 
      ReadCapacityUnits: 5, 
      WriteCapacityUnits: 5
     }, 
     TableName: "Music", 
     TableSizeBytes: 0, 
     TableStatus: "DELETING"
    }
   }
   */
 });

Calling the deleteTable operation

var params = {
  TableName: 'STRING_VALUE' /* required */
};
dynamodb.deleteTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TableName — (String)

      The name of the table to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TableDescription — (map)

        Represents the properties of a table.

        • AttributeDefinitions — (Array<map>)

          An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.

          Each AttributeDefinition object in this array is composed of:

          • AttributeName - The name of the attribute.

          • AttributeType - The data type for the attribute.

          • AttributeName — required — (String)

            A name for the attribute.

          • AttributeType — required — (String)

            The data type for the attribute, where:

            • S - the attribute is of type String

            • N - the attribute is of type Number

            • B - the attribute is of type Binary

            Possible values include:
            • "S"
            • "N"
            • "B"
        • TableName — (String)

          The name of the table.

        • KeySchema — (Array<map>)

          The primary key structure for the table. Each KeySchemaElement consists of:

          • AttributeName - The name of the attribute.

          • KeyType - The role of the attribute:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

          For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

          • AttributeName — required — (String)

            The name of a key attribute.

          • KeyType — required — (String)

            The role that this key attribute will assume:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            Possible values include:
            • "HASH"
            • "RANGE"
        • TableStatus — (String)

          The current state of the table:

          • CREATING - The table is being created.

          • UPDATING - The table is being updated.

          • DELETING - The table is being deleted.

          • ACTIVE - The table is ready for use.

          Possible values include:
          • "CREATING"
          • "UPDATING"
          • "DELETING"
          • "ACTIVE"
        • CreationDateTime — (Date)

          The date and time when the table was created, in UNIX epoch time format.

        • ProvisionedThroughput — (map)

          The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

          • LastIncreaseDateTime — (Date)

            The date and time of the last provisioned throughput increase for this table.

          • LastDecreaseDateTime — (Date)

            The date and time of the last provisioned throughput decrease for this table.

          • NumberOfDecreasesToday — (Integer)

            The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

          • ReadCapacityUnits — (Integer)

            The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.

          • WriteCapacityUnits — (Integer)

            The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

        • TableSizeBytes — (Integer)

          The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • ItemCount — (Integer)

          The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • TableArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the table.

        • TableId — (String)

          Unique identifier for the table for which the backup was created.

        • BillingModeSummary — (map)

          Contains the details for the read/write capacity mode.

          • BillingMode — (String)

            Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

            • PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

            • PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

            Possible values include:
            • "PROVISIONED"
            • "PAY_PER_REQUEST"
          • LastUpdateToPayPerRequestDateTime — (Date)

            Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.

        • LocalSecondaryIndexes — (Array<map>)

          Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:

          • IndexName - The name of the local secondary index.

          • KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

          • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

            • ProjectionType - One of the following:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

            • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          If the table is in the DELETING state, no information about indexes will be returned.

          • IndexName — (String)

            Represents the name of the local secondary index.

          • KeySchema — (Array<map>)

            The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            • AttributeName — required — (String)

              The name of a key attribute.

            • KeyType — required — (String)

              The role that this key attribute will assume:

              • HASH - partition key

              • RANGE - sort key

              Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
              Possible values include:
              • "HASH"
              • "RANGE"
          • Projection — (map)

            Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

            • ProjectionType — (String)

              The set of attributes that are projected into the index:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

              Possible values include:
              • "ALL"
              • "KEYS_ONLY"
              • "INCLUDE"
            • NonKeyAttributes — (Array<String>)

              Represents the non-key attribute names which will be projected into the index.

              For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • IndexSizeBytes — (Integer)

            The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • ItemCount — (Integer)

            The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • IndexArn — (String)

            The Amazon Resource Name (ARN) that uniquely identifies the index.

        • GlobalSecondaryIndexes — (Array<map>)

          The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:

          • Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table; it is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.)

          • IndexName - The name of the global secondary index.

          • IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • IndexStatus - The current status of the global secondary index:

            • CREATING - The index is being created.

            • UPDATING - The index is being updated.

            • DELETING - The index is being deleted.

            • ACTIVE - The index is ready for use.

          • ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

          • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

            • ProjectionType - One of the following:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

            • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.

          If the table is in the DELETING state, no information about indexes will be returned.

          • IndexName — (String)

            The name of the global secondary index.

          • KeySchema — (Array<map>)

            The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            • AttributeName — required — (String)

              The name of a key attribute.

            • KeyType — required — (String)

              The role that this key attribute will assume:

              • HASH - partition key

              • RANGE - sort key

              Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
              Possible values include:
              • "HASH"
              • "RANGE"
          • Projection — (map)

            Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

            • ProjectionType — (String)

              The set of attributes that are projected into the index:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

              Possible values include:
              • "ALL"
              • "KEYS_ONLY"
              • "INCLUDE"
            • NonKeyAttributes — (Array<String>)

              Represents the non-key attribute names which will be projected into the index.

              For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • IndexStatus — (String)

            The current state of the global secondary index:

            • CREATING - The index is being created.

            • UPDATING - The index is being updated.

            • DELETING - The index is being deleted.

            • ACTIVE - The index is ready for use.

            Possible values include:
            • "CREATING"
            • "UPDATING"
            • "DELETING"
            • "ACTIVE"
          • Backfilling — (Boolean)

            Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.

            Note: For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
          • ProvisionedThroughput — (map)

            Represents the provisioned throughput settings for the specified global secondary index.

            For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

            • LastIncreaseDateTime — (Date)

              The date and time of the last provisioned throughput increase for this table.

            • LastDecreaseDateTime — (Date)

              The date and time of the last provisioned throughput decrease for this table.

            • NumberOfDecreasesToday — (Integer)

              The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

            • ReadCapacityUnits — (Integer)

              The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.

            • WriteCapacityUnits — (Integer)

              The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

          • IndexSizeBytes — (Integer)

            The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • ItemCount — (Integer)

            The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • IndexArn — (String)

            The Amazon Resource Name (ARN) that uniquely identifies the index.

        • StreamSpecification — (map)

          The current DynamoDB Streams configuration for the table.

          • StreamEnabled — (Boolean)

            Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

          • StreamViewType — (String)

            When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

            • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

            • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

            • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

            • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

            Possible values include:
            • "NEW_IMAGE"
            • "OLD_IMAGE"
            • "NEW_AND_OLD_IMAGES"
            • "KEYS_ONLY"
        • LatestStreamLabel — (String)

          A timestamp, in ISO 8601 format, for this stream.

          Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

          • the AWS customer ID.

          • the table name.

          • the StreamLabel.

        • LatestStreamArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.

        • RestoreSummary — (map)

          Contains details for the restore.

          • SourceBackupArn — (String)

            ARN of the backup from which the table was restored.

          • SourceTableArn — (String)

            ARN of the source table of the backup that is being restored.

          • RestoreDateTime — required — (Date)

            Point in time or source backup time.

          • RestoreInProgress — required — (Boolean)

            Indicates if a restore is in progress or not.

        • SSEDescription — (map)

          The description of the server-side encryption status on the specified table.

          • Status — (String)

            The current state of server-side encryption:

            • ENABLING - Server-side encryption is being enabled.

            • ENABLED - Server-side encryption is enabled.

            • DISABLING - Server-side encryption is being disabled.

            • DISABLED - Server-side encryption is disabled.

            • UPDATING - Server-side encryption is being updated.

            Possible values include:
            • "ENABLING"
            • "ENABLED"
            • "DISABLING"
            • "DISABLED"
            • "UPDATING"
          • SSEType — (String)

            Server-side encryption type:

            • AES256 - Server-side encryption which uses the AES256 algorithm (not applicable).

            • KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).

            Possible values include:
            • "AES256"
            • "KMS"
          • KMSMasterKeyArn — (String)

            The KMS master key ARN used for the KMS encryption.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeBackup(params = {}, callback) ⇒ AWS.Request

Describes an existing backup of a table.

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

Service Reference:

Examples:

Calling the describeBackup operation

var params = {
  BackupArn: 'STRING_VALUE' /* required */
};
dynamodb.describeBackup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupArn — (String)

      The ARN associated with the backup.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupDescription — (map)

        Contains the description of the backup created for the table.

        • BackupDetails — (map)

          Contains the details of the backup created for the table.

          • BackupArn — required — (String)

            ARN associated with the backup.

          • BackupName — required — (String)

            Name of the requested backup.

          • BackupSizeBytes — (Integer)

            Size of the backup in bytes.

          • BackupStatus — required — (String)

            Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

            Possible values include:
            • "CREATING"
            • "DELETED"
            • "AVAILABLE"
          • BackupType — required — (String)

            BackupType:

            • USER - You create and manage these using the on-demand backup feature.

            • SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion.

            • AWS_BACKUP - On-demand backup created by you from AWS Backup service.

            Possible values include:
            • "USER"
            • "SYSTEM"
            • "AWS_BACKUP"
          • BackupCreationDateTime — required — (Date)

            Time at which the backup was created. This is the request time of the backup.

          • BackupExpiryDateTime — (Date)

            Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation.

        • SourceTableDetails — (map)

          Contains the details of the table when the backup was created.

          • TableName — required — (String)

            The name of the table for which the backup was created.

          • TableId — required — (String)

            Unique identifier for the table for which the backup was created.

          • TableArn — (String)

            ARN of the table for which backup was created.

          • TableSizeBytes — (Integer)

            Size of the table in bytes. Please note this is an approximate value.

          • KeySchema — required — (Array<map>)

            Schema of the table.

            • AttributeName — required — (String)

              The name of a key attribute.

            • KeyType — required — (String)

              The role that this key attribute will assume:

              • HASH - partition key

              • RANGE - sort key

              Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
              Possible values include:
              • "HASH"
              • "RANGE"
          • TableCreationDateTime — required — (Date)

            Time when the source table was created.

          • ProvisionedThroughput — required — (map)

            Read IOPs and Write IOPS on the table when the backup was created.

            • ReadCapacityUnits — required — (Integer)

              The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

              If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

            • WriteCapacityUnits — required — (Integer)

              The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

              If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

          • ItemCount — (Integer)

            Number of items in the table. Please note this is an approximate value.

          • BillingMode — (String)

            Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

            • PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

            • PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

            Possible values include:
            • "PROVISIONED"
            • "PAY_PER_REQUEST"
        • SourceTableFeatureDetails — (map)

          Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.

          • LocalSecondaryIndexes — (Array<map>)

            Represents the LSI properties for the table when the backup was created. It includes the IndexName, KeySchema and Projection for the LSIs on the table at the time of backup.

            • IndexName — (String)

              Represents the name of the local secondary index.

            • KeySchema — (Array<map>)

              The complete key schema for a local secondary index, which consists of one or more pairs of attribute names and key types:

              • HASH - partition key

              • RANGE - sort key

              Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
              • AttributeName — required — (String)

                The name of a key attribute.

              • KeyType — required — (String)

                The role that this key attribute will assume:

                • HASH - partition key

                • RANGE - sort key

                Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
                Possible values include:
                • "HASH"
                • "RANGE"
            • Projection — (map)

              Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

              • ProjectionType — (String)

                The set of attributes that are projected into the index:

                • KEYS_ONLY - Only the index and primary keys are projected into the index.

                • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

                • ALL - All of the table attributes are projected into the index.

                Possible values include:
                • "ALL"
                • "KEYS_ONLY"
                • "INCLUDE"
              • NonKeyAttributes — (Array<String>)

                Represents the non-key attribute names which will be projected into the index.

                For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • GlobalSecondaryIndexes — (Array<map>)

            Represents the GSI properties for the table when the backup was created. It includes the IndexName, KeySchema, Projection and ProvisionedThroughput for the GSIs on the table at the time of backup.

            • IndexName — (String)

              The name of the global secondary index.

            • KeySchema — (Array<map>)

              The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

              • HASH - partition key

              • RANGE - sort key

              Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
              • AttributeName — required — (String)

                The name of a key attribute.

              • KeyType — required — (String)

                The role that this key attribute will assume:

                • HASH - partition key

                • RANGE - sort key

                Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
                Possible values include:
                • "HASH"
                • "RANGE"
            • Projection — (map)

              Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

              • ProjectionType — (String)

                The set of attributes that are projected into the index:

                • KEYS_ONLY - Only the index and primary keys are projected into the index.

                • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

                • ALL - All of the table attributes are projected into the index.

                Possible values include:
                • "ALL"
                • "KEYS_ONLY"
                • "INCLUDE"
              • NonKeyAttributes — (Array<String>)

                Represents the non-key attribute names which will be projected into the index.

                For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

            • ProvisionedThroughput — (map)

              Represents the provisioned throughput settings for the specified global secondary index.

              • ReadCapacityUnits — required — (Integer)

                The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

                If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

              • WriteCapacityUnits — required — (Integer)

                The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

                If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

          • StreamDescription — (map)

            Stream settings on the table when the backup was created.

            • StreamEnabled — (Boolean)

              Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

            • StreamViewType — (String)

              When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

              • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

              • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

              • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

              • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

              Possible values include:
              • "NEW_IMAGE"
              • "OLD_IMAGE"
              • "NEW_AND_OLD_IMAGES"
              • "KEYS_ONLY"
          • TimeToLiveDescription — (map)

            Time to Live settings on the table when the backup was created.

            • TimeToLiveStatus — (String)

              The Time to Live status for the table.

              Possible values include:
              • "ENABLING"
              • "DISABLING"
              • "ENABLED"
              • "DISABLED"
            • AttributeName — (String)

              The name of the Time to Live attribute for items in the table.

          • SSEDescription — (map)

            The description of the server-side encryption status on the table when the backup was created.

            • Status — (String)

              The current state of server-side encryption:

              • ENABLING - Server-side encryption is being enabled.

              • ENABLED - Server-side encryption is enabled.

              • DISABLING - Server-side encryption is being disabled.

              • DISABLED - Server-side encryption is disabled.

              • UPDATING - Server-side encryption is being updated.

              Possible values include:
              • "ENABLING"
              • "ENABLED"
              • "DISABLING"
              • "DISABLED"
              • "UPDATING"
            • SSEType — (String)

              Server-side encryption type:

              • AES256 - Server-side encryption which uses the AES256 algorithm (not applicable).

              • KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).

              Possible values include:
              • "AES256"
              • "KMS"
            • KMSMasterKeyArn — (String)

              The KMS master key ARN used for the KMS encryption.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeContinuousBackups(params = {}, callback) ⇒ AWS.Request

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.

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

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

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

Service Reference:

Examples:

Calling the describeContinuousBackups operation

var params = {
  TableName: 'STRING_VALUE' /* required */
};
dynamodb.describeContinuousBackups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TableName — (String)

      Name of the table for which the customer wants to check the continuous backups and point in time recovery settings.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ContinuousBackupsDescription — (map)

        Represents the continuous backups and point in time recovery settings on the table.

        • ContinuousBackupsStatus — required — (String)

          ContinuousBackupsStatus can be one of the following states: ENABLED, DISABLED

          Possible values include:
          • "ENABLED"
          • "DISABLED"
        • PointInTimeRecoveryDescription — (map)

          The description of the point in time recovery settings applied to the table.

          • PointInTimeRecoveryStatus — (String)

            The current state of point in time recovery:

            • ENABLING - Point in time recovery is being enabled.

            • ENABLED - Point in time recovery is enabled.

            • DISABLED - Point in time recovery is disabled.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
          • EarliestRestorableDateTime — (Date)

            Specifies the earliest point in time you can restore your table to. It You can restore your table to any point in time during the last 35 days.

          • LatestRestorableDateTime — (Date)

            LatestRestorableDateTime is typically 5 minutes before the current time.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeEndpoints(params = {}, callback) ⇒ AWS.Request

Returns the regional endpoint information.

Service Reference:

Examples:

Calling the describeEndpoints operation

var params = {
};
dynamodb.describeEndpoints(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Endpoints — (Array<map>)

        List of endpoints.

        • Address — required — (String)

          IP address of the endpoint.

        • CachePeriodInMinutes — required — (Integer)

          Endpoint cache time to live (TTL) value.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeGlobalTable(params = {}, callback) ⇒ AWS.Request

Returns information about the specified global table.

Service Reference:

Examples:

Calling the describeGlobalTable operation

var params = {
  GlobalTableName: 'STRING_VALUE' /* required */
};
dynamodb.describeGlobalTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalTableName — (String)

      The name of the global table.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GlobalTableDescription — (map)

        Contains the details of the global table.

        • ReplicationGroup — (Array<map>)

          The regions where the global table has replicas.

          • RegionName — (String)

            The name of the region.

        • GlobalTableArn — (String)

          The unique identifier of the global table.

        • CreationDateTime — (Date)

          The creation time of the global table.

        • GlobalTableStatus — (String)

          The current state of the global table:

          • CREATING - The global table is being created.

          • UPDATING - The global table is being updated.

          • DELETING - The global table is being deleted.

          • ACTIVE - The global table is ready for use.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "DELETING"
          • "UPDATING"
        • GlobalTableName — (String)

          The global table name.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeGlobalTableSettings(params = {}, callback) ⇒ AWS.Request

Describes region specific settings for a global table.

Service Reference:

Examples:

Calling the describeGlobalTableSettings operation

var params = {
  GlobalTableName: 'STRING_VALUE' /* required */
};
dynamodb.describeGlobalTableSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalTableName — (String)

      The name of the global table to describe.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GlobalTableName — (String)

        The name of the global table.

      • ReplicaSettings — (Array<map>)

        The region specific settings for the global table.

        • RegionName — required — (String)

          The region name of the replica.

        • ReplicaStatus — (String)

          The current state of the region:

          • CREATING - The region is being created.

          • UPDATING - The region is being updated.

          • DELETING - The region is being deleted.

          • ACTIVE - The region is ready for use.

          Possible values include:
          • "CREATING"
          • "UPDATING"
          • "DELETING"
          • "ACTIVE"
        • ReplicaBillingModeSummary — (map)

          The read/write capacity mode of the replica.

          • BillingMode — (String)

            Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

            • PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

            • PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

            Possible values include:
            • "PROVISIONED"
            • "PAY_PER_REQUEST"
          • LastUpdateToPayPerRequestDateTime — (Date)

            Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.

        • ReplicaProvisionedReadCapacityUnits — (Integer)

          The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

        • ReplicaProvisionedReadCapacityAutoScalingSettings — (map)

          Autoscaling settings for a global table replica's read capacity units.

          • MinimumUnits — (Integer)

            The minimum capacity units that a global table or global secondary index should be scaled down to.

          • MaximumUnits — (Integer)

            The maximum capacity units that a global table or global secondary index should be scaled up to.

          • AutoScalingDisabled — (Boolean)

            Disabled autoscaling for this global table or global secondary index.

          • AutoScalingRoleArn — (String)

            Role ARN used for configuring autoScaling policy.

          • ScalingPolicies — (Array<map>)

            Information about the scaling policies.

            • PolicyName — (String)

              The name of the scaling policy.

            • TargetTrackingScalingPolicyConfiguration — (map)

              Represents a target tracking scaling policy configuration.

              • DisableScaleIn — (Boolean)

                Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

              • ScaleInCooldown — (Integer)

                The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application autoscaling scales out your scalable target immediately.

              • ScaleOutCooldown — (Integer)

                The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.

              • TargetValue — required — (Float)

                The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

        • ReplicaProvisionedWriteCapacityUnits — (Integer)

          The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

        • ReplicaProvisionedWriteCapacityAutoScalingSettings — (map)

          AutoScaling settings for a global table replica's write capacity units.

          • MinimumUnits — (Integer)

            The minimum capacity units that a global table or global secondary index should be scaled down to.

          • MaximumUnits — (Integer)

            The maximum capacity units that a global table or global secondary index should be scaled up to.

          • AutoScalingDisabled — (Boolean)

            Disabled autoscaling for this global table or global secondary index.

          • AutoScalingRoleArn — (String)

            Role ARN used for configuring autoScaling policy.

          • ScalingPolicies — (Array<map>)

            Information about the scaling policies.

            • PolicyName — (String)

              The name of the scaling policy.

            • TargetTrackingScalingPolicyConfiguration — (map)

              Represents a target tracking scaling policy configuration.

              • DisableScaleIn — (Boolean)

                Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

              • ScaleInCooldown — (Integer)

                The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application autoscaling scales out your scalable target immediately.

              • ScaleOutCooldown — (Integer)

                The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.

              • TargetValue — required — (Float)

                The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

        • ReplicaGlobalSecondaryIndexSettings — (Array<map>)

          Replica global secondary index settings for the global table.

          • IndexName — required — (String)

            The name of the global secondary index. The name must be unique among all other indexes on this table.

          • IndexStatus — (String)

            The current status of the global secondary index:

            • CREATING - The global secondary index is being created.

            • UPDATING - The global secondary index is being updated.

            • DELETING - The global secondary index is being deleted.

            • ACTIVE - The global secondary index is ready for use.

            Possible values include:
            • "CREATING"
            • "UPDATING"
            • "DELETING"
            • "ACTIVE"
          • ProvisionedReadCapacityUnits — (Integer)

            The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

          • ProvisionedReadCapacityAutoScalingSettings — (map)

            Autoscaling settings for a global secondary index replica's read capacity units.

            • MinimumUnits — (Integer)

              The minimum capacity units that a global table or global secondary index should be scaled down to.

            • MaximumUnits — (Integer)

              The maximum capacity units that a global table or global secondary index should be scaled up to.

            • AutoScalingDisabled — (Boolean)

              Disabled autoscaling for this global table or global secondary index.

            • AutoScalingRoleArn — (String)

              Role ARN used for configuring autoScaling policy.

            • ScalingPolicies — (Array<map>)

              Information about the scaling policies.

              • PolicyName — (String)

                The name of the scaling policy.

              • TargetTrackingScalingPolicyConfiguration — (map)

                Represents a target tracking scaling policy configuration.

                • DisableScaleIn — (Boolean)

                  Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

                • ScaleInCooldown — (Integer)

                  The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application autoscaling scales out your scalable target immediately.

                • ScaleOutCooldown — (Integer)

                  The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.

                • TargetValue — required — (Float)

                  The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

          • ProvisionedWriteCapacityUnits — (Integer)

            The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

          • ProvisionedWriteCapacityAutoScalingSettings — (map)

            AutoScaling settings for a global secondary index replica's write capacity units.

            • MinimumUnits — (Integer)

              The minimum capacity units that a global table or global secondary index should be scaled down to.

            • MaximumUnits — (Integer)

              The maximum capacity units that a global table or global secondary index should be scaled up to.

            • AutoScalingDisabled — (Boolean)

              Disabled autoscaling for this global table or global secondary index.

            • AutoScalingRoleArn — (String)

              Role ARN used for configuring autoScaling policy.

            • ScalingPolicies — (Array<map>)

              Information about the scaling policies.

              • PolicyName — (String)

                The name of the scaling policy.

              • TargetTrackingScalingPolicyConfiguration — (map)

                Represents a target tracking scaling policy configuration.

                • DisableScaleIn — (Boolean)

                  Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

                • ScaleInCooldown — (Integer)

                  The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application autoscaling scales out your scalable target immediately.

                • ScaleOutCooldown — (Integer)

                  The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.

                • TargetValue — required — (Float)

                  The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeLimits(params = {}, callback) ⇒ AWS.Request

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

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

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

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

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

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

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

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

    • Call DescribeTable with the table name.

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

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

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

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

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

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

Note: 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.

Service Reference:

Examples:

To determine capacity limits per table and account, in the current AWS region


/* The following example returns the maximum read and write capacity units per table, and for the AWS account, in the current AWS region. */

 var params = {
 };
 dynamodb.describeLimits(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AccountMaxReadCapacityUnits: 20000, 
    AccountMaxWriteCapacityUnits: 20000, 
    TableMaxReadCapacityUnits: 10000, 
    TableMaxWriteCapacityUnits: 10000
   }
   */
 });

Calling the describeLimits operation

var params = {
};
dynamodb.describeLimits(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AccountMaxReadCapacityUnits — (Integer)

        The maximum total read capacity units that your account allows you to provision across all of your tables in this region.

      • AccountMaxWriteCapacityUnits — (Integer)

        The maximum total write capacity units that your account allows you to provision across all of your tables in this region.

      • TableMaxReadCapacityUnits — (Integer)

        The maximum read capacity units that your account allows you to provision for a new table that you are creating in this region, including the read capacity units provisioned for its global secondary indexes (GSIs).

      • TableMaxWriteCapacityUnits — (Integer)

        The maximum write capacity units that your account allows you to provision for a new table that you are creating in this region, including the write capacity units provisioned for its global secondary indexes (GSIs).

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeTable(params = {}, callback) ⇒ AWS.Request

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.

Note: 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.

Service Reference:

Examples:

To describe a table


/* This example describes the Music table. */

 var params = {
  TableName: "Music"
 };
 dynamodb.describeTable(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Table: {
     AttributeDefinitions: [
        {
       AttributeName: "Artist", 
       AttributeType: "S"
      }, 
        {
       AttributeName: "SongTitle", 
       AttributeType: "S"
      }
     ], 
     CreationDateTime: <Date Representation>, 
     ItemCount: 0, 
     KeySchema: [
        {
       AttributeName: "Artist", 
       KeyType: "HASH"
      }, 
        {
       AttributeName: "SongTitle", 
       KeyType: "RANGE"
      }
     ], 
     ProvisionedThroughput: {
      NumberOfDecreasesToday: 1, 
      ReadCapacityUnits: 5, 
      WriteCapacityUnits: 5
     }, 
     TableName: "Music", 
     TableSizeBytes: 0, 
     TableStatus: "ACTIVE"
    }
   }
   */
 });

Calling the describeTable operation

var params = {
  TableName: 'STRING_VALUE' /* required */
};
dynamodb.describeTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TableName — (String)

      The name of the table to describe.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Table — (map)

        The properties of the table.

        • AttributeDefinitions — (Array<map>)

          An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.

          Each AttributeDefinition object in this array is composed of:

          • AttributeName - The name of the attribute.

          • AttributeType - The data type for the attribute.

          • AttributeName — required — (String)

            A name for the attribute.

          • AttributeType — required — (String)

            The data type for the attribute, where:

            • S - the attribute is of type String

            • N - the attribute is of type Number

            • B - the attribute is of type Binary

            Possible values include:
            • "S"
            • "N"
            • "B"
        • TableName — (String)

          The name of the table.

        • KeySchema — (Array<map>)

          The primary key structure for the table. Each KeySchemaElement consists of:

          • AttributeName - The name of the attribute.

          • KeyType - The role of the attribute:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

          For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

          • AttributeName — required — (String)

            The name of a key attribute.

          • KeyType — required — (String)

            The role that this key attribute will assume:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            Possible values include:
            • "HASH"
            • "RANGE"
        • TableStatus — (String)

          The current state of the table:

          • CREATING - The table is being created.

          • UPDATING - The table is being updated.

          • DELETING - The table is being deleted.

          • ACTIVE - The table is ready for use.

          Possible values include:
          • "CREATING"
          • "UPDATING"
          • "DELETING"
          • "ACTIVE"
        • CreationDateTime — (Date)

          The date and time when the table was created, in UNIX epoch time format.

        • ProvisionedThroughput — (map)

          The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

          • LastIncreaseDateTime — (Date)

            The date and time of the last provisioned throughput increase for this table.

          • LastDecreaseDateTime — (Date)

            The date and time of the last provisioned throughput decrease for this table.

          • NumberOfDecreasesToday — (Integer)

            The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

          • ReadCapacityUnits — (Integer)

            The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.

          • WriteCapacityUnits — (Integer)

            The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

        • TableSizeBytes — (Integer)

          The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • ItemCount — (Integer)

          The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • TableArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the table.

        • TableId — (String)

          Unique identifier for the table for which the backup was created.

        • BillingModeSummary — (map)

          Contains the details for the read/write capacity mode.

          • BillingMode — (String)

            Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

            • PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

            • PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

            Possible values include:
            • "PROVISIONED"
            • "PAY_PER_REQUEST"
          • LastUpdateToPayPerRequestDateTime — (Date)

            Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.

        • LocalSecondaryIndexes — (Array<map>)

          Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:

          • IndexName - The name of the local secondary index.

          • KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

          • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

            • ProjectionType - One of the following:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

            • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          If the table is in the DELETING state, no information about indexes will be returned.

          • IndexName — (String)

            Represents the name of the local secondary index.

          • KeySchema — (Array<map>)

            The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            • AttributeName — required — (String)

              The name of a key attribute.

            • KeyType — required — (String)

              The role that this key attribute will assume:

              • HASH - partition key

              • RANGE - sort key

              Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
              Possible values include:
              • "HASH"
              • "RANGE"
          • Projection — (map)

            Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

            • ProjectionType — (String)

              The set of attributes that are projected into the index:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

              Possible values include:
              • "ALL"
              • "KEYS_ONLY"
              • "INCLUDE"
            • NonKeyAttributes — (Array<String>)

              Represents the non-key attribute names which will be projected into the index.

              For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • IndexSizeBytes — (Integer)

            The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • ItemCount — (Integer)

            The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • IndexArn — (String)

            The Amazon Resource Name (ARN) that uniquely identifies the index.

        • GlobalSecondaryIndexes — (Array<map>)

          The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:

          • Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table; it is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.)

          • IndexName - The name of the global secondary index.

          • IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • IndexStatus - The current status of the global secondary index:

            • CREATING - The index is being created.

            • UPDATING - The index is being updated.

            • DELETING - The index is being deleted.

            • ACTIVE - The index is ready for use.

          • ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

          • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

            • ProjectionType - One of the following:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

            • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.

          If the table is in the DELETING state, no information about indexes will be returned.

          • IndexName — (String)

            The name of the global secondary index.

          • KeySchema — (Array<map>)

            The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            • AttributeName — required — (String)

              The name of a key attribute.

            • KeyType — required — (String)

              The role that this key attribute will assume:

              • HASH - partition key

              • RANGE - sort key

              Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
              Possible values include:
              • "HASH"
              • "RANGE"
          • Projection — (map)

            Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

            • ProjectionType — (String)

              The set of attributes that are projected into the index:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

              Possible values include:
              • "ALL"
              • "KEYS_ONLY"
              • "INCLUDE"
            • NonKeyAttributes — (Array<String>)

              Represents the non-key attribute names which will be projected into the index.

              For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • IndexStatus — (String)

            The current state of the global secondary index:

            • CREATING - The index is being created.

            • UPDATING - The index is being updated.

            • DELETING - The index is being deleted.

            • ACTIVE - The index is ready for use.

            Possible values include:
            • "CREATING"
            • "UPDATING"
            • "DELETING"
            • "ACTIVE"
          • Backfilling — (Boolean)

            Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.

            Note: For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
          • ProvisionedThroughput — (map)

            Represents the provisioned throughput settings for the specified global secondary index.

            For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

            • LastIncreaseDateTime — (Date)

              The date and time of the last provisioned throughput increase for this table.

            • LastDecreaseDateTime — (Date)

              The date and time of the last provisioned throughput decrease for this table.

            • NumberOfDecreasesToday — (Integer)

              The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

            • ReadCapacityUnits — (Integer)

              The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.

            • WriteCapacityUnits — (Integer)

              The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

          • IndexSizeBytes — (Integer)

            The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • ItemCount — (Integer)

            The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • IndexArn — (String)

            The Amazon Resource Name (ARN) that uniquely identifies the index.

        • StreamSpecification — (map)

          The current DynamoDB Streams configuration for the table.

          • StreamEnabled — (Boolean)

            Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

          • StreamViewType — (String)

            When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

            • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

            • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

            • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

            • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

            Possible values include:
            • "NEW_IMAGE"
            • "OLD_IMAGE"
            • "NEW_AND_OLD_IMAGES"
            • "KEYS_ONLY"
        • LatestStreamLabel — (String)

          A timestamp, in ISO 8601 format, for this stream.

          Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

          • the AWS customer ID.

          • the table name.

          • the StreamLabel.

        • LatestStreamArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.

        • RestoreSummary — (map)

          Contains details for the restore.

          • SourceBackupArn — (String)

            ARN of the backup from which the table was restored.

          • SourceTableArn — (String)

            ARN of the source table of the backup that is being restored.

          • RestoreDateTime — required — (Date)

            Point in time or source backup time.

          • RestoreInProgress — required — (Boolean)

            Indicates if a restore is in progress or not.

        • SSEDescription — (map)

          The description of the server-side encryption status on the specified table.

          • Status — (String)

            The current state of server-side encryption:

            • ENABLING - Server-side encryption is being enabled.

            • ENABLED - Server-side encryption is enabled.

            • DISABLING - Server-side encryption is being disabled.

            • DISABLED - Server-side encryption is disabled.

            • UPDATING - Server-side encryption is being updated.

            Possible values include:
            • "ENABLING"
            • "ENABLED"
            • "DISABLING"
            • "DISABLED"
            • "UPDATING"
          • SSEType — (String)

            Server-side encryption type:

            • AES256 - Server-side encryption which uses the AES256 algorithm (not applicable).

            • KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).

            Possible values include:
            • "AES256"
            • "KMS"
          • KMSMasterKeyArn — (String)

            The KMS master key ARN used for the KMS encryption.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeTimeToLive(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the describeTimeToLive operation

var params = {
  TableName: 'STRING_VALUE' /* required */
};
dynamodb.describeTimeToLive(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TableName — (String)

      The name of the table to be described.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TimeToLiveDescription — (map)

        • TimeToLiveStatus — (String)

          The Time to Live status for the table.

          Possible values include:
          • "ENABLING"
          • "DISABLING"
          • "ENABLED"
          • "DISABLED"
        • AttributeName — (String)

          The name of the Time to Live attribute for items in the table.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getItem(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To read an item from a table


/* This example retrieves an item from the Music table. The table has a partition key and a sort key (Artist and SongTitle), so you must specify both of these attributes. */

 var params = {
  Key: {
   "Artist": {
     S: "Acme Band"
    }, 
   "SongTitle": {
     S: "Happy Day"
    }
  }, 
  TableName: "Music"
 };
 dynamodb.getItem(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Item: {
     "AlbumTitle": {
       S: "Songs About Life"
      }, 
     "Artist": {
       S: "Acme Band"
      }, 
     "SongTitle": {
       S: "Happy Day"
      }
    }
   }
   */
 });

Calling the getItem operation

var params = {
  Key: { /* required */
    '<AttributeName>': { /* AttributeValue */
      B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
      BOOL: true || false,
      BS: [
        new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
        /* more items */
      ],
      L: [
        /* recursive AttributeValue */,
        /* more items */
      ],
      M: {
        '<AttributeName>': /* recursive AttributeValue */,
        /* '<AttributeName>': ... */
      },
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      NULL: true || false,
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* '<AttributeName>': ... */
  },
  TableName: 'STRING_VALUE', /* required */
  AttributesToGet: [
    'STRING_VALUE',
    /* more items */
  ],
  ConsistentRead: true || false,
  ExpressionAttributeNames: {
    '<ExpressionAttributeNameVariable>': 'STRING_VALUE',
    /* '<ExpressionAttributeNameVariable>': ... */
  },
  ProjectionExpression: 'STRING_VALUE',
  ReturnConsumedCapacity: INDEXES | TOTAL | NONE
};
dynamodb.getItem(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TableName — (String)

      The name of the table containing the requested item.

    • Key — (map<map>)

      A map of attribute names to AttributeValue objects, representing the primary key of the item to retrieve.

      For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

      • S — (String)

        An attribute of type String. For example:

        "S": "Hello"

      • N — (String)

        An attribute of type Number. For example:

        "N": "123.45"

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • B — (Buffer, Typed Array, Blob, String)

        An attribute of type Binary. For example:

        "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

      • SS — (Array<String>)

        An attribute of type String Set. For example:

        "SS": ["Giraffe", "Hippo" ,"Zebra"]

      • NS — (Array<String>)

        An attribute of type Number Set. For example:

        "NS": ["42.2", "-19", "7.5", "3.14"]

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • BS — (Array<Buffer, Typed Array, Blob, String>)

        An attribute of type Binary Set. For example:

        "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

      • M — (map<map>)

        An attribute of type Map. For example:

        "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

      • L — (Array<map>)

        An attribute of type List. For example:

        "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

      • NULL — (Boolean)

        An attribute of type Null. For example:

        "NULL": true

      • BOOL — (Boolean)

        An attribute of type Boolean. For example:

        "BOOL": true

    • AttributesToGet — (Array<String>)

      This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

    • ConsistentRead — (Boolean)

      Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

    • ReturnConsumedCapacity — (String)

      Determines the level of detail about provisioned throughput consumption that is returned in the response:

      • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

        Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

      • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

      • NONE - No ConsumedCapacity details are included in the response.

      Possible values include:
      • "INDEXES"
      • "TOTAL"
      • "NONE"
    • ProjectionExpression — (String)

      A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

      If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

      For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

    • ExpressionAttributeNames — (map<String>)

      One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

      • To access an attribute whose name conflicts with a DynamoDB reserved word.

      • To create a placeholder for repeating occurrences of an attribute name in an expression.

      • To prevent special characters in an attribute name from being misinterpreted in an expression.

      Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

      • Percentile

      The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

      • {"#P":"Percentile"}

      You could then use this substitution in an expression, as in this example:

      • #P = :val

      Note: Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

      For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Item — (map<map>)

        A map of attribute names to AttributeValue objects, as specified by ProjectionExpression.

        • S — (String)

          An attribute of type String. For example:

          "S": "Hello"

        • N — (String)

          An attribute of type Number. For example:

          "N": "123.45"

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • B — (Buffer, Typed Array, Blob, String)

          An attribute of type Binary. For example:

          "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

        • SS — (Array<String>)

          An attribute of type String Set. For example:

          "SS": ["Giraffe", "Hippo" ,"Zebra"]

        • NS — (Array<String>)

          An attribute of type Number Set. For example:

          "NS": ["42.2", "-19", "7.5", "3.14"]

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • BS — (Array<Buffer, Typed Array, Blob, String>)

          An attribute of type Binary Set. For example:

          "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

        • M — (map<map>)

          An attribute of type Map. For example:

          "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

        • L — (Array<map>)

          An attribute of type List. For example:

          "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

        • NULL — (Boolean)

          An attribute of type Null. For example:

          "NULL": true

        • BOOL — (Boolean)

          An attribute of type Boolean. For example:

          "BOOL": true

      • ConsumedCapacity — (map)

        The capacity units consumed by the GetItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

        • TableName — (String)

          The name of the table that was affected by the operation.

        • CapacityUnits — (Float)

          The total number of capacity units consumed by the operation.

        • ReadCapacityUnits — (Float)

          The total number of read capacity units consumed by the operation.

        • WriteCapacityUnits — (Float)

          The total number of write capacity units consumed by the operation.

        • Table — (map)

          The amount of throughput consumed on the table affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

        • LocalSecondaryIndexes — (map<map>)

          The amount of throughput consumed on each local index affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

        • GlobalSecondaryIndexes — (map<map>)

          The amount of throughput consumed on each global index affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listBackups(params = {}, callback) ⇒ AWS.Request

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

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

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

Service Reference:

Examples:

Calling the listBackups operation

var params = {
  BackupType: USER | SYSTEM | AWS_BACKUP | ALL,
  ExclusiveStartBackupArn: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  TableName: 'STRING_VALUE',
  TimeRangeLowerBound: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  TimeRangeUpperBound: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
dynamodb.listBackups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TableName — (String)

      The backups from the table specified by TableName are listed.

    • Limit — (Integer)

      Maximum number of backups to return at once.

    • TimeRangeLowerBound — (Date)

      Only backups created after this time are listed. TimeRangeLowerBound is inclusive.

    • TimeRangeUpperBound — (Date)

      Only backups created before this time are listed. TimeRangeUpperBound is exclusive.

    • ExclusiveStartBackupArn — (String)

      LastEvaluatedBackupArn is the ARN of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next page of results.

    • BackupType — (String)

      The backups from the table specified by BackupType are listed.

      Where BackupType can be:

      • USER - On-demand backup created by you.

      • SYSTEM - On-demand backup automatically created by DynamoDB.

      • ALL - All types of on-demand backups (USER and SYSTEM).

      Possible values include:
      • "USER"
      • "SYSTEM"
      • "AWS_BACKUP"
      • "ALL"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupSummaries — (Array<map>)

        List of BackupSummary objects.

        • TableName — (String)

          Name of the table.

        • TableId — (String)

          Unique identifier for the table.

        • TableArn — (String)

          ARN associated with the table.

        • BackupArn — (String)

          ARN associated with the backup.

        • BackupName — (String)

          Name of the specified backup.

        • BackupCreationDateTime — (Date)

          Time at which the backup was created.

        • BackupExpiryDateTime — (Date)

          Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation.

        • BackupStatus — (String)

          Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

          Possible values include:
          • "CREATING"
          • "DELETED"
          • "AVAILABLE"
        • BackupType — (String)

          BackupType:

          • USER - You create and manage these using the on-demand backup feature.

          • SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion.

          • AWS_BACKUP - On-demand backup created by you from AWS Backup service.

          Possible values include:
          • "USER"
          • "SYSTEM"
          • "AWS_BACKUP"
        • BackupSizeBytes — (Integer)

          Size of the backup in bytes.

      • LastEvaluatedBackupArn — (String)

        The ARN of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next page of results.

        If LastEvaluatedBackupArn is empty, then the last page of results has been processed and there are no more results to be retrieved.

        If LastEvaluatedBackupArn is not empty, this may or may not indicate there is more data to be returned. All results are guaranteed to have been returned if and only if no value for LastEvaluatedBackupArn is returned.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listGlobalTables(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listGlobalTables operation

var params = {
  ExclusiveStartGlobalTableName: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  RegionName: 'STRING_VALUE'
};
dynamodb.listGlobalTables(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ExclusiveStartGlobalTableName — (String)

      The first global table name that this operation will evaluate.

    • Limit — (Integer)

      The maximum number of table names to return.

    • RegionName — (String)

      Lists the global tables in a specific region.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GlobalTables — (Array<map>)

        List of global table names.

        • GlobalTableName — (String)

          The global table name.

        • ReplicationGroup — (Array<map>)

          The regions where the global table has replicas.

          • RegionName — (String)

            The region where the replica needs to be created.

      • LastEvaluatedGlobalTableName — (String)

        Last evaluated global table name.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTables(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To list tables


/* This example lists all of the tables associated with the current AWS account and endpoint. */

 var params = {
 };
 dynamodb.listTables(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    TableNames: [
       "Forum", 
       "ProductCatalog", 
       "Reply", 
       "Thread"
    ]
   }
   */
 });

Calling the listTables operation

var params = {
  ExclusiveStartTableName: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE'
};
dynamodb.listTables(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ExclusiveStartTableName — (String)

      The first table name that this operation will evaluate. Use the value that was returned for LastEvaluatedTableName in a previous operation, so that you can obtain the next page of results.

    • Limit — (Integer)

      A maximum number of table names to return. If this parameter is not specified, the limit is 100.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TableNames — (Array<String>)

        The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100.

        If LastEvaluatedTableName also appears in the output, you can use this value as the ExclusiveStartTableName parameter in a subsequent ListTables request and obtain the next page of results.

      • LastEvaluatedTableName — (String)

        The name of the last table in the current page of results. Use this value as the ExclusiveStartTableName in a new request to obtain the next page of results, until all the table names are returned.

        If you do not receive a LastEvaluatedTableName value in the response, this means that there are no more table names to be retrieved.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTagsOfResource(params = {}, callback) ⇒ AWS.Request

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

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

Service Reference:

Examples:

Calling the listTagsOfResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  NextToken: 'STRING_VALUE'
};
dynamodb.listTagsOfResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The Amazon DynamoDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).

    • NextToken — (String)

      An optional string that, if supplied, must be copied from the output of a previous call to ListTagOfResource. When provided in this manner, this API fetches the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

        The tags currently associated with the Amazon DynamoDB resource.

        • Key — required — (String)

          The key of the tag.Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.

        • Value — required — (String)

          The value of the tag. Tag values are case-sensitive and can be null.

      • NextToken — (String)

        If this value is returned, there are additional results to be displayed. To retrieve them, call ListTagsOfResource again, with NextToken set to this value.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putItem(params = {}, callback) ⇒ AWS.Request

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

This topic provides general information about the PutItem API.

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

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

Note: 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.

Service Reference:

Examples:

To add an item to a table


/* This example adds a new item to the Music table. */

 var params = {
  Item: {
   "AlbumTitle": {
     S: "Somewhat Famous"
    }, 
   "Artist": {
     S: "No One You Know"
    }, 
   "SongTitle": {
     S: "Call Me Today"
    }
  }, 
  ReturnConsumedCapacity: "TOTAL", 
  TableName: "Music"
 };
 dynamodb.putItem(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ConsumedCapacity: {
     CapacityUnits: 1, 
     TableName: "Music"
    }
   }
   */
 });

Calling the putItem operation

var params = {
  Item: { /* required */
    '<AttributeName>': { /* AttributeValue */
      B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
      BOOL: true || false,
      BS: [
        new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
        /* more items */
      ],
      L: [
        /* recursive AttributeValue */,
        /* more items */
      ],
      M: {
        '<AttributeName>': /* recursive AttributeValue */,
        /* '<AttributeName>': ... */
      },
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      NULL: true || false,
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* '<AttributeName>': ... */
  },
  TableName: 'STRING_VALUE', /* required */
  ConditionExpression: 'STRING_VALUE',
  ConditionalOperator: AND | OR,
  Expected: {
    '<AttributeName>': {
      AttributeValueList: [
        { /* AttributeValue */
          B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
          BOOL: true || false,
          BS: [
            new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
            /* more items */
          ],
          L: [
            /* recursive AttributeValue */,
            /* more items */
          ],
          M: {
            '<AttributeName>': /* recursive AttributeValue */,
            /* '<AttributeName>': ... */
          },
          N: 'STRING_VALUE',
          NS: [
            'STRING_VALUE',
            /* more items */
          ],
          NULL: true || false,
          S: 'STRING_VALUE',
          SS: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ],
      ComparisonOperator: EQ | NE | IN | LE | LT | GE | GT | BETWEEN | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH,
      Exists: true || false,
      Value: { /* AttributeValue */
        B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
        BOOL: true || false,
        BS: [
          new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
          /* more items */
        ],
        L: [
          /* recursive AttributeValue */,
          /* more items */
        ],
        M: {
          '<AttributeName>': /* recursive AttributeValue */,
          /* '<AttributeName>': ... */
        },
        N: 'STRING_VALUE',
        NS: [
          'STRING_VALUE',
          /* more items */
        ],
        NULL: true || false,
        S: 'STRING_VALUE',
        SS: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    /* '<AttributeName>': ... */
  },
  ExpressionAttributeNames: {
    '<ExpressionAttributeNameVariable>': 'STRING_VALUE',
    /* '<ExpressionAttributeNameVariable>': ... */
  },
  ExpressionAttributeValues: {
    '<ExpressionAttributeValueVariable>': { /* AttributeValue */
      B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
      BOOL: true || false,
      BS: [
        new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
        /* more items */
      ],
      L: [
        /* recursive AttributeValue */,
        /* more items */
      ],
      M: {
        '<AttributeName>': /* recursive AttributeValue */,
        /* '<AttributeName>': ... */
      },
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      NULL: true || false,
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* '<ExpressionAttributeValueVariable>': ... */
  },
  ReturnConsumedCapacity: INDEXES | TOTAL | NONE,
  ReturnItemCollectionMetrics: SIZE | NONE,
  ReturnValues: NONE | ALL_OLD | UPDATED_OLD | ALL_NEW | UPDATED_NEW
};
dynamodb.putItem(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TableName — (String)

      The name of the table to contain the item.

    • Item — (map<map>)

      A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

      You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key.

      If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

      For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

      Each element in the Item map is an AttributeValue object.

      • S — (String)

        An attribute of type String. For example:

        "S": "Hello"

      • N — (String)

        An attribute of type Number. For example:

        "N": "123.45"

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • B — (Buffer, Typed Array, Blob, String)

        An attribute of type Binary. For example:

        "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

      • SS — (Array<String>)

        An attribute of type String Set. For example:

        "SS": ["Giraffe", "Hippo" ,"Zebra"]

      • NS — (Array<String>)

        An attribute of type Number Set. For example:

        "NS": ["42.2", "-19", "7.5", "3.14"]

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • BS — (Array<Buffer, Typed Array, Blob, String>)

        An attribute of type Binary Set. For example:

        "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

      • M — (map<map>)

        An attribute of type Map. For example:

        "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

      • L — (Array<map>)

        An attribute of type List. For example:

        "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

      • NULL — (Boolean)

        An attribute of type Null. For example:

        "NULL": true

      • BOOL — (Boolean)

        An attribute of type Boolean. For example:

        "BOOL": true

    • Expected — (map<map>)

      This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

      • Value — (map)

        Represents the data for the expected attribute.

        Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

        For more information, see Data Types in the Amazon DynamoDB Developer Guide.

        • S — (String)

          An attribute of type String. For example:

          "S": "Hello"

        • N — (String)

          An attribute of type Number. For example:

          "N": "123.45"

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • B — (Buffer, Typed Array, Blob, String)

          An attribute of type Binary. For example:

          "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

        • SS — (Array<String>)

          An attribute of type String Set. For example:

          "SS": ["Giraffe", "Hippo" ,"Zebra"]

        • NS — (Array<String>)

          An attribute of type Number Set. For example:

          "NS": ["42.2", "-19", "7.5", "3.14"]

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • BS — (Array<Buffer, Typed Array, Blob, String>)

          An attribute of type Binary Set. For example:

          "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

        • M — (map<map>)

          An attribute of type Map. For example:

          "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

        • L — (Array<map>)

          An attribute of type List. For example:

          "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

        • NULL — (Boolean)

          An attribute of type Null. For example:

          "NULL": true

        • BOOL — (Boolean)

          An attribute of type Boolean. For example:

          "BOOL": true

      • Exists — (Boolean)

        Causes DynamoDB to evaluate the value before attempting a conditional operation:

        • If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a ConditionCheckFailedException.

        • If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a ConditionCheckFailedException.

        The default setting for Exists is true. If you supply a Value all by itself, DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied.

        DynamoDB returns a ValidationException if:

        • Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.)

        • Exists is false but you also provide a Value. (You cannot expect an attribute to have a value, while also expecting it not to exist.)

      • ComparisonOperator — (String)

        A comparator for evaluating attributes in the AttributeValueList. For example, equals, greater than, less than, etc.

        The following comparison operators are available:

        EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN

        The following are descriptions of each comparison operator.

        • EQ : Equal. EQ is supported for all data types, including lists and maps.

          AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

        • NE : Not equal. NE is supported for all data types, including lists and maps.

          AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

        • LE : Less than or equal.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

        • LT : Less than.

          AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

        • GE : Greater than or equal.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

        • GT : Greater than.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

        • NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including lists and maps.

          Note: This operator tests for the existence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute "a" exists; its data type is not relevant to the NOT_NULL comparison operator.

        • NULL : The attribute does not exist. NULL is supported for all data types, including lists and maps.

          Note: This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute "a" exists; its data type is not relevant to the NULL comparison operator.

        • CONTAINS : Checks for a subsequence, or value in a set.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it finds an exact match with any member of the set.

          CONTAINS is supported for lists: When evaluating "a CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list.

        • NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it does not find an exact match with any member of the set.

          NOT_CONTAINS is supported for lists: When evaluating "a NOT CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list.

        • BEGINS_WITH : Checks for a prefix.

          AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).

        • IN : Checks for matching elements in a list.

          AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true.

        • BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.

          AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}

        Possible values include:
        • "EQ"
        • "NE"
        • "IN"
        • "LE"
        • "LT"
        • "GE"
        • "GT"
        • "BETWEEN"
        • "NOT_NULL"
        • "NULL"
        • "CONTAINS"
        • "NOT_CONTAINS"
        • "BEGINS_WITH"
      • AttributeValueList — (Array<map>)

        One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.

        For type Number, value comparisons are numeric.

        String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

        For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

        For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.

        • S — (String)

          An attribute of type String. For example:

          "S": "Hello"

        • N — (String)

          An attribute of type Number. For example:

          "N": "123.45"

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • B — (Buffer, Typed Array, Blob, String)

          An attribute of type Binary. For example:

          "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

        • SS — (Array<String>)

          An attribute of type String Set. For example:

          "SS": ["Giraffe", "Hippo" ,"Zebra"]

        • NS — (Array<String>)

          An attribute of type Number Set. For example:

          "NS": ["42.2", "-19", "7.5", "3.14"]

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • BS — (Array<Buffer, Typed Array, Blob, String>)

          An attribute of type Binary Set. For example:

          "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

        • M — (map<map>)

          An attribute of type Map. For example:

          "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

        • L — (Array<map>)

          An attribute of type List. For example:

          "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

        • NULL — (Boolean)

          An attribute of type Null. For example:

          "NULL": true

        • BOOL — (Boolean)

          An attribute of type Boolean. For example:

          "BOOL": true

    • ReturnValues — (String)

      Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. For PutItem, the valid values are:

      • NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

      • ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.

      Note: The ReturnValues parameter is used by several DynamoDB operations; however, PutItem does not recognize any values other than NONE or ALL_OLD.
      Possible values include:
      • "NONE"
      • "ALL_OLD"
      • "UPDATED_OLD"
      • "ALL_NEW"
      • "UPDATED_NEW"
    • ReturnConsumedCapacity — (String)

      Determines the level of detail about provisioned throughput consumption that is returned in the response:

      • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

        Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

      • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

      • NONE - No ConsumedCapacity details are included in the response.

      Possible values include:
      • "INDEXES"
      • "TOTAL"
      • "NONE"
    • ReturnItemCollectionMetrics — (String)

      Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

      Possible values include:
      • "SIZE"
      • "NONE"
    • ConditionalOperator — (String)

      This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

      Possible values include:
      • "AND"
      • "OR"
    • ConditionExpression — (String)

      A condition that must be satisfied in order for a conditional PutItem operation to succeed.

      An expression can contain any of the following:

      • Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

        These function names are case-sensitive.

      • Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

      • Logical operators: AND | OR | NOT

      For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

    • ExpressionAttributeNames — (map<String>)

      One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

      • To access an attribute whose name conflicts with a DynamoDB reserved word.

      • To create a placeholder for repeating occurrences of an attribute name in an expression.

      • To prevent special characters in an attribute name from being misinterpreted in an expression.

      Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

      • Percentile

      The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

      • {"#P":"Percentile"}

      You could then use this substitution in an expression, as in this example:

      • #P = :val

      Note: Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

      For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

    • ExpressionAttributeValues — (map<map>)

      One or more values that can be substituted in an expression.

      Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

      Available | Backordered | Discontinued

      You would first need to specify ExpressionAttributeValues as follows:

      { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

      You could then use these values in an expression, such as this:

      ProductStatus IN (:avail, :back, :disc)

      For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

      • S — (String)

        An attribute of type String. For example:

        "S": "Hello"

      • N — (String)

        An attribute of type Number. For example:

        "N": "123.45"

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • B — (Buffer, Typed Array, Blob, String)

        An attribute of type Binary. For example:

        "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

      • SS — (Array<String>)

        An attribute of type String Set. For example:

        "SS": ["Giraffe", "Hippo" ,"Zebra"]

      • NS — (Array<String>)

        An attribute of type Number Set. For example:

        "NS": ["42.2", "-19", "7.5", "3.14"]

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • BS — (Array<Buffer, Typed Array, Blob, String>)

        An attribute of type Binary Set. For example:

        "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

      • M — (map<map>)

        An attribute of type Map. For example:

        "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

      • L — (Array<map>)

        An attribute of type List. For example:

        "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

      • NULL — (Boolean)

        An attribute of type Null. For example:

        "NULL": true

      • BOOL — (Boolean)

        An attribute of type Boolean. For example:

        "BOOL": true

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Attributes — (map<map>)

        The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request. Each element consists of an attribute name and an attribute value.

        • S — (String)

          An attribute of type String. For example:

          "S": "Hello"

        • N — (String)

          An attribute of type Number. For example:

          "N": "123.45"

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • B — (Buffer, Typed Array, Blob, String)

          An attribute of type Binary. For example:

          "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

        • SS — (Array<String>)

          An attribute of type String Set. For example:

          "SS": ["Giraffe", "Hippo" ,"Zebra"]

        • NS — (Array<String>)

          An attribute of type Number Set. For example:

          "NS": ["42.2", "-19", "7.5", "3.14"]

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • BS — (Array<Buffer, Typed Array, Blob, String>)

          An attribute of type Binary Set. For example:

          "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

        • M — (map<map>)

          An attribute of type Map. For example:

          "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

        • L — (Array<map>)

          An attribute of type List. For example:

          "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

        • NULL — (Boolean)

          An attribute of type Null. For example:

          "NULL": true

        • BOOL — (Boolean)

          An attribute of type Boolean. For example:

          "BOOL": true

      • ConsumedCapacity — (map)

        The capacity units consumed by the PutItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

        • TableName — (String)

          The name of the table that was affected by the operation.

        • CapacityUnits — (Float)

          The total number of capacity units consumed by the operation.

        • ReadCapacityUnits — (Float)

          The total number of read capacity units consumed by the operation.

        • WriteCapacityUnits — (Float)

          The total number of write capacity units consumed by the operation.

        • Table — (map)

          The amount of throughput consumed on the table affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

        • LocalSecondaryIndexes — (map<map>)

          The amount of throughput consumed on each local index affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

        • GlobalSecondaryIndexes — (map<map>)

          The amount of throughput consumed on each global index affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

      • ItemCollectionMetrics — (map)

        Information about item collections, if any, that were affected by the PutItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.

        Each ItemCollectionMetrics element consists of:

        • ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.

        • SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

          The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

        • ItemCollectionKey — (map<map>)

          The partition key value of the item collection. This value is the same as the partition key value of the item.

          • S — (String)

            An attribute of type String. For example:

            "S": "Hello"

          • N — (String)

            An attribute of type Number. For example:

            "N": "123.45"

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • B — (Buffer, Typed Array, Blob, String)

            An attribute of type Binary. For example:

            "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

          • SS — (Array<String>)

            An attribute of type String Set. For example:

            "SS": ["Giraffe", "Hippo" ,"Zebra"]

          • NS — (Array<String>)

            An attribute of type Number Set. For example:

            "NS": ["42.2", "-19", "7.5", "3.14"]

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • BS — (Array<Buffer, Typed Array, Blob, String>)

            An attribute of type Binary Set. For example:

            "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

          • M — (map<map>)

            An attribute of type Map. For example:

            "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

          • L — (Array<map>)

            An attribute of type List. For example:

            "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

          • NULL — (Boolean)

            An attribute of type Null. For example:

            "NULL": true

          • BOOL — (Boolean)

            An attribute of type Boolean. For example:

            "BOOL": true

        • SizeEstimateRangeGB — (Array<Float>)

          An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

          The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

query(params = {}, callback) ⇒ AWS.Request

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

Use the KeyConditionExpression parameter to provide a specific value for the partition key. The Query operation will return all of the items from the table or index with that partition key value. You can optionally narrow the scope of the Query operation by specifying a sort key value and a comparison operator in KeyConditionExpression. To further refine the Query results, you can optionally provide a FilterExpression. A FilterExpression determines which items within the results should be returned to you. All of the other results are discarded.

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

Note: 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.

Note: 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.

Service Reference:

Examples:

To query an item


/* This example queries items in the Music table. The table has a partition key and sort key (Artist and SongTitle), but this query only specifies the partition key value. It returns song titles by the artist named "No One You Know". */

 var params = {
  ExpressionAttributeValues: {
   ":v1": {
     S: "No One You Know"
    }
  }, 
  KeyConditionExpression: "Artist = :v1", 
  ProjectionExpression: "SongTitle", 
  TableName: "Music"
 };
 dynamodb.query(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ConsumedCapacity: {
    }, 
    Count: 2, 
    Items: [
       {
      "SongTitle": {
        S: "Call Me Today"
       }
     }
    ], 
    ScannedCount: 2
   }
   */
 });

Calling the query operation

var params = {
  TableName: 'STRING_VALUE', /* required */
  AttributesToGet: [
    'STRING_VALUE',
    /* more items */
  ],
  ConditionalOperator: AND | OR,
  ConsistentRead: true || false,
  ExclusiveStartKey: {
    '<AttributeName>': { /* AttributeValue */
      B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
      BOOL: true || false,
      BS: [
        new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
        /* more items */
      ],
      L: [
        /* recursive AttributeValue */,
        /* more items */
      ],
      M: {
        '<AttributeName>': /* recursive AttributeValue */,
        /* '<AttributeName>': ... */
      },
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      NULL: true || false,
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* '<AttributeName>': ... */
  },
  ExpressionAttributeNames: {
    '<ExpressionAttributeNameVariable>': 'STRING_VALUE',
    /* '<ExpressionAttributeNameVariable>': ... */
  },
  ExpressionAttributeValues: {
    '<ExpressionAttributeValueVariable>': { /* AttributeValue */
      B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
      BOOL: true || false,
      BS: [
        new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
        /* more items */
      ],
      L: [
        /* recursive AttributeValue */,
        /* more items */
      ],
      M: {
        '<AttributeName>': /* recursive AttributeValue */,
        /* '<AttributeName>': ... */
      },
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      NULL: true || false,
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* '<ExpressionAttributeValueVariable>': ... */
  },
  FilterExpression: 'STRING_VALUE',
  IndexName: 'STRING_VALUE',
  KeyConditionExpression: 'STRING_VALUE',
  KeyConditions: {
    '<AttributeName>': {
      ComparisonOperator: EQ | NE | IN | LE | LT | GE | GT | BETWEEN | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH, /* required */
      AttributeValueList: [
        { /* AttributeValue */
          B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
          BOOL: true || false,
          BS: [
            new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
            /* more items */
          ],
          L: [
            /* recursive AttributeValue */,
            /* more items */
          ],
          M: {
            '<AttributeName>': /* recursive AttributeValue */,
            /* '<AttributeName>': ... */
          },
          N: 'STRING_VALUE',
          NS: [
            'STRING_VALUE',
            /* more items */
          ],
          NULL: true || false,
          S: 'STRING_VALUE',
          SS: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    /* '<AttributeName>': ... */
  },
  Limit: 'NUMBER_VALUE',
  ProjectionExpression: 'STRING_VALUE',
  QueryFilter: {
    '<AttributeName>': {
      ComparisonOperator: EQ | NE | IN | LE | LT | GE | GT | BETWEEN | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH, /* required */
      AttributeValueList: [
        { /* AttributeValue */
          B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
          BOOL: true || false,
          BS: [
            new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
            /* more items */
          ],
          L: [
            /* recursive AttributeValue */,
            /* more items */
          ],
          M: {
            '<AttributeName>': /* recursive AttributeValue */,
            /* '<AttributeName>': ... */
          },
          N: 'STRING_VALUE',
          NS: [
            'STRING_VALUE',
            /* more items */
          ],
          NULL: true || false,
          S: 'STRING_VALUE',
          SS: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    /* '<AttributeName>': ... */
  },
  ReturnConsumedCapacity: INDEXES | TOTAL | NONE,
  ScanIndexForward: true || false,
  Select: ALL_ATTRIBUTES | ALL_PROJECTED_ATTRIBUTES | SPECIFIC_ATTRIBUTES | COUNT
};
dynamodb.query(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TableName — (String)

      The name of the table containing the requested items.

    • IndexName — (String)

      The name of an index to query. This index can be any local secondary index or global secondary index on the table. Note that if you use the IndexName parameter, you must also provide TableName.

    • Select — (String)

      The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.

      • ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.

      • ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying ALL_ATTRIBUTES.

      • COUNT - Returns the number of matching items, rather than the matching items themselves.

      • SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select.

        If you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.

        If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.

      If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)

      Note: If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
      Possible values include:
      • "ALL_ATTRIBUTES"
      • "ALL_PROJECTED_ATTRIBUTES"
      • "SPECIFIC_ATTRIBUTES"
      • "COUNT"
    • AttributesToGet — (Array<String>)

      This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

    • Limit — (Integer)

      The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.

    • ConsistentRead — (Boolean)

      Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

      Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary index with ConsistentRead set to true, you will receive a ValidationException.

    • KeyConditions — (map<map>)

      This is a legacy parameter. Use KeyConditionExpression instead. For more information, see KeyConditions in the Amazon DynamoDB Developer Guide.

      • AttributeValueList — (Array<map>)

        One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.

        For type Number, value comparisons are numeric.

        String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

        For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

        • S — (String)

          An attribute of type String. For example:

          "S": "Hello"

        • N — (String)

          An attribute of type Number. For example:

          "N": "123.45"

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • B — (Buffer, Typed Array, Blob, String)

          An attribute of type Binary. For example:

          "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

        • SS — (Array<String>)

          An attribute of type String Set. For example:

          "SS": ["Giraffe", "Hippo" ,"Zebra"]

        • NS — (Array<String>)

          An attribute of type Number Set. For example:

          "NS": ["42.2", "-19", "7.5", "3.14"]

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • BS — (Array<Buffer, Typed Array, Blob, String>)

          An attribute of type Binary Set. For example:

          "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

        • M — (map<map>)

          An attribute of type Map. For example:

          "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

        • L — (Array<map>)

          An attribute of type List. For example:

          "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

        • NULL — (Boolean)

          An attribute of type Null. For example:

          "NULL": true

        • BOOL — (Boolean)

          An attribute of type Boolean. For example:

          "BOOL": true

      • ComparisonOperator — required — (String)

        A comparator for evaluating attributes. For example, equals, greater than, less than, etc.

        The following comparison operators are available:

        EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN

        The following are descriptions of each comparison operator.

        • EQ : Equal. EQ is supported for all data types, including lists and maps.

          AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

        • NE : Not equal. NE is supported for all data types, including lists and maps.

          AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

        • LE : Less than or equal.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

        • LT : Less than.

          AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

        • GE : Greater than or equal.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

        • GT : Greater than.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

        • NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including lists and maps.

          Note: This operator tests for the existence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute "a" exists; its data type is not relevant to the NOT_NULL comparison operator.

        • NULL : The attribute does not exist. NULL is supported for all data types, including lists and maps.

          Note: This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute "a" exists; its data type is not relevant to the NULL comparison operator.

        • CONTAINS : Checks for a subsequence, or value in a set.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it finds an exact match with any member of the set.

          CONTAINS is supported for lists: When evaluating "a CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list.

        • NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it does not find an exact match with any member of the set.

          NOT_CONTAINS is supported for lists: When evaluating "a NOT CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list.

        • BEGINS_WITH : Checks for a prefix.

          AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).

        • IN : Checks for matching elements in a list.

          AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true.

        • BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.

          AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}

        For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.

        Possible values include:
        • "EQ"
        • "NE"
        • "IN"
        • "LE"
        • "LT"
        • "GE"
        • "GT"
        • "BETWEEN"
        • "NOT_NULL"
        • "NULL"
        • "CONTAINS"
        • "NOT_CONTAINS"
        • "BEGINS_WITH"
    • QueryFilter — (map<map>)

      This is a legacy parameter. Use FilterExpression instead. For more information, see QueryFilter in the Amazon DynamoDB Developer Guide.

      • AttributeValueList — (Array<map>)

        One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.

        For type Number, value comparisons are numeric.

        String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

        For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

        • S — (String)

          An attribute of type String. For example:

          "S": "Hello"

        • N — (String)

          An attribute of type Number. For example:

          "N": "123.45"

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • B — (Buffer, Typed Array, Blob, String)

          An attribute of type Binary. For example:

          "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

        • SS — (Array<String>)

          An attribute of type String Set. For example:

          "SS": ["Giraffe", "Hippo" ,"Zebra"]

        • NS — (Array<String>)

          An attribute of type Number Set. For example:

          "NS": ["42.2", "-19", "7.5", "3.14"]

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • BS — (Array<Buffer, Typed Array, Blob, String>)

          An attribute of type Binary Set. For example:

          "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

        • M — (map<map>)

          An attribute of type Map. For example:

          "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

        • L — (Array<map>)

          An attribute of type List. For example:

          "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

        • NULL — (Boolean)

          An attribute of type Null. For example:

          "NULL": true

        • BOOL — (Boolean)

          An attribute of type Boolean. For example:

          "BOOL": true

      • ComparisonOperator — required — (String)

        A comparator for evaluating attributes. For example, equals, greater than, less than, etc.

        The following comparison operators are available:

        EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN

        The following are descriptions of each comparison operator.

        • EQ : Equal. EQ is supported for all data types, including lists and maps.

          AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

        • NE : Not equal. NE is supported for all data types, including lists and maps.

          AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

        • LE : Less than or equal.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

        • LT : Less than.

          AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

        • GE : Greater than or equal.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

        • GT : Greater than.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

        • NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including lists and maps.

          Note: This operator tests for the existence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute "a" exists; its data type is not relevant to the NOT_NULL comparison operator.

        • NULL : The attribute does not exist. NULL is supported for all data types, including lists and maps.

          Note: This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute "a" exists; its data type is not relevant to the NULL comparison operator.

        • CONTAINS : Checks for a subsequence, or value in a set.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it finds an exact match with any member of the set.

          CONTAINS is supported for lists: When evaluating "a CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list.

        • NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it does not find an exact match with any member of the set.

          NOT_CONTAINS is supported for lists: When evaluating "a NOT CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list.

        • BEGINS_WITH : Checks for a prefix.

          AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).

        • IN : Checks for matching elements in a list.

          AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true.

        • BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.

          AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}

        For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.

        Possible values include:
        • "EQ"
        • "NE"
        • "IN"
        • "LE"
        • "LT"
        • "GE"
        • "GT"
        • "BETWEEN"
        • "NOT_NULL"
        • "NULL"
        • "CONTAINS"
        • "NOT_CONTAINS"
        • "BEGINS_WITH"
    • ConditionalOperator — (String)

      This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

      Possible values include:
      • "AND"
      • "OR"
    • ScanIndexForward — (Boolean)

      Specifies the order for index traversal: If true (default), the traversal is performed in ascending order; if false, the traversal is performed in descending order.

      Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of UTF-8 bytes. For type Binary, DynamoDB treats each byte of the binary data as unsigned.

      If ScanIndexForward is true, DynamoDB returns the results in the order in which they are stored (by sort key value). This is the default behavior. If ScanIndexForward is false, DynamoDB reads the results in reverse order by sort key value, and then returns the results to the client.

    • ExclusiveStartKey — (map<map>)

      The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

      The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.

      • S — (String)

        An attribute of type String. For example:

        "S": "Hello"

      • N — (String)

        An attribute of type Number. For example:

        "N": "123.45"

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • B — (Buffer, Typed Array, Blob, String)

        An attribute of type Binary. For example:

        "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

      • SS — (Array<String>)

        An attribute of type String Set. For example:

        "SS": ["Giraffe", "Hippo" ,"Zebra"]

      • NS — (Array<String>)

        An attribute of type Number Set. For example:

        "NS": ["42.2", "-19", "7.5", "3.14"]

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • BS — (Array<Buffer, Typed Array, Blob, String>)

        An attribute of type Binary Set. For example:

        "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

      • M — (map<map>)

        An attribute of type Map. For example:

        "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

      • L — (Array<map>)

        An attribute of type List. For example:

        "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

      • NULL — (Boolean)

        An attribute of type Null. For example:

        "NULL": true

      • BOOL — (Boolean)

        An attribute of type Boolean. For example:

        "BOOL": true

    • ReturnConsumedCapacity — (String)

      Determines the level of detail about provisioned throughput consumption that is returned in the response:

      • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

        Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

      • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

      • NONE - No ConsumedCapacity details are included in the response.

      Possible values include:
      • "INDEXES"
      • "TOTAL"
      • "NONE"
    • ProjectionExpression — (String)

      A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

      If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

      For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

    • FilterExpression — (String)

      A string that contains conditions that DynamoDB applies after the Query operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.

      A FilterExpression does not allow key attributes. You cannot define a filter expression based on a partition key or a sort key.

      Note: A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.

      For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.

    • KeyConditionExpression — (String)

      The condition that specifies the key value(s) for items to be retrieved by the Query action.

      The condition must perform an equality test on a single partition key value.

      The condition can optionally perform one of several comparison tests on a single sort key value. This allows Query to retrieve one item with a given partition key value and sort key value, or several items that have the same partition key value but different sort key values.

      The partition key equality test is required, and must be specified in the following format:

      partitionKeyName = :partitionkeyval

      If you also want to provide a condition for the sort key, it must be combined using AND with the condition for the sort key. Following is an example, using the = comparison operator for the sort key:

      partitionKeyName = :partitionkeyval AND sortKeyName = :sortkeyval

      Valid comparisons for the sort key condition are as follows:

      • sortKeyName = :sortkeyval - true if the sort key value is equal to :sortkeyval.

      • sortKeyName < :sortkeyval - true if the sort key value is less than :sortkeyval.

      • sortKeyName <= :sortkeyval - true if the sort key value is less than or equal to :sortkeyval.

      • sortKeyName > :sortkeyval - true if the sort key value is greater than :sortkeyval.

      • sortKeyName >= :sortkeyval - true if the sort key value is greater than or equal to :sortkeyval.

      • sortKeyName BETWEEN :sortkeyval1 AND :sortkeyval2 - true if the sort key value is greater than or equal to :sortkeyval1, and less than or equal to :sortkeyval2.

      • begins_with ( sortKeyName, :sortkeyval ) - true if the sort key value begins with a particular operand. (You cannot use this function with a sort key that is of type Number.) Note that the function name begins_with is case-sensitive.

      Use the ExpressionAttributeValues parameter to replace tokens such as :partitionval and :sortval with actual values at runtime.

      You can optionally use the ExpressionAttributeNames parameter to replace the names of the partition key and sort key with placeholder tokens. This option might be necessary if an attribute name conflicts with a DynamoDB reserved word. For example, the following KeyConditionExpression parameter causes an error because Size is a reserved word:

      • Size = :myval

      To work around this, define a placeholder (such a #S) to represent the attribute name Size. KeyConditionExpression then is as follows:

      • #S = :myval

      For a list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.

      For more information on ExpressionAttributeNames and ExpressionAttributeValues, see Using Placeholders for Attribute Names and Values in the Amazon DynamoDB Developer Guide.

    • ExpressionAttributeNames — (map<String>)

      One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

      • To access an attribute whose name conflicts with a DynamoDB reserved word.

      • To create a placeholder for repeating occurrences of an attribute name in an expression.

      • To prevent special characters in an attribute name from being misinterpreted in an expression.

      Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

      • Percentile

      The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

      • {"#P":"Percentile"}

      You could then use this substitution in an expression, as in this example:

      • #P = :val

      Note: Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

      For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

    • ExpressionAttributeValues — (map<map>)

      One or more values that can be substituted in an expression.

      Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

      Available | Backordered | Discontinued

      You would first need to specify ExpressionAttributeValues as follows:

      { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

      You could then use these values in an expression, such as this:

      ProductStatus IN (:avail, :back, :disc)

      For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

      • S — (String)

        An attribute of type String. For example:

        "S": "Hello"

      • N — (String)

        An attribute of type Number. For example:

        "N": "123.45"

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • B — (Buffer, Typed Array, Blob, String)

        An attribute of type Binary. For example:

        "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

      • SS — (Array<String>)

        An attribute of type String Set. For example:

        "SS": ["Giraffe", "Hippo" ,"Zebra"]

      • NS — (Array<String>)

        An attribute of type Number Set. For example:

        "NS": ["42.2", "-19", "7.5", "3.14"]

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • BS — (Array<Buffer, Typed Array, Blob, String>)

        An attribute of type Binary Set. For example:

        "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

      • M — (map<map>)

        An attribute of type Map. For example:

        "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

      • L — (Array<map>)

        An attribute of type List. For example:

        "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

      • NULL — (Boolean)

        An attribute of type Null. For example:

        "NULL": true

      • BOOL — (Boolean)

        An attribute of type Boolean. For example:

        "BOOL": true

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Items — (Array<map<map>>)

        An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.

        • S — (String)

          An attribute of type String. For example:

          "S": "Hello"

        • N — (String)

          An attribute of type Number. For example:

          "N": "123.45"

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • B — (Buffer, Typed Array, Blob, String)

          An attribute of type Binary. For example:

          "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

        • SS — (Array<String>)

          An attribute of type String Set. For example:

          "SS": ["Giraffe", "Hippo" ,"Zebra"]

        • NS — (Array<String>)

          An attribute of type Number Set. For example:

          "NS": ["42.2", "-19", "7.5", "3.14"]

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • BS — (Array<Buffer, Typed Array, Blob, String>)

          An attribute of type Binary Set. For example:

          "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

        • M — (map<map>)

          An attribute of type Map. For example:

          "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

        • L — (Array<map>)

          An attribute of type List. For example:

          "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

        • NULL — (Boolean)

          An attribute of type Null. For example:

          "NULL": true

        • BOOL — (Boolean)

          An attribute of type Boolean. For example:

          "BOOL": true

      • Count — (Integer)

        The number of items in the response.

        If you used a QueryFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.

        If you did not use a filter in the request, then Count and ScannedCount are the same.

      • ScannedCount — (Integer)

        The number of items evaluated, before any QueryFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Query operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

        If you did not use a filter in the request, then ScannedCount is the same as Count.

      • LastEvaluatedKey — (map<map>)

        The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

        If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.

        If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

        • S — (String)

          An attribute of type String. For example:

          "S": "Hello"

        • N — (String)

          An attribute of type Number. For example:

          "N": "123.45"

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • B — (Buffer, Typed Array, Blob, String)

          An attribute of type Binary. For example:

          "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

        • SS — (Array<String>)

          An attribute of type String Set. For example:

          "SS": ["Giraffe", "Hippo" ,"Zebra"]

        • NS — (Array<String>)

          An attribute of type Number Set. For example:

          "NS": ["42.2", "-19", "7.5", "3.14"]

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • BS — (Array<Buffer, Typed Array, Blob, String>)

          An attribute of type Binary Set. For example:

          "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

        • M — (map<map>)

          An attribute of type Map. For example:

          "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

        • L — (Array<map>)

          An attribute of type List. For example:

          "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

        • NULL — (Boolean)

          An attribute of type Null. For example:

          "NULL": true

        • BOOL — (Boolean)

          An attribute of type Boolean. For example:

          "BOOL": true

      • ConsumedCapacity — (map)

        The capacity units consumed by the Query operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

        • TableName — (String)

          The name of the table that was affected by the operation.

        • CapacityUnits — (Float)

          The total number of capacity units consumed by the operation.

        • ReadCapacityUnits — (Float)

          The total number of read capacity units consumed by the operation.

        • WriteCapacityUnits — (Float)

          The total number of write capacity units consumed by the operation.

        • Table — (map)

          The amount of throughput consumed on the table affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

        • LocalSecondaryIndexes — (map<map>)

          The amount of throughput consumed on each local index affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

        • GlobalSecondaryIndexes — (map<map>)

          The amount of throughput consumed on each global index affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

restoreTableFromBackup(params = {}, callback) ⇒ AWS.Request

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

  • Cloudwatch metrics and alarms

  • Tags

  • Stream settings

  • Time to Live (TTL) settings

Service Reference:

Examples:

Calling the restoreTableFromBackup operation

var params = {
  BackupArn: 'STRING_VALUE', /* required */
  TargetTableName: 'STRING_VALUE' /* required */
};
dynamodb.restoreTableFromBackup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TargetTableName — (String)

      The name of the new table to which the backup must be restored.

    • BackupArn — (String)

      The ARN associated with the backup.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TableDescription — (map)

        The description of the table created from an existing backup.

        • AttributeDefinitions — (Array<map>)

          An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.

          Each AttributeDefinition object in this array is composed of:

          • AttributeName - The name of the attribute.

          • AttributeType - The data type for the attribute.

          • AttributeName — required — (String)

            A name for the attribute.

          • AttributeType — required — (String)

            The data type for the attribute, where:

            • S - the attribute is of type String

            • N - the attribute is of type Number

            • B - the attribute is of type Binary

            Possible values include:
            • "S"
            • "N"
            • "B"
        • TableName — (String)

          The name of the table.

        • KeySchema — (Array<map>)

          The primary key structure for the table. Each KeySchemaElement consists of:

          • AttributeName - The name of the attribute.

          • KeyType - The role of the attribute:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

          For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

          • AttributeName — required — (String)

            The name of a key attribute.

          • KeyType — required — (String)

            The role that this key attribute will assume:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            Possible values include:
            • "HASH"
            • "RANGE"
        • TableStatus — (String)

          The current state of the table:

          • CREATING - The table is being created.

          • UPDATING - The table is being updated.

          • DELETING - The table is being deleted.

          • ACTIVE - The table is ready for use.

          Possible values include:
          • "CREATING"
          • "UPDATING"
          • "DELETING"
          • "ACTIVE"
        • CreationDateTime — (Date)

          The date and time when the table was created, in UNIX epoch time format.

        • ProvisionedThroughput — (map)

          The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

          • LastIncreaseDateTime — (Date)

            The date and time of the last provisioned throughput increase for this table.

          • LastDecreaseDateTime — (Date)

            The date and time of the last provisioned throughput decrease for this table.

          • NumberOfDecreasesToday — (Integer)

            The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

          • ReadCapacityUnits — (Integer)

            The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.

          • WriteCapacityUnits — (Integer)

            The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

        • TableSizeBytes — (Integer)

          The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • ItemCount — (Integer)

          The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • TableArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the table.

        • TableId — (String)

          Unique identifier for the table for which the backup was created.

        • BillingModeSummary — (map)

          Contains the details for the read/write capacity mode.

          • BillingMode — (String)

            Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

            • PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

            • PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

            Possible values include:
            • "PROVISIONED"
            • "PAY_PER_REQUEST"
          • LastUpdateToPayPerRequestDateTime — (Date)

            Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.

        • LocalSecondaryIndexes — (Array<map>)

          Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:

          • IndexName - The name of the local secondary index.

          • KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

          • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

            • ProjectionType - One of the following:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

            • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          If the table is in the DELETING state, no information about indexes will be returned.

          • IndexName — (String)

            Represents the name of the local secondary index.

          • KeySchema — (Array<map>)

            The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            • AttributeName — required — (String)

              The name of a key attribute.

            • KeyType — required — (String)

              The role that this key attribute will assume:

              • HASH - partition key

              • RANGE - sort key

              Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
              Possible values include:
              • "HASH"
              • "RANGE"
          • Projection — (map)

            Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

            • ProjectionType — (String)

              The set of attributes that are projected into the index:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

              Possible values include:
              • "ALL"
              • "KEYS_ONLY"
              • "INCLUDE"
            • NonKeyAttributes — (Array<String>)

              Represents the non-key attribute names which will be projected into the index.

              For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • IndexSizeBytes — (Integer)

            The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • ItemCount — (Integer)

            The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • IndexArn — (String)

            The Amazon Resource Name (ARN) that uniquely identifies the index.

        • GlobalSecondaryIndexes — (Array<map>)

          The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:

          • Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table; it is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.)

          • IndexName - The name of the global secondary index.

          • IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • IndexStatus - The current status of the global secondary index:

            • CREATING - The index is being created.

            • UPDATING - The index is being updated.

            • DELETING - The index is being deleted.

            • ACTIVE - The index is ready for use.

          • ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

          • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

            • ProjectionType - One of the following:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

            • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.

          If the table is in the DELETING state, no information about indexes will be returned.

          • IndexName — (String)

            The name of the global secondary index.

          • KeySchema — (Array<map>)

            The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            • AttributeName — required — (String)

              The name of a key attribute.

            • KeyType — required — (String)

              The role that this key attribute will assume:

              • HASH - partition key

              • RANGE - sort key

              Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
              Possible values include:
              • "HASH"
              • "RANGE"
          • Projection — (map)

            Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

            • ProjectionType — (String)

              The set of attributes that are projected into the index:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

              Possible values include:
              • "ALL"
              • "KEYS_ONLY"
              • "INCLUDE"
            • NonKeyAttributes — (Array<String>)

              Represents the non-key attribute names which will be projected into the index.

              For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • IndexStatus — (String)

            The current state of the global secondary index:

            • CREATING - The index is being created.

            • UPDATING - The index is being updated.

            • DELETING - The index is being deleted.

            • ACTIVE - The index is ready for use.

            Possible values include:
            • "CREATING"
            • "UPDATING"
            • "DELETING"
            • "ACTIVE"
          • Backfilling — (Boolean)

            Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.

            Note: For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
          • ProvisionedThroughput — (map)

            Represents the provisioned throughput settings for the specified global secondary index.

            For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

            • LastIncreaseDateTime — (Date)

              The date and time of the last provisioned throughput increase for this table.

            • LastDecreaseDateTime — (Date)

              The date and time of the last provisioned throughput decrease for this table.

            • NumberOfDecreasesToday — (Integer)

              The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

            • ReadCapacityUnits — (Integer)

              The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.

            • WriteCapacityUnits — (Integer)

              The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

          • IndexSizeBytes — (Integer)

            The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • ItemCount — (Integer)

            The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • IndexArn — (String)

            The Amazon Resource Name (ARN) that uniquely identifies the index.

        • StreamSpecification — (map)

          The current DynamoDB Streams configuration for the table.

          • StreamEnabled — (Boolean)

            Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

          • StreamViewType — (String)

            When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

            • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

            • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

            • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

            • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

            Possible values include:
            • "NEW_IMAGE"
            • "OLD_IMAGE"
            • "NEW_AND_OLD_IMAGES"
            • "KEYS_ONLY"
        • LatestStreamLabel — (String)

          A timestamp, in ISO 8601 format, for this stream.

          Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

          • the AWS customer ID.

          • the table name.

          • the StreamLabel.

        • LatestStreamArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.

        • RestoreSummary — (map)

          Contains details for the restore.

          • SourceBackupArn — (String)

            ARN of the backup from which the table was restored.

          • SourceTableArn — (String)

            ARN of the source table of the backup that is being restored.

          • RestoreDateTime — required — (Date)

            Point in time or source backup time.

          • RestoreInProgress — required — (Boolean)

            Indicates if a restore is in progress or not.

        • SSEDescription — (map)

          The description of the server-side encryption status on the specified table.

          • Status — (String)

            The current state of server-side encryption:

            • ENABLING - Server-side encryption is being enabled.

            • ENABLED - Server-side encryption is enabled.

            • DISABLING - Server-side encryption is being disabled.

            • DISABLED - Server-side encryption is disabled.

            • UPDATING - Server-side encryption is being updated.

            Possible values include:
            • "ENABLING"
            • "ENABLED"
            • "DISABLING"
            • "DISABLED"
            • "UPDATING"
          • SSEType — (String)

            Server-side encryption type:

            • AES256 - Server-side encryption which uses the AES256 algorithm (not applicable).

            • KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).

            Possible values include:
            • "AES256"
            • "KMS"
          • KMSMasterKeyArn — (String)

            The KMS master key ARN used for the KMS encryption.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

restoreTableToPointInTime(params = {}, callback) ⇒ AWS.Request

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

  • Cloudwatch metrics and alarms

  • Tags

  • Stream settings

  • Time to Live (TTL) settings

  • Point in time recovery settings

Service Reference:

Examples:

Calling the restoreTableToPointInTime operation

var params = {
  SourceTableName: 'STRING_VALUE', /* required */
  TargetTableName: 'STRING_VALUE', /* required */
  RestoreDateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  UseLatestRestorableTime: true || false
};
dynamodb.restoreTableToPointInTime(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SourceTableName — (String)

      Name of the source table that is being restored.

    • TargetTableName — (String)

      The name of the new table to which it must be restored to.

    • UseLatestRestorableTime — (Boolean)

      Restore the table to the latest possible time. LatestRestorableDateTime is typically 5 minutes before the current time.

    • RestoreDateTime — (Date)

      Time in the past to restore the table to.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TableDescription — (map)

        Represents the properties of a table.

        • AttributeDefinitions — (Array<map>)

          An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.

          Each AttributeDefinition object in this array is composed of:

          • AttributeName - The name of the attribute.

          • AttributeType - The data type for the attribute.

          • AttributeName — required — (String)

            A name for the attribute.

          • AttributeType — required — (String)

            The data type for the attribute, where:

            • S - the attribute is of type String

            • N - the attribute is of type Number

            • B - the attribute is of type Binary

            Possible values include:
            • "S"
            • "N"
            • "B"
        • TableName — (String)

          The name of the table.

        • KeySchema — (Array<map>)

          The primary key structure for the table. Each KeySchemaElement consists of:

          • AttributeName - The name of the attribute.

          • KeyType - The role of the attribute:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

          For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

          • AttributeName — required — (String)

            The name of a key attribute.

          • KeyType — required — (String)

            The role that this key attribute will assume:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            Possible values include:
            • "HASH"
            • "RANGE"
        • TableStatus — (String)

          The current state of the table:

          • CREATING - The table is being created.

          • UPDATING - The table is being updated.

          • DELETING - The table is being deleted.

          • ACTIVE - The table is ready for use.

          Possible values include:
          • "CREATING"
          • "UPDATING"
          • "DELETING"
          • "ACTIVE"
        • CreationDateTime — (Date)

          The date and time when the table was created, in UNIX epoch time format.

        • ProvisionedThroughput — (map)

          The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

          • LastIncreaseDateTime — (Date)

            The date and time of the last provisioned throughput increase for this table.

          • LastDecreaseDateTime — (Date)

            The date and time of the last provisioned throughput decrease for this table.

          • NumberOfDecreasesToday — (Integer)

            The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

          • ReadCapacityUnits — (Integer)

            The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.

          • WriteCapacityUnits — (Integer)

            The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

        • TableSizeBytes — (Integer)

          The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • ItemCount — (Integer)

          The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • TableArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the table.

        • TableId — (String)

          Unique identifier for the table for which the backup was created.

        • BillingModeSummary — (map)

          Contains the details for the read/write capacity mode.

          • BillingMode — (String)

            Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

            • PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

            • PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

            Possible values include:
            • "PROVISIONED"
            • "PAY_PER_REQUEST"
          • LastUpdateToPayPerRequestDateTime — (Date)

            Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.

        • LocalSecondaryIndexes — (Array<map>)

          Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:

          • IndexName - The name of the local secondary index.

          • KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

          • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

            • ProjectionType - One of the following:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

            • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          If the table is in the DELETING state, no information about indexes will be returned.

          • IndexName — (String)

            Represents the name of the local secondary index.

          • KeySchema — (Array<map>)

            The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            • AttributeName — required — (String)

              The name of a key attribute.

            • KeyType — required — (String)

              The role that this key attribute will assume:

              • HASH - partition key

              • RANGE - sort key

              Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
              Possible values include:
              • "HASH"
              • "RANGE"
          • Projection — (map)

            Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

            • ProjectionType — (String)

              The set of attributes that are projected into the index:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

              Possible values include:
              • "ALL"
              • "KEYS_ONLY"
              • "INCLUDE"
            • NonKeyAttributes — (Array<String>)

              Represents the non-key attribute names which will be projected into the index.

              For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • IndexSizeBytes — (Integer)

            The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • ItemCount — (Integer)

            The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • IndexArn — (String)

            The Amazon Resource Name (ARN) that uniquely identifies the index.

        • GlobalSecondaryIndexes — (Array<map>)

          The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:

          • Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table; it is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.)

          • IndexName - The name of the global secondary index.

          • IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • IndexStatus - The current status of the global secondary index:

            • CREATING - The index is being created.

            • UPDATING - The index is being updated.

            • DELETING - The index is being deleted.

            • ACTIVE - The index is ready for use.

          • ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

          • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

            • ProjectionType - One of the following:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

            • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.

          If the table is in the DELETING state, no information about indexes will be returned.

          • IndexName — (String)

            The name of the global secondary index.

          • KeySchema — (Array<map>)

            The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            • AttributeName — required — (String)

              The name of a key attribute.

            • KeyType — required — (String)

              The role that this key attribute will assume:

              • HASH - partition key

              • RANGE - sort key

              Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
              Possible values include:
              • "HASH"
              • "RANGE"
          • Projection — (map)

            Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

            • ProjectionType — (String)

              The set of attributes that are projected into the index:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

              Possible values include:
              • "ALL"
              • "KEYS_ONLY"
              • "INCLUDE"
            • NonKeyAttributes — (Array<String>)

              Represents the non-key attribute names which will be projected into the index.

              For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • IndexStatus — (String)

            The current state of the global secondary index:

            • CREATING - The index is being created.

            • UPDATING - The index is being updated.

            • DELETING - The index is being deleted.

            • ACTIVE - The index is ready for use.

            Possible values include:
            • "CREATING"
            • "UPDATING"
            • "DELETING"
            • "ACTIVE"
          • Backfilling — (Boolean)

            Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.

            Note: For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
          • ProvisionedThroughput — (map)

            Represents the provisioned throughput settings for the specified global secondary index.

            For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

            • LastIncreaseDateTime — (Date)

              The date and time of the last provisioned throughput increase for this table.

            • LastDecreaseDateTime — (Date)

              The date and time of the last provisioned throughput decrease for this table.

            • NumberOfDecreasesToday — (Integer)

              The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

            • ReadCapacityUnits — (Integer)

              The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.

            • WriteCapacityUnits — (Integer)

              The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

          • IndexSizeBytes — (Integer)

            The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • ItemCount — (Integer)

            The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • IndexArn — (String)

            The Amazon Resource Name (ARN) that uniquely identifies the index.

        • StreamSpecification — (map)

          The current DynamoDB Streams configuration for the table.

          • StreamEnabled — (Boolean)

            Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

          • StreamViewType — (String)

            When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

            • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

            • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

            • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

            • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

            Possible values include:
            • "NEW_IMAGE"
            • "OLD_IMAGE"
            • "NEW_AND_OLD_IMAGES"
            • "KEYS_ONLY"
        • LatestStreamLabel — (String)

          A timestamp, in ISO 8601 format, for this stream.

          Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

          • the AWS customer ID.

          • the table name.

          • the StreamLabel.

        • LatestStreamArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.

        • RestoreSummary — (map)

          Contains details for the restore.

          • SourceBackupArn — (String)

            ARN of the backup from which the table was restored.

          • SourceTableArn — (String)

            ARN of the source table of the backup that is being restored.

          • RestoreDateTime — required — (Date)

            Point in time or source backup time.

          • RestoreInProgress — required — (Boolean)

            Indicates if a restore is in progress or not.

        • SSEDescription — (map)

          The description of the server-side encryption status on the specified table.

          • Status — (String)

            The current state of server-side encryption:

            • ENABLING - Server-side encryption is being enabled.

            • ENABLED - Server-side encryption is enabled.

            • DISABLING - Server-side encryption is being disabled.

            • DISABLED - Server-side encryption is disabled.

            • UPDATING - Server-side encryption is being updated.

            Possible values include:
            • "ENABLING"
            • "ENABLED"
            • "DISABLING"
            • "DISABLED"
            • "UPDATING"
          • SSEType — (String)

            Server-side encryption type:

            • AES256 - Server-side encryption which uses the AES256 algorithm (not applicable).

            • KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).

            Possible values include:
            • "AES256"
            • "KMS"
          • KMSMasterKeyArn — (String)

            The KMS master key ARN used for the KMS encryption.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

scan(params = {}, callback) ⇒ AWS.Request

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 data set size limit of 1 MB, the scan stops and results are returned to the user as a LastEvaluatedKey value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria.

A single Scan 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.

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.

Service Reference:

Examples:

To scan a table


/* This example scans the entire Music table, and then narrows the results to songs by the artist "No One You Know". For each item, only the album title and song title are returned. */

 var params = {
  ExpressionAttributeNames: {
   "AT": "AlbumTitle", 
   "ST": "SongTitle"
  }, 
  ExpressionAttributeValues: {
   ":a": {
     S: "No One You Know"
    }
  }, 
  FilterExpression: "Artist = :a", 
  ProjectionExpression: "#ST, #AT", 
  TableName: "Music"
 };
 dynamodb.scan(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ConsumedCapacity: {
    }, 
    Count: 2, 
    Items: [
       {
      "AlbumTitle": {
        S: "Somewhat Famous"
       }, 
      "SongTitle": {
        S: "Call Me Today"
       }
     }, 
       {
      "AlbumTitle": {
        S: "Blue Sky Blues"
       }, 
      "SongTitle": {
        S: "Scared of My Shadow"
       }
     }
    ], 
    ScannedCount: 3
   }
   */
 });

Calling the scan operation

var params = {
  TableName: 'STRING_VALUE', /* required */
  AttributesToGet: [
    'STRING_VALUE',
    /* more items */
  ],
  ConditionalOperator: AND | OR,
  ConsistentRead: true || false,
  ExclusiveStartKey: {
    '<AttributeName>': { /* AttributeValue */
      B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
      BOOL: true || false,
      BS: [
        new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
        /* more items */
      ],
      L: [
        /* recursive AttributeValue */,
        /* more items */
      ],
      M: {
        '<AttributeName>': /* recursive AttributeValue */,
        /* '<AttributeName>': ... */
      },
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      NULL: true || false,
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* '<AttributeName>': ... */
  },
  ExpressionAttributeNames: {
    '<ExpressionAttributeNameVariable>': 'STRING_VALUE',
    /* '<ExpressionAttributeNameVariable>': ... */
  },
  ExpressionAttributeValues: {
    '<ExpressionAttributeValueVariable>': { /* AttributeValue */
      B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
      BOOL: true || false,
      BS: [
        new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
        /* more items */
      ],
      L: [
        /* recursive AttributeValue */,
        /* more items */
      ],
      M: {
        '<AttributeName>': /* recursive AttributeValue */,
        /* '<AttributeName>': ... */
      },
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      NULL: true || false,
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* '<ExpressionAttributeValueVariable>': ... */
  },
  FilterExpression: 'STRING_VALUE',
  IndexName: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  ProjectionExpression: 'STRING_VALUE',
  ReturnConsumedCapacity: INDEXES | TOTAL | NONE,
  ScanFilter: {
    '<AttributeName>': {
      ComparisonOperator: EQ | NE | IN | LE | LT | GE | GT | BETWEEN | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH, /* required */
      AttributeValueList: [
        { /* AttributeValue */
          B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
          BOOL: true || false,
          BS: [
            new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
            /* more items */
          ],
          L: [
            /* recursive AttributeValue */,
            /* more items */
          ],
          M: {
            '<AttributeName>': /* recursive AttributeValue */,
            /* '<AttributeName>': ... */
          },
          N: 'STRING_VALUE',
          NS: [
            'STRING_VALUE',
            /* more items */
          ],
          NULL: true || false,
          S: 'STRING_VALUE',
          SS: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    /* '<AttributeName>': ... */
  },
  Segment: 'NUMBER_VALUE',
  Select: ALL_ATTRIBUTES | ALL_PROJECTED_ATTRIBUTES | SPECIFIC_ATTRIBUTES | COUNT,
  TotalSegments: 'NUMBER_VALUE'
};
dynamodb.scan(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TableName — (String)

      The name of the table containing the requested items; or, if you provide IndexName, the name of the table to which that index belongs.

    • IndexName — (String)

      The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the IndexName parameter, you must also provide TableName.

    • AttributesToGet — (Array<String>)

      This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

    • Limit — (Integer)

      The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.

    • Select — (String)

      The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.

      • ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.

      • ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying ALL_ATTRIBUTES.

      • COUNT - Returns the number of matching items, rather than the matching items themselves.

      • SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select.

        If you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.

        If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.

      If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)

      Note: If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
      Possible values include:
      • "ALL_ATTRIBUTES"
      • "ALL_PROJECTED_ATTRIBUTES"
      • "SPECIFIC_ATTRIBUTES"
      • "COUNT"
    • ScanFilter — (map<map>)

      This is a legacy parameter. Use FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide.

      • AttributeValueList — (Array<map>)

        One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.

        For type Number, value comparisons are numeric.

        String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

        For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

        • S — (String)

          An attribute of type String. For example:

          "S": "Hello"

        • N — (String)

          An attribute of type Number. For example:

          "N": "123.45"

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • B — (Buffer, Typed Array, Blob, String)

          An attribute of type Binary. For example:

          "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

        • SS — (Array<String>)

          An attribute of type String Set. For example:

          "SS": ["Giraffe", "Hippo" ,"Zebra"]

        • NS — (Array<String>)

          An attribute of type Number Set. For example:

          "NS": ["42.2", "-19", "7.5", "3.14"]

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • BS — (Array<Buffer, Typed Array, Blob, String>)

          An attribute of type Binary Set. For example:

          "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

        • M — (map<map>)

          An attribute of type Map. For example:

          "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

        • L — (Array<map>)

          An attribute of type List. For example:

          "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

        • NULL — (Boolean)

          An attribute of type Null. For example:

          "NULL": true

        • BOOL — (Boolean)

          An attribute of type Boolean. For example:

          "BOOL": true

      • ComparisonOperator — required — (String)

        A comparator for evaluating attributes. For example, equals, greater than, less than, etc.

        The following comparison operators are available:

        EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN

        The following are descriptions of each comparison operator.

        • EQ : Equal. EQ is supported for all data types, including lists and maps.

          AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

        • NE : Not equal. NE is supported for all data types, including lists and maps.

          AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

        • LE : Less than or equal.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

        • LT : Less than.

          AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

        • GE : Greater than or equal.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

        • GT : Greater than.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

        • NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including lists and maps.

          Note: This operator tests for the existence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute "a" exists; its data type is not relevant to the NOT_NULL comparison operator.

        • NULL : The attribute does not exist. NULL is supported for all data types, including lists and maps.

          Note: This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute "a" exists; its data type is not relevant to the NULL comparison operator.

        • CONTAINS : Checks for a subsequence, or value in a set.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it finds an exact match with any member of the set.

          CONTAINS is supported for lists: When evaluating "a CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list.

        • NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it does not find an exact match with any member of the set.

          NOT_CONTAINS is supported for lists: When evaluating "a NOT CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list.

        • BEGINS_WITH : Checks for a prefix.

          AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).

        • IN : Checks for matching elements in a list.

          AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true.

        • BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.

          AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}

        For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.

        Possible values include:
        • "EQ"
        • "NE"
        • "IN"
        • "LE"
        • "LT"
        • "GE"
        • "GT"
        • "BETWEEN"
        • "NOT_NULL"
        • "NULL"
        • "CONTAINS"
        • "NOT_CONTAINS"
        • "BEGINS_WITH"
    • ConditionalOperator — (String)

      This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

      Possible values include:
      • "AND"
      • "OR"
    • ExclusiveStartKey — (map<map>)

      The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

      The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.

      In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.

      • S — (String)

        An attribute of type String. For example:

        "S": "Hello"

      • N — (String)

        An attribute of type Number. For example:

        "N": "123.45"

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • B — (Buffer, Typed Array, Blob, String)

        An attribute of type Binary. For example:

        "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

      • SS — (Array<String>)

        An attribute of type String Set. For example:

        "SS": ["Giraffe", "Hippo" ,"Zebra"]

      • NS — (Array<String>)

        An attribute of type Number Set. For example:

        "NS": ["42.2", "-19", "7.5", "3.14"]

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • BS — (Array<Buffer, Typed Array, Blob, String>)

        An attribute of type Binary Set. For example:

        "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

      • M — (map<map>)

        An attribute of type Map. For example:

        "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

      • L — (Array<map>)

        An attribute of type List. For example:

        "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

      • NULL — (Boolean)

        An attribute of type Null. For example:

        "NULL": true

      • BOOL — (Boolean)

        An attribute of type Boolean. For example:

        "BOOL": true

    • ReturnConsumedCapacity — (String)

      Determines the level of detail about provisioned throughput consumption that is returned in the response:

      • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

        Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

      • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

      • NONE - No ConsumedCapacity details are included in the response.

      Possible values include:
      • "INDEXES"
      • "TOTAL"
      • "NONE"
    • TotalSegments — (Integer)

      For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided. The value of TotalSegments corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a TotalSegments value of 4.

      The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.

      If you specify TotalSegments, you must also specify Segment.

    • Segment — (Integer)

      For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.

      Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.

      The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.

      The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.

      If you provide Segment, you must also provide TotalSegments.

    • ProjectionExpression — (String)

      A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

      If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

      For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

    • FilterExpression — (String)

      A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.

      Note: A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.

      For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.

    • ExpressionAttributeNames — (map<String>)

      One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

      • To access an attribute whose name conflicts with a DynamoDB reserved word.

      • To create a placeholder for repeating occurrences of an attribute name in an expression.

      • To prevent special characters in an attribute name from being misinterpreted in an expression.

      Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

      • Percentile

      The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

      • {"#P":"Percentile"}

      You could then use this substitution in an expression, as in this example:

      • #P = :val

      Note: Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

      For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

    • ExpressionAttributeValues — (map<map>)

      One or more values that can be substituted in an expression.

      Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

      Available | Backordered | Discontinued

      You would first need to specify ExpressionAttributeValues as follows:

      { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

      You could then use these values in an expression, such as this:

      ProductStatus IN (:avail, :back, :disc)

      For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

      • S — (String)

        An attribute of type String. For example:

        "S": "Hello"

      • N — (String)

        An attribute of type Number. For example:

        "N": "123.45"

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • B — (Buffer, Typed Array, Blob, String)

        An attribute of type Binary. For example:

        "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

      • SS — (Array<String>)

        An attribute of type String Set. For example:

        "SS": ["Giraffe", "Hippo" ,"Zebra"]

      • NS — (Array<String>)

        An attribute of type Number Set. For example:

        "NS": ["42.2", "-19", "7.5", "3.14"]

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • BS — (Array<Buffer, Typed Array, Blob, String>)

        An attribute of type Binary Set. For example:

        "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

      • M — (map<map>)

        An attribute of type Map. For example:

        "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

      • L — (Array<map>)

        An attribute of type List. For example:

        "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

      • NULL — (Boolean)

        An attribute of type Null. For example:

        "NULL": true

      • BOOL — (Boolean)

        An attribute of type Boolean. For example:

        "BOOL": true

    • ConsistentRead — (Boolean)

      A Boolean value that determines the read consistency model during the scan:

      • If ConsistentRead is false, then the data returned from Scan might not contain the results from other recently completed write operations (PutItem, UpdateItem or DeleteItem).

      • If ConsistentRead is true, then all of the write operations that completed before the Scan began are guaranteed to be contained in the Scan response.

      The default setting for ConsistentRead is false.

      The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Items — (Array<map<map>>)

        An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.

        • S — (String)

          An attribute of type String. For example:

          "S": "Hello"

        • N — (String)

          An attribute of type Number. For example:

          "N": "123.45"

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • B — (Buffer, Typed Array, Blob, String)

          An attribute of type Binary. For example:

          "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

        • SS — (Array<String>)

          An attribute of type String Set. For example:

          "SS": ["Giraffe", "Hippo" ,"Zebra"]

        • NS — (Array<String>)

          An attribute of type Number Set. For example:

          "NS": ["42.2", "-19", "7.5", "3.14"]

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • BS — (Array<Buffer, Typed Array, Blob, String>)

          An attribute of type Binary Set. For example:

          "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

        • M — (map<map>)

          An attribute of type Map. For example:

          "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

        • L — (Array<map>)

          An attribute of type List. For example:

          "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

        • NULL — (Boolean)

          An attribute of type Null. For example:

          "NULL": true

        • BOOL — (Boolean)

          An attribute of type Boolean. For example:

          "BOOL": true

      • Count — (Integer)

        The number of items in the response.

        If you set ScanFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.

        If you did not use a filter in the request, then Count is the same as ScannedCount.

      • ScannedCount — (Integer)

        The number of items evaluated, before any ScanFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

        If you did not use a filter in the request, then ScannedCount is the same as Count.

      • LastEvaluatedKey — (map<map>)

        The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

        If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.

        If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

        • S — (String)

          An attribute of type String. For example:

          "S": "Hello"

        • N — (String)

          An attribute of type Number. For example:

          "N": "123.45"

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • B — (Buffer, Typed Array, Blob, String)

          An attribute of type Binary. For example:

          "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

        • SS — (Array<String>)

          An attribute of type String Set. For example:

          "SS": ["Giraffe", "Hippo" ,"Zebra"]

        • NS — (Array<String>)

          An attribute of type Number Set. For example:

          "NS": ["42.2", "-19", "7.5", "3.14"]

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • BS — (Array<Buffer, Typed Array, Blob, String>)

          An attribute of type Binary Set. For example:

          "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

        • M — (map<map>)

          An attribute of type Map. For example:

          "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

        • L — (Array<map>)

          An attribute of type List. For example:

          "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

        • NULL — (Boolean)

          An attribute of type Null. For example:

          "NULL": true

        • BOOL — (Boolean)

          An attribute of type Boolean. For example:

          "BOOL": true

      • ConsumedCapacity — (map)

        The capacity units consumed by the Scan operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

        • TableName — (String)

          The name of the table that was affected by the operation.

        • CapacityUnits — (Float)

          The total number of capacity units consumed by the operation.

        • ReadCapacityUnits — (Float)

          The total number of read capacity units consumed by the operation.

        • WriteCapacityUnits — (Float)

          The total number of write capacity units consumed by the operation.

        • Table — (map)

          The amount of throughput consumed on the table affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

        • LocalSecondaryIndexes — (map<map>)

          The amount of throughput consumed on each local index affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

        • GlobalSecondaryIndexes — (map<map>)

          The amount of throughput consumed on each global index affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

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

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

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
dynamodb.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      Identifies the Amazon DynamoDB resource to which tags should be added. This value is an Amazon Resource Name (ARN).

    • Tags — (Array<map>)

      The tags to be assigned to the Amazon DynamoDB resource.

      • Key — required — (String)

        The key of the tag.Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.

      • Value — required — (String)

        The value of the tag. Tag values are case-sensitive and can be null.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

transactGetItems(params = {}, callback) ⇒ AWS.Request

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

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

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

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

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

Service Reference:

Examples:

Calling the transactGetItems operation

var params = {
  TransactItems: [ /* required */
    {
      Get: { /* required */
        Key: { /* required */
          '<AttributeName>': { /* AttributeValue */
            B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
            BOOL: true || false,
            BS: [
              new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
              /* more items */
            ],
            L: [
              /* recursive AttributeValue */,
              /* more items */
            ],
            M: {
              '<AttributeName>': /* recursive AttributeValue */,
              /* '<AttributeName>': ... */
            },
            N: 'STRING_VALUE',
            NS: [
              'STRING_VALUE',
              /* more items */
            ],
            NULL: true || false,
            S: 'STRING_VALUE',
            SS: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          /* '<AttributeName>': ... */
        },
        TableName: 'STRING_VALUE', /* required */
        ExpressionAttributeNames: {
          '<ExpressionAttributeNameVariable>': 'STRING_VALUE',
          /* '<ExpressionAttributeNameVariable>': ... */
        },
        ProjectionExpression: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  ReturnConsumedCapacity: INDEXES | TOTAL | NONE
};
dynamodb.transactGetItems(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransactItems — (Array<map>)

      An ordered array of up to 10 TransactGetItem objects, each of which contains a Get structure.

      • Get — required — (map)

        Contains the primary key that identifies the item to get, together with the name of the table that contains the item, and optionally the specific attributes of the item to retrieve.

        • Key — required — (map<map>)

          A map of attribute names to AttributeValue objects that specifies the primary key of the item to retrieve.

          • S — (String)

            An attribute of type String. For example:

            "S": "Hello"

          • N — (String)

            An attribute of type Number. For example:

            "N": "123.45"

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • B — (Buffer, Typed Array, Blob, String)

            An attribute of type Binary. For example:

            "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

          • SS — (Array<String>)

            An attribute of type String Set. For example:

            "SS": ["Giraffe", "Hippo" ,"Zebra"]

          • NS — (Array<String>)

            An attribute of type Number Set. For example:

            "NS": ["42.2", "-19", "7.5", "3.14"]

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • BS — (Array<Buffer, Typed Array, Blob, String>)

            An attribute of type Binary Set. For example:

            "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

          • M — (map<map>)

            An attribute of type Map. For example:

            "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

          • L — (Array<map>)

            An attribute of type List. For example:

            "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

          • NULL — (Boolean)

            An attribute of type Null. For example:

            "NULL": true

          • BOOL — (Boolean)

            An attribute of type Boolean. For example:

            "BOOL": true

        • TableName — required — (String)

          The name of the table from which to retrieve the specified item.

        • ProjectionExpression — (String)

          A string that identifies one or more attributes of the specified item to retrieve from the table. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes of the specified item are returned. If any of the requested attributes are not found, they do not appear in the result.

        • ExpressionAttributeNames — (map<String>)

          One or more substitution tokens for attribute names in the ProjectionExpression parameter.

    • ReturnConsumedCapacity — (String)

      A value of TOTAL causes consumed capacity information to be returned, and a value of NONE prevents that information from being returned. No other value is valid.

      Possible values include:
      • "INDEXES"
      • "TOTAL"
      • "NONE"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConsumedCapacity — (Array<map>)

        If the ReturnConsumedCapacity value was TOTAL, this is an array of ConsumedCapacity objects, one for each table addressed by TransactGetItem objects in the TransactItems parameter. These ConsumedCapacity objects report the read-capacity units consumed by the TransactGetItems call in that table.

        • TableName — (String)

          The name of the table that was affected by the operation.

        • CapacityUnits — (Float)

          The total number of capacity units consumed by the operation.

        • ReadCapacityUnits — (Float)

          The total number of read capacity units consumed by the operation.

        • WriteCapacityUnits — (Float)

          The total number of write capacity units consumed by the operation.

        • Table — (map)

          The amount of throughput consumed on the table affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

        • LocalSecondaryIndexes — (map<map>)

          The amount of throughput consumed on each local index affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

        • GlobalSecondaryIndexes — (map<map>)

          The amount of throughput consumed on each global index affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

      • Responses — (Array<map>)

        An ordered array of up to 10 ItemResponse objects, each of which corresponds to the TransactGetItem object in the same position in the TransactItems array. Each ItemResponse object contains a Map of the name-value pairs that are the projected attributes of the requested item.

        If a requested item could not be retrieved, the corresponding ItemResponse object is Null, or if the requested item has no projected attributes, the corresponding ItemResponse object is an empty Map.

        • Item — (map<map>)

          Map of attribute data consisting of the data type and attribute value.

          • S — (String)

            An attribute of type String. For example:

            "S": "Hello"

          • N — (String)

            An attribute of type Number. For example:

            "N": "123.45"

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • B — (Buffer, Typed Array, Blob, String)

            An attribute of type Binary. For example:

            "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

          • SS — (Array<String>)

            An attribute of type String Set. For example:

            "SS": ["Giraffe", "Hippo" ,"Zebra"]

          • NS — (Array<String>)

            An attribute of type Number Set. For example:

            "NS": ["42.2", "-19", "7.5", "3.14"]

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • BS — (Array<Buffer, Typed Array, Blob, String>)

            An attribute of type Binary Set. For example:

            "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

          • M — (map<map>)

            An attribute of type Map. For example:

            "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

          • L — (Array<map>)

            An attribute of type List. For example:

            "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

          • NULL — (Boolean)

            An attribute of type Null. For example:

            "NULL": true

          • BOOL — (Boolean)

            An attribute of type Boolean. For example:

            "BOOL": true

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

transactWriteItems(params = {}, callback) ⇒ AWS.Request

TransactWriteItems is a synchronous write operation that groups up to 10 action requests. These actions can target items in different tables, but not in different AWS accounts or regions, and no two actions can target the same item. For example, you cannot both ConditionCheck and Update the same item.

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

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

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

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

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

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

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

  • A conflicting operation is in the process of updating the same item.

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

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

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

Service Reference:

Examples:

Calling the transactWriteItems operation

var params = {
  TransactItems: [ /* required */
    {
      ConditionCheck: {
        ConditionExpression: 'STRING_VALUE', /* required */
        Key: { /* required */
          '<AttributeName>': { /* AttributeValue */
            B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
            BOOL: true || false,
            BS: [
              new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
              /* more items */
            ],
            L: [
              /* recursive AttributeValue */,
              /* more items */
            ],
            M: {
              '<AttributeName>': /* recursive AttributeValue */,
              /* '<AttributeName>': ... */
            },
            N: 'STRING_VALUE',
            NS: [
              'STRING_VALUE',
              /* more items */
            ],
            NULL: true || false,
            S: 'STRING_VALUE',
            SS: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          /* '<AttributeName>': ... */
        },
        TableName: 'STRING_VALUE', /* required */
        ExpressionAttributeNames: {
          '<ExpressionAttributeNameVariable>': 'STRING_VALUE',
          /* '<ExpressionAttributeNameVariable>': ... */
        },
        ExpressionAttributeValues: {
          '<ExpressionAttributeValueVariable>': { /* AttributeValue */
            B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
            BOOL: true || false,
            BS: [
              new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
              /* more items */
            ],
            L: [
              /* recursive AttributeValue */,
              /* more items */
            ],
            M: {
              '<AttributeName>': /* recursive AttributeValue */,
              /* '<AttributeName>': ... */
            },
            N: 'STRING_VALUE',
            NS: [
              'STRING_VALUE',
              /* more items */
            ],
            NULL: true || false,
            S: 'STRING_VALUE',
            SS: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          /* '<ExpressionAttributeValueVariable>': ... */
        },
        ReturnValuesOnConditionCheckFailure: ALL_OLD | NONE
      },
      Delete: {
        Key: { /* required */
          '<AttributeName>': { /* AttributeValue */
            B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
            BOOL: true || false,
            BS: [
              new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
              /* more items */
            ],
            L: [
              /* recursive AttributeValue */,
              /* more items */
            ],
            M: {
              '<AttributeName>': /* recursive AttributeValue */,
              /* '<AttributeName>': ... */
            },
            N: 'STRING_VALUE',
            NS: [
              'STRING_VALUE',
              /* more items */
            ],
            NULL: true || false,
            S: 'STRING_VALUE',
            SS: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          /* '<AttributeName>': ... */
        },
        TableName: 'STRING_VALUE', /* required */
        ConditionExpression: 'STRING_VALUE',
        ExpressionAttributeNames: {
          '<ExpressionAttributeNameVariable>': 'STRING_VALUE',
          /* '<ExpressionAttributeNameVariable>': ... */
        },
        ExpressionAttributeValues: {
          '<ExpressionAttributeValueVariable>': { /* AttributeValue */
            B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
            BOOL: true || false,
            BS: [
              new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
              /* more items */
            ],
            L: [
              /* recursive AttributeValue */,
              /* more items */
            ],
            M: {
              '<AttributeName>': /* recursive AttributeValue */,
              /* '<AttributeName>': ... */
            },
            N: 'STRING_VALUE',
            NS: [
              'STRING_VALUE',
              /* more items */
            ],
            NULL: true || false,
            S: 'STRING_VALUE',
            SS: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          /* '<ExpressionAttributeValueVariable>': ... */
        },
        ReturnValuesOnConditionCheckFailure: ALL_OLD | NONE
      },
      Put: {
        Item: { /* required */
          '<AttributeName>': { /* AttributeValue */
            B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
            BOOL: true || false,
            BS: [
              new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
              /* more items */
            ],
            L: [
              /* recursive AttributeValue */,
              /* more items */
            ],
            M: {
              '<AttributeName>': /* recursive AttributeValue */,
              /* '<AttributeName>': ... */
            },
            N: 'STRING_VALUE',
            NS: [
              'STRING_VALUE',
              /* more items */
            ],
            NULL: true || false,
            S: 'STRING_VALUE',
            SS: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          /* '<AttributeName>': ... */
        },
        TableName: 'STRING_VALUE', /* required */
        ConditionExpression: 'STRING_VALUE',
        ExpressionAttributeNames: {
          '<ExpressionAttributeNameVariable>': 'STRING_VALUE',
          /* '<ExpressionAttributeNameVariable>': ... */
        },
        ExpressionAttributeValues: {
          '<ExpressionAttributeValueVariable>': { /* AttributeValue */
            B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
            BOOL: true || false,
            BS: [
              new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
              /* more items */
            ],
            L: [
              /* recursive AttributeValue */,
              /* more items */
            ],
            M: {
              '<AttributeName>': /* recursive AttributeValue */,
              /* '<AttributeName>': ... */
            },
            N: 'STRING_VALUE',
            NS: [
              'STRING_VALUE',
              /* more items */
            ],
            NULL: true || false,
            S: 'STRING_VALUE',
            SS: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          /* '<ExpressionAttributeValueVariable>': ... */
        },
        ReturnValuesOnConditionCheckFailure: ALL_OLD | NONE
      },
      Update: {
        Key: { /* required */
          '<AttributeName>': { /* AttributeValue */
            B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
            BOOL: true || false,
            BS: [
              new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
              /* more items */
            ],
            L: [
              /* recursive AttributeValue */,
              /* more items */
            ],
            M: {
              '<AttributeName>': /* recursive AttributeValue */,
              /* '<AttributeName>': ... */
            },
            N: 'STRING_VALUE',
            NS: [
              'STRING_VALUE',
              /* more items */
            ],
            NULL: true || false,
            S: 'STRING_VALUE',
            SS: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          /* '<AttributeName>': ... */
        },
        TableName: 'STRING_VALUE', /* required */
        UpdateExpression: 'STRING_VALUE', /* required */
        ConditionExpression: 'STRING_VALUE',
        ExpressionAttributeNames: {
          '<ExpressionAttributeNameVariable>': 'STRING_VALUE',
          /* '<ExpressionAttributeNameVariable>': ... */
        },
        ExpressionAttributeValues: {
          '<ExpressionAttributeValueVariable>': { /* AttributeValue */
            B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
            BOOL: true || false,
            BS: [
              new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
              /* more items */
            ],
            L: [
              /* recursive AttributeValue */,
              /* more items */
            ],
            M: {
              '<AttributeName>': /* recursive AttributeValue */,
              /* '<AttributeName>': ... */
            },
            N: 'STRING_VALUE',
            NS: [
              'STRING_VALUE',
              /* more items */
            ],
            NULL: true || false,
            S: 'STRING_VALUE',
            SS: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          /* '<ExpressionAttributeValueVariable>': ... */
        },
        ReturnValuesOnConditionCheckFailure: ALL_OLD | NONE
      }
    },
    /* more items */
  ],
  ClientRequestToken: 'STRING_VALUE',
  ReturnConsumedCapacity: INDEXES | TOTAL | NONE,
  ReturnItemCollectionMetrics: SIZE | NONE
};
dynamodb.transactWriteItems(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TransactItems — (Array<map>)

      An ordered array of up to 10 TransactWriteItem objects, each of which contains a ConditionCheck, Put, Update, or Delete object. These can operate on items in different tables, but the tables must reside in the same AWS account and region, and no two of them can operate on the same item.

      • ConditionCheck — (map)

        A request to perform a check item operation.

        • Key — required — (map<map>)

          The primary key of the item to be checked. Each element consists of an attribute name and a value for that attribute.

          • S — (String)

            An attribute of type String. For example:

            "S": "Hello"

          • N — (String)

            An attribute of type Number. For example:

            "N": "123.45"

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • B — (Buffer, Typed Array, Blob, String)

            An attribute of type Binary. For example:

            "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

          • SS — (Array<String>)

            An attribute of type String Set. For example:

            "SS": ["Giraffe", "Hippo" ,"Zebra"]

          • NS — (Array<String>)

            An attribute of type Number Set. For example:

            "NS": ["42.2", "-19", "7.5", "3.14"]

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • BS — (Array<Buffer, Typed Array, Blob, String>)

            An attribute of type Binary Set. For example:

            "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

          • M — (map<map>)

            An attribute of type Map. For example:

            "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

          • L — (Array<map>)

            An attribute of type List. For example:

            "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

          • NULL — (Boolean)

            An attribute of type Null. For example:

            "NULL": true

          • BOOL — (Boolean)

            An attribute of type Boolean. For example:

            "BOOL": true

        • TableName — required — (String)

          Name of the table for the check item request.

        • ConditionExpression — required — (String)

          A condition that must be satisfied in order for a conditional update to succeed.

        • ExpressionAttributeNames — (map<String>)

          One or more substitution tokens for attribute names in an expression.

        • ExpressionAttributeValues — (map<map>)

          One or more values that can be substituted in an expression.

          • S — (String)

            An attribute of type String. For example:

            "S": "Hello"

          • N — (String)

            An attribute of type Number. For example:

            "N": "123.45"

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • B — (Buffer, Typed Array, Blob, String)

            An attribute of type Binary. For example:

            "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

          • SS — (Array<String>)

            An attribute of type String Set. For example:

            "SS": ["Giraffe", "Hippo" ,"Zebra"]

          • NS — (Array<String>)

            An attribute of type Number Set. For example:

            "NS": ["42.2", "-19", "7.5", "3.14"]

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • BS — (Array<Buffer, Typed Array, Blob, String>)

            An attribute of type Binary Set. For example:

            "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

          • M — (map<map>)

            An attribute of type Map. For example:

            "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

          • L — (Array<map>)

            An attribute of type List. For example:

            "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

          • NULL — (Boolean)

            An attribute of type Null. For example:

            "NULL": true

          • BOOL — (Boolean)

            An attribute of type Boolean. For example:

            "BOOL": true

        • ReturnValuesOnConditionCheckFailure — (String)

          Use ReturnValuesOnConditionCheckFailure to get the item attributes if the ConditionCheck condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.

          Possible values include:
          • "ALL_OLD"
          • "NONE"
      • Put — (map)

        A request to perform a PutItem operation.

        • Item — required — (map<map>)

          A map of attribute name to attribute values, representing the primary key of the item to be written by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item that are part of an index key schema for the table, their types must match the index key schema.

          • S — (String)

            An attribute of type String. For example:

            "S": "Hello"

          • N — (String)

            An attribute of type Number. For example:

            "N": "123.45"

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • B — (Buffer, Typed Array, Blob, String)

            An attribute of type Binary. For example:

            "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

          • SS — (Array<String>)

            An attribute of type String Set. For example:

            "SS": ["Giraffe", "Hippo" ,"Zebra"]

          • NS — (Array<String>)

            An attribute of type Number Set. For example:

            "NS": ["42.2", "-19", "7.5", "3.14"]

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • BS — (Array<Buffer, Typed Array, Blob, String>)

            An attribute of type Binary Set. For example:

            "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

          • M — (map<map>)

            An attribute of type Map. For example:

            "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

          • L — (Array<map>)

            An attribute of type List. For example:

            "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

          • NULL — (Boolean)

            An attribute of type Null. For example:

            "NULL": true

          • BOOL — (Boolean)

            An attribute of type Boolean. For example:

            "BOOL": true

        • TableName — required — (String)

          Name of the table in which to write the item.

        • ConditionExpression — (String)

          A condition that must be satisfied in order for a conditional update to succeed.

        • ExpressionAttributeNames — (map<String>)

          One or more substitution tokens for attribute names in an expression.

        • ExpressionAttributeValues — (map<map>)

          One or more values that can be substituted in an expression.

          • S — (String)

            An attribute of type String. For example:

            "S": "Hello"

          • N — (String)

            An attribute of type Number. For example:

            "N": "123.45"

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • B — (Buffer, Typed Array, Blob, String)

            An attribute of type Binary. For example:

            "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

          • SS — (Array<String>)

            An attribute of type String Set. For example:

            "SS": ["Giraffe", "Hippo" ,"Zebra"]

          • NS — (Array<String>)

            An attribute of type Number Set. For example:

            "NS": ["42.2", "-19", "7.5", "3.14"]

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • BS — (Array<Buffer, Typed Array, Blob, String>)

            An attribute of type Binary Set. For example:

            "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

          • M — (map<map>)

            An attribute of type Map. For example:

            "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

          • L — (Array<map>)

            An attribute of type List. For example:

            "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

          • NULL — (Boolean)

            An attribute of type Null. For example:

            "NULL": true

          • BOOL — (Boolean)

            An attribute of type Boolean. For example:

            "BOOL": true

        • ReturnValuesOnConditionCheckFailure — (String)

          Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Put condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.

          Possible values include:
          • "ALL_OLD"
          • "NONE"
      • Delete — (map)

        A request to perform a DeleteItem operation.

        • Key — required — (map<map>)

          The primary key of the item to be deleted. Each element consists of an attribute name and a value for that attribute.

          • S — (String)

            An attribute of type String. For example:

            "S": "Hello"

          • N — (String)

            An attribute of type Number. For example:

            "N": "123.45"

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • B — (Buffer, Typed Array, Blob, String)

            An attribute of type Binary. For example:

            "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

          • SS — (Array<String>)

            An attribute of type String Set. For example:

            "SS": ["Giraffe", "Hippo" ,"Zebra"]

          • NS — (Array<String>)

            An attribute of type Number Set. For example:

            "NS": ["42.2", "-19", "7.5", "3.14"]

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • BS — (Array<Buffer, Typed Array, Blob, String>)

            An attribute of type Binary Set. For example:

            "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

          • M — (map<map>)

            An attribute of type Map. For example:

            "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

          • L — (Array<map>)

            An attribute of type List. For example:

            "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

          • NULL — (Boolean)

            An attribute of type Null. For example:

            "NULL": true

          • BOOL — (Boolean)

            An attribute of type Boolean. For example:

            "BOOL": true

        • TableName — required — (String)

          Name of the table in which the item to be deleted resides.

        • ConditionExpression — (String)

          A condition that must be satisfied in order for a conditional delete to succeed.

        • ExpressionAttributeNames — (map<String>)

          One or more substitution tokens for attribute names in an expression.

        • ExpressionAttributeValues — (map<map>)

          One or more values that can be substituted in an expression.

          • S — (String)

            An attribute of type String. For example:

            "S": "Hello"

          • N — (String)

            An attribute of type Number. For example:

            "N": "123.45"

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • B — (Buffer, Typed Array, Blob, String)

            An attribute of type Binary. For example:

            "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

          • SS — (Array<String>)

            An attribute of type String Set. For example:

            "SS": ["Giraffe", "Hippo" ,"Zebra"]

          • NS — (Array<String>)

            An attribute of type Number Set. For example:

            "NS": ["42.2", "-19", "7.5", "3.14"]

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • BS — (Array<Buffer, Typed Array, Blob, String>)

            An attribute of type Binary Set. For example:

            "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

          • M — (map<map>)

            An attribute of type Map. For example:

            "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

          • L — (Array<map>)

            An attribute of type List. For example:

            "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

          • NULL — (Boolean)

            An attribute of type Null. For example:

            "NULL": true

          • BOOL — (Boolean)

            An attribute of type Boolean. For example:

            "BOOL": true

        • ReturnValuesOnConditionCheckFailure — (String)

          Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Delete condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.

          Possible values include:
          • "ALL_OLD"
          • "NONE"
      • Update — (map)

        A request to perform an UpdateItem operation.

        • Key — required — (map<map>)

          The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

          • S — (String)

            An attribute of type String. For example:

            "S": "Hello"

          • N — (String)

            An attribute of type Number. For example:

            "N": "123.45"

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • B — (Buffer, Typed Array, Blob, String)

            An attribute of type Binary. For example:

            "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

          • SS — (Array<String>)

            An attribute of type String Set. For example:

            "SS": ["Giraffe", "Hippo" ,"Zebra"]

          • NS — (Array<String>)

            An attribute of type Number Set. For example:

            "NS": ["42.2", "-19", "7.5", "3.14"]

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • BS — (Array<Buffer, Typed Array, Blob, String>)

            An attribute of type Binary Set. For example:

            "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

          • M — (map<map>)

            An attribute of type Map. For example:

            "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

          • L — (Array<map>)

            An attribute of type List. For example:

            "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

          • NULL — (Boolean)

            An attribute of type Null. For example:

            "NULL": true

          • BOOL — (Boolean)

            An attribute of type Boolean. For example:

            "BOOL": true

        • UpdateExpression — required — (String)

          An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.

        • TableName — required — (String)

          Name of the table for the UpdateItem request.

        • ConditionExpression — (String)

          A condition that must be satisfied in order for a conditional update to succeed.

        • ExpressionAttributeNames — (map<String>)

          One or more substitution tokens for attribute names in an expression.

        • ExpressionAttributeValues — (map<map>)

          One or more values that can be substituted in an expression.

          • S — (String)

            An attribute of type String. For example:

            "S": "Hello"

          • N — (String)

            An attribute of type Number. For example:

            "N": "123.45"

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • B — (Buffer, Typed Array, Blob, String)

            An attribute of type Binary. For example:

            "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

          • SS — (Array<String>)

            An attribute of type String Set. For example:

            "SS": ["Giraffe", "Hippo" ,"Zebra"]

          • NS — (Array<String>)

            An attribute of type Number Set. For example:

            "NS": ["42.2", "-19", "7.5", "3.14"]

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • BS — (Array<Buffer, Typed Array, Blob, String>)

            An attribute of type Binary Set. For example:

            "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

          • M — (map<map>)

            An attribute of type Map. For example:

            "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

          • L — (Array<map>)

            An attribute of type List. For example:

            "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

          • NULL — (Boolean)

            An attribute of type Null. For example:

            "NULL": true

          • BOOL — (Boolean)

            An attribute of type Boolean. For example:

            "BOOL": true

        • ReturnValuesOnConditionCheckFailure — (String)

          Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Update condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW.

          Possible values include:
          • "ALL_OLD"
          • "NONE"
    • ReturnConsumedCapacity — (String)

      Determines the level of detail about provisioned throughput consumption that is returned in the response:

      • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

        Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

      • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

      • NONE - No ConsumedCapacity details are included in the response.

      Possible values include:
      • "INDEXES"
      • "TOTAL"
      • "NONE"
    • ReturnItemCollectionMetrics — (String)

      Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections (if any), that were modified during the operation and are returned in the response. If set to NONE (the default), no statistics are returned.

      Possible values include:
      • "SIZE"
      • "NONE"
    • ClientRequestToken — (String)

      Providing a ClientRequestToken makes the call to TransactWriteItems idempotent, meaning that multiple identical calls have the same effect as one single call.

      Although multiple identical calls using the same client request token produce the same result on the server (no side effects), the responses to the calls may not be the same. If the ReturnConsumedCapacity> parameter is set, then the initial TransactWriteItems call returns the amount of write capacity units consumed in making the changes, and subsequent TransactWriteItems calls with the same client token return the amount of read capacity units consumed in reading the item.

      A client request token is valid for 10 minutes after the first request that uses it completes. After 10 minutes, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 10 minutes or the result may not be idempotent.

      If you submit a request with the same client token but a change in other parameters within the 10 minute idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConsumedCapacity — (Array<map>)

        The capacity units consumed by the entire TransactWriteItems operation. The values of the list are ordered according to the ordering of the TransactItems request parameter.

        • TableName — (String)

          The name of the table that was affected by the operation.

        • CapacityUnits — (Float)

          The total number of capacity units consumed by the operation.

        • ReadCapacityUnits — (Float)

          The total number of read capacity units consumed by the operation.

        • WriteCapacityUnits — (Float)

          The total number of write capacity units consumed by the operation.

        • Table — (map)

          The amount of throughput consumed on the table affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

        • LocalSecondaryIndexes — (map<map>)

          The amount of throughput consumed on each local index affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

        • GlobalSecondaryIndexes — (map<map>)

          The amount of throughput consumed on each global index affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

      • ItemCollectionMetrics — (map<Array<map>>)

        A list of tables that were processed by TransactWriteItems and, for each table, information about any item collections that were affected by individual UpdateItem, PutItem or DeleteItem operations.

        • ItemCollectionKey — (map<map>)

          The partition key value of the item collection. This value is the same as the partition key value of the item.

          • S — (String)

            An attribute of type String. For example:

            "S": "Hello"

          • N — (String)

            An attribute of type Number. For example:

            "N": "123.45"

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • B — (Buffer, Typed Array, Blob, String)

            An attribute of type Binary. For example:

            "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

          • SS — (Array<String>)

            An attribute of type String Set. For example:

            "SS": ["Giraffe", "Hippo" ,"Zebra"]

          • NS — (Array<String>)

            An attribute of type Number Set. For example:

            "NS": ["42.2", "-19", "7.5", "3.14"]

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • BS — (Array<Buffer, Typed Array, Blob, String>)

            An attribute of type Binary Set. For example:

            "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

          • M — (map<map>)

            An attribute of type Map. For example:

            "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

          • L — (Array<map>)

            An attribute of type List. For example:

            "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

          • NULL — (Boolean)

            An attribute of type Null. For example:

            "NULL": true

          • BOOL — (Boolean)

            An attribute of type Boolean. For example:

            "BOOL": true

        • SizeEstimateRangeGB — (Array<Float>)

          An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

          The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

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

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

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
dynamodb.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The Amazon DyanamoDB resource the tags will be removed from. This value is an Amazon Resource Name (ARN).

    • TagKeys — (Array<String>)

      A list of tag keys. Existing tags of the resource whose keys are members of this list will be removed from the Amazon DynamoDB resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateContinuousBackups(params = {}, callback) ⇒ AWS.Request

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

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

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

Service Reference:

Examples:

Calling the updateContinuousBackups operation

var params = {
  PointInTimeRecoverySpecification: { /* required */
    PointInTimeRecoveryEnabled: true || false /* required */
  },
  TableName: 'STRING_VALUE' /* required */
};
dynamodb.updateContinuousBackups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TableName — (String)

      The name of the table.

    • PointInTimeRecoverySpecification — (map)

      Represents the settings used to enable point in time recovery.

      • PointInTimeRecoveryEnabled — required — (Boolean)

        Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ContinuousBackupsDescription — (map)

        Represents the continuous backups and point in time recovery settings on the table.

        • ContinuousBackupsStatus — required — (String)

          ContinuousBackupsStatus can be one of the following states: ENABLED, DISABLED

          Possible values include:
          • "ENABLED"
          • "DISABLED"
        • PointInTimeRecoveryDescription — (map)

          The description of the point in time recovery settings applied to the table.

          • PointInTimeRecoveryStatus — (String)

            The current state of point in time recovery:

            • ENABLING - Point in time recovery is being enabled.

            • ENABLED - Point in time recovery is enabled.

            • DISABLED - Point in time recovery is disabled.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
          • EarliestRestorableDateTime — (Date)

            Specifies the earliest point in time you can restore your table to. It You can restore your table to any point in time during the last 35 days.

          • LatestRestorableDateTime — (Date)

            LatestRestorableDateTime is typically 5 minutes before the current time.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateGlobalTable(params = {}, callback) ⇒ AWS.Request

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

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

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

  • The global secondary indexes must have the same name.

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

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

Service Reference:

Examples:

Calling the updateGlobalTable operation

var params = {
  GlobalTableName: 'STRING_VALUE', /* required */
  ReplicaUpdates: [ /* required */
    {
      Create: {
        RegionName: 'STRING_VALUE' /* required */
      },
      Delete: {
        RegionName: 'STRING_VALUE' /* required */
      }
    },
    /* more items */
  ]
};
dynamodb.updateGlobalTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalTableName — (String)

      The global table name.

    • ReplicaUpdates — (Array<map>)

      A list of regions that should be added or removed from the global table.

      • Create — (map)

        The parameters required for creating a replica on an existing global table.

        • RegionName — required — (String)

          The region of the replica to be added.

      • Delete — (map)

        The name of the existing replica to be removed.

        • RegionName — required — (String)

          The region of the replica to be removed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GlobalTableDescription — (map)

        Contains the details of the global table.

        • ReplicationGroup — (Array<map>)

          The regions where the global table has replicas.

          • RegionName — (String)

            The name of the region.

        • GlobalTableArn — (String)

          The unique identifier of the global table.

        • CreationDateTime — (Date)

          The creation time of the global table.

        • GlobalTableStatus — (String)

          The current state of the global table:

          • CREATING - The global table is being created.

          • UPDATING - The global table is being updated.

          • DELETING - The global table is being deleted.

          • ACTIVE - The global table is ready for use.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "DELETING"
          • "UPDATING"
        • GlobalTableName — (String)

          The global table name.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateGlobalTableSettings(params = {}, callback) ⇒ AWS.Request

Updates settings for a global table.

Service Reference:

Examples:

Calling the updateGlobalTableSettings operation

var params = {
  GlobalTableName: 'STRING_VALUE', /* required */
  GlobalTableBillingMode: PROVISIONED | PAY_PER_REQUEST,
  GlobalTableGlobalSecondaryIndexSettingsUpdate: [
    {
      IndexName: 'STRING_VALUE', /* required */
      ProvisionedWriteCapacityAutoScalingSettingsUpdate: {
        AutoScalingDisabled: true || false,
        AutoScalingRoleArn: 'STRING_VALUE',
        MaximumUnits: 'NUMBER_VALUE',
        MinimumUnits: 'NUMBER_VALUE',
        ScalingPolicyUpdate: {
          TargetTrackingScalingPolicyConfiguration: { /* required */
            TargetValue: 'NUMBER_VALUE', /* required */
            DisableScaleIn: true || false,
            ScaleInCooldown: 'NUMBER_VALUE',
            ScaleOutCooldown: 'NUMBER_VALUE'
          },
          PolicyName: 'STRING_VALUE'
        }
      },
      ProvisionedWriteCapacityUnits: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate: {
    AutoScalingDisabled: true || false,
    AutoScalingRoleArn: 'STRING_VALUE',
    MaximumUnits: 'NUMBER_VALUE',
    MinimumUnits: 'NUMBER_VALUE',
    ScalingPolicyUpdate: {
      TargetTrackingScalingPolicyConfiguration: { /* required */
        TargetValue: 'NUMBER_VALUE', /* required */
        DisableScaleIn: true || false,
        ScaleInCooldown: 'NUMBER_VALUE',
        ScaleOutCooldown: 'NUMBER_VALUE'
      },
      PolicyName: 'STRING_VALUE'
    }
  },
  GlobalTableProvisionedWriteCapacityUnits: 'NUMBER_VALUE',
  ReplicaSettingsUpdate: [
    {
      RegionName: 'STRING_VALUE', /* required */
      ReplicaGlobalSecondaryIndexSettingsUpdate: [
        {
          IndexName: 'STRING_VALUE', /* required */
          ProvisionedReadCapacityAutoScalingSettingsUpdate: {
            AutoScalingDisabled: true || false,
            AutoScalingRoleArn: 'STRING_VALUE',
            MaximumUnits: 'NUMBER_VALUE',
            MinimumUnits: 'NUMBER_VALUE',
            ScalingPolicyUpdate: {
              TargetTrackingScalingPolicyConfiguration: { /* required */
                TargetValue: 'NUMBER_VALUE', /* required */
                DisableScaleIn: true || false,
                ScaleInCooldown: 'NUMBER_VALUE',
                ScaleOutCooldown: 'NUMBER_VALUE'
              },
              PolicyName: 'STRING_VALUE'
            }
          },
          ProvisionedReadCapacityUnits: 'NUMBER_VALUE'
        },
        /* more items */
      ],
      ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate: {
        AutoScalingDisabled: true || false,
        AutoScalingRoleArn: 'STRING_VALUE',
        MaximumUnits: 'NUMBER_VALUE',
        MinimumUnits: 'NUMBER_VALUE',
        ScalingPolicyUpdate: {
          TargetTrackingScalingPolicyConfiguration: { /* required */
            TargetValue: 'NUMBER_VALUE', /* required */
            DisableScaleIn: true || false,
            ScaleInCooldown: 'NUMBER_VALUE',
            ScaleOutCooldown: 'NUMBER_VALUE'
          },
          PolicyName: 'STRING_VALUE'
        }
      },
      ReplicaProvisionedReadCapacityUnits: 'NUMBER_VALUE'
    },
    /* more items */
  ]
};
dynamodb.updateGlobalTableSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalTableName — (String)

      The name of the global table

    • GlobalTableBillingMode — (String)

      The billing mode of the global table. If GlobalTableBillingMode is not specified, the global table defaults to PROVISIONED capacity billing mode.

      Possible values include:
      • "PROVISIONED"
      • "PAY_PER_REQUEST"
    • GlobalTableProvisionedWriteCapacityUnits — (Integer)

      The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

    • GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate — (map)

      AutoScaling settings for managing provisioned write capacity for the global table.

      • MinimumUnits — (Integer)

        The minimum capacity units that a global table or global secondary index should be scaled down to.

      • MaximumUnits — (Integer)

        The maximum capacity units that a global table or global secondary index should be scaled up to.

      • AutoScalingDisabled — (Boolean)

        Disabled autoscaling for this global table or global secondary index.

      • AutoScalingRoleArn — (String)

        Role ARN used for configuring autoscaling policy.

      • ScalingPolicyUpdate — (map)

        The scaling policy to apply for scaling target global table or global secondary index capacity units.

        • PolicyName — (String)

          The name of the scaling policy.

        • TargetTrackingScalingPolicyConfiguration — required — (map)

          Represents a target tracking scaling policy configuration.

          • DisableScaleIn — (Boolean)

            Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

          • ScaleInCooldown — (Integer)

            The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application autoscaling scales out your scalable target immediately.

          • ScaleOutCooldown — (Integer)

            The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.

          • TargetValue — required — (Float)

            The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

    • GlobalTableGlobalSecondaryIndexSettingsUpdate — (Array<map>)

      Represents the settings of a global secondary index for a global table that will be modified.

      • IndexName — required — (String)

        The name of the global secondary index. The name must be unique among all other indexes on this table.

      • ProvisionedWriteCapacityUnits — (Integer)

        The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

      • ProvisionedWriteCapacityAutoScalingSettingsUpdate — (map)

        AutoScaling settings for managing a global secondary index's write capacity units.

        • MinimumUnits — (Integer)

          The minimum capacity units that a global table or global secondary index should be scaled down to.

        • MaximumUnits — (Integer)

          The maximum capacity units that a global table or global secondary index should be scaled up to.

        • AutoScalingDisabled — (Boolean)

          Disabled autoscaling for this global table or global secondary index.

        • AutoScalingRoleArn — (String)

          Role ARN used for configuring autoscaling policy.

        • ScalingPolicyUpdate — (map)

          The scaling policy to apply for scaling target global table or global secondary index capacity units.

          • PolicyName — (String)

            The name of the scaling policy.

          • TargetTrackingScalingPolicyConfiguration — required — (map)

            Represents a target tracking scaling policy configuration.

            • DisableScaleIn — (Boolean)

              Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

            • ScaleInCooldown — (Integer)

              The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application autoscaling scales out your scalable target immediately.

            • ScaleOutCooldown — (Integer)

              The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.

            • TargetValue — required — (Float)

              The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

    • ReplicaSettingsUpdate — (Array<map>)

      Represents the settings for a global table in a region that will be modified.

      • RegionName — required — (String)

        The region of the replica to be added.

      • ReplicaProvisionedReadCapacityUnits — (Integer)

        The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

      • ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate — (map)

        Autoscaling settings for managing a global table replica's read capacity units.

        • MinimumUnits — (Integer)

          The minimum capacity units that a global table or global secondary index should be scaled down to.

        • MaximumUnits — (Integer)

          The maximum capacity units that a global table or global secondary index should be scaled up to.

        • AutoScalingDisabled — (Boolean)

          Disabled autoscaling for this global table or global secondary index.

        • AutoScalingRoleArn — (String)

          Role ARN used for configuring autoscaling policy.

        • ScalingPolicyUpdate — (map)

          The scaling policy to apply for scaling target global table or global secondary index capacity units.

          • PolicyName — (String)

            The name of the scaling policy.

          • TargetTrackingScalingPolicyConfiguration — required — (map)

            Represents a target tracking scaling policy configuration.

            • DisableScaleIn — (Boolean)

              Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

            • ScaleInCooldown — (Integer)

              The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application autoscaling scales out your scalable target immediately.

            • ScaleOutCooldown — (Integer)

              The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.

            • TargetValue — required — (Float)

              The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

      • ReplicaGlobalSecondaryIndexSettingsUpdate — (Array<map>)

        Represents the settings of a global secondary index for a global table that will be modified.

        • IndexName — required — (String)

          The name of the global secondary index. The name must be unique among all other indexes on this table.

        • ProvisionedReadCapacityUnits — (Integer)

          The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

        • ProvisionedReadCapacityAutoScalingSettingsUpdate — (map)

          Autoscaling settings for managing a global secondary index replica's read capacity units.

          • MinimumUnits — (Integer)

            The minimum capacity units that a global table or global secondary index should be scaled down to.

          • MaximumUnits — (Integer)

            The maximum capacity units that a global table or global secondary index should be scaled up to.

          • AutoScalingDisabled — (Boolean)

            Disabled autoscaling for this global table or global secondary index.

          • AutoScalingRoleArn — (String)

            Role ARN used for configuring autoscaling policy.

          • ScalingPolicyUpdate — (map)

            The scaling policy to apply for scaling target global table or global secondary index capacity units.

            • PolicyName — (String)

              The name of the scaling policy.

            • TargetTrackingScalingPolicyConfiguration — required — (map)

              Represents a target tracking scaling policy configuration.

              • DisableScaleIn — (Boolean)

                Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

              • ScaleInCooldown — (Integer)

                The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application autoscaling scales out your scalable target immediately.

              • ScaleOutCooldown — (Integer)

                The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.

              • TargetValue — required — (Float)

                The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GlobalTableName — (String)

        The name of the global table.

      • ReplicaSettings — (Array<map>)

        The region specific settings for the global table.

        • RegionName — required — (String)

          The region name of the replica.

        • ReplicaStatus — (String)

          The current state of the region:

          • CREATING - The region is being created.

          • UPDATING - The region is being updated.

          • DELETING - The region is being deleted.

          • ACTIVE - The region is ready for use.

          Possible values include:
          • "CREATING"
          • "UPDATING"
          • "DELETING"
          • "ACTIVE"
        • ReplicaBillingModeSummary — (map)

          The read/write capacity mode of the replica.

          • BillingMode — (String)

            Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

            • PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

            • PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

            Possible values include:
            • "PROVISIONED"
            • "PAY_PER_REQUEST"
          • LastUpdateToPayPerRequestDateTime — (Date)

            Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.

        • ReplicaProvisionedReadCapacityUnits — (Integer)

          The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

        • ReplicaProvisionedReadCapacityAutoScalingSettings — (map)

          Autoscaling settings for a global table replica's read capacity units.

          • MinimumUnits — (Integer)

            The minimum capacity units that a global table or global secondary index should be scaled down to.

          • MaximumUnits — (Integer)

            The maximum capacity units that a global table or global secondary index should be scaled up to.

          • AutoScalingDisabled — (Boolean)

            Disabled autoscaling for this global table or global secondary index.

          • AutoScalingRoleArn — (String)

            Role ARN used for configuring autoScaling policy.

          • ScalingPolicies — (Array<map>)

            Information about the scaling policies.

            • PolicyName — (String)

              The name of the scaling policy.

            • TargetTrackingScalingPolicyConfiguration — (map)

              Represents a target tracking scaling policy configuration.

              • DisableScaleIn — (Boolean)

                Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

              • ScaleInCooldown — (Integer)

                The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application autoscaling scales out your scalable target immediately.

              • ScaleOutCooldown — (Integer)

                The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.

              • TargetValue — required — (Float)

                The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

        • ReplicaProvisionedWriteCapacityUnits — (Integer)

          The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

        • ReplicaProvisionedWriteCapacityAutoScalingSettings — (map)

          AutoScaling settings for a global table replica's write capacity units.

          • MinimumUnits — (Integer)

            The minimum capacity units that a global table or global secondary index should be scaled down to.

          • MaximumUnits — (Integer)

            The maximum capacity units that a global table or global secondary index should be scaled up to.

          • AutoScalingDisabled — (Boolean)

            Disabled autoscaling for this global table or global secondary index.

          • AutoScalingRoleArn — (String)

            Role ARN used for configuring autoScaling policy.

          • ScalingPolicies — (Array<map>)

            Information about the scaling policies.

            • PolicyName — (String)

              The name of the scaling policy.

            • TargetTrackingScalingPolicyConfiguration — (map)

              Represents a target tracking scaling policy configuration.

              • DisableScaleIn — (Boolean)

                Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

              • ScaleInCooldown — (Integer)

                The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application autoscaling scales out your scalable target immediately.

              • ScaleOutCooldown — (Integer)

                The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.

              • TargetValue — required — (Float)

                The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

        • ReplicaGlobalSecondaryIndexSettings — (Array<map>)

          Replica global secondary index settings for the global table.

          • IndexName — required — (String)

            The name of the global secondary index. The name must be unique among all other indexes on this table.

          • IndexStatus — (String)

            The current status of the global secondary index:

            • CREATING - The global secondary index is being created.

            • UPDATING - The global secondary index is being updated.

            • DELETING - The global secondary index is being deleted.

            • ACTIVE - The global secondary index is ready for use.

            Possible values include:
            • "CREATING"
            • "UPDATING"
            • "DELETING"
            • "ACTIVE"
          • ProvisionedReadCapacityUnits — (Integer)

            The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

          • ProvisionedReadCapacityAutoScalingSettings — (map)

            Autoscaling settings for a global secondary index replica's read capacity units.

            • MinimumUnits — (Integer)

              The minimum capacity units that a global table or global secondary index should be scaled down to.

            • MaximumUnits — (Integer)

              The maximum capacity units that a global table or global secondary index should be scaled up to.

            • AutoScalingDisabled — (Boolean)

              Disabled autoscaling for this global table or global secondary index.

            • AutoScalingRoleArn — (String)

              Role ARN used for configuring autoScaling policy.

            • ScalingPolicies — (Array<map>)

              Information about the scaling policies.

              • PolicyName — (String)

                The name of the scaling policy.

              • TargetTrackingScalingPolicyConfiguration — (map)

                Represents a target tracking scaling policy configuration.

                • DisableScaleIn — (Boolean)

                  Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

                • ScaleInCooldown — (Integer)

                  The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application autoscaling scales out your scalable target immediately.

                • ScaleOutCooldown — (Integer)

                  The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.

                • TargetValue — required — (Float)

                  The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

          • ProvisionedWriteCapacityUnits — (Integer)

            The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

          • ProvisionedWriteCapacityAutoScalingSettings — (map)

            AutoScaling settings for a global secondary index replica's write capacity units.

            • MinimumUnits — (Integer)

              The minimum capacity units that a global table or global secondary index should be scaled down to.

            • MaximumUnits — (Integer)

              The maximum capacity units that a global table or global secondary index should be scaled up to.

            • AutoScalingDisabled — (Boolean)

              Disabled autoscaling for this global table or global secondary index.

            • AutoScalingRoleArn — (String)

              Role ARN used for configuring autoScaling policy.

            • ScalingPolicies — (Array<map>)

              Information about the scaling policies.

              • PolicyName — (String)

                The name of the scaling policy.

              • TargetTrackingScalingPolicyConfiguration — (map)

                Represents a target tracking scaling policy configuration.

                • DisableScaleIn — (Boolean)

                  Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

                • ScaleInCooldown — (Integer)

                  The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application autoscaling scales out your scalable target immediately.

                • ScaleOutCooldown — (Integer)

                  The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.

                • TargetValue — required — (Float)

                  The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateItem(params = {}, callback) ⇒ AWS.Request

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

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

Service Reference:

Examples:

To update an item in a table


/* This example updates an item in the Music table. It adds a new attribute (Year) and modifies the AlbumTitle attribute.  All of the attributes in the item, as they appear after the update, are returned in the response. */

 var params = {
  ExpressionAttributeNames: {
   "#AT": "AlbumTitle", 
   "#Y": "Year"
  }, 
  ExpressionAttributeValues: {
   ":t": {
     S: "Louder Than Ever"
    }, 
   ":y": {
     N: "2015"
    }
  }, 
  Key: {
   "Artist": {
     S: "Acme Band"
    }, 
   "SongTitle": {
     S: "Happy Day"
    }
  }, 
  ReturnValues: "ALL_NEW", 
  TableName: "Music", 
  UpdateExpression: "SET #Y = :y, #AT = :t"
 };
 dynamodb.updateItem(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Attributes: {
     "AlbumTitle": {
       S: "Louder Than Ever"
      }, 
     "Artist": {
       S: "Acme Band"
      }, 
     "SongTitle": {
       S: "Happy Day"
      }, 
     "Year": {
       N: "2015"
      }
    }
   }
   */
 });

Calling the updateItem operation

var params = {
  Key: { /* required */
    '<AttributeName>': { /* AttributeValue */
      B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
      BOOL: true || false,
      BS: [
        new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
        /* more items */
      ],
      L: [
        /* recursive AttributeValue */,
        /* more items */
      ],
      M: {
        '<AttributeName>': /* recursive AttributeValue */,
        /* '<AttributeName>': ... */
      },
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      NULL: true || false,
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* '<AttributeName>': ... */
  },
  TableName: 'STRING_VALUE', /* required */
  AttributeUpdates: {
    '<AttributeName>': {
      Action: ADD | PUT | DELETE,
      Value: { /* AttributeValue */
        B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
        BOOL: true || false,
        BS: [
          new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
          /* more items */
        ],
        L: [
          /* recursive AttributeValue */,
          /* more items */
        ],
        M: {
          '<AttributeName>': /* recursive AttributeValue */,
          /* '<AttributeName>': ... */
        },
        N: 'STRING_VALUE',
        NS: [
          'STRING_VALUE',
          /* more items */
        ],
        NULL: true || false,
        S: 'STRING_VALUE',
        SS: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    /* '<AttributeName>': ... */
  },
  ConditionExpression: 'STRING_VALUE',
  ConditionalOperator: AND | OR,
  Expected: {
    '<AttributeName>': {
      AttributeValueList: [
        { /* AttributeValue */
          B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
          BOOL: true || false,
          BS: [
            new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
            /* more items */
          ],
          L: [
            /* recursive AttributeValue */,
            /* more items */
          ],
          M: {
            '<AttributeName>': /* recursive AttributeValue */,
            /* '<AttributeName>': ... */
          },
          N: 'STRING_VALUE',
          NS: [
            'STRING_VALUE',
            /* more items */
          ],
          NULL: true || false,
          S: 'STRING_VALUE',
          SS: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ],
      ComparisonOperator: EQ | NE | IN | LE | LT | GE | GT | BETWEEN | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH,
      Exists: true || false,
      Value: { /* AttributeValue */
        B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
        BOOL: true || false,
        BS: [
          new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
          /* more items */
        ],
        L: [
          /* recursive AttributeValue */,
          /* more items */
        ],
        M: {
          '<AttributeName>': /* recursive AttributeValue */,
          /* '<AttributeName>': ... */
        },
        N: 'STRING_VALUE',
        NS: [
          'STRING_VALUE',
          /* more items */
        ],
        NULL: true || false,
        S: 'STRING_VALUE',
        SS: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    /* '<AttributeName>': ... */
  },
  ExpressionAttributeNames: {
    '<ExpressionAttributeNameVariable>': 'STRING_VALUE',
    /* '<ExpressionAttributeNameVariable>': ... */
  },
  ExpressionAttributeValues: {
    '<ExpressionAttributeValueVariable>': { /* AttributeValue */
      B: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
      BOOL: true || false,
      BS: [
        new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
        /* more items */
      ],
      L: [
        /* recursive AttributeValue */,
        /* more items */
      ],
      M: {
        '<AttributeName>': /* recursive AttributeValue */,
        /* '<AttributeName>': ... */
      },
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      NULL: true || false,
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* '<ExpressionAttributeValueVariable>': ... */
  },
  ReturnConsumedCapacity: INDEXES | TOTAL | NONE,
  ReturnItemCollectionMetrics: SIZE | NONE,
  ReturnValues: NONE | ALL_OLD | UPDATED_OLD | ALL_NEW | UPDATED_NEW,
  UpdateExpression: 'STRING_VALUE'
};
dynamodb.updateItem(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TableName — (String)

      The name of the table containing the item to update.

    • Key — (map<map>)

      The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

      For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

      • S — (String)

        An attribute of type String. For example:

        "S": "Hello"

      • N — (String)

        An attribute of type Number. For example:

        "N": "123.45"

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • B — (Buffer, Typed Array, Blob, String)

        An attribute of type Binary. For example:

        "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

      • SS — (Array<String>)

        An attribute of type String Set. For example:

        "SS": ["Giraffe", "Hippo" ,"Zebra"]

      • NS — (Array<String>)

        An attribute of type Number Set. For example:

        "NS": ["42.2", "-19", "7.5", "3.14"]

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • BS — (Array<Buffer, Typed Array, Blob, String>)

        An attribute of type Binary Set. For example:

        "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

      • M — (map<map>)

        An attribute of type Map. For example:

        "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

      • L — (Array<map>)

        An attribute of type List. For example:

        "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

      • NULL — (Boolean)

        An attribute of type Null. For example:

        "NULL": true

      • BOOL — (Boolean)

        An attribute of type Boolean. For example:

        "BOOL": true

    • AttributeUpdates — (map<map>)

      This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.

      • Value — (map)

        Represents the data for an attribute.

        Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

        For more information, see Data Types in the Amazon DynamoDB Developer Guide.

        • S — (String)

          An attribute of type String. For example:

          "S": "Hello"

        • N — (String)

          An attribute of type Number. For example:

          "N": "123.45"

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • B — (Buffer, Typed Array, Blob, String)

          An attribute of type Binary. For example:

          "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

        • SS — (Array<String>)

          An attribute of type String Set. For example:

          "SS": ["Giraffe", "Hippo" ,"Zebra"]

        • NS — (Array<String>)

          An attribute of type Number Set. For example:

          "NS": ["42.2", "-19", "7.5", "3.14"]

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • BS — (Array<Buffer, Typed Array, Blob, String>)

          An attribute of type Binary Set. For example:

          "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

        • M — (map<map>)

          An attribute of type Map. For example:

          "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

        • L — (Array<map>)

          An attribute of type List. For example:

          "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

        • NULL — (Boolean)

          An attribute of type Null. For example:

          "NULL": true

        • BOOL — (Boolean)

          An attribute of type Boolean. For example:

          "BOOL": true

      • Action — (String)

        Specifies how to perform the update. Valid values are PUT (default), DELETE, and ADD. The behavior depends on whether the specified primary key already exists in the table.

        If an item with the specified Key is found in the table:

        • PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.

        • DELETE - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.

          If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specified [a,c], then the final attribute value would be [b]. Specifying an empty set is an error.

        • ADD - If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:

          • If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.

            Note: If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value. In addition, if you use ADD to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.

          • If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set [1,2], and the ADD action specified [3], then the final attribute value would be [1,2,3]. An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type.

            Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.

          This action is only valid for an existing attribute whose data type is number or is a set. Do not use ADD for any other data types.

        If no item with the specified Key is found:

        • PUT - DynamoDB creates a new item with the specified primary key, and then adds the attribute.

        • DELETE - Nothing happens; there is no attribute to delete.

        • ADD - DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.

        Possible values include:
        • "ADD"
        • "PUT"
        • "DELETE"
    • Expected — (map<map>)

      This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

      • Value — (map)

        Represents the data for the expected attribute.

        Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

        For more information, see Data Types in the Amazon DynamoDB Developer Guide.

        • S — (String)

          An attribute of type String. For example:

          "S": "Hello"

        • N — (String)

          An attribute of type Number. For example:

          "N": "123.45"

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • B — (Buffer, Typed Array, Blob, String)

          An attribute of type Binary. For example:

          "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

        • SS — (Array<String>)

          An attribute of type String Set. For example:

          "SS": ["Giraffe", "Hippo" ,"Zebra"]

        • NS — (Array<String>)

          An attribute of type Number Set. For example:

          "NS": ["42.2", "-19", "7.5", "3.14"]

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • BS — (Array<Buffer, Typed Array, Blob, String>)

          An attribute of type Binary Set. For example:

          "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

        • M — (map<map>)

          An attribute of type Map. For example:

          "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

        • L — (Array<map>)

          An attribute of type List. For example:

          "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

        • NULL — (Boolean)

          An attribute of type Null. For example:

          "NULL": true

        • BOOL — (Boolean)

          An attribute of type Boolean. For example:

          "BOOL": true

      • Exists — (Boolean)

        Causes DynamoDB to evaluate the value before attempting a conditional operation:

        • If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a ConditionCheckFailedException.

        • If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a ConditionCheckFailedException.

        The default setting for Exists is true. If you supply a Value all by itself, DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied.

        DynamoDB returns a ValidationException if:

        • Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.)

        • Exists is false but you also provide a Value. (You cannot expect an attribute to have a value, while also expecting it not to exist.)

      • ComparisonOperator — (String)

        A comparator for evaluating attributes in the AttributeValueList. For example, equals, greater than, less than, etc.

        The following comparison operators are available:

        EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN

        The following are descriptions of each comparison operator.

        • EQ : Equal. EQ is supported for all data types, including lists and maps.

          AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

        • NE : Not equal. NE is supported for all data types, including lists and maps.

          AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.

        • LE : Less than or equal.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

        • LT : Less than.

          AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

        • GE : Greater than or equal.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

        • GT : Greater than.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

        • NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including lists and maps.

          Note: This operator tests for the existence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute "a" exists; its data type is not relevant to the NOT_NULL comparison operator.

        • NULL : The attribute does not exist. NULL is supported for all data types, including lists and maps.

          Note: This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute "a" exists; its data type is not relevant to the NULL comparison operator.

        • CONTAINS : Checks for a subsequence, or value in a set.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it finds an exact match with any member of the set.

          CONTAINS is supported for lists: When evaluating "a CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list.

        • NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.

          AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it does not find an exact match with any member of the set.

          NOT_CONTAINS is supported for lists: When evaluating "a NOT CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list.

        • BEGINS_WITH : Checks for a prefix.

          AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).

        • IN : Checks for matching elements in a list.

          AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true.

        • BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.

          AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}

        Possible values include:
        • "EQ"
        • "NE"
        • "IN"
        • "LE"
        • "LT"
        • "GE"
        • "GT"
        • "BETWEEN"
        • "NOT_NULL"
        • "NULL"
        • "CONTAINS"
        • "NOT_CONTAINS"
        • "BEGINS_WITH"
      • AttributeValueList — (Array<map>)

        One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.

        For type Number, value comparisons are numeric.

        String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

        For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

        For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.

        • S — (String)

          An attribute of type String. For example:

          "S": "Hello"

        • N — (String)

          An attribute of type Number. For example:

          "N": "123.45"

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • B — (Buffer, Typed Array, Blob, String)

          An attribute of type Binary. For example:

          "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

        • SS — (Array<String>)

          An attribute of type String Set. For example:

          "SS": ["Giraffe", "Hippo" ,"Zebra"]

        • NS — (Array<String>)

          An attribute of type Number Set. For example:

          "NS": ["42.2", "-19", "7.5", "3.14"]

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • BS — (Array<Buffer, Typed Array, Blob, String>)

          An attribute of type Binary Set. For example:

          "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

        • M — (map<map>)

          An attribute of type Map. For example:

          "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

        • L — (Array<map>)

          An attribute of type List. For example:

          "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

        • NULL — (Boolean)

          An attribute of type Null. For example:

          "NULL": true

        • BOOL — (Boolean)

          An attribute of type Boolean. For example:

          "BOOL": true

    • ConditionalOperator — (String)

      This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

      Possible values include:
      • "AND"
      • "OR"
    • ReturnValues — (String)

      Use ReturnValues if you want to get the item attributes as they appear before or after they are updated. For UpdateItem, the valid values are:

      • NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

      • ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.

      • UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.

      • ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.

      • UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.

      There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

      The values returned are strongly consistent.

      Possible values include:
      • "NONE"
      • "ALL_OLD"
      • "UPDATED_OLD"
      • "ALL_NEW"
      • "UPDATED_NEW"
    • ReturnConsumedCapacity — (String)

      Determines the level of detail about provisioned throughput consumption that is returned in the response:

      • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

        Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

      • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

      • NONE - No ConsumedCapacity details are included in the response.

      Possible values include:
      • "INDEXES"
      • "TOTAL"
      • "NONE"
    • ReturnItemCollectionMetrics — (String)

      Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

      Possible values include:
      • "SIZE"
      • "NONE"
    • UpdateExpression — (String)

      An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.

      The following action values are available for UpdateExpression.

      • SET - Adds one or more attributes and values to an item. If any of these attribute already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. For example: SET myNum = myNum + :val

        SET supports the following functions:

        • if_not_exists (path, operand) - if the item does not contain an attribute at the specified path, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.

        • list_append (operand, operand) - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.

        These function names are case-sensitive.

      • REMOVE - Removes one or more attributes from an item.

      • ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:

        • If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.

          Note: If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value. Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.

        • If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.

          Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.

        The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.

      • DELETE - Deletes an element from a set.

        If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.

        The DELETE action only supports set data types. In addition, DELETE can only be used on top-level attributes, not nested attributes.

      You can have many actions in a single expression, such as the following: SET a=:value1, b=:value2 DELETE :value3, :value4, :value5

      For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.

    • ConditionExpression — (String)

      A condition that must be satisfied in order for a conditional update to succeed.

      An expression can contain any of the following:

      • Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

        These function names are case-sensitive.

      • Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

      • Logical operators: AND | OR | NOT

      For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

    • ExpressionAttributeNames — (map<String>)

      One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

      • To access an attribute whose name conflicts with a DynamoDB reserved word.

      • To create a placeholder for repeating occurrences of an attribute name in an expression.

      • To prevent special characters in an attribute name from being misinterpreted in an expression.

      Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

      • Percentile

      The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

      • {"#P":"Percentile"}

      You could then use this substitution in an expression, as in this example:

      • #P = :val

      Note: Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

      For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

    • ExpressionAttributeValues — (map<map>)

      One or more values that can be substituted in an expression.

      Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

      Available | Backordered | Discontinued

      You would first need to specify ExpressionAttributeValues as follows:

      { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

      You could then use these values in an expression, such as this:

      ProductStatus IN (:avail, :back, :disc)

      For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

      • S — (String)

        An attribute of type String. For example:

        "S": "Hello"

      • N — (String)

        An attribute of type Number. For example:

        "N": "123.45"

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • B — (Buffer, Typed Array, Blob, String)

        An attribute of type Binary. For example:

        "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

      • SS — (Array<String>)

        An attribute of type String Set. For example:

        "SS": ["Giraffe", "Hippo" ,"Zebra"]

      • NS — (Array<String>)

        An attribute of type Number Set. For example:

        "NS": ["42.2", "-19", "7.5", "3.14"]

        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

      • BS — (Array<Buffer, Typed Array, Blob, String>)

        An attribute of type Binary Set. For example:

        "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

      • M — (map<map>)

        An attribute of type Map. For example:

        "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

      • L — (Array<map>)

        An attribute of type List. For example:

        "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

      • NULL — (Boolean)

        An attribute of type Null. For example:

        "NULL": true

      • BOOL — (Boolean)

        An attribute of type Boolean. For example:

        "BOOL": true

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Attributes — (map<map>)

        A map of attribute values as they appear before or after the UpdateItem operation, as determined by the ReturnValues parameter.

        The Attributes map is only present if ReturnValues was specified as something other than NONE in the request. Each element represents one attribute.

        • S — (String)

          An attribute of type String. For example:

          "S": "Hello"

        • N — (String)

          An attribute of type Number. For example:

          "N": "123.45"

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • B — (Buffer, Typed Array, Blob, String)

          An attribute of type Binary. For example:

          "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

        • SS — (Array<String>)

          An attribute of type String Set. For example:

          "SS": ["Giraffe", "Hippo" ,"Zebra"]

        • NS — (Array<String>)

          An attribute of type Number Set. For example:

          "NS": ["42.2", "-19", "7.5", "3.14"]

          Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

        • BS — (Array<Buffer, Typed Array, Blob, String>)

          An attribute of type Binary Set. For example:

          "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

        • M — (map<map>)

          An attribute of type Map. For example:

          "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

        • L — (Array<map>)

          An attribute of type List. For example:

          "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

        • NULL — (Boolean)

          An attribute of type Null. For example:

          "NULL": true

        • BOOL — (Boolean)

          An attribute of type Boolean. For example:

          "BOOL": true

      • ConsumedCapacity — (map)

        The capacity units consumed by the UpdateItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

        • TableName — (String)

          The name of the table that was affected by the operation.

        • CapacityUnits — (Float)

          The total number of capacity units consumed by the operation.

        • ReadCapacityUnits — (Float)

          The total number of read capacity units consumed by the operation.

        • WriteCapacityUnits — (Float)

          The total number of write capacity units consumed by the operation.

        • Table — (map)

          The amount of throughput consumed on the table affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

        • LocalSecondaryIndexes — (map<map>)

          The amount of throughput consumed on each local index affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

        • GlobalSecondaryIndexes — (map<map>)

          The amount of throughput consumed on each global index affected by the operation.

          • ReadCapacityUnits — (Float)

            The total number of read capacity units consumed on a table or an index.

          • WriteCapacityUnits — (Float)

            The total number of write capacity units consumed on a table or an index.

          • CapacityUnits — (Float)

            The total number of capacity units consumed on a table or an index.

      • ItemCollectionMetrics — (map)

        Information about item collections, if any, that were affected by the UpdateItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.

        Each ItemCollectionMetrics element consists of:

        • ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.

        • SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

          The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

        • ItemCollectionKey — (map<map>)

          The partition key value of the item collection. This value is the same as the partition key value of the item.

          • S — (String)

            An attribute of type String. For example:

            "S": "Hello"

          • N — (String)

            An attribute of type Number. For example:

            "N": "123.45"

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • B — (Buffer, Typed Array, Blob, String)

            An attribute of type Binary. For example:

            "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

          • SS — (Array<String>)

            An attribute of type String Set. For example:

            "SS": ["Giraffe", "Hippo" ,"Zebra"]

          • NS — (Array<String>)

            An attribute of type Number Set. For example:

            "NS": ["42.2", "-19", "7.5", "3.14"]

            Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

          • BS — (Array<Buffer, Typed Array, Blob, String>)

            An attribute of type Binary Set. For example:

            "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

          • M — (map<map>)

            An attribute of type Map. For example:

            "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

          • L — (Array<map>)

            An attribute of type List. For example:

            "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

          • NULL — (Boolean)

            An attribute of type Null. For example:

            "NULL": true

          • BOOL — (Boolean)

            An attribute of type Boolean. For example:

            "BOOL": true

        • SizeEstimateRangeGB — (Array<Float>)

          An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

          The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateTable(params = {}, callback) ⇒ AWS.Request

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

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

  • Modify the provisioned throughput settings of the table.

  • Enable or disable Streams on the table.

  • Remove a global secondary index from the table.

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

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

Service Reference:

Examples:

To modify a table's provisioned throughput


/* This example increases the provisioned read and write capacity on the Music table. */

 var params = {
  ProvisionedThroughput: {
   ReadCapacityUnits: 10, 
   WriteCapacityUnits: 10
  }, 
  TableName: "MusicCollection"
 };
 dynamodb.updateTable(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    TableDescription: {
     AttributeDefinitions: [
        {
       AttributeName: "Artist", 
       AttributeType: "S"
      }, 
        {
       AttributeName: "SongTitle", 
       AttributeType: "S"
      }
     ], 
     CreationDateTime: <Date Representation>, 
     ItemCount: 0, 
     KeySchema: [
        {
       AttributeName: "Artist", 
       KeyType: "HASH"
      }, 
        {
       AttributeName: "SongTitle", 
       KeyType: "RANGE"
      }
     ], 
     ProvisionedThroughput: {
      LastIncreaseDateTime: <Date Representation>, 
      NumberOfDecreasesToday: 1, 
      ReadCapacityUnits: 1, 
      WriteCapacityUnits: 1
     }, 
     TableName: "MusicCollection", 
     TableSizeBytes: 0, 
     TableStatus: "UPDATING"
    }
   }
   */
 });

Calling the updateTable operation

var params = {
  TableName: 'STRING_VALUE', /* required */
  AttributeDefinitions: [
    {
      AttributeName: 'STRING_VALUE', /* required */
      AttributeType: S | N | B /* required */
    },
    /* more items */
  ],
  BillingMode: PROVISIONED | PAY_PER_REQUEST,
  GlobalSecondaryIndexUpdates: [
    {
      Create: {
        IndexName: 'STRING_VALUE', /* required */
        KeySchema: [ /* required */
          {
            AttributeName: 'STRING_VALUE', /* required */
            KeyType: HASH | RANGE /* required */
          },
          /* more items */
        ],
        Projection: { /* required */
          NonKeyAttributes: [
            'STRING_VALUE',
            /* more items */
          ],
          ProjectionType: ALL | KEYS_ONLY | INCLUDE
        },
        ProvisionedThroughput: {
          ReadCapacityUnits: 'NUMBER_VALUE', /* required */
          WriteCapacityUnits: 'NUMBER_VALUE' /* required */
        }
      },
      Delete: {
        IndexName: 'STRING_VALUE' /* required */
      },
      Update: {
        IndexName: 'STRING_VALUE', /* required */
        ProvisionedThroughput: { /* required */
          ReadCapacityUnits: 'NUMBER_VALUE', /* required */
          WriteCapacityUnits: 'NUMBER_VALUE' /* required */
        }
      }
    },
    /* more items */
  ],
  ProvisionedThroughput: {
    ReadCapacityUnits: 'NUMBER_VALUE', /* required */
    WriteCapacityUnits: 'NUMBER_VALUE' /* required */
  },
  SSESpecification: {
    Enabled: true || false,
    KMSMasterKeyId: 'STRING_VALUE',
    SSEType: AES256 | KMS
  },
  StreamSpecification: {
    StreamEnabled: true || false,
    StreamViewType: NEW_IMAGE | OLD_IMAGE | NEW_AND_OLD_IMAGES | KEYS_ONLY
  }
};
dynamodb.updateTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AttributeDefinitions — (Array<map>)

      An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.

      • AttributeName — required — (String)

        A name for the attribute.

      • AttributeType — required — (String)

        The data type for the attribute, where:

        • S - the attribute is of type String

        • N - the attribute is of type Number

        • B - the attribute is of type Binary

        Possible values include:
        • "S"
        • "N"
        • "B"
    • TableName — (String)

      The name of the table to be updated.

    • BillingMode — (String)

      Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.

      • PROVISIONED - Sets the billing mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

      • PAY_PER_REQUEST - Sets the billing mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

      Possible values include:
      • "PROVISIONED"
      • "PAY_PER_REQUEST"
    • ProvisionedThroughput — (map)

      The new provisioned throughput settings for the specified table or index.

      • ReadCapacityUnits — required — (Integer)

        The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

        If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

      • WriteCapacityUnits — required — (Integer)

        The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

        If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

    • GlobalSecondaryIndexUpdates — (Array<map>)

      An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:

      • Create - add a new global secondary index to the table.

      • Update - modify the provisioned throughput settings of an existing global secondary index.

      • Delete - remove a global secondary index from the table.

      For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.

      • Update — (map)

        The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.

        • IndexName — required — (String)

          The name of the global secondary index to be updated.

        • ProvisionedThroughput — required — (map)

          Represents the provisioned throughput settings for the specified global secondary index.

          For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

          • ReadCapacityUnits — required — (Integer)

            The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

            If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

          • WriteCapacityUnits — required — (Integer)

            The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

            If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

      • Create — (map)

        The parameters required for creating a global secondary index on an existing table:

        • IndexName

        • KeySchema

        • AttributeDefinitions

        • Projection

        • ProvisionedThroughput

        • IndexName — required — (String)

          The name of the global secondary index to be created.

        • KeySchema — required — (Array<map>)

          The key schema for the global secondary index.

          • AttributeName — required — (String)

            The name of a key attribute.

          • KeyType — required — (String)

            The role that this key attribute will assume:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            Possible values include:
            • "HASH"
            • "RANGE"
        • Projection — required — (map)

          Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

          • ProjectionType — (String)

            The set of attributes that are projected into the index:

            • KEYS_ONLY - Only the index and primary keys are projected into the index.

            • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

            • ALL - All of the table attributes are projected into the index.

            Possible values include:
            • "ALL"
            • "KEYS_ONLY"
            • "INCLUDE"
          • NonKeyAttributes — (Array<String>)

            Represents the non-key attribute names which will be projected into the index.

            For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

        • ProvisionedThroughput — (map)

          Represents the provisioned throughput settings for the specified global secondary index.

          For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

          • ReadCapacityUnits — required — (Integer)

            The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

            If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

          • WriteCapacityUnits — required — (Integer)

            The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

            If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

      • Delete — (map)

        The name of an existing global secondary index to be removed.

        • IndexName — required — (String)

          The name of the global secondary index to be deleted.

    • StreamSpecification — (map)

      Represents the DynamoDB Streams configuration for the table.

      Note: You will receive a ResourceInUseException if you attempt to enable a stream on a table that already has a stream, or if you attempt to disable a stream on a table which does not have a stream.
      • StreamEnabled — (Boolean)

        Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

      • StreamViewType — (String)

        When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

        • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

        • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

        • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

        • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

        Possible values include:
        • "NEW_IMAGE"
        • "OLD_IMAGE"
        • "NEW_AND_OLD_IMAGES"
        • "KEYS_ONLY"
    • SSESpecification — (map)

      The new server-side encryption settings for the specified table.

      • Enabled — (Boolean)

        Indicates whether server-side encryption is enabled (true) or disabled (false) on the table. If enabled (true), server-side encryption type is set to KMS. If disabled (false) or not specified, server-side encryption is set to AWS owned CMK.

      • SSEType — (String)

        Server-side encryption type:

        • AES256 - Server-side encryption which uses the AES256 algorithm (not applicable).

        • KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).

        Possible values include:
        • "AES256"
        • "KMS"
      • KMSMasterKeyId — (String)

        The KMS Master Key (CMK) which should be used for the KMS encryption. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB KMS Master Key alias/aws/dynamodb.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TableDescription — (map)

        Represents the properties of the table.

        • AttributeDefinitions — (Array<map>)

          An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.

          Each AttributeDefinition object in this array is composed of:

          • AttributeName - The name of the attribute.

          • AttributeType - The data type for the attribute.

          • AttributeName — required — (String)

            A name for the attribute.

          • AttributeType — required — (String)

            The data type for the attribute, where:

            • S - the attribute is of type String

            • N - the attribute is of type Number

            • B - the attribute is of type Binary

            Possible values include:
            • "S"
            • "N"
            • "B"
        • TableName — (String)

          The name of the table.

        • KeySchema — (Array<map>)

          The primary key structure for the table. Each KeySchemaElement consists of:

          • AttributeName - The name of the attribute.

          • KeyType - The role of the attribute:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

          For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

          • AttributeName — required — (String)

            The name of a key attribute.

          • KeyType — required — (String)

            The role that this key attribute will assume:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            Possible values include:
            • "HASH"
            • "RANGE"
        • TableStatus — (String)

          The current state of the table:

          • CREATING - The table is being created.

          • UPDATING - The table is being updated.

          • DELETING - The table is being deleted.

          • ACTIVE - The table is ready for use.

          Possible values include:
          • "CREATING"
          • "UPDATING"
          • "DELETING"
          • "ACTIVE"
        • CreationDateTime — (Date)

          The date and time when the table was created, in UNIX epoch time format.

        • ProvisionedThroughput — (map)

          The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

          • LastIncreaseDateTime — (Date)

            The date and time of the last provisioned throughput increase for this table.

          • LastDecreaseDateTime — (Date)

            The date and time of the last provisioned throughput decrease for this table.

          • NumberOfDecreasesToday — (Integer)

            The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

          • ReadCapacityUnits — (Integer)

            The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.

          • WriteCapacityUnits — (Integer)

            The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

        • TableSizeBytes — (Integer)

          The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • ItemCount — (Integer)

          The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • TableArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the table.

        • TableId — (String)

          Unique identifier for the table for which the backup was created.

        • BillingModeSummary — (map)

          Contains the details for the read/write capacity mode.

          • BillingMode — (String)

            Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

            • PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

            • PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

            Possible values include:
            • "PROVISIONED"
            • "PAY_PER_REQUEST"
          • LastUpdateToPayPerRequestDateTime — (Date)

            Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.

        • LocalSecondaryIndexes — (Array<map>)

          Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:

          • IndexName - The name of the local secondary index.

          • KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

          • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

            • ProjectionType - One of the following:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

            • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          If the table is in the DELETING state, no information about indexes will be returned.

          • IndexName — (String)

            Represents the name of the local secondary index.

          • KeySchema — (Array<map>)

            The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            • AttributeName — required — (String)

              The name of a key attribute.

            • KeyType — required — (String)

              The role that this key attribute will assume:

              • HASH - partition key

              • RANGE - sort key

              Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
              Possible values include:
              • "HASH"
              • "RANGE"
          • Projection — (map)

            Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

            • ProjectionType — (String)

              The set of attributes that are projected into the index:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

              Possible values include:
              • "ALL"
              • "KEYS_ONLY"
              • "INCLUDE"
            • NonKeyAttributes — (Array<String>)

              Represents the non-key attribute names which will be projected into the index.

              For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • IndexSizeBytes — (Integer)

            The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • ItemCount — (Integer)

            The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • IndexArn — (String)

            The Amazon Resource Name (ARN) that uniquely identifies the index.

        • GlobalSecondaryIndexes — (Array<map>)

          The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:

          • Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table; it is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.)

          • IndexName - The name of the global secondary index.

          • IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • IndexStatus - The current status of the global secondary index:

            • CREATING - The index is being created.

            • UPDATING - The index is being updated.

            • DELETING - The index is being deleted.

            • ACTIVE - The index is ready for use.

          • ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

          • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

            • ProjectionType - One of the following:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

            • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.

          If the table is in the DELETING state, no information about indexes will be returned.

          • IndexName — (String)

            The name of the global secondary index.

          • KeySchema — (Array<map>)

            The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            • AttributeName — required — (String)

              The name of a key attribute.

            • KeyType — required — (String)

              The role that this key attribute will assume:

              • HASH - partition key

              • RANGE - sort key

              Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
              Possible values include:
              • "HASH"
              • "RANGE"
          • Projection — (map)

            Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

            • ProjectionType — (String)

              The set of attributes that are projected into the index:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

              Possible values include:
              • "ALL"
              • "KEYS_ONLY"
              • "INCLUDE"
            • NonKeyAttributes — (Array<String>)

              Represents the non-key attribute names which will be projected into the index.

              For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • IndexStatus — (String)

            The current state of the global secondary index:

            • CREATING - The index is being created.

            • UPDATING - The index is being updated.

            • DELETING - The index is being deleted.

            • ACTIVE - The index is ready for use.

            Possible values include:
            • "CREATING"
            • "UPDATING"
            • "DELETING"
            • "ACTIVE"
          • Backfilling — (Boolean)

            Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.

            Note: For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
          • ProvisionedThroughput — (map)

            Represents the provisioned throughput settings for the specified global secondary index.

            For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

            • LastIncreaseDateTime — (Date)

              The date and time of the last provisioned throughput increase for this table.

            • LastDecreaseDateTime — (Date)

              The date and time of the last provisioned throughput decrease for this table.

            • NumberOfDecreasesToday — (Integer)

              The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

            • ReadCapacityUnits — (Integer)

              The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.

            • WriteCapacityUnits — (Integer)

              The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

          • IndexSizeBytes — (Integer)

            The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • ItemCount — (Integer)

            The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • IndexArn — (String)

            The Amazon Resource Name (ARN) that uniquely identifies the index.

        • StreamSpecification — (map)

          The current DynamoDB Streams configuration for the table.

          • StreamEnabled — (Boolean)

            Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

          • StreamViewType — (String)

            When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

            • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

            • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

            • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

            • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

            Possible values include:
            • "NEW_IMAGE"
            • "OLD_IMAGE"
            • "NEW_AND_OLD_IMAGES"
            • "KEYS_ONLY"
        • LatestStreamLabel — (String)

          A timestamp, in ISO 8601 format, for this stream.

          Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

          • the AWS customer ID.

          • the table name.

          • the StreamLabel.

        • LatestStreamArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.

        • RestoreSummary — (map)

          Contains details for the restore.

          • SourceBackupArn — (String)

            ARN of the backup from which the table was restored.

          • SourceTableArn — (String)

            ARN of the source table of the backup that is being restored.

          • RestoreDateTime — required — (Date)

            Point in time or source backup time.

          • RestoreInProgress — required — (Boolean)

            Indicates if a restore is in progress or not.

        • SSEDescription — (map)

          The description of the server-side encryption status on the specified table.

          • Status — (String)

            The current state of server-side encryption:

            • ENABLING - Server-side encryption is being enabled.

            • ENABLED - Server-side encryption is enabled.

            • DISABLING - Server-side encryption is being disabled.

            • DISABLED - Server-side encryption is disabled.

            • UPDATING - Server-side encryption is being updated.

            Possible values include:
            • "ENABLING"
            • "ENABLED"
            • "DISABLING"
            • "DISABLED"
            • "UPDATING"
          • SSEType — (String)

            Server-side encryption type:

            • AES256 - Server-side encryption which uses the AES256 algorithm (not applicable).

            • KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).

            Possible values include:
            • "AES256"
            • "KMS"
          • KMSMasterKeyArn — (String)

            The KMS master key ARN used for the KMS encryption.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateTimeToLive(params = {}, callback) ⇒ AWS.Request

The UpdateTimeToLive method will enable or disable TTL for the specified table. A successful UpdateTimeToLive call returns the current TimeToLiveSpecification; it may take up to one hour for the change to fully process. Any additional UpdateTimeToLive calls for the same table during this one hour duration result in a ValidationException.

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

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

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

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

As items are deleted, they are removed from any Local Secondary Index and Global Secondary Index immediately in the same eventually consistent way as a standard delete operation.

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

Service Reference:

Examples:

Calling the updateTimeToLive operation

var params = {
  TableName: 'STRING_VALUE', /* required */
  TimeToLiveSpecification: { /* required */
    AttributeName: 'STRING_VALUE', /* required */
    Enabled: true || false /* required */
  }
};
dynamodb.updateTimeToLive(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TableName — (String)

      The name of the table to be configured.

    • TimeToLiveSpecification — (map)

      Represents the settings used to enable or disable Time to Live for the specified table.

      • Enabled — required — (Boolean)

        Indicates whether Time To Live is to be enabled (true) or disabled (false) on the table.

      • AttributeName — required — (String)

        The name of the Time to Live attribute used to store the expiration time for items in the table.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TimeToLiveSpecification — (map)

        Represents the output of an UpdateTimeToLive operation.

        • Enabled — required — (Boolean)

          Indicates whether Time To Live is to be enabled (true) or disabled (false) on the table.

        • AttributeName — required — (String)

          The name of the Time to Live attribute used to store the expiration time for items in the table.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given DynamoDB resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Examples:

Waiting for the tableExists state

var params = {
  TableName: 'STRING_VALUE' /* required */
};
dynamodb.waitFor('tableExists', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • state (String) —

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

  • params (map) (defaults to: {}) —

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

  • function(err, data) { ... }

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

Waiter Resource Details

dynamodb.waitFor('tableExists', params = {}, [callback]) ⇒ AWS.Request

Waits for the tableExists state by periodically calling the underlying DynamoDB.describeTable() operation every 20 seconds (at most 25 times).

Examples:

Waiting for the tableExists state

var params = {
  TableName: 'STRING_VALUE' /* required */
};
dynamodb.waitFor('tableExists', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • TableName — (String)

      The name of the table to describe.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Table — (map)

        The properties of the table.

        • AttributeDefinitions — (Array<map>)

          An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.

          Each AttributeDefinition object in this array is composed of:

          • AttributeName - The name of the attribute.

          • AttributeType - The data type for the attribute.

          • AttributeName — required — (String)

            A name for the attribute.

          • AttributeType — required — (String)

            The data type for the attribute, where:

            • S - the attribute is of type String

            • N - the attribute is of type Number

            • B - the attribute is of type Binary

            Possible values include:
            • "S"
            • "N"
            • "B"
        • TableName — (String)

          The name of the table.

        • KeySchema — (Array<map>)

          The primary key structure for the table. Each KeySchemaElement consists of:

          • AttributeName - The name of the attribute.

          • KeyType - The role of the attribute:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

          For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

          • AttributeName — required — (String)

            The name of a key attribute.

          • KeyType — required — (String)

            The role that this key attribute will assume:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            Possible values include:
            • "HASH"
            • "RANGE"
        • TableStatus — (String)

          The current state of the table:

          • CREATING - The table is being created.

          • UPDATING - The table is being updated.

          • DELETING - The table is being deleted.

          • ACTIVE - The table is ready for use.

          Possible values include:
          • "CREATING"
          • "UPDATING"
          • "DELETING"
          • "ACTIVE"
        • CreationDateTime — (Date)

          The date and time when the table was created, in UNIX epoch time format.

        • ProvisionedThroughput — (map)

          The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

          • LastIncreaseDateTime — (Date)

            The date and time of the last provisioned throughput increase for this table.

          • LastDecreaseDateTime — (Date)

            The date and time of the last provisioned throughput decrease for this table.

          • NumberOfDecreasesToday — (Integer)

            The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

          • ReadCapacityUnits — (Integer)

            The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.

          • WriteCapacityUnits — (Integer)

            The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

        • TableSizeBytes — (Integer)

          The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • ItemCount — (Integer)

          The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • TableArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the table.

        • TableId — (String)

          Unique identifier for the table for which the backup was created.

        • BillingModeSummary — (map)

          Contains the details for the read/write capacity mode.

          • BillingMode — (String)

            Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

            • PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

            • PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

            Possible values include:
            • "PROVISIONED"
            • "PAY_PER_REQUEST"
          • LastUpdateToPayPerRequestDateTime — (Date)

            Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.

        • LocalSecondaryIndexes — (Array<map>)

          Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:

          • IndexName - The name of the local secondary index.

          • KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

          • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

            • ProjectionType - One of the following:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

            • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          If the table is in the DELETING state, no information about indexes will be returned.

          • IndexName — (String)

            Represents the name of the local secondary index.

          • KeySchema — (Array<map>)

            The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            • AttributeName — required — (String)

              The name of a key attribute.

            • KeyType — required — (String)

              The role that this key attribute will assume:

              • HASH - partition key

              • RANGE - sort key

              Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
              Possible values include:
              • "HASH"
              • "RANGE"
          • Projection — (map)

            Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

            • ProjectionType — (String)

              The set of attributes that are projected into the index:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

              Possible values include:
              • "ALL"
              • "KEYS_ONLY"
              • "INCLUDE"
            • NonKeyAttributes — (Array<String>)

              Represents the non-key attribute names which will be projected into the index.

              For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • IndexSizeBytes — (Integer)

            The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • ItemCount — (Integer)

            The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • IndexArn — (String)

            The Amazon Resource Name (ARN) that uniquely identifies the index.

        • GlobalSecondaryIndexes — (Array<map>)

          The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:

          • Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table; it is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.)

          • IndexName - The name of the global secondary index.

          • IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • IndexStatus - The current status of the global secondary index:

            • CREATING - The index is being created.

            • UPDATING - The index is being updated.

            • DELETING - The index is being deleted.

            • ACTIVE - The index is ready for use.

          • ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

          • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

            • ProjectionType - One of the following:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

            • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.

          If the table is in the DELETING state, no information about indexes will be returned.

          • IndexName — (String)

            The name of the global secondary index.

          • KeySchema — (Array<map>)

            The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            • AttributeName — required — (String)

              The name of a key attribute.

            • KeyType — required — (String)

              The role that this key attribute will assume:

              • HASH - partition key

              • RANGE - sort key

              Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
              Possible values include:
              • "HASH"
              • "RANGE"
          • Projection — (map)

            Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

            • ProjectionType — (String)

              The set of attributes that are projected into the index:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

              Possible values include:
              • "ALL"
              • "KEYS_ONLY"
              • "INCLUDE"
            • NonKeyAttributes — (Array<String>)

              Represents the non-key attribute names which will be projected into the index.

              For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • IndexStatus — (String)

            The current state of the global secondary index:

            • CREATING - The index is being created.

            • UPDATING - The index is being updated.

            • DELETING - The index is being deleted.

            • ACTIVE - The index is ready for use.

            Possible values include:
            • "CREATING"
            • "UPDATING"
            • "DELETING"
            • "ACTIVE"
          • Backfilling — (Boolean)

            Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.

            Note: For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
          • ProvisionedThroughput — (map)

            Represents the provisioned throughput settings for the specified global secondary index.

            For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

            • LastIncreaseDateTime — (Date)

              The date and time of the last provisioned throughput increase for this table.

            • LastDecreaseDateTime — (Date)

              The date and time of the last provisioned throughput decrease for this table.

            • NumberOfDecreasesToday — (Integer)

              The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

            • ReadCapacityUnits — (Integer)

              The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.

            • WriteCapacityUnits — (Integer)

              The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

          • IndexSizeBytes — (Integer)

            The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • ItemCount — (Integer)

            The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • IndexArn — (String)

            The Amazon Resource Name (ARN) that uniquely identifies the index.

        • StreamSpecification — (map)

          The current DynamoDB Streams configuration for the table.

          • StreamEnabled — (Boolean)

            Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

          • StreamViewType — (String)

            When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

            • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

            • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

            • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

            • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

            Possible values include:
            • "NEW_IMAGE"
            • "OLD_IMAGE"
            • "NEW_AND_OLD_IMAGES"
            • "KEYS_ONLY"
        • LatestStreamLabel — (String)

          A timestamp, in ISO 8601 format, for this stream.

          Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

          • the AWS customer ID.

          • the table name.

          • the StreamLabel.

        • LatestStreamArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.

        • RestoreSummary — (map)

          Contains details for the restore.

          • SourceBackupArn — (String)

            ARN of the backup from which the table was restored.

          • SourceTableArn — (String)

            ARN of the source table of the backup that is being restored.

          • RestoreDateTime — required — (Date)

            Point in time or source backup time.

          • RestoreInProgress — required — (Boolean)

            Indicates if a restore is in progress or not.

        • SSEDescription — (map)

          The description of the server-side encryption status on the specified table.

          • Status — (String)

            The current state of server-side encryption:

            • ENABLING - Server-side encryption is being enabled.

            • ENABLED - Server-side encryption is enabled.

            • DISABLING - Server-side encryption is being disabled.

            • DISABLED - Server-side encryption is disabled.

            • UPDATING - Server-side encryption is being updated.

            Possible values include:
            • "ENABLING"
            • "ENABLED"
            • "DISABLING"
            • "DISABLED"
            • "UPDATING"
          • SSEType — (String)

            Server-side encryption type:

            • AES256 - Server-side encryption which uses the AES256 algorithm (not applicable).

            • KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).

            Possible values include:
            • "AES256"
            • "KMS"
          • KMSMasterKeyArn — (String)

            The KMS master key ARN used for the KMS encryption.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also:

dynamodb.waitFor('tableNotExists', params = {}, [callback]) ⇒ AWS.Request

Waits for the tableNotExists state by periodically calling the underlying DynamoDB.describeTable() operation every 20 seconds (at most 25 times).

Examples:

Waiting for the tableNotExists state

var params = {
  TableName: 'STRING_VALUE' /* required */
};
dynamodb.waitFor('tableNotExists', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • TableName — (String)

      The name of the table to describe.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Table — (map)

        The properties of the table.

        • AttributeDefinitions — (Array<map>)

          An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.

          Each AttributeDefinition object in this array is composed of:

          • AttributeName - The name of the attribute.

          • AttributeType - The data type for the attribute.

          • AttributeName — required — (String)

            A name for the attribute.

          • AttributeType — required — (String)

            The data type for the attribute, where:

            • S - the attribute is of type String

            • N - the attribute is of type Number

            • B - the attribute is of type Binary

            Possible values include:
            • "S"
            • "N"
            • "B"
        • TableName — (String)

          The name of the table.

        • KeySchema — (Array<map>)

          The primary key structure for the table. Each KeySchemaElement consists of:

          • AttributeName - The name of the attribute.

          • KeyType - The role of the attribute:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

          For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

          • AttributeName — required — (String)

            The name of a key attribute.

          • KeyType — required — (String)

            The role that this key attribute will assume:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            Possible values include:
            • "HASH"
            • "RANGE"
        • TableStatus — (String)

          The current state of the table:

          • CREATING - The table is being created.

          • UPDATING - The table is being updated.

          • DELETING - The table is being deleted.

          • ACTIVE - The table is ready for use.

          Possible values include:
          • "CREATING"
          • "UPDATING"
          • "DELETING"
          • "ACTIVE"
        • CreationDateTime — (Date)

          The date and time when the table was created, in UNIX epoch time format.

        • ProvisionedThroughput — (map)

          The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

          • LastIncreaseDateTime — (Date)

            The date and time of the last provisioned throughput increase for this table.

          • LastDecreaseDateTime — (Date)

            The date and time of the last provisioned throughput decrease for this table.

          • NumberOfDecreasesToday — (Integer)

            The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

          • ReadCapacityUnits — (Integer)

            The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.

          • WriteCapacityUnits — (Integer)

            The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

        • TableSizeBytes — (Integer)

          The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • ItemCount — (Integer)

          The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

        • TableArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the table.

        • TableId — (String)

          Unique identifier for the table for which the backup was created.

        • BillingModeSummary — (map)

          Contains the details for the read/write capacity mode.

          • BillingMode — (String)

            Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

            • PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

            • PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

            Possible values include:
            • "PROVISIONED"
            • "PAY_PER_REQUEST"
          • LastUpdateToPayPerRequestDateTime — (Date)

            Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.

        • LocalSecondaryIndexes — (Array<map>)

          Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:

          • IndexName - The name of the local secondary index.

          • KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

          • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

            • ProjectionType - One of the following:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

            • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          If the table is in the DELETING state, no information about indexes will be returned.

          • IndexName — (String)

            Represents the name of the local secondary index.

          • KeySchema — (Array<map>)

            The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            • AttributeName — required — (String)

              The name of a key attribute.

            • KeyType — required — (String)

              The role that this key attribute will assume:

              • HASH - partition key

              • RANGE - sort key

              Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
              Possible values include:
              • "HASH"
              • "RANGE"
          • Projection — (map)

            Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

            • ProjectionType — (String)

              The set of attributes that are projected into the index:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

              Possible values include:
              • "ALL"
              • "KEYS_ONLY"
              • "INCLUDE"
            • NonKeyAttributes — (Array<String>)

              Represents the non-key attribute names which will be projected into the index.

              For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • IndexSizeBytes — (Integer)

            The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • ItemCount — (Integer)

            The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • IndexArn — (String)

            The Amazon Resource Name (ARN) that uniquely identifies the index.

        • GlobalSecondaryIndexes — (Array<map>)

          The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:

          • Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table; it is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.)

          • IndexName - The name of the global secondary index.

          • IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • IndexStatus - The current status of the global secondary index:

            • CREATING - The index is being created.

            • UPDATING - The index is being updated.

            • DELETING - The index is being deleted.

            • ACTIVE - The index is ready for use.

          • ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

          • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

            • ProjectionType - One of the following:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

            • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.

          If the table is in the DELETING state, no information about indexes will be returned.

          • IndexName — (String)

            The name of the global secondary index.

          • KeySchema — (Array<map>)

            The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

            • HASH - partition key

            • RANGE - sort key

            Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
            • AttributeName — required — (String)

              The name of a key attribute.

            • KeyType — required — (String)

              The role that this key attribute will assume:

              • HASH - partition key

              • RANGE - sort key

              Note: The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
              Possible values include:
              • "HASH"
              • "RANGE"
          • Projection — (map)

            Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

            • ProjectionType — (String)

              The set of attributes that are projected into the index:

              • KEYS_ONLY - Only the index and primary keys are projected into the index.

              • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

              • ALL - All of the table attributes are projected into the index.

              Possible values include:
              • "ALL"
              • "KEYS_ONLY"
              • "INCLUDE"
            • NonKeyAttributes — (Array<String>)

              Represents the non-key attribute names which will be projected into the index.

              For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

          • IndexStatus — (String)

            The current state of the global secondary index:

            • CREATING - The index is being created.

            • UPDATING - The index is being updated.

            • DELETING - The index is being deleted.

            • ACTIVE - The index is ready for use.

            Possible values include:
            • "CREATING"
            • "UPDATING"
            • "DELETING"
            • "ACTIVE"
          • Backfilling — (Boolean)

            Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.

            Note: For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
          • ProvisionedThroughput — (map)

            Represents the provisioned throughput settings for the specified global secondary index.

            For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

            • LastIncreaseDateTime — (Date)

              The date and time of the last provisioned throughput increase for this table.

            • LastDecreaseDateTime — (Date)

              The date and time of the last provisioned throughput decrease for this table.

            • NumberOfDecreasesToday — (Integer)

              The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

            • ReadCapacityUnits — (Integer)

              The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.

            • WriteCapacityUnits — (Integer)

              The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

          • IndexSizeBytes — (Integer)

            The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • ItemCount — (Integer)

            The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

          • IndexArn — (String)

            The Amazon Resource Name (ARN) that uniquely identifies the index.

        • StreamSpecification — (map)

          The current DynamoDB Streams configuration for the table.

          • StreamEnabled — (Boolean)

            Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

          • StreamViewType — (String)

            When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

            • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

            • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

            • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

            • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

            Possible values include:
            • "NEW_IMAGE"
            • "OLD_IMAGE"
            • "NEW_AND_OLD_IMAGES"
            • "KEYS_ONLY"
        • LatestStreamLabel — (String)

          A timestamp, in ISO 8601 format, for this stream.

          Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

          • the AWS customer ID.

          • the table name.

          • the StreamLabel.

        • LatestStreamArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.

        • RestoreSummary — (map)

          Contains details for the restore.

          • SourceBackupArn — (String)

            ARN of the backup from which the table was restored.

          • SourceTableArn — (String)

            ARN of the source table of the backup that is being restored.

          • RestoreDateTime — required — (Date)

            Point in time or source backup time.

          • RestoreInProgress — required — (Boolean)

            Indicates if a restore is in progress or not.

        • SSEDescription — (map)

          The description of the server-side encryption status on the specified table.

          • Status — (String)

            The current state of server-side encryption:

            • ENABLING - Server-side encryption is being enabled.

            • ENABLED - Server-side encryption is enabled.

            • DISABLING - Server-side encryption is being disabled.

            • DISABLED - Server-side encryption is disabled.

            • UPDATING - Server-side encryption is being updated.

            Possible values include:
            • "ENABLING"
            • "ENABLED"
            • "DISABLING"
            • "DISABLED"
            • "UPDATING"
          • SSEType — (String)

            Server-side encryption type:

            • AES256 - Server-side encryption which uses the AES256 algorithm (not applicable).

            • KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).

            Possible values include:
            • "AES256"
            • "KMS"
          • KMSMasterKeyArn — (String)

            The KMS master key ARN used for the KMS encryption.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also: