Class: AWS.DynamoDB (2011-12-05)

var params = {
  RequestItems: { /* required */
    '<TableName>': [
      {
        DeleteRequest: {
          Key: { /* required */
            HashKeyElement: { /* required */
              B: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
              BS: [
                Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
                /* more items */
              ],
              N: 'STRING_VALUE',
              NS: [
                'STRING_VALUE',
                /* more items */
              ],
              S: 'STRING_VALUE',
              SS: [
                'STRING_VALUE',
                /* more items */
              ]
            },
            RangeKeyElement: {
              B: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
              BS: [
                Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
                /* more items */
              ],
              N: 'STRING_VALUE',
              NS: [
                'STRING_VALUE',
                /* more items */
              ],
              S: 'STRING_VALUE',
              SS: [
                'STRING_VALUE',
                /* more items */
              ]
            }
          }
        },
        PutRequest: {
          Item: { /* required */
            '<AttributeName>': {
              B: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
              BS: [
                Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
                /* more items */
              ],
              N: 'STRING_VALUE',
              NS: [
                'STRING_VALUE',
                /* more items */
              ],
              S: 'STRING_VALUE',
              SS: [
                'STRING_VALUE',
                /* more items */
              ]
            },
            /* '<AttributeName>': ... */
          }
        }
      },
      /* more items */
    ],
    /* '<TableName>': ... */
  }
};
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 table name to list-of-write-requests. Used as input to the BatchWriteItem API call

    • PutRequest — (map)

      A container for a Put BatchWrite request

      • Item — required — (map<map>)

        The item to put

        • S — (String)

          Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).

        • N — (String)

          Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.

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

          Binary attributes are sequences of unsigned bytes.

        • SS — (Array<String>)

          A set of strings.

        • NS — (Array<String>)

          A set of numbers.

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

          A set of binary attributes.

    • DeleteRequest — (map)

      A container for a Delete BatchWrite request

      • Key — required — (map)

        The item's key to be delete

        • HashKeyElement — required — (map)

          A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.

          • S — (String)

            Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).

          • N — (String)

            Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.

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

            Binary attributes are sequences of unsigned bytes.

          • SS — (Array<String>)

            A set of strings.

          • NS — (Array<String>)

            A set of numbers.

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

            A set of binary attributes.

        • RangeKeyElement — (map)

          A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.

          • S — (String)

            Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).

          • N — (String)

            Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.

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

            Binary attributes are sequences of unsigned bytes.

          • SS — (Array<String>)

            A set of strings.

          • NS — (Array<String>)

            A set of numbers.

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

            A set of binary attributes.

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

      The response object as a result of BatchWriteItem call. This is essentially a map of table name to ConsumedCapacityUnits.

      • ConsumedCapacityUnits — (Float)

        The number of Capacity Units of the provisioned throughput of the table consumed during the operation. GetItem, BatchGetItem, BatchWriteItem, Query, and Scan operations consume ReadCapacityUnits, while PutItem, UpdateItem, and DeleteItem operations consume WriteCapacityUnits.

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

      The Items which we could not successfully process in a BatchWriteItem call is returned as UnprocessedItems

      • PutRequest — (map)

        A container for a Put BatchWrite request

        • Item — required — (map<map>)

          The item to put

          • S — (String)

            Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).

          • N — (String)

            Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.

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

            Binary attributes are sequences of unsigned bytes.

          • SS — (Array<String>)

            A set of strings.

          • NS — (Array<String>)

            A set of numbers.

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

            A set of binary attributes.

      • DeleteRequest — (map)

        A container for a Delete BatchWrite request

        • Key — required — (map)

          The item's key to be delete

          • HashKeyElement — required — (map)

            A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.

            • S — (String)

              Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).

            • N — (String)

              Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.

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

              Binary attributes are sequences of unsigned bytes.

            • SS — (Array<String>)

              A set of strings.

            • NS — (Array<String>)

              A set of numbers.

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

              A set of binary attributes.

          • RangeKeyElement — (map)

            A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.

            • S — (String)

              Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).

            • N — (String)

              Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.

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

              Binary attributes are sequences of unsigned bytes.

            • SS — (Array<String>)

              A set of strings.

            • NS — (Array<String>)

              A set of numbers.

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

              A set of binary attributes.

Returns:

• (AWS.Request) —

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

var params = {
  KeySchema: { /* required */
    HashKeyElement: { /* required */
      AttributeName: 'STRING_VALUE', /* required */
      AttributeType: S | N | B /* required */
    },
    RangeKeyElement: {
      AttributeName: 'STRING_VALUE', /* required */
      AttributeType: S | N | B /* required */
    }
  },
  ProvisionedThroughput: { /* required */
    ReadCapacityUnits: 'NUMBER_VALUE', /* required */
    WriteCapacityUnits: 'NUMBER_VALUE' /* required */
  },
  TableName: 'STRING_VALUE' /* required */
};
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: {}) —
  • TableName — (String)

    The name of the table you want to create. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

  • KeySchema — (map)

    The KeySchema identifies the primary key as a one attribute primary key (hash) or a composite two attribute (hash-and-range) primary key. Single attribute primary keys have one index value: a HashKeyElement. A composite hash-and-range primary key contains two attribute values: a HashKeyElement and a RangeKeyElement.

    • HashKeyElement — required — (map)

      A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.

      • AttributeName — required — (String)

        The AttributeName of the KeySchemaElement.

      • AttributeType — required — (String)

        The AttributeType of the KeySchemaElement which can be a String or a Number.

        Possible values include:
        • "S"
        • "N"
        • "B"
    • RangeKeyElement — (map)

      A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.

      • AttributeName — required — (String)

        The AttributeName of the KeySchemaElement.

      • AttributeType — required — (String)

        The AttributeType of the KeySchemaElement which can be a String or a Number.

        Possible values include:
        • "S"
        • "N"
        • "B"
  • ProvisionedThroughput — (map)

    Provisioned throughput reserves the required read and write resources for your table in terms of ReadCapacityUnits and WriteCapacityUnits. Values for provisioned throughput depend upon your expected read/write rates, item size, and consistency. Provide the expected number of read and write operations, assuming an item size of 1k and strictly consistent reads. For 2k item size, double the value. For 3k, triple the value, etc. Eventually-consistent reads consume half the resources of strictly consistent reads.

    • ReadCapacityUnits — required — (Integer)

      ReadCapacityUnits are in terms of strictly consistent reads, assuming items of 1k. 2k items require twice the ReadCapacityUnits. Eventually-consistent reads only require half the ReadCapacityUnits of stirctly consistent reads.

    • WriteCapacityUnits — required — (Integer)

      WriteCapacityUnits are in terms of strictly consistent reads, assuming items of 1k. 2k items require twice the WriteCapacityUnits.

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

        The name of the table being described.

      • KeySchema — (map)

        The KeySchema identifies the primary key as a one attribute primary key (hash) or a composite two attribute (hash-and-range) primary key. Single attribute primary keys have one index value: a HashKeyElement. A composite hash-and-range primary key contains two attribute values: a HashKeyElement and a RangeKeyElement.

        • HashKeyElement — required — (map)

          A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.

          • AttributeName — required — (String)

            The AttributeName of the KeySchemaElement.

          • AttributeType — required — (String)

            The AttributeType of the KeySchemaElement which can be a String or a Number.

            Possible values include:
            • "S"
            • "N"
            • "B"
        • RangeKeyElement — (map)

          A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.

          • AttributeName — required — (String)

            The AttributeName of the KeySchemaElement.

          • AttributeType — required — (String)

            The AttributeType of the KeySchemaElement which can be a String or a Number.

            Possible values include:
            • "S"
            • "N"
            • "B"
      • TableStatus — (String) Possible values include:
        • "CREATING"
        • "UPDATING"
        • "DELETING"
        • "ACTIVE"
      • CreationDateTime — (Date)
      • ProvisionedThroughput — (map)
        • LastIncreaseDateTime — (Date)
        • LastDecreaseDateTime — (Date)
        • NumberOfDecreasesToday — (Integer)
        • ReadCapacityUnits — (Integer)
        • WriteCapacityUnits — (Integer)
      • TableSizeBytes — (Integer)
      • ItemCount — (Integer)

Returns:

• (AWS.Request) —

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

var params = {
  Key: { /* required */
    HashKeyElement: { /* required */
      B: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
      BS: [
        Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
        /* more items */
      ],
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    RangeKeyElement: {
      B: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
      BS: [
        Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
        /* more items */
      ],
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    }
  },
  TableName: 'STRING_VALUE', /* required */
  Expected: {
    '<AttributeName>': {
      Exists: true || false,
      Value: {
        B: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
        BS: [
          Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
          /* more items */
        ],
        N: 'STRING_VALUE',
        NS: [
          'STRING_VALUE',
          /* more items */
        ],
        S: 'STRING_VALUE',
        SS: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    /* '<AttributeName>': ... */
  },
  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 in which you want to delete an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

  • Key — (map)

    The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

    • HashKeyElement — required — (map)

      A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.

      • S — (String)

        Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).

      • N — (String)

        Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.

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

        Binary attributes are sequences of unsigned bytes.

      • SS — (Array<String>)

        A set of strings.

      • NS — (Array<String>)

        A set of numbers.

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

        A set of binary attributes.

    • RangeKeyElement — (map)

      A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.

      • S — (String)

        Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).

      • N — (String)

        Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.

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

        Binary attributes are sequences of unsigned bytes.

      • SS — (Array<String>)

        A set of strings.

      • NS — (Array<String>)

        A set of numbers.

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

        A set of binary attributes.

  • Expected — (map<map>)

    Designates an attribute for a conditional modification. The Expected parameter allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute has a particular value before modifying it.

    • Value — (map)

      Specify whether or not a value already exists and has a specific content for the attribute name-value pair.

      • S — (String)

        Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).

      • N — (String)

        Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.

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

        Binary attributes are sequences of unsigned bytes.

      • SS — (Array<String>)

        A set of strings.

      • NS — (Array<String>)

        A set of numbers.

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

        A set of binary attributes.

    • Exists — (Boolean)

      Specify whether or not a value already exists for the attribute name-value pair.

  • ReturnValues — (String)

    Use this parameter if you want to get the attribute name-value pairs before or after they are modified. For PUT operations, the possible parameter values are NONE (default) or ALL_OLD. For update operations, the possible parameter values are NONE (default) or ALL_OLD, UPDATED_OLD, ALL_NEW or UPDATED_NEW.

    • NONE: Nothing is returned.
    • ALL_OLD: Returns the attributes of the item as they were before the operation.
    • UPDATED_OLD: Returns the values of the updated attributes, only, as they were before the operation.
    • ALL_NEW: Returns all the attributes and their new values after the operation.
    • UPDATED_NEW: Returns the values of the updated attributes, only, as they are after the operation.
    Possible values include:
    • "NONE"
    • "ALL_OLD"
    • "UPDATED_OLD"
    • "ALL_NEW"
    • "UPDATED_NEW"

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

      If the ReturnValues parameter is provided as ALL_OLD in the request, Amazon DynamoDB returns an array of attribute name-value pairs (essentially, the deleted item). Otherwise, the response contains an empty set.

      • S — (String)

        Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).

      • N — (String)

        Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.

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

        Binary attributes are sequences of unsigned bytes.

      • SS — (Array<String>)

        A set of strings.

      • NS — (Array<String>)

        A set of numbers.

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

        A set of binary attributes.

    • ConsumedCapacityUnits — (Float)

      The number of Capacity Units of the provisioned throughput of the table consumed during the operation. GetItem, BatchGetItem, BatchWriteItem, Query, and Scan operations consume ReadCapacityUnits, while PutItem, UpdateItem, and DeleteItem operations consume WriteCapacityUnits.

Returns:

• (AWS.Request) —

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

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 you want to delete. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

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

        The name of the table being described.

      • KeySchema — (map)

        The KeySchema identifies the primary key as a one attribute primary key (hash) or a composite two attribute (hash-and-range) primary key. Single attribute primary keys have one index value: a HashKeyElement. A composite hash-and-range primary key contains two attribute values: a HashKeyElement and a RangeKeyElement.

        • HashKeyElement — required — (map)

          A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.

          • AttributeName — required — (String)

            The AttributeName of the KeySchemaElement.

          • AttributeType — required — (String)

            The AttributeType of the KeySchemaElement which can be a String or a Number.

            Possible values include:
            • "S"
            • "N"
            • "B"
        • RangeKeyElement — (map)

          A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.

          • AttributeName — required — (String)

            The AttributeName of the KeySchemaElement.

          • AttributeType — required — (String)

            The AttributeType of the KeySchemaElement which can be a String or a Number.

            Possible values include:
            • "S"
            • "N"
            • "B"
      • TableStatus — (String) Possible values include:
        • "CREATING"
        • "UPDATING"
        • "DELETING"
        • "ACTIVE"
      • CreationDateTime — (Date)
      • ProvisionedThroughput — (map)
        • LastIncreaseDateTime — (Date)
        • LastDecreaseDateTime — (Date)
        • NumberOfDecreasesToday — (Integer)
        • ReadCapacityUnits — (Integer)
        • WriteCapacityUnits — (Integer)
      • TableSizeBytes — (Integer)
      • ItemCount — (Integer)

Returns:

• (AWS.Request) —

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

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 you want to describe. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

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

        The name of the table being described.

      • KeySchema — (map)

        The KeySchema identifies the primary key as a one attribute primary key (hash) or a composite two attribute (hash-and-range) primary key. Single attribute primary keys have one index value: a HashKeyElement. A composite hash-and-range primary key contains two attribute values: a HashKeyElement and a RangeKeyElement.

        • HashKeyElement — required — (map)

          A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.

          • AttributeName — required — (String)

            The AttributeName of the KeySchemaElement.

          • AttributeType — required — (String)

            The AttributeType of the KeySchemaElement which can be a String or a Number.

            Possible values include:
            • "S"
            • "N"
            • "B"
        • RangeKeyElement — (map)

          A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.

          • AttributeName — required — (String)

            The AttributeName of the KeySchemaElement.

          • AttributeType — required — (String)

            The AttributeType of the KeySchemaElement which can be a String or a Number.

            Possible values include:
            • "S"
            • "N"
            • "B"
      • TableStatus — (String) Possible values include:
        • "CREATING"
        • "UPDATING"
        • "DELETING"
        • "ACTIVE"
      • CreationDateTime — (Date)
      • ProvisionedThroughput — (map)
        • LastIncreaseDateTime — (Date)
        • LastDecreaseDateTime — (Date)
        • NumberOfDecreasesToday — (Integer)
        • ReadCapacityUnits — (Integer)
        • WriteCapacityUnits — (Integer)
      • TableSizeBytes — (Integer)
      • ItemCount — (Integer)

Returns:

• (AWS.Request) —

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

Waiter Resource States:

• tableExists

• tableNotExists

var params = {
  Key: { /* required */
    HashKeyElement: { /* required */
      B: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
      BS: [
        Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
        /* more items */
      ],
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    RangeKeyElement: {
      B: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
      BS: [
        Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
        /* more items */
      ],
      N: 'STRING_VALUE',
      NS: [
        'STRING_VALUE',
        /* more items */
      ],
      S: 'STRING_VALUE',
      SS: [
        'STRING_VALUE',
        /* more items */
      ]
    }
  },
  TableName: 'STRING_VALUE', /* required */
  AttributesToGet: [
    'STRING_VALUE',
    /* more items */
  ],
  ConsistentRead: true || false
};
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 in which you want to get an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

  • Key — (map)

    The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.

    • HashKeyElement — required — (map)

      A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be String, Number, StringSet, NumberSet.

      • S — (String)

        Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).

      • N — (String)

        Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.

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

        Binary attributes are sequences of unsigned bytes.

      • SS — (Array<String>)

        A set of strings.

      • NS — (Array<String>)

        A set of numbers.

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

        A set of binary attributes.

    • RangeKeyElement — (map)

      A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be String, Number, StringSet, NumberSet.

      • S — (String)

        Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k).

      • N — (String)

        Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126.

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

        Binary attributes are sequences of unsigned bytes.

      • SS — (Array<String>)

        A set of strings.

      • NS — (Array<String>)