@aws-sdk/client-s3

Description

AWS SDK for JavaScript S3 Client for Node.js, Browser and React Native.

Installing

To install this package, simply type add or install @aws-sdk/client-s3
using your favorite package manager:
- npm install @aws-sdk/client-s3
- yarn add @aws-sdk/client-s3
- pnpm add @aws-sdk/client-s3

Getting Started

$3

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, for example ListBucketsCommand:

``js
// ES5 example
const { S3Client, ListBucketsCommand } = require("@aws-sdk/client-s3");
`

`ts
// ES6+ example
import { S3Client, ListBucketsCommand } from "@aws-sdk/client-s3";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- 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.

`js
// a client can be shared by different commands.
const client = new S3Client({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListBucketsCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
`

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-s3";
const client = new AWS.S3({ region: "REGION" });

// async/await.
try {
const data = await client.listBuckets(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listBuckets(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listBuckets(params, (err, data) => {
// process err and data.
});
`

$3

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

`js
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, 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, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-s3` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

AbortMultipartUpload

Command API Reference / Input / Output

CompleteMultipartUpload

Command API Reference / Input / Output

CopyObject

Command API Reference / Input / Output

CreateBucket

Command API Reference / Input / Output

CreateBucketMetadataConfiguration

Command API Reference / Input / Output

CreateBucketMetadataTableConfiguration

Command API Reference / Input / Output

CreateMultipartUpload

Command API Reference / Input / Output

CreateSession

Command API Reference / Input / Output

DeleteBucket

Command API Reference / Input / Output

DeleteBucketAnalyticsConfiguration

Command API Reference / Input / Output

DeleteBucketCors

Command API Reference / Input / Output

DeleteBucketEncryption

Command API Reference / Input / Output

DeleteBucketIntelligentTieringConfiguration

Command API Reference / Input / Output

DeleteBucketInventoryConfiguration

Command API Reference / Input / Output

DeleteBucketLifecycle

Command API Reference / Input / Output

DeleteBucketMetadataConfiguration

Command API Reference / Input / Output

DeleteBucketMetadataTableConfiguration

Command API Reference / Input / Output

DeleteBucketMetricsConfiguration

Command API Reference / Input / Output

DeleteBucketOwnershipControls

Command API Reference / Input / Output

DeleteBucketPolicy

Command API Reference / Input / Output

DeleteBucketReplication

Command API Reference / Input / Output

DeleteBucketTagging

Command API Reference / Input / Output

DeleteBucketWebsite

Command API Reference / Input / Output

DeleteObject

Command API Reference / Input / Output

DeleteObjects

Command API Reference / Input / Output

DeleteObjectTagging

Command API Reference / Input / Output

DeletePublicAccessBlock

Command API Reference / Input / Output

GetBucketAbac

Command API Reference / Input / Output

GetBucketAccelerateConfiguration

Command API Reference / Input / Output

GetBucketAcl

Command API Reference / Input / Output

GetBucketAnalyticsConfiguration

Command API Reference / Input / Output

GetBucketCors

Command API Reference / Input / Output

GetBucketEncryption

Command API Reference / Input / Output

GetBucketIntelligentTieringConfiguration

Command API Reference / Input / Output

GetBucketInventoryConfiguration

Command API Reference / Input / Output

GetBucketLifecycleConfiguration

Command API Reference / Input / Output

GetBucketLocation

Command API Reference / Input / Output

GetBucketLogging

Command API Reference / Input / Output

GetBucketMetadataConfiguration

Command API Reference / Input / Output

GetBucketMetadataTableConfiguration

Command API Reference / Input / Output

GetBucketMetricsConfiguration

Command API Reference / Input / Output

GetBucketNotificationConfiguration

Command API Reference / Input / Output

GetBucketOwnershipControls

Command API Reference / Input / Output

GetBucketPolicy

Command API Reference / Input / Output

GetBucketPolicyStatus

Command API Reference / Input / Output

GetBucketReplication

Command API Reference / Input / Output

GetBucketRequestPayment

Command API Reference / Input / Output

GetBucketTagging

Command API Reference / Input / Output

GetBucketVersioning

Command API Reference / Input / Output

GetBucketWebsite

Command API Reference / Input / Output

GetObject

Command API Reference / Input / Output

GetObjectAcl

Command API Reference / Input / Output

GetObjectAttributes

Command API Reference / Input / Output

GetObjectLegalHold

Command API Reference / Input / Output

GetObjectLockConfiguration

Command API Reference / Input / Output

GetObjectRetention

Command API Reference / Input / Output

GetObjectTagging

Command API Reference / Input / Output

GetObjectTorrent

Command API Reference / Input / Output

GetPublicAccessBlock

Command API Reference / Input / Output

HeadBucket

Command API Reference / Input / Output

HeadObject

Command API Reference / Input / Output

ListBucketAnalyticsConfigurations

Command API Reference / Input / Output

ListBucketIntelligentTieringConfigurations

Command API Reference / Input / Output

ListBucketInventoryConfigurations

Command API Reference / Input / Output

ListBucketMetricsConfigurations

Command API Reference / Input / Output

ListBuckets

Command API Reference / Input / Output

ListDirectoryBuckets

Command API Reference / Input / Output

ListMultipartUploads

Command API Reference / Input / Output

ListObjects

Command API Reference / Input / Output

ListObjectsV2

Command API Reference / Input / Output

ListObjectVersions

Command API Reference / Input / Output

ListParts

Command API Reference / Input / Output

PutBucketAbac

Command API Reference / Input / Output

PutBucketAccelerateConfiguration

Command API Reference / Input / Output

PutBucketAcl

Command API Reference / Input / Output

PutBucketAnalyticsConfiguration

Command API Reference / Input / Output

PutBucketCors

Command API Reference / Input / Output

PutBucketEncryption

Command API Reference / Input / Output

PutBucketIntelligentTieringConfiguration

Command API Reference / Input / Output

PutBucketInventoryConfiguration

Command API Reference / Input / Output

PutBucketLifecycleConfiguration

Command API Reference / Input / Output

PutBucketLogging

Command API Reference / Input / Output

PutBucketMetricsConfiguration

Command API Reference / Input / Output

PutBucketNotificationConfiguration

Command API Reference / Input / Output

PutBucketOwnershipControls

Command API Reference / Input / Output

PutBucketPolicy

Command API Reference / Input / Output

PutBucketReplication

Command API Reference / Input / Output

PutBucketRequestPayment

Command API Reference / Input / Output

PutBucketTagging

Command API Reference / Input / Output

PutBucketVersioning

Command API Reference / Input / Output

PutBucketWebsite

Command API Reference / Input / Output

PutObject

Command API Reference / Input / Output

PutObjectAcl

Command API Reference / Input / Output

PutObjectLegalHold

Command API Reference / Input / Output

PutObjectLockConfiguration

Command API Reference / Input / Output

PutObjectRetention

Command API Reference / Input / Output

PutObjectTagging

Command API Reference / Input / Output

PutPublicAccessBlock

Command API Reference / Input / Output

RenameObject

Command API Reference / Input / Output

RestoreObject

Command API Reference / Input / Output

SelectObjectContent

Command API Reference / Input / Output

UpdateBucketMetadataInventoryTableConfiguration

Command API Reference / Input / Output

UpdateBucketMetadataJournalTableConfiguration

Command API Reference / Input / Output

UpdateObjectEncryption

Command API Reference / Input / Output

UploadPart

Command API Reference / Input / Output

UploadPartCopy

Command API Reference / Input / Output

WriteGetObjectResponse

Command API Reference / Input / Output