@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:

1//javascript
2const { S3Client } = require("@aws-sdk/client-s3-node/S3Client");
3const {
4  PutObjectCommand
5} = require("@aws-sdk/client-s3-node/commands/PutObjectCommand");

1//typescript
2const { S3Client } = import '@aws-sdk/client-s3-node/S3Client';
3const { 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.

1const s3 = new S3Client({region: 'region'});
2//clients can be shared by different commands
3const params = {
4  Body: /**a blob value*/
5  /**You can supply readable stream to streaming input. e.g. fs.createReadStream(file) */,
6  Bucket: /**a string value*/,
7  Key: /**a string value*/,
8};
9const putObjectCommand = new PutObjectCommand(params);
10s3.send(putObjectCommand).then(data => {
11    // do something
12}).catch(error => {
13    // error handling
14})

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

1// async/await
2try {
3  const data = await s3.send(putObjectCommand);
4  // do something
5} catch (error) {
6  // error handling
7}

1// callback
2s3.send(putObjectCommand, (err, data) => {
3  //do something
4});

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

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

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).

1try {
2  const data = await s3.send(putObjectCommand);
3  // do something
4} catch (error) {
5  const metadata = error.$metadata;
6  console.log(
7    `requestId: ${metadata.requestId}
8cfId: ${metadata.cfId}
9extendedRequestId: ${metadata.extendedRequestId}`
10  );
11  /*
12The keys within exceptions are also parsed. You can access them by specifying exception names:
13    if(error.name === 'SomeServiceException') {
14        const value = error.specialKeyInException;
15    }
16*/
17}

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 and tag it with aws-sdk-js
• Come join the AWS JavaScript community on gitter
• If it turns out that you may have found a bug, please open an issue

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, see LICENSE for more information.