# aws4-with-assume-role

> aws4 with assume role

Latest version **0.1.2** (published 2021-06-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install aws4-with-assume-role
pnpm add aws4-with-assume-role
yarn add aws4-with-assume-role
bun add aws4-with-assume-role
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2021-06-27 |
| First published | 2018-06-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 8.3 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Kengo Nakatsuka |
| Maintainers | nak2k |
| Keywords | aws, aws4, signature |

## Links

- npm: https://www.npmjs.com/package/aws4-with-assume-role
- Repository: https://github.com/nak2k/node-aws4-with-assume-role
- Issues: https://github.com/nak2k/node-aws4-with-assume-role/issues
- npm.io page: https://npm.io/package/aws4-with-assume-role

## Dependencies (5)

- [ini](https://npm.io/package/ini.md) ^2.0.0
- [arn2](https://npm.io/package/arn2.md) ^0.1.1
- [aws4](https://npm.io/package/aws4.md) ^1.7.0
- [xml2js](https://npm.io/package/xml2js.md) ^0.4.19
- [proxy-agent](https://npm.io/package/proxy-agent.md) ^4.0.1

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 0.1.2 (latest) — 2021-06-27
- 0.1.1 — 2018-09-16
- 0.1.0 — 2018-08-08
- 0.0.2 — 2018-07-02
- 0.0.1 — 2018-06-30

## README

# aws4-with-assume-role

[aws4](https://github.com/mhart/aws4#readme) with assume role.

## Installation

```
npm i aws4-with-assume-role
```

## Usage

``` javascript
const { makeSigner } = require('aws4-with-assume-role');

makeSigner({
  profile: 'my_profile',
  region: 'us-west-2',
}, (err, sign) => {
  if (err) {
    return callback(err);
  }

  /*
   * Make a signed request options with credentials of 'my_profile'.
   */
  const requestOptions = sign({
    service: 's3',
    path: '/',
    signQuery: true,
  });
});
```

## makeSigner([options, ]callback)

- `options.profile`
    - A name of a profile that gets a credential.
- `options.region`
    - A target region to which an request calls.
- `callback(err, sign)`
    - A function that is called when a signer function has made or an error occurs.

## License

MIT

---
_Source: https://npm.io/package/aws4-with-assume-role · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
