# @aws-sdk/client-s3-node

> Node SDK for Amazon Simple Storage Service

Latest version **0.1.0-preview.2** (published 2019-07-12) · Apache-2.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @aws-sdk/client-s3-node
pnpm add @aws-sdk/client-s3-node
yarn add @aws-sdk/client-s3-node
bun add @aws-sdk/client-s3-node
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.1.0-preview.2 |
| Published | 2019-07-12 |
| First published | 2019-07-12 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 32 |
| Unpacked size | 1.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | AWS SDK for JavaScript Team |
| Maintainers | trivikr-aws, aws-sdk-bot, zheallan, amzn-oss |

## Links

- npm: https://www.npmjs.com/package/@aws-sdk/client-s3-node
- npm.io page: https://npm.io/package/@aws-sdk/client-s3-node

## Dependencies (32)

- [tslib](https://npm.io/package/tslib.md) ^1.8.0
- [@aws-sdk/types](https://npm.io/package/@aws-sdk/types.md) ^0.1.0-preview.4
- [@aws-sdk/hash-node](https://npm.io/package/@aws-sdk/hash-node.md) ^0.1.0-preview.4
- [@aws-sdk/core-handler](https://npm.io/package/@aws-sdk/core-handler.md) ^0.1.0-preview.4
- [@aws-sdk/signature-v4](https://npm.io/package/@aws-sdk/signature-v4.md) ^0.1.0-preview.5
- [@aws-sdk/protocol-rest](https://npm.io/package/@aws-sdk/protocol-rest.md) ^0.1.0-preview.6
- [@aws-sdk/util-utf8-node](https://npm.io/package/@aws-sdk/util-utf8-node.md) ^0.1.0-preview.2
- [@aws-sdk/config-resolver](https://npm.io/package/@aws-sdk/config-resolver.md) ^0.1.0-preview.4
- [@aws-sdk/region-provider](https://npm.io/package/@aws-sdk/region-provider.md) ^0.1.0-preview.4
- [@aws-sdk/ssec-middleware](https://npm.io/package/@aws-sdk/ssec-middleware.md) ^0.1.0-preview.4
- [@aws-sdk/url-parser-node](https://npm.io/package/@aws-sdk/url-parser-node.md) ^0.1.0-preview.4
- [@aws-sdk/xml-body-parser](https://npm.io/package/@aws-sdk/xml-body-parser.md) ^0.1.0-preview.5
- [@aws-sdk/hash-stream-node](https://npm.io/package/@aws-sdk/hash-stream-node.md) ^0.1.0-preview.5
- [@aws-sdk/middleware-stack](https://npm.io/package/@aws-sdk/middleware-stack.md) ^0.1.0-preview.5
- [@aws-sdk/retry-middleware](https://npm.io/package/@aws-sdk/retry-middleware.md) ^0.1.0-preview.4
- [@aws-sdk/util-base64-node](https://npm.io/package/@aws-sdk/util-base64-node.md) ^0.1.0-preview.2
- [@aws-sdk/xml-body-builder](https://npm.io/package/@aws-sdk/xml-body-builder.md) ^0.1.0-preview.4
- [@aws-sdk/node-http-handler](https://npm.io/package/@aws-sdk/node-http-handler.md) ^0.1.0-preview.5
- [@aws-sdk/signing-middleware](https://npm.io/package/@aws-sdk/signing-middleware.md) ^0.1.0-preview.5
- [@aws-sdk/util-user-agent-node](https://npm.io/package/@aws-sdk/util-user-agent-node.md) ^0.1.0-preview.5
- [@aws-sdk/middleware-serializer](https://npm.io/package/@aws-sdk/middleware-serializer.md) ^0.1.0-preview.4
- [@aws-sdk/s3-error-unmarshaller](https://npm.io/package/@aws-sdk/s3-error-unmarshaller.md) ^0.1.0-preview.2
- [@aws-sdk/stream-collector-node](https://npm.io/package/@aws-sdk/stream-collector-node.md) ^0.1.0-preview.4
- [@aws-sdk/util-body-length-node](https://npm.io/package/@aws-sdk/util-body-length-node.md) ^0.1.0-preview.3
- [@aws-sdk/credential-provider-node](https://npm.io/package/@aws-sdk/credential-provider-node.md) ^0.1.0-preview.5
- [@aws-sdk/query-error-unmarshaller](https://npm.io/package/@aws-sdk/query-error-unmarshaller.md) ^0.1.0-preview.5
- [@aws-sdk/middleware-content-length](https://npm.io/package/@aws-sdk/middleware-content-length.md) ^0.1.0-preview.4
- [@aws-sdk/middleware-header-default](https://npm.io/package/@aws-sdk/middleware-header-default.md) ^0.1.0-preview.4
- [@aws-sdk/bucket-endpoint-middleware](https://npm.io/package/@aws-sdk/bucket-endpoint-middleware.md) ^0.1.0-preview.4
- [@aws-sdk/middleware-expect-continue](https://npm.io/package/@aws-sdk/middleware-expect-continue.md) ^0.1.0-preview.4
- [@aws-sdk/apply-body-checksum-middleware](https://npm.io/package/@aws-sdk/apply-body-checksum-middleware.md) ^0.1.0-preview.4
- [@aws-sdk/location-constraint-middleware](https://npm.io/package/@aws-sdk/location-constraint-middleware.md) ^0.1.0-preview.4

## Recent versions

- 0.1.0-preview.2 (latest) — 2019-07-12
- 0.1.0-preview.7 (preview) — 2019-11-19
- 0.1.0-preview.6 — 2019-10-30
- 0.1.0-preview.5 — 2019-10-29
- 0.1.0-preview.4 — 2019-09-19
- 0.1.0-preview.3 — 2019-09-09

## README

# @aws-sdk/client-s3-node

[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-s3-node/preview.svg)](https://www.npmjs.com/package/@aws-sdk/client-s3-node)
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-s3-node.svg)](https://www.npmjs.com/package/@aws-sdk/client-s3-node)

## Description

Amazon Simple Storage Service service

## Installing

To install the this package using NPM, simply type the following into a terminal window:

```
npm install @aws-sdk/client-s3-node
```

## Getting Started

### Import

The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`S3Client`) and the commands you need, for example `PutObjectCommand`:

```javascript
//javascript
const { S3Client } = require("@aws-sdk/client-s3-node/S3Client");
const {
  PutObjectCommand
} = require("@aws-sdk/client-s3-node/commands/PutObjectCommand");
```

```javascript
//typescript
const { S3Client } = import '@aws-sdk/client-s3-node/S3Client';
const { PutObjectCommand } = import '@aws-sdk/client-s3-node/commands/PutObjectCommand';
```

### Usage

To send a request, you:

- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].
- Initiate command with input parameters.
- Call `send` operation on client with command object as input.
- If you are using a custom http handler, you may call `destroy()` to close open connections.

```javascript
const s3 = new S3Client({region: 'region'});
//clients can be shared by different commands
const params = {
  Body: /**a blob value*/
  /**You can supply readable stream to streaming input. e.g. fs.createReadStream(file) */,
  Bucket: /**a string value*/,
  Key: /**a string value*/,
};
const putObjectCommand = new PutObjectCommand(params);
s3.send(putObjectCommand).then(data => {
    // do something
}).catch(error => {
    // error handling
})
```

In addition to using promises, there are 2 other ways to send a request:

```javascript
// async/await
try {
  const data = await s3.send(putObjectCommand);
  // do something
} catch (error) {
  // error handling
}
```

```javascript
// callback
s3.send(putObjectCommand, (err, data) => {
  //do something
});
```

The SDK can also send requests using the simplified callback style from version 2 of the SDK.

```javascript
import * as AWS from "@aws-sdk/@aws-sdk/client-s3-node/S3";
const s3 = new AWS.S3({ region: "region" });
s3.putObject(params, (err, data) => {
  //do something
});
```

For operations containing stream response like `GetObject()`, you can get response stream by accessing to streaming member. e.g. data.Body.pipe(/_ some writable stream _/).(`data` is the resolved response object)

### Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

```javascript
try {
  const data = await s3.send(putObjectCommand);
  // do something
} catch (error) {
  const metadata = error.$metadata;
  console.log(
    `requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.extendedRequestId}`
  );
  /*
The keys within exceptions are also parsed. You can access them by specifying exception names:
    if(error.name === 'SomeServiceException') {
        const value = error.specialKeyInException;
    }
*/
}
```

## Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.

- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`
- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)
- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)

## Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-s3-node' package is updated. To contribute to SDK you can checkout our [code generator package][].

## License

This SDK is distributed under the
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),
see LICENSE for more information.

[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator
[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/

---
_Source: https://npm.io/package/@aws-sdk/client-s3-node · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._