JavaScript SDK v3

In this section we will show you the steps needed to install and use the AWS SDK for JavaScript v3.

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the S3Client and the commands you need.

Installation

To install this package, simply type “add”, or install @aws-sdk/client-s3 using your preferred package manager:

npm install @aws-sdk/client-s3
yarn add @aws-sdk/client-s3
pnpm add @aws-sdk/client-s3

Usage

To send a request:

• Initiate client with configuration (e.g. credentials).

• Initiate command with input parameters.

• Call send operation on client with command object as input.

Tebi Object storage is globally distributed. This means that it does not require to specify separate regions, but a single global region instead. Physical location of your files is controlled by a user-defined Storage Class.

import { S3Client } from "@aws-sdk/client-s3";
import { ListBucketsCommand, PutObjectCommand } from "@aws-sdk/client-s3";

const credentials = {
        accessKeyId: "<PUT_YOUR_KEY>",
        secretAccessKey: "<PUT_YOUR_SECRET>"
};

// Create an S3 service client object.
const s3Client = new S3Client({
        endpoint: "https://s3.tebi.io",
        credentials: credentials,
        region: "global"
});

Now that you have an S3 Client resource, you can send requests to the service. The following code uses ListBucketsCommand to get and print out all bucket names:

// List buckets
const buckets_data = await s3Client.send(
        new ListBucketsCommand({})
);
console.log(buckets_data);

You can also upload and download binary data. For example, the following uploads a new file to S3, assuming that the bucket my-bucket already exists:

// Upload a file
const upload_data = await s3Client.send(
        new PutObjectCommand({
                Bucket: "my-bucket",
                Key: "node-js.txt",
                Body: "some data"
        })
);
console.log(upload_data);

To generate a presigned URL, you must install and use @aws-sdk/s3-request-presigner package:

Install it with your favorite package manager:

npm install @aws-sdk/s3-request-presigner
yarn add @aws-sdk/s3-request-presigner
pnpm add @aws-sdk/s3-request-presigner

This code will generate a signed URL that will replace a Content-Disposition server response header as an example to force the browser to use a different file name. Use s3Client variable from the first code example. Refer to the full @aws-sdk/s3-request-presigner module documentation for more examples and GetObject API function for a full list of supported headers.

import { getSignedUrl } from "@aws-sdk/s3-request-presigner";
import { GetObjectCommand } from "@aws-sdk/client-s3";

// Generate a presigned URL
const get_command = new GetObjectCommand({
        Bucket: "test",
        Key: "node-js.txt",
        ResponseContentDisposition: 'attachment; filename="YOUR_FILENAME.txt"'
});
const url = await getSignedUrl(s3Client, get_command, { expiresIn: 3600 });
console.log(url);

For more examples, please refer to the official AWS SDK v3 documentation examples. Full AWS SDK v3 S3 reference is available here.