README.md

DynamoDB (Document Client)

Get an instance of the DynamoDB DocumentClient, stored as client on a DynamoDB instance. All methods described in the docs are available.

To set up the lib:

const aws = require('@sparkpost/aws')
const ddb = new aws.DynamoDB().client // DynamoDB() constructor takes optional Document Client config object if necessary

Regular callback usage:

const getParams = {
  TableName: 'some_table',
  Key: {
    my_partition_key: 'abc;123'
  }
}

ddb.get(getParams, (err, result) => {
  if (err) return console.log('error', err)
  console.log('success', result)
})

The client has been "promisified" using Bluebird's promisifyAll method to attach promise-versions of all available methods, which are then available at <methodName>Async.

Promise usage:

const getParams = {
  TableName: 'some_table',
  Key: {
    my_partition_key: 'abc;123'
  }
}

ddb.getAsync(getParams)
  .then((result) => console.log('success', result))
  .catch((err) => console.log('error', err))