Minimalist AWS Client for Node.js

Common errors

• Error: Cannot find module 'aws-sdk'

  cause Legacy 'v1' functions were used without installing the `aws-sdk` package, which became an optional peer dependency for those functions starting in v2.
  fix Run `npm install aws-sdk` if you intend to use 'v1' functions. Otherwise, refactor your code to use 'v2' functions which do not have this dependency.

• TypeError: client.unsupportedMethod is not a function

  cause Attempting to call an AWS service method that `aws-client` does not explicitly wrap or support. The library provides a minimalist API.
  fix Verify that the desired operation is listed in the `aws-client` documentation for the specific client (e.g., `DynamoClient`, `SNSClient`). If not supported, use the official AWS SDK directly for that operation.

Warnings

• gotcha Prior to version 2, `aws-client` functions required the full `aws-sdk` package. With the introduction of 'v2 functions' in version 2, the library began using modular AWS SDK v3 packages internally. However, if you are still using 'v1 functions', you *must* explicitly install `aws-sdk` as a separate dependency.
  Fix: If using `v1` functions, run `npm install aws-sdk`. It is recommended to migrate to the `v2` functions as `v1` functions will eventually be deprecated and removed.
• gotcha `aws-client` is intentionally minimalist and only supports a limited set of operations for DynamoDB and SNS. It does not provide full coverage of all AWS services or all operations within supported services. Attempting to use an unsupported service or operation will result in runtime errors.
  Fix: Consult the package documentation for the list of supported services and operations. For broader AWS service coverage or unsupported operations, consider using the official AWS SDK directly.

Install

• npm install aws-client npm
• yarn add aws-client yarn
• pnpm add aws-client pnpm

Imports

• DynamoClient
  wrong:

  const DynamoClient = require('aws-client').DynamoClient

  correct:

  import { DynamoClient } from 'aws-client'

  ES6 named import. For CommonJS, use destructuring `const { DynamoClient } = require('aws-client')`.
• SNSClient
  wrong:

  const SNSClient = require('aws-client').SNSClient

  correct:

  import { SNSClient } from 'aws-client'

  ES6 named import. For CommonJS, use destructuring `const { SNSClient } = require('aws-client')`.
• { DynamoClient, SNSClient }
  wrong:

  import awsClient from 'aws-client'; const dynamo = new awsClient.DynamoClient(...)

  correct:

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

  The library exports named clients, not a default export or a single object containing all clients. Always use named imports or destructuring require.

Quickstart

Demonstrates initializing a DynamoClient and fetching an item by ID. Includes error handling and shows the minimalist API for a common DynamoDB operation.

import { DynamoClient } from 'aws-client';

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

const getUser = async (id) => {
  try {
    const data = await client.get({ id });
    console.log('User data:', data);
  } catch (error) {
    console.error('Error fetching user:', error.message);
  }
};

getUser('fred');
// Example: batch operations (if 'users-prod' has items with ids 'fred' and 'jane')
// const getMultipleUsers = async () => {
//   const data = await client.batchGet(['fred', 'jane']);
//   console.log('Batch user data:', data);
// };
// getMultipleUsers();