exoego / aws-lite Goto Github PK

aws-lite is simple, extremely fast, extensible Node.js client for interacting with AWS services.

(It's got good error reporting, too.)

You can think of it as a community-driven alternative to AWS's JavaScript SDK.

• Who made this?
• So, what is aws-lite?
• Why not use aws-sdk / @aws-sdk/*?
• Features
• Install aws-lite
• Example
• Learn more
  • Client configuration
  • Requests / responses
  • Using TypeScript
  • Plugin API
  • Performance
  • Contributing
• List of official @aws-lite/* plugins

aws-lite is developed and maintained by the folks at OpenJS Foundation Architect. We <3 AWS!

aws-lite is a simple, extremely fast, extensible Node.js client for interacting with AWS services.

(It's got good error reporting, too.)

You can think of it as a community-driven alternative to AWS's JavaScript SDK.

Amazon has historically done a great job of maintaining its SDKs. However, AWS has deprecated its widely-adopted v2 SDK; its v3 SDK relies on generated code, resulting in large dependencies, poor performance, awkward semantics, difficult to understand documentation, and errors without usable stack traces.

We rely on and believe in AWS, so we built aws-lite to provide a simpler, faster, more stable position from which to work with AWS services in Node.js.

• 2-5x faster than AWS SDK v3
• Simple semantics & straightforward promise-based interface
• Human-readable documentation
• Customizable
• Errors with stack traces and line numbers
• Built-in pagination
• Secured with AWS Signature v4
• Interacts with any AWS service without needing any plugins
• Automatically parses / serializes JSON, AWS-flavored JSON, and XML request / response payloads
• Easily integrates with local testing suites and AWS service mocks
• Use existing service plugins, or develop your own
• Debug mode for inspecting raw requests and responses
• Just two dependencies

Install the client:

npm i @aws-lite/client

You can use the client as-is to quickly interact with AWS service APIs, or extend it with specific service plugins like so:

npm i @aws-lite/dynamodb

Generally, types are available as optional @aws-lite/*-types packages, and can be added like so:

npm i -D @aws-lite/dynamodb-types

Learn more about aws-lite types.

Now start making calls to AWS:

// Instantiate a client with the DynamoDB plugin
import awsLite from '@aws-lite/client'
const aws = await awsLite({ region: 'us-west-1', plugins: [ import('@aws-lite/dynamodb') ] })

// Easily interact with the AWS services your application relies on
await aws.DynamoDB.PutItem({
  TableName: '$table-name',
  Item: {
    // AWS-lite automatically de/serializes DynamoDB JSON
    pk: '$item-key',
    data: {
      ok: true,
      hi: 'friends'
    }
  }
})

await aws.DynamoDB.GetItem({
  TableName: '$table-name',
  Key: { pk: '$item-key' }
})
// {
//   Item: {
//     pk: '$item-key',
//     data: data: {
//       ok: true,
//       hi: 'friends'
//     }
//   }
// }

// Use the lower-level client to fire a GET request by specifying a `service` and `endpoint`
await aws({
  service: 'lambda',
  endpoint: '/2015-03-31/functions/$function-name/configuration',
})
// {
//   FunctionName: '$function-name',
//   Runtime: 'nodejs20.x',
//   ...
// }

// POST JSON by adding a `payload` property
await aws({
  service: 'lambda',
  endpoint: '/2015-03-31/functions/$function-name/invocations',
  payload: { ok: true },
})

Credential and general configuration options for aws-lite

Using aws-lite to make requests and receiving responses

Guide and examples for using TypeScript with aws-lite

Docs and examples for the aws-lite plugin API

Open, reproducible, real-world metrics for the performance of aws-lite and other AWS SDKs

Open source contributor guidelines, methodology, and instructions

• API Gateway V2
• API Gateway WebSocket Management API
• CloudFormation
• CloudFront
• CloudWatch Logs
• DynamoDB
• Lambda
• RDS Data Service
• S3
• SNS
• SQS
• SSM