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.

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

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 (collapse)

Property Summary (collapse)

Properties inherited from AWS.Service

apiVersions

Method Summary (collapse)

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, defineService

Constructor Details

new AWS.DynamoDB(options = {})

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

Property Details

(AWS.Endpoint) 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

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

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

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

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

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

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

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

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

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

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

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

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

Examples:

Calling the batchGetItem operation

var params = {
  RequestItems: { /* required */
    someKey: {
      Keys: [ /* required */
        {
          someKey: { /* AttributeValue */
            B: new Buffer('...') || 'STRING_VALUE',
            BOOL: true || false,
            BS: [
              new Buffer('...') || 'STRING_VALUE',
              /* more items */
            ],
            L: [
              /* recursive AttributeValue */,
              /* more items */
            ],
            M: {
              someKey: /* recursive AttributeValue */,
              /* anotherKey: ... */
            },
            N: 'STRING_VALUE',
            NS: [
              'STRING_VALUE',
              /* more items */
            ],
            NULL: true || false,
            S: 'STRING_VALUE',
            SS: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          /* anotherKey: ... */
        },
        /* more items */
      ],
      AttributesToGet: [
        'STRING_VALUE',
        /* more items */
      ],
      ConsistentRead: true || false,
      ExpressionAttributeNames: {
        someKey: 'STRING_VALUE',
        /* anotherKey: ... */
      },
      ProjectionExpression: 'STRING_VALUE'
    },
    /* anotherKey: ... */
  },
  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, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.

        This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.

        The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

        Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.

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

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

        • S — (String)

          A String data type.

        • N — (String)

          A Number data type.

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

          A Binary data type.

        • SS — (Array<String>)

          A String Set data type.

        • NS — (Array<String>)

          A Number Set data type.

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

          A Binary Set data type.

        • M — (map<map>)

          A Map of attribute values.

        • L — (Array<map>)

          A List of attribute values.

        • NULL — (Boolean)

          A Null data type.

        • BOOL — (Boolean)

          A Boolean data type.

      • AttributesToGet — (Array<String>)

        One or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.

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

        Note: ProjectionExpression replaces the legacy AttributesToGet parameter.
      • 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)

          A String data type.

        • N — (String)

          A Number data type.

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

          A Binary data type.

        • SS — (Array<String>)

          A String Set data type.

        • NS — (Array<String>)

          A Number Set data type.

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

          A Binary Set data type.

        • M — (map<map>)

          A Map of attribute values.

        • L — (Array<map>)

          A List of attribute values.

        • NULL — (Boolean)

          A Null data type.

        • BOOL — (Boolean)

          A Boolean data type.

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

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

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

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

          • S — (String)

            A String data type.

          • N — (String)

            A Number data type.

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

            A Binary data type.

          • SS — (Array<String>)

            A String Set data type.

          • NS — (Array<String>)

            A Number Set data type.

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

            A Binary Set data type.

          • M — (map<map>)

            A Map of attribute values.

          • L — (Array<map>)

            A List of attribute values.

          • NULL — (Boolean)

            A Null data type.

          • BOOL — (Boolean)

            A Boolean data type.

        • AttributesToGet — (Array<String>)

          One or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.

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

          Note: ProjectionExpression replaces the legacy AttributesToGet parameter.
        • 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 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.

        • Table — (map)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • There are more than 25 requests in the batch.

  • Any individual item in a batch exceeds 400 KB.

  • The total request size exceeds 16 MB.

Examples:

Calling the batchWriteItem operation

var params = {
  RequestItems: { /* required */
    someKey: [
      {
        DeleteRequest: {
          Key: { /* required */
            someKey: { /* AttributeValue */
              B: new Buffer('...') || 'STRING_VALUE',
              BOOL: true || false,
              BS: [
                new Buffer('...') || 'STRING_VALUE',
                /* more items */
              ],
              L: [
                /* recursive AttributeValue */,
                /* more items */
              ],
              M: {
                someKey: /* recursive AttributeValue */,
                /* anotherKey: ... */
              },
              N: 'STRING_VALUE',
              NS: [
                'STRING_VALUE',
                /* more items */
              ],
              NULL: true || false,
              S: 'STRING_VALUE',
              SS: [
                'STRING_VALUE',
                /* more items */
              ]
            },
            /* anotherKey: ... */
          }
        },
        PutRequest: {
          Item: { /* required */
            someKey: { /* AttributeValue */
              B: new Buffer('...') || 'STRING_VALUE',
              BOOL: true || false,
              BS: [
                new Buffer('...') || 'STRING_VALUE',
                /* more items */
              ],
              L: [
                /* recursive AttributeValue */,
                /* more items */
              ],
              M: {
                someKey: /* recursive AttributeValue */,
                /* anotherKey: ... */
              },
              N: 'STRING_VALUE',
              NS: [
                'STRING_VALUE',
                /* more items */
              ],
              NULL: true || false,
              S: 'STRING_VALUE',
              SS: [
                'STRING_VALUE',
                /* more items */
              ]
            },
            /* anotherKey: ... */
          }
        }
      },
      /* more items */
    ],
    /* anotherKey: ... */
  },
  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.

        • Itemrequired — (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)

            A String data type.

          • N — (String)

            A Number data type.

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

            A Binary data type.

          • SS — (Array<String>)

            A String Set data type.

          • NS — (Array<String>)

            A Number Set data type.

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

            A Binary Set data type.

          • M — (map<map>)

            A Map of attribute values.

          • L — (Array<map>)

            A List of attribute values.

          • NULL — (Boolean)

            A Null data type.

          • BOOL — (Boolean)

            A Boolean data type.

      • DeleteRequest — (map)

        A request to perform a DeleteItem operation.

        • Keyrequired — (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)

            A String data type.

          • N — (String)

            A Number data type.

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

            A Binary data type.

          • SS — (Array<String>)

            A String Set data type.

          • NS — (Array<String>)

            A Number Set data type.

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

            A Binary Set data type.

          • M — (map<map>)

            A Map of attribute values.

          • L — (Array<map>)

            A List of attribute values.

          • NULL — (Boolean)

            A Null data type.

          • BOOL — (Boolean)

            A Boolean data type.

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

          • Itemrequired — (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)

              A String data type.

            • N — (String)

              A Number data type.

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

              A Binary data type.

            • SS — (Array<String>)

              A String Set data type.

            • NS — (Array<String>)

              A Number Set data type.

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

              A Binary Set data type.

            • M — (map<map>)

              A Map of attribute values.

            • L — (Array<map>)

              A List of attribute values.

            • NULL — (Boolean)

              A Null data type.

            • BOOL — (Boolean)

              A Boolean data type.

        • DeleteRequest — (map)

          A request to perform a DeleteItem operation.

          • Keyrequired — (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)

              A String data type.

            • N — (String)

              A Number data type.

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

              A Binary data type.

            • SS — (Array<String>)

              A String Set data type.

            • NS — (Array<String>)

              A Number Set data type.

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

              A Binary Set data type.

            • M — (map<map>)

              A Map of attribute values.

            • L — (Array<map>)

              A List of attribute values.

            • NULL — (Boolean)

              A Null data type.

            • BOOL — (Boolean)

              A Boolean data type.

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

        • SizeEstimateRange - 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)

            A String data type.

          • N — (String)

            A Number data type.

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

            A Binary data type.

          • SS — (Array<String>)

            A String Set data type.

          • NS — (Array<String>)

            A Number Set data type.

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

            A Binary Set data type.

          • M — (map<map>)

            A Map of attribute values.

          • L — (Array<map>)

            A List of attribute values.

          • NULL — (Boolean)

            A Null data type.

          • BOOL — (Boolean)

            A Boolean data type.

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

        • Table — (map)

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

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

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

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

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

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

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

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

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

Examples:

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 */
  ],
  ProvisionedThroughput: { /* required */
    ReadCapacityUnits: 0, /* required */
    WriteCapacityUnits: 0 /* required */
  },
  TableName: 'STRING_VALUE', /* required */
  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: { /* required */
        ReadCapacityUnits: 0, /* required */
        WriteCapacityUnits: 0 /* 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 */
  ],
  StreamSpecification: {
    StreamEnabled: true || false,
    StreamViewType: 'NEW_IMAGE | OLD_IMAGE | NEW_AND_OLD_IMAGES | KEYS_ONLY'
  }
};
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.

      • AttributeNamerequired — (String)

        A name for the attribute.

      • AttributeTyperequired — (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.

      • AttributeNamerequired — (String)

        The name of a key attribute.

      • KeyTyperequired — (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 five) 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 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

      • IndexNamerequired — (String)

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

      • KeySchemarequired — (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.
        • AttributeNamerequired — (String)

          The name of a key attribute.

        • KeyTyperequired — (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"
      • Projectionrequired — (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.

    • GlobalSecondaryIndexes — (Array<map>)

      One or more global secondary indexes (the maximum is five) 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 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.

      • IndexNamerequired — (String)

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

      • KeySchemarequired — (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.
        • AttributeNamerequired — (String)

          The name of a key attribute.

        • KeyTyperequired — (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"
      • Projectionrequired — (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.

      • ProvisionedThroughputrequired — (map)

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

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

        • ReadCapacityUnitsrequired — (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.

        • WriteCapacityUnitsrequired — (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.

    • ProvisionedThroughput — (map)

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

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

      • ReadCapacityUnitsrequired — (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.

      • WriteCapacityUnitsrequired — (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.

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

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

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

        • StreamViewType - 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"

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.

          • AttributeNamerequired — (String)

            A name for the attribute.

          • AttributeTyperequired — (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.

          • AttributeNamerequired — (String)

            The name of a key attribute.

          • KeyTyperequired — (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.

        • 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.
            • AttributeNamerequired — (String)

              The name of a key attribute.

            • KeyTyperequired — (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 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.

          • 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.
            • AttributeNamerequired — (String)

              The name of a key attribute.

            • KeyTyperequired — (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 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.

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

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

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

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

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

Returns:

  • (AWS.Request)

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

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

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.

Examples:

Calling the deleteItem operation

var params = {
  Key: { /* required */
    someKey: { /* AttributeValue */
      B: new Buffer('...') || 'STRING_VALUE',
      BOOL: true || false,
      BS: [
        new Buffer('...') || 'STRING_VALUE',
        /* more items */
      ],
      L: [
        /* recursive AttributeValue */,
        /* more items */
      ],
      M: {
        someKey: /* recursive AttributeValue */,
        /* anotherKey: ... */
      },
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      NULL: true || false,
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* anotherKey: ... */
  },
  TableName: 'STRING_VALUE', /* required */
  ConditionExpression: 'STRING_VALUE',
  ConditionalOperator: 'AND | OR',
  Expected: {
    someKey: {
      AttributeValueList: [
        { /* AttributeValue */
          B: new Buffer('...') || 'STRING_VALUE',
          BOOL: true || false,
          BS: [
            new Buffer('...') || 'STRING_VALUE',
            /* more items */
          ],
          L: [
            /* recursive AttributeValue */,
            /* more items */
          ],
          M: {
            someKey: /* recursive AttributeValue */,
            /* anotherKey: ... */
          },
          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',
        BOOL: true || false,
        BS: [
          new Buffer('...') || 'STRING_VALUE',
          /* more items */
        ],
        L: [
          /* recursive AttributeValue */,
          /* more items */
        ],
        M: {
          someKey: /* recursive AttributeValue */,
          /* anotherKey: ... */
        },
        N: 'STRING_VALUE',
        NS: [
          'STRING_VALUE',
          /* more items */
        ],
        NULL: true || false,
        S: 'STRING_VALUE',
        SS: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    /* anotherKey: ... */
  },
  ExpressionAttributeNames: {
    someKey: 'STRING_VALUE',
    /* anotherKey: ... */
  },
  ExpressionAttributeValues: {
    someKey: { /* AttributeValue */
      B: new Buffer('...') || 'STRING_VALUE',
      BOOL: true || false,
      BS: [
        new Buffer('...') || 'STRING_VALUE',
        /* more items */
      ],
      L: [
        /* recursive AttributeValue */,
        /* more items */
      ],
      M: {
        someKey: /* recursive AttributeValue */,
        /* anotherKey: ... */
      },
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      NULL: true || false,
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* anotherKey: ... */
  },
  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)

        A String data type.

      • N — (String)

        A Number data type.

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

        A Binary data type.

      • SS — (Array<String>)

        A String Set data type.

      • NS — (Array<String>)

        A Number Set data type.

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

        A Binary Set data type.

      • M — (map<map>)

        A Map of attribute values.

      • L — (Array<map>)

        A List of attribute values.

      • NULL — (Boolean)

        A Null data type.

      • BOOL — (Boolean)

        A Boolean data type.

    • Expected — (map<map>)

      This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.

      A map of attribute/condition pairs. Expected provides a conditional block for the DeleteItem operation.

      Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.

      If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)

      If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.

      Expected contains the following:

      • AttributeValueList - 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 type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

      • ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.

        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 datatypes, 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 datatypes, 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 datatypes, 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 datatypes, 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 within two sets.

          AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in 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.

      For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:

      • Value - A value for DynamoDB to compare with an attribute.

      • Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the 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 condition evaluates to true; otherwise the condition evaluate to false.

        • 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 condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.

        Note that the default value for Exists is true.

      The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.

      Note: This parameter does not support attributes of type List or Map.
      • Value — (map)

        Represents the data for an attribute. You can set one, and only one, of the elements.

        Each attribute in an item is a name-value pair. An attribute can be single-valued or multi-valued set. For example, a book item can have title and authors attributes. Each book has one title but can have many authors. The multi-valued attribute is a set; duplicate values are not allowed.

        • S — (String)

          A String data type.

        • N — (String)

          A Number data type.

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

          A Binary data type.

        • SS — (Array<String>)

          A String Set data type.

        • NS — (Array<String>)

          A Number Set data type.

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

          A Binary Set data type.

        • M — (map<map>)

          A Map of attribute values.

        • L — (Array<map>)

          A List of attribute values.

        • NULL — (Boolean)

          A Null data type.

        • BOOL — (Boolean)

          A Boolean data type.

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

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

        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 datatypes, 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 datatypes, 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 datatypes, 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 datatypes, 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 within two sets.

          AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in 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)

          A String data type.

        • N — (String)

          A Number data type.

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

          A Binary data type.

        • SS — (Array<String>)

          A String Set data type.

        • NS — (Array<String>)

          A Number Set data type.

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

          A Binary Set data type.

        • M — (map<map>)

          A Map of attribute values.

        • L — (Array<map>)

          A List of attribute values.

        • NULL — (Boolean)

          A Null data type.

        • BOOL — (Boolean)

          A Boolean data type.

    • ConditionalOperator — (String)

      This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.

      A logical operator to apply to the conditions in the Expected map:

      • AND - If all of the conditions evaluate to true, then the entire map evaluates to true.

      • OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.

      If you omit ConditionalOperator, then AND is the default.

      The operation will succeed only if the entire map evaluates to true.

      Note: This parameter does not support attributes of type List or Map.
      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: = | &#x3C;&#x3E; | &#x3C; | &#x3E; | &#x3C;= | &#x3E;= | BETWEEN | IN

      • Logical operators: AND | OR | NOT

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

      Note: ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
    • 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)

        A String data type.

      • N — (String)

        A Number data type.

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

        A Binary data type.

      • SS — (Array<String>)

        A String Set data type.

      • NS — (Array<String>)

        A Number Set data type.

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

        A Binary Set data type.

      • M — (map<map>)

        A Map of attribute values.

      • L — (Array<map>)

        A List of attribute values.

      • NULL — (Boolean)

        A Null data type.

      • BOOL — (Boolean)

        A Boolean data type.

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)

          A String data type.

        • N — (String)

          A Number data type.

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

          A Binary data type.

        • SS — (Array<String>)

          A String Set data type.

        • NS — (Array<String>)

          A Number Set data type.

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

          A Binary Set data type.

        • M — (map<map>)

          A Map of attribute values.

        • L — (Array<map>)

          A List of attribute values.

        • NULL — (Boolean)

          A Null data type.

        • BOOL — (Boolean)

          A Boolean data type.

      • ConsumedCapacity — (map)

        The capacity units consumed by an 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 request asked for it. 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.

        • Table — (map)

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

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

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

          • 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 operation. ItemCollectionMetrics is only returned if the request asked for it. 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.

        • SizeEstimateRange - 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)

            A String data type.

          • N — (String)

            A Number data type.

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

            A Binary data type.

          • SS — (Array<String>)

            A String Set data type.

          • NS — (Array<String>)

            A Number Set data type.

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

            A Binary Set data type.

          • M — (map<map>)

            A Map of attribute values.

          • L — (Array<map>)

            A List of attribute values.

          • NULL — (Boolean)

            A Null data type.

          • BOOL — (Boolean)

            A Boolean data type.

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

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

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

Examples:

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.

          • AttributeNamerequired — (String)

            A name for the attribute.

          • AttributeTyperequired — (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.

          • AttributeNamerequired — (String)

            The name of a key attribute.

          • KeyTyperequired — (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.

        • 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.
            • AttributeNamerequired — (String)

              The name of a key attribute.

            • KeyTyperequired — (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 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.

          • 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.
            • AttributeNamerequired — (String)

              The name of a key attribute.

            • KeyTyperequired — (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 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.

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

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

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

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

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

Returns:

  • (AWS.Request)

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

(AWS.Request) describeLimits(params = {}, callback)

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

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

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

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

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

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

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

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

    • Call DescribeTable with the table name.

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

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

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

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

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

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

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.

Examples:

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.

(AWS.Request) describeTable(params = {}, callback)

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.

Examples:

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)

        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.

          • AttributeNamerequired — (String)

            A name for the attribute.

          • AttributeTyperequired — (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.

          • AttributeNamerequired — (String)

            The name of a key attribute.

          • KeyTyperequired — (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.

        • 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.
            • AttributeNamerequired — (String)

              The name of a key attribute.

            • KeyTyperequired — (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 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.

          • 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.
            • AttributeNamerequired — (String)

              The name of a key attribute.

            • KeyTyperequired — (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 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.

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

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

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

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

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

Returns:

  • (AWS.Request)

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

Waiter Resource States:

(AWS.Request) getItem(params = {}, callback)

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

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

Examples:

Calling the getItem operation

var params = {
  Key: { /* required */
    someKey: { /* AttributeValue */
      B: new Buffer('...') || 'STRING_VALUE',
      BOOL: true || false,
      BS: [
        new Buffer('...') || 'STRING_VALUE',
        /* more items */
      ],
      L: [
        /* recursive AttributeValue */,
        /* more items */
      ],
      M: {
        someKey: /* recursive AttributeValue */,
        /* anotherKey: ... */
      },
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      NULL: true || false,
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* anotherKey: ... */
  },
  TableName: 'STRING_VALUE', /* required */
  AttributesToGet: [
    'STRING_VALUE',
    /* more items */
  ],
  ConsistentRead: true || false,
  ExpressionAttributeNames: {
    someKey: 'STRING_VALUE',
    /* anotherKey: ... */
  },
  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)

        A String data type.

      • N — (String)

        A Number data type.

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

        A Binary data type.

      • SS — (Array<String>)

        A String Set data type.

      • NS — (Array<String>)

        A Number Set data type.

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

        A Binary Set data type.

      • M — (map<map>)

        A Map of attribute values.

      • L — (Array<map>)

        A List of attribute values.

      • NULL — (Boolean)

        A Null data type.

      • BOOL — (Boolean)

        A Boolean data type.

    • AttributesToGet — (Array<String>)

      This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.

      This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.

      The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

      Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.

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

      Note: ProjectionExpression replaces the legacy AttributesToGet parameter.
    • 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 AttributesToGet.

        • S — (String)

          A String data type.

        • N — (String)

          A Number data type.

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

          A Binary data type.

        • SS — (Array<String>)

          A String Set data type.

        • NS — (Array<String>)

          A Number Set data type.

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

          A Binary Set data type.

        • M — (map<map>)

          A Map of attribute values.

        • L — (Array<map>)

          A List of attribute values.

        • NULL — (Boolean)

          A Null data type.

        • BOOL — (Boolean)

          A Boolean data type.

      • ConsumedCapacity — (map)

        The capacity units consumed by an 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 request asked for it. 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.

        • Table — (map)

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

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

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

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

(AWS.Request) listTables(params = {}, callback)

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.

Examples:

Calling the listTables operation

var params = {
  ExclusiveStartTableName: 'STRING_VALUE',
  Limit: 0
};
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.

(AWS.Request) putItem(params = {}, callback)

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

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

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

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

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

Examples:

Calling the putItem operation

var params = {
  Item: { /* required */
    someKey: { /* AttributeValue */
      B: new Buffer('...') || 'STRING_VALUE',
      BOOL: true || false,
      BS: [
        new Buffer('...') || 'STRING_VALUE',
        /* more items */
      ],
      L: [
        /* recursive AttributeValue */,
        /* more items */
      ],
      M: {
        someKey: /* recursive AttributeValue */,
        /* anotherKey: ... */
      },
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      NULL: true || false,
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* anotherKey: ... */
  },
  TableName: 'STRING_VALUE', /* required */
  ConditionExpression: 'STRING_VALUE',
  ConditionalOperator: 'AND | OR',
  Expected: {
    someKey: {
      AttributeValueList: [
        { /* AttributeValue */
          B: new Buffer('...') || 'STRING_VALUE',
          BOOL: true || false,
          BS: [
            new Buffer('...') || 'STRING_VALUE',
            /* more items */
          ],
          L: [
            /* recursive AttributeValue */,
            /* more items */
          ],
          M: {
            someKey: /* recursive AttributeValue */,
            /* anotherKey: ... */
          },
          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',
        BOOL: true || false,
        BS: [
          new Buffer('...') || 'STRING_VALUE',
          /* more items */
        ],
        L: [
          /* recursive AttributeValue */,
          /* more items */
        ],
        M: {
          someKey: /* recursive AttributeValue */,
          /* anotherKey: ... */
        },
        N: 'STRING_VALUE',
        NS: [
          'STRING_VALUE',
          /* more items */
        ],
        NULL: true || false,
        S: 'STRING_VALUE',
        SS: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    /* anotherKey: ... */
  },
  ExpressionAttributeNames: {
    someKey: 'STRING_VALUE',
    /* anotherKey: ... */
  },
  ExpressionAttributeValues: {
    someKey: { /* AttributeValue */
      B: new Buffer('...') || 'STRING_VALUE',
      BOOL: true || false,
      BS: [
        new Buffer('...') || 'STRING_VALUE',
        /* more items */
      ],
      L: [
        /* recursive AttributeValue */,
        /* more items */
      ],
      M: {
        someKey: /* recursive AttributeValue */,
        /* anotherKey: ... */
      },
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      NULL: true || false,
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* anotherKey: ... */
  },
  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)

        A String data type.

      • N — (String)

        A Number data type.

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

        A Binary data type.

      • SS — (Array<String>)

        A String Set data type.

      • NS — (Array<String>)

        A Number Set data type.

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

        A Binary Set data type.

      • M — (map<map>)

        A Map of attribute values.

      • L — (Array<map>)

        A List of attribute values.

      • NULL — (Boolean)

        A Null data type.

      • BOOL — (Boolean)

        A Boolean data type.

    • Expected — (map<map>)

      This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.

      A map of attribute/condition pairs. Expected provides a conditional block for the PutItem operation.

      Note: This parameter does not support attributes of type List or Map.

      Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.

      If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)

      If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.

      Expected contains the following:

      • AttributeValueList - 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 type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

      • ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.

        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 datatypes, 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 datatypes, 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 datatypes, 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 datatypes, 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 within two sets.

          AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in 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.

      For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:

      • Value - A value for DynamoDB to compare with an attribute.

      • Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the 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 condition evaluates to true; otherwise the condition evaluate to false.

        • 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 condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.

        Note that the default value for Exists is true.

      The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.

      • Value — (map)

        Represents the data for an attribute. You can set one, and only one, of the elements.

        Each attribute in an item is a name-value pair. An attribute can be single-valued or multi-valued set. For example, a book item can have title and authors attributes. Each book has one title but can have many authors. The multi-valued attribute is a set; duplicate values are not allowed.

        • S — (String)

          A String data type.

        • N — (String)

          A Number data type.

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

          A Binary data type.

        • SS — (Array<String>)

          A String Set data type.

        • NS — (Array<String>)

          A Number Set data type.

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

          A Binary Set data type.

        • M — (map<map>)

          A Map of attribute values.

        • L — (Array<map>)

          A List of attribute values.

        • NULL — (Boolean)

          A Null data type.

        • BOOL — (Boolean)

          A Boolean data type.

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

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

        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 datatypes, 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 datatypes, 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 datatypes, 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 datatypes, 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 within two sets.

          AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in 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)

          A String data type.

        • N — (String)

          A Number data type.

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

          A Binary data type.

        • SS — (Array<String>)

          A String Set data type.

        • NS — (Array<String>)

          A Number Set data type.

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

          A Binary Set data type.

        • M — (map<map>)

          A Map of attribute values.

        • L — (Array<map>)

          A List of attribute values.

        • NULL — (Boolean)

          A Null data type.

        • BOOL — (Boolean)

          A Boolean data type.

    • 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, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.

      A logical operator to apply to the conditions in the Expected map:

      • AND - If all of the conditions evaluate to true, then the entire map evaluates to true.

      • OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.

      If you omit ConditionalOperator, then AND is the default.

      The operation will succeed only if the entire map evaluates to true.

      Note: This parameter does not support attributes of type List or Map.
      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: = | &#x3C;&#x3E; | &#x3C; | &#x3E; | &#x3C;= | &#x3E;= | BETWEEN | IN

      • Logical operators: AND | OR | NOT

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

      Note: ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
    • 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)

        A String data type.

      • N — (String)

        A Number data type.

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

        A Binary data type.

      • SS — (Array<String>)

        A String Set data type.

      • NS — (Array<String>)

        A Number Set data type.

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

        A Binary Set data type.

      • M — (map<map>)

        A Map of attribute values.

      • L — (Array<map>)

        A List of attribute values.

      • NULL — (Boolean)

        A Null data type.

      • BOOL — (Boolean)

        A Boolean data type.

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)

          A String data type.

        • N — (String)

          A Number data type.

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

          A Binary data type.

        • SS — (Array<String>)

          A String Set data type.

        • NS — (Array<String>)

          A Number Set data type.

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

          A Binary Set data type.

        • M — (map<map>)

          A Map of attribute values.

        • L — (Array<map>)

          A List of attribute values.

        • NULL — (Boolean)

          A Null data type.

        • BOOL — (Boolean)

          A Boolean data type.

      • ConsumedCapacity — (map)

        The capacity units consumed by an 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 request asked for it. 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.

        • Table — (map)

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

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

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

          • 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 operation. ItemCollectionMetrics is only returned if the request asked for it. 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.

        • SizeEstimateRange - 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)

            A String data type.

          • N — (String)

            A Number data type.

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

            A Binary data type.

          • SS — (Array<String>)

            A String Set data type.

          • NS — (Array<String>)

            A Number Set data type.

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

            A Binary Set data type.

          • M — (map<map>)

            A Map of attribute values.

          • L — (Array<map>)

            A List of attribute values.

          • NULL — (Boolean)

            A Null data type.

          • BOOL — (Boolean)

            A Boolean data type.

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

(AWS.Request) query(params = {}, callback)

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

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

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

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

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

Examples:

Calling the query operation

var params = {
  TableName: 'STRING_VALUE', /* required */
  AttributesToGet: [
    'STRING_VALUE',
    /* more items */
  ],
  ConditionalOperator: 'AND | OR',
  ConsistentRead: true || false,
  ExclusiveStartKey: {
    someKey: { /* AttributeValue */
      B: new Buffer('...') || 'STRING_VALUE',
      BOOL: true || false,
      BS: [
        new Buffer('...') || 'STRING_VALUE',
        /* more items */
      ],
      L: [
        /* recursive AttributeValue */,
        /* more items */
      ],
      M: {
        someKey: /* recursive AttributeValue */,
        /* anotherKey: ... */
      },
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      NULL: true || false,
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* anotherKey: ... */
  },
  ExpressionAttributeNames: {
    someKey: 'STRING_VALUE',
    /* anotherKey: ... */
  },
  ExpressionAttributeValues: {
    someKey: { /* AttributeValue */
      B: new Buffer('...') || 'STRING_VALUE',
      BOOL: true || false,
      BS: [
        new Buffer('...') || 'STRING_VALUE',
        /* more items */
      ],
      L: [
        /* recursive AttributeValue */,
        /* more items */
      ],
      M: {
        someKey: /* recursive AttributeValue */,
        /* anotherKey: ... */
      },
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      NULL: true || false,
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* anotherKey: ... */
  },
  FilterExpression: 'STRING_VALUE',
  IndexName: 'STRING_VALUE',
  KeyConditionExpression: 'STRING_VALUE',
  KeyConditions: {
    someKey: {
      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',
          BOOL: true || false,
          BS: [
            new Buffer('...') || 'STRING_VALUE',
            /* more items */
          ],
          L: [
            /* recursive AttributeValue */,
            /* more items */
          ],
          M: {
            someKey: /* recursive AttributeValue */,
            /* anotherKey: ... */
          },
          N: 'STRING_VALUE',
          NS: [
            'STRING_VALUE',
            /* more items */
          ],
          NULL: true || false,
          S: 'STRING_VALUE',
          SS: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    /* anotherKey: ... */
  },
  Limit: 0,
  ProjectionExpression: 'STRING_VALUE',
  QueryFilter: {
    someKey: {
      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',
          BOOL: true || false,
          BS: [
            new Buffer('...') || 'STRING_VALUE',
            /* more items */
          ],
          L: [
            /* recursive AttributeValue */,
            /* more items */
          ],
          M: {
            someKey: /* recursive AttributeValue */,
            /* anotherKey: ... */
          },
          N: 'STRING_VALUE',
          NS: [
            'STRING_VALUE',
            /* more items */
          ],
          NULL: true || false,
          S: 'STRING_VALUE',
          SS: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    /* anotherKey: ... */
  },
  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 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 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, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.

      This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.

      The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

      Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.

      You cannot use both AttributesToGet and Select together in a Query request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)

      If you query 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 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.

    • 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, for backward compatibility. New applications should use KeyConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.

      The selection criteria for the query. For a query on a table, you can have conditions only on the table primary key attributes. You must provide the partition key name and value as an EQ condition. You can optionally provide a second condition, referring to the sort key.

      Note: If you don't provide a sort key condition, all of the items that match the partition key will be retrieved. If a FilterExpression or QueryFilter is present, it will be applied after the items are retrieved.

      For a query on an index, you can have conditions only on the index key attributes. You must provide the index partition key name and value as an EQ condition. You can optionally provide a second condition, referring to the index sort key.

      Each KeyConditions element consists of an attribute name to compare, along with the following:

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

      • ComparisonOperator - A comparator for evaluating attributes, for example, equals, greater than, less than, and so on.

        For KeyConditions, only the following comparison operators are supported:

        EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN

        The following are descriptions of these comparison operators.

        • EQ : Equal.

          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 specified 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"]}.

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

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

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

          A String data type.

        • N — (String)

          A Number data type.

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

          A Binary data type.

        • SS — (Array<String>)

          A String Set data type.

        • NS — (Array<String>)

          A Number Set data type.

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

          A Binary Set data type.

        • M — (map<map>)

          A Map of attribute values.

        • L — (Array<map>)

          A List of attribute values.

        • NULL — (Boolean)

          A Null data type.

        • BOOL — (Boolean)

          A Boolean data type.

      • ComparisonOperatorrequired — (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 datatypes, 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 datatypes, 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 datatypes, 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 datatypes, 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 within two sets.

          AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in 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, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.

      A condition that evaluates the query results after the items are read and returns only the desired values.

      This parameter does not support attributes of type List or Map.

      Note: A QueryFilter is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.

      If you provide more than one condition in the QueryFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)

      Note that QueryFilter does not allow key attributes. You cannot define a filter condition on a partition key or a sort key.

      Each QueryFilter element consists of an attribute name to compare, along with the following:

      • AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator.

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

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

        For complete descriptions of all comparison operators, see the Condition data type.

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

          A String data type.

        • N — (String)

          A Number data type.

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

          A Binary data type.

        • SS — (Array<String>)

          A String Set data type.

        • NS — (Array<String>)

          A Number Set data type.

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

          A Binary Set data type.

        • M — (map<map>)

          A Map of attribute values.

        • L — (Array<map>)

          A List of attribute values.

        • NULL — (Boolean)

          A Null data type.

        • BOOL — (Boolean)

          A Boolean data type.

      • ComparisonOperatorrequired — (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 datatypes, 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 datatypes, 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 datatypes, 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 datatypes, 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 within two sets.

          AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in 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, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.

      A logical operator to apply to the conditions in a QueryFilter map:

      • AND - If all of the conditions evaluate to true, then the entire map evaluates to true.

      • OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.

      If you omit ConditionalOperator, then AND is the default.

      The operation will succeed only if the entire map evaluates to true.

      Note: This parameter does not support attributes of type List or Map.
      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 ASCII character code values. 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)

        A String data type.

      • N — (String)

        A Number data type.

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

        A Binary data type.

      • SS — (Array<String>)

        A String Set data type.

      • NS — (Array<String>)

        A Number Set data type.

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

        A Binary Set data type.

      • M — (map<map>)

        A Map of attribute values.

      • L — (Array<map>)

        A List of attribute values.

      • NULL — (Boolean)

        A Null data type.

      • BOOL — (Boolean)

        A Boolean data type.

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

      Note: ProjectionExpression replaces the legacy AttributesToGet parameter.
    • 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.

      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.

      Note: FilterExpression replaces the legacy QueryFilter and ConditionalOperator parameters.
    • 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 also perform one of several comparison tests on a single sort key value. Query can use KeyConditionExpression 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.

      Note: KeyConditionExpression replaces the legacy KeyConditions parameter.
    • 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)

        A String data type.

      • N — (String)

        A Number data type.

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

        A Binary data type.

      • SS — (Array<String>)

        A String Set data type.

      • NS — (Array<String>)

        A Number Set data type.

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

        A Binary Set data type.

      • M — (map<map>)

        A Map of attribute values.

      • L — (Array<map>)

        A List of attribute values.

      • NULL — (Boolean)

        A Null data type.

      • BOOL — (Boolean)

        A Boolean data type.

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)

          A String data type.

        • N — (String)

          A Number data type.

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

          A Binary data type.

        • SS — (Array<String>)

          A String Set data type.

        • NS — (Array<String>)

          A Number Set data type.

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

          A Binary Set data type.

        • M — (map<map>)

          A Map of attribute values.

        • L — (Array<map>)

          A List of attribute values.

        • NULL — (Boolean)

          A Null data type.

        • BOOL — (Boolean)

          A Boolean data type.

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

          A String data type.

        • N — (String)

          A Number data type.

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

          A Binary data type.

        • SS — (Array<String>)

          A String Set data type.

        • NS — (Array<String>)

          A Number Set data type.

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

          A Binary Set data type.

        • M — (map<map>)

          A Map of attribute values.

        • L — (Array<map>)

          A List of attribute values.

        • NULL — (Boolean)

          A Null data type.

        • BOOL — (Boolean)

          A Boolean data type.

      • ConsumedCapacity — (map)

        The capacity units consumed by an 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 request asked for it. 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.

        • Table — (map)

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

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

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

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

(AWS.Request) scan(params = {}, callback)

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

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

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

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

Examples:

Calling the scan operation

var params = {
  TableName: 'STRING_VALUE', /* required */
  AttributesToGet: [
    'STRING_VALUE',
    /* more items */
  ],
  ConditionalOperator: 'AND | OR',
  ConsistentRead: true || false,
  ExclusiveStartKey: {
    someKey: { /* AttributeValue */
      B: new Buffer('...') || 'STRING_VALUE',
      BOOL: true || false,
      BS: [
        new Buffer('...') || 'STRING_VALUE',
        /* more items */
      ],
      L: [
        /* recursive AttributeValue */,
        /* more items */
      ],
      M: {
        someKey: /* recursive AttributeValue */,
        /* anotherKey: ... */
      },
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      NULL: true || false,
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* anotherKey: ... */
  },
  ExpressionAttributeNames: {
    someKey: 'STRING_VALUE',
    /* anotherKey: ... */
  },
  ExpressionAttributeValues: {
    someKey: { /* AttributeValue */
      B: new Buffer('...') || 'STRING_VALUE',
      BOOL: true || false,
      BS: [
        new Buffer('...') || 'STRING_VALUE',
        /* more items */
      ],
      L: [
        /* recursive AttributeValue */,
        /* more items */
      ],
      M: {
        someKey: /* recursive AttributeValue */,
        /* anotherKey: ... */
      },
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      NULL: true || false,
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* anotherKey: ... */
  },
  FilterExpression: 'STRING_VALUE',
  IndexName: 'STRING_VALUE',
  Limit: 0,
  ProjectionExpression: 'STRING_VALUE',
  ReturnConsumedCapacity: 'INDEXES | TOTAL | NONE',
  ScanFilter: {
    someKey: {
      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',
          BOOL: true || false,
          BS: [
            new Buffer('...') || 'STRING_VALUE',
            /* more items */
          ],
          L: [
            /* recursive AttributeValue */,
            /* more items */
          ],
          M: {
            someKey: /* recursive AttributeValue */,
            /* anotherKey: ... */
          },
          N: 'STRING_VALUE',
          NS: [
            'STRING_VALUE',
            /* more items */
          ],
          NULL: true || false,
          S: 'STRING_VALUE',
          SS: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    /* anotherKey: ... */
  },
  Segment: 0,
  Select: 'ALL_ATTRIBUTES | ALL_PROJECTED_ATTRIBUTES | SPECIFIC_ATTRIBUTES | COUNT',
  TotalSegments: 0
};
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, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.

      This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.

      The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

      Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.

    • 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, or the count of matching items.

      • ALL_ATTRIBUTES - Returns all of the item attributes.

      • 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 neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES. You cannot use both AttributesToGet and Select 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.)

      Possible values include:
      • "ALL_ATTRIBUTES"
      • "ALL_PROJECTED_ATTRIBUTES"
      • "SPECIFIC_ATTRIBUTES"
      • "COUNT"
    • ScanFilter — (map<map>)

      This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.

      A condition that evaluates the scan results and returns only the desired values.

      Note: This parameter does not support attributes of type List or Map.

      If you specify more than one condition in the ScanFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)

      Each ScanFilter element consists of an attribute name to compare, along with the following:

      • AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator .

        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.

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

        For complete descriptions of all comparison operators, see Condition.

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

          A String data type.

        • N — (String)

          A Number data type.

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

          A Binary data type.

        • SS — (Array<String>)

          A String Set data type.

        • NS — (Array<String>)

          A Number Set data type.

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

          A Binary Set data type.

        • M — (map<map>)

          A Map of attribute values.

        • L — (Array<map>)

          A List of attribute values.

        • NULL — (Boolean)

          A Null data type.

        • BOOL — (Boolean)

          A Boolean data type.

      • ComparisonOperatorrequired — (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 datatypes, 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 datatypes, 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 datatypes, 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 datatypes, 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 within two sets.

          AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in 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, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.

      A logical operator to apply to the conditions in a ScanFilter map:

      • AND - If all of the conditions evaluate to true, then the entire map evaluates to true.

      • OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.

      If you omit ConditionalOperator, then AND is the default.

      The operation will succeed only if the entire map evaluates to true.

      Note: This parameter does not support attributes of type List or Map.
      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)

        A String data type.

      • N — (String)

        A Number data type.

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

        A Binary data type.

      • SS — (Array<String>)

        A String Set data type.

      • NS — (Array<String>)

        A Number Set data type.

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

        A Binary Set data type.

      • M — (map<map>)

        A Map of attribute values.

      • L — (Array<map>)

        A List of attribute values.

      • NULL — (Boolean)

        A Null data type.

      • BOOL — (Boolean)

        A Boolean data type.

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

      Note: ProjectionExpression replaces the legacy AttributesToGet parameter.
    • 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.

      Note: FilterExpression replaces the legacy ScanFilter and ConditionalOperator parameters.
    • 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)

        A String data type.

      • N — (String)

        A Number data type.

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

        A Binary data type.

      • SS — (Array<String>)

        A String Set data type.

      • NS — (Array<String>)

        A Number Set data type.

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

        A Binary Set data type.

      • M — (map<map>)

        A Map of attribute values.

      • L — (Array<map>)

        A List of attribute values.

      • NULL — (Boolean)

        A Null data type.

      • BOOL — (Boolean)

        A Boolean data type.

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

          A String data type.

        • N — (String)

          A Number data type.

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

          A Binary data type.

        • SS — (Array<String>)

          A String Set data type.

        • NS — (Array<String>)

          A Number Set data type.

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

          A Binary Set data type.

        • M — (map<map>)

          A Map of attribute values.

        • L — (Array<map>)

          A List of attribute values.

        • NULL — (Boolean)

          A Null data type.

        • BOOL — (Boolean)

          A Boolean data type.

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

          A String data type.

        • N — (String)

          A Number data type.

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

          A Binary data type.

        • SS — (Array<String>)

          A String Set data type.

        • NS — (Array<String>)

          A Number Set data type.

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

          A Binary Set data type.

        • M — (map<map>)

          A Map of attribute values.

        • L — (Array<map>)

          A List of attribute values.

        • NULL — (Boolean)

          A Null data type.

        • BOOL — (Boolean)

          A Boolean data type.

      • ConsumedCapacity — (map)

        The capacity units consumed by an 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 request asked for it. 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.

        • Table — (map)

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

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

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

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

(AWS.Request) updateItem(params = {}, callback)

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.

Examples:

Calling the updateItem operation

var params = {
  Key: { /* required */
    someKey: { /* AttributeValue */
      B: new Buffer('...') || 'STRING_VALUE',
      BOOL: true || false,
      BS: [
        new Buffer('...') || 'STRING_VALUE',
        /* more items */
      ],
      L: [
        /* recursive AttributeValue */,
        /* more items */
      ],
      M: {
        someKey: /* recursive AttributeValue */,
        /* anotherKey: ... */
      },
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      NULL: true || false,
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* anotherKey: ... */
  },
  TableName: 'STRING_VALUE', /* required */
  AttributeUpdates: {
    someKey: {
      Action: 'ADD | PUT | DELETE',
      Value: { /* AttributeValue */
        B: new Buffer('...') || 'STRING_VALUE',
        BOOL: true || false,
        BS: [
          new Buffer('...') || 'STRING_VALUE',
          /* more items */
        ],
        L: [
          /* recursive AttributeValue */,
          /* more items */
        ],
        M: {
          someKey: /* recursive AttributeValue */,
          /* anotherKey: ... */
        },
        N: 'STRING_VALUE',
        NS: [
          'STRING_VALUE',
          /* more items */
        ],
        NULL: true || false,
        S: 'STRING_VALUE',
        SS: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    /* anotherKey: ... */
  },
  ConditionExpression: 'STRING_VALUE',
  ConditionalOperator: 'AND | OR',
  Expected: {
    someKey: {
      AttributeValueList: [
        { /* AttributeValue */
          B: new Buffer('...') || 'STRING_VALUE',
          BOOL: true || false,
          BS: [
            new Buffer('...') || 'STRING_VALUE',
            /* more items */
          ],
          L: [
            /* recursive AttributeValue */,
            /* more items */
          ],
          M: {
            someKey: /* recursive AttributeValue */,
            /* anotherKey: ... */
          },
          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',
        BOOL: true || false,
        BS: [
          new Buffer('...') || 'STRING_VALUE',
          /* more items */
        ],
        L: [
          /* recursive AttributeValue */,
          /* more items */
        ],
        M: {
          someKey: /* recursive AttributeValue */,
          /* anotherKey: ... */
        },
        N: 'STRING_VALUE',
        NS: [
          'STRING_VALUE',
          /* more items */
        ],
        NULL: true || false,
        S: 'STRING_VALUE',
        SS: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    /* anotherKey: ... */
  },
  ExpressionAttributeNames: {
    someKey: 'STRING_VALUE',
    /* anotherKey: ... */
  },
  ExpressionAttributeValues: {
    someKey: { /* AttributeValue */
      B: new Buffer('...') || 'STRING_VALUE',
      BOOL: true || false,
      BS: [
        new Buffer('...') || 'STRING_VALUE',
        /* more items */
      ],
      L: [
        /* recursive AttributeValue */,
        /* more items */
      ],
      M: {
        someKey: /* recursive AttributeValue */,
        /* anotherKey: ... */
      },
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      NULL: true || false,
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* anotherKey: ... */
  },
  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)

        A String data type.

      • N — (String)

        A Number data type.

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

        A Binary data type.

      • SS — (Array<String>)

        A String Set data type.

      • NS — (Array<String>)

        A Number Set data type.

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

        A Binary Set data type.

      • M — (map<map>)

        A Map of attribute values.

      • L — (Array<map>)

        A List of attribute values.

      • NULL — (Boolean)

        A Null data type.

      • BOOL — (Boolean)

        A Boolean data type.

    • AttributeUpdates — (map<map>)

      This is a legacy parameter, for backward compatibility. New applications should use UpdateExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.

      This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements.

      The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any non-key attributes.

      Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.

      Each AttributeUpdates element consists of an attribute name to modify, along with the following:

      • Value - The new value, if applicable, for this attribute.

      • Action - A value that specifies how to perform the update. This action is only valid for an existing attribute whose data type is Number or is a set; do not use ADD for other data types.

        If an item with the specified primary key is found in the table, the following values perform the following actions:

        • PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.

        • DELETE - Removes the attribute and its value, if no value is specified for DELETE. 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 specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.

        • 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, with a value of 3.
          • If the existing data type is a set, and if Value is also a set, then Value is appended 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, Value must also be a set of strings.

        If no item with the specified key is found in the table, the following values perform the following actions:

        • PUT - Causes DynamoDB to create a new item with the specified primary key, and then adds the attribute.

        • DELETE - Nothing happens, because attributes cannot be deleted from a nonexistent item. The operation succeeds, but DynamoDB does not create a new item.

        • ADD - Causes DynamoDB to create 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.

      If you provide 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.

      • Value — (map)

        Represents the data for an attribute. You can set one, and only one, of the elements.

        Each attribute in an item is a name-value pair. An attribute can be single-valued or multi-valued set. For example, a book item can have title and authors attributes. Each book has one title but can have many authors. The multi-valued attribute is a set; duplicate values are not allowed.

        • S — (String)

          A String data type.

        • N — (String)

          A Number data type.

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

          A Binary data type.

        • SS — (Array<String>)

          A String Set data type.

        • NS — (Array<String>)

          A Number Set data type.

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

          A Binary Set data type.

        • M — (map<map>)

          A Map of attribute values.

        • L — (Array<map>)

          A List of attribute values.

        • NULL — (Boolean)

          A Null data type.

        • BOOL — (Boolean)

          A Boolean data type.

      • 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, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.

      A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.

      Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.

      If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)

      If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.

      Expected contains the following:

      • AttributeValueList - 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 type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

      • ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.

        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 datatypes, 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 datatypes, 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 datatypes, 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 datatypes, 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 within two sets.

          AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in 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.

      For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:

      • Value - A value for DynamoDB to compare with an attribute.

      • Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the 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 condition evaluates to true; otherwise the condition evaluate to false.

        • 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 condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.

        Note that the default value for Exists is true.

      The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.

      Note: This parameter does not support attributes of type List or Map.
      • Value — (map)

        Represents the data for an attribute. You can set one, and only one, of the elements.

        Each attribute in an item is a name-value pair. An attribute can be single-valued or multi-valued set. For example, a book item can have title and authors attributes. Each book has one title but can have many authors. The multi-valued attribute is a set; duplicate values are not allowed.

        • S — (String)

          A String data type.

        • N — (String)

          A Number data type.

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

          A Binary data type.

        • SS — (Array<String>)

          A String Set data type.

        • NS — (Array<String>)

          A Number Set data type.

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

          A Binary Set data type.

        • M — (map<map>)

          A Map of attribute values.

        • L — (Array<map>)

          A List of attribute values.

        • NULL — (Boolean)

          A Null data type.

        • BOOL — (Boolean)

          A Boolean data type.

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

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

        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 datatypes, 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 datatypes, 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 datatypes, 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 datatypes, 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 within two sets.

          AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in 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)

          A String data type.

        • N — (String)

          A Number data type.

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

          A Binary data type.

        • SS — (Array<String>)

          A String Set data type.

        • NS — (Array<String>)

          A Number Set data type.

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

          A Binary Set data type.

        • M — (map<map>)

          A Map of attribute values.

        • L — (Array<map>)

          A List of attribute values.

        • NULL — (Boolean)

          A Null data type.

        • BOOL — (Boolean)

          A Boolean data type.

    • ConditionalOperator — (String)

      This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.

      A logical operator to apply to the conditions in the Expected map:

      • AND - If all of the conditions evaluate to true, then the entire map evaluates to true.

      • OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.

      If you omit ConditionalOperator, then AND is the default.

      The operation will succeed only if the entire map evaluates to true.

      Note: This parameter does not support attributes of type List or Map.
      Possible values include:
      • "AND"
      • "OR"
    • ReturnValues — (String)

      Use ReturnValues if you want to get the item attributes as they appeared either before or after they were 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 - If UpdateItem overwrote an attribute name-value pair, then the content of the old item is returned.

      • UPDATED_OLD - The old versions of only the updated attributes are returned.

      • ALL_NEW - All of the attributes of the new version of the item are returned.

      • UPDATED_NEW - The new versions of only the updated attributes are returned.

      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.

      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.

      Note: UpdateExpression replaces the legacy AttributeUpdates parameter.
    • 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: = | &#x3C;&#x3E; | &#x3C; | &#x3E; | &#x3C;= | &#x3E;= | BETWEEN | IN

      • Logical operators: AND | OR | NOT

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

      Note: ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
    • 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)

        A String data type.

      • N — (String)

        A Number data type.

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

        A Binary data type.

      • SS — (Array<String>)

        A String Set data type.

      • NS — (Array<String>)

        A Number Set data type.

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

        A Binary Set data type.

      • M — (map<map>)

        A Map of attribute values.

      • L — (Array<map>)

        A List of attribute values.

      • NULL — (Boolean)

        A Null data type.

      • BOOL — (Boolean)

        A Boolean data type.

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 appeared before the UpdateItem operation. This map only appears if ReturnValues was specified as something other than NONE in the request. Each element represents one attribute.

        • S — (String)

          A String data type.

        • N — (String)

          A Number data type.

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

          A Binary data type.

        • SS — (Array<String>)

          A String Set data type.

        • NS — (Array<String>)

          A Number Set data type.

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

          A Binary Set data type.

        • M — (map<map>)

          A Map of attribute values.

        • L — (Array<map>)

          A List of attribute values.

        • NULL — (Boolean)

          A Null data type.

        • BOOL — (Boolean)

          A Boolean data type.

      • ConsumedCapacity — (map)

        The capacity units consumed by an 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 request asked for it. 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.

        • Table — (map)

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

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

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

          • 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 operation. ItemCollectionMetrics is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response.

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

            A String data type.

          • N — (String)

            A Number data type.

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

            A Binary data type.

          • SS — (Array<String>)

            A String Set data type.

          • NS — (Array<String>)

            A Number Set data type.

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

            A Binary Set data type.

          • M — (map<map>)

            A Map of attribute values.

          • L — (Array<map>)

            A List of attribute values.

          • NULL — (Boolean)

            A Null data type.

          • BOOL — (Boolean)

            A Boolean data type.

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

(AWS.Request) updateTable(params = {}, callback)

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.

Examples:

Calling the updateTable operation

var params = {
  TableName: 'STRING_VALUE', /* required */
  AttributeDefinitions: [
    {
      AttributeName: 'STRING_VALUE', /* required */
      AttributeType: 'S | N | B' /* required */
    },
    /* more items */
  ],
  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: { /* required */
          ReadCapacityUnits: 0, /* required */
          WriteCapacityUnits: 0 /* required */
        }
      },
      Delete: {
        IndexName: 'STRING_VALUE' /* required */
      },
      Update: {
        IndexName: 'STRING_VALUE', /* required */
        ProvisionedThroughput: { /* required */
          ReadCapacityUnits: 0, /* required */
          WriteCapacityUnits: 0 /* required */
        }
      }
    },
    /* more items */
  ],
  ProvisionedThroughput: {
    ReadCapacityUnits: 0, /* required */
    WriteCapacityUnits: 0 /* required */
  },
  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.

      • AttributeNamerequired — (String)

        A name for the attribute.

      • AttributeTyperequired — (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.

    • ProvisionedThroughput — (map)

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

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

      • ReadCapacityUnitsrequired — (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.

      • WriteCapacityUnitsrequired — (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.

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

        • IndexNamerequired — (String)

          The name of the global secondary index to be updated.

        • ProvisionedThroughputrequired — (map)

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

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

          • ReadCapacityUnitsrequired — (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.

          • WriteCapacityUnitsrequired — (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.

      • Create — (map)

        The parameters required for creating a global secondary index on an existing table:

        • IndexName

        • KeySchema

        • AttributeDefinitions

        • Projection

        • ProvisionedThroughput

        • IndexNamerequired — (String)

          The name of the global secondary index to be created.

        • KeySchemarequired — (Array<map>)

          The key schema for the global secondary index.

          • AttributeNamerequired — (String)

            The name of a key attribute.

          • KeyTyperequired — (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"
        • Projectionrequired — (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.

        • ProvisionedThroughputrequired — (map)

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

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

          • ReadCapacityUnitsrequired — (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.

          • WriteCapacityUnitsrequired — (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.

      • Delete — (map)

        The name of an existing global secondary index to be removed.

        • IndexNamerequired — (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)

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

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

        • StreamViewType - 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"

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.

          • AttributeNamerequired — (String)

            A name for the attribute.

          • AttributeTyperequired — (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.

          • AttributeNamerequired — (String)

            The name of a key attribute.

          • KeyTyperequired — (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.

        • 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.
            • AttributeNamerequired — (String)

              The name of a key attribute.

            • KeyTyperequired — (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 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.

          • 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.
            • AttributeNamerequired — (String)

              The name of a key attribute.

            • KeyTyperequired — (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 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.

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

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

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

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

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

Returns:

  • (AWS.Request)

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

(AWS.Request) waitFor(state, params = {}, callback)

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)

        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.

          • AttributeNamerequired — (String)

            A name for the attribute.

          • AttributeTyperequired — (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.

          • AttributeNamerequired — (String)

            The name of a key attribute.

          • KeyTyperequired — (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.

        • 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.
            • AttributeNamerequired — (String)

              The name of a key attribute.

            • KeyTyperequired — (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 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.

          • 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.
            • AttributeNamerequired — (String)

              The name of a key attribute.

            • KeyTyperequired — (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 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.

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

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

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

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

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

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)

        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.

          • AttributeNamerequired — (String)

            A name for the attribute.

          • AttributeTyperequired — (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.

          • AttributeNamerequired — (String)

            The name of a key attribute.

          • KeyTyperequired — (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.

        • 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.
            • AttributeNamerequired — (String)

              The name of a key attribute.

            • KeyTyperequired — (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 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.

          • 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.
            • AttributeNamerequired — (String)

              The name of a key attribute.

            • KeyTyperequired — (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 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.

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

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

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

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

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

Returns:

  • (AWS.Request)

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

See Also: