aws-client/README.md

Minimalist Node.js client for AWS services

# aws-client
Minimalist Node.js client for AWS services

Currently Supports:

 * **DynamoDB** (get, batchGet, put, batchPut, query) - *DynamoClient*
 * **SNS** (publish) - *SNSClient*

# Installation

`npm install aws-client`

If you are using any v1 functions (i.e. function name does not end in v2), then you must also install aws-sdk:

`npm install aws-sdk`

aws-client v2 functions do not require any additional imports as this package imports the required modular packages (new AWS SDK v3 feature). Eventually all v1 packages will migrate to aws-client v2

# Import

You can import one or many clients depending on what you need:

ES6 Import:

`import { DynamoClient, SNSClient } from 'aws-client'`

CommonJS:

`const { DynamoClient, SNSClient } = require('aws-client')`

# Usage

```
const client = new DynamoClient({
  region: 'eu-west-1',
  tableName: 'users-prod'
})

const getUser = async (id) => {
  const data = await client.get({ id })
  console.log(data)
}

getUser('fred')
```
If there is a DynamoDB table called *users-prod* in your AWS account containing an item with the primary key (id) of 'fred', the above code will print it to the console.