Gathering detailed insights and metrics for @aws-sdk/client-s3
Gathering detailed insights and metrics for @aws-sdk/client-s3
Modularized AWS SDK for JavaScript.
Installations
npm install @aws-sdk/client-s3Developer Guide
BETA
Typescript
Yes
Module System
CommonJS, UMD
Min. Node Version
>=16.0.0
Node Version
18.20.3
NPM Version
10.7.0
Score
65.2
Supply Chain
100
Quality
98.7
Maintenance
100
Vulnerability
99.6
License
Releases
891
Languages
TypeScript
Java
JavaScript
Gherkin
Starlark
Objective-C
Ruby
Shell
Handlebars
Smithy
Makefile
TypeScript (99.64%)
Java (0.23%)
JavaScript (0.1%)
Gherkin (0.02%)
Developer
aws
Download Statistics
Total
586,890,000
Last Day
318,225
Last Week
7,781,117
Last Month
31,401,986
Last Year
314,527,936
Statistics
3,138 Stars
8,289 Commits
582 Forks
45 Watching
11 Branches
168 Contributors
Bundle Size
392.75 kB
Minified
91.63 kB
Minified + Gzipped
Maintainers & Contributors
Package Meta Information
Latest Version
3.705.0
Package Id
@aws-sdk/client-s3@3.705.0
Unpacked Size
3.23 MB
Size
369.47 kB
File Count
398
NPM Version
10.7.0
Node Version
18.20.3
Publised On
03 Dec 2024
Total Downloads
Cumulative downloads
Total Downloads
586,890,000
Last day
16%
318,225
Compared to previous day
Last week
12.4%
7,781,117
Compared to previous week
Last month
-0.8%
31,401,986
Compared to previous month
Last year
70.3%
314,527,936
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
58
@aws-crypto/sha1-browser@aws-crypto/sha256-browser@aws-crypto/sha256-js@aws-sdk/client-sso-oidc@aws-sdk/client-sts@aws-sdk/core@aws-sdk/credential-provider-node@aws-sdk/middleware-bucket-endpoint@aws-sdk/middleware-expect-continue@aws-sdk/middleware-flexible-checksums@aws-sdk/middleware-host-header@aws-sdk/middleware-location-constraint@aws-sdk/middleware-logger@aws-sdk/middleware-recursion-detection@aws-sdk/middleware-sdk-s3@aws-sdk/middleware-ssec@aws-sdk/middleware-user-agent@aws-sdk/region-config-resolver@aws-sdk/signature-v4-multi-region@aws-sdk/types@aws-sdk/util-endpoints@aws-sdk/util-user-agent-browser@aws-sdk/util-user-agent-node@aws-sdk/xml-builder@smithy/config-resolver@smithy/core@smithy/eventstream-serde-browser@smithy/eventstream-serde-config-resolver@smithy/eventstream-serde-node@smithy/fetch-http-handler@smithy/hash-blob-browser@smithy/hash-node@smithy/hash-stream-node@smithy/invalid-dependency@smithy/md5-js@smithy/middleware-content-length@smithy/middleware-endpoint@smithy/middleware-retry@smithy/middleware-serde@smithy/middleware-stack@smithy/node-config-provider@smithy/node-http-handler@smithy/protocol-http@smithy/smithy-client@smithy/types@smithy/url-parser@smithy/util-base64@smithy/util-body-length-browser@smithy/util-body-length-node@smithy/util-defaults-mode-browser@smithy/util-defaults-mode-node@smithy/util-endpoints@smithy/util-middleware@smithy/util-retry@smithy/util-stream@smithy/util-utf8@smithy/util-waitertslib
Versions
@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-s3yarn add @aws-sdk/client-s3pnpm add @aws-sdk/client-s3
Getting Started
Import
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:
1// ES5 example 2const { S3Client, ListBucketsCommand } = require("@aws-sdk/client-s3");
1// ES6+ example 2import { S3Client, ListBucketsCommand } from "@aws-sdk/client-s3";
Usage
To send a request, you:
- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call
sendoperation on client with command object as input. - If you are using a custom http handler, you may call
destroy()to close open connections.
1// a client can be shared by different commands. 2const client = new S3Client({ region: "REGION" }); 3 4const params = { 5 /** input parameters */ 6}; 7const command = new ListBucketsCommand(params);
Async/await
We recommend using await operator to wait for the promise returned by send operation as follows:
1// async/await. 2try { 3 const data = await client.send(command); 4 // process data. 5} catch (error) { 6 // error handling. 7} finally { 8 // finally. 9}
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.
1client.send(command).then( 2 (data) => { 3 // process data. 4 }, 5 (error) => { 6 // error handling. 7 } 8);
Promises can also be called using .catch() and .finally() as follows:
1client 2 .send(command) 3 .then((data) => { 4 // process data. 5 }) 6 .catch((error) => { 7 // error handling. 8 }) 9 .finally(() => { 10 // finally. 11 });
Callbacks
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
1// callbacks. 2client.send(command, (err, data) => { 3 // process err and data. 4});
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
1import * as AWS from "@aws-sdk/client-s3"; 2const client = new AWS.S3({ region: "REGION" }); 3 4// async/await. 5try { 6 const data = await client.listBuckets(params); 7 // process data. 8} catch (error) { 9 // error handling. 10} 11 12// Promises. 13client 14 .listBuckets(params) 15 .then((data) => { 16 // process data. 17 }) 18 .catch((error) => { 19 // error handling. 20 }); 21 22// callbacks. 23client.listBuckets(params, (err, data) => { 24 // process err and data. 25});
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 client.send(command); 3 // process data. 4} catch (error) { 5 const { requestId, cfId, extendedRequestId } = error.$metadata; 6 console.log({ requestId, cfId, extendedRequestId }); 7 /** 8 * The keys within exceptions are also parsed. 9 * You can access them by specifying exception names: 10 * if (error.name === 'SomeServiceException') { 11 * const value = error.specialKeyInException; 12 * } 13 */ 14}
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-json 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
CompleteMultipartUpload
CopyObject
CreateBucket
CreateBucketMetadataTableConfiguration
CreateMultipartUpload
CreateSession
DeleteBucket
DeleteBucketAnalyticsConfiguration
DeleteBucketCors
DeleteBucketEncryption
DeleteBucketIntelligentTieringConfiguration
DeleteBucketInventoryConfiguration
DeleteBucketLifecycle
DeleteBucketMetadataTableConfiguration
DeleteBucketMetricsConfiguration
DeleteBucketOwnershipControls
DeleteBucketPolicy
DeleteBucketReplication
DeleteBucketTagging
DeleteBucketWebsite
DeleteObject
DeleteObjects
DeleteObjectTagging
DeletePublicAccessBlock
GetBucketAccelerateConfiguration
GetBucketAcl
GetBucketAnalyticsConfiguration
GetBucketCors
GetBucketEncryption
GetBucketIntelligentTieringConfiguration
GetBucketInventoryConfiguration
GetBucketLifecycleConfiguration
GetBucketLocation
GetBucketLogging
GetBucketMetadataTableConfiguration
GetBucketMetricsConfiguration
GetBucketNotificationConfiguration
GetBucketOwnershipControls
GetBucketPolicy
GetBucketPolicyStatus
GetBucketReplication
GetBucketRequestPayment
GetBucketTagging
GetBucketVersioning
GetBucketWebsite
GetObject
GetObjectAcl
GetObjectAttributes
GetObjectLegalHold
GetObjectLockConfiguration
GetObjectRetention
GetObjectTagging
GetObjectTorrent
GetPublicAccessBlock
HeadBucket
HeadObject
ListBucketAnalyticsConfigurations
ListBucketIntelligentTieringConfigurations
ListBucketInventoryConfigurations
ListBucketMetricsConfigurations
ListBuckets
ListDirectoryBuckets
ListMultipartUploads
ListObjects
ListObjectsV2
ListObjectVersions
ListParts
PutBucketAccelerateConfiguration
PutBucketAcl
PutBucketAnalyticsConfiguration
PutBucketCors
PutBucketEncryption
PutBucketIntelligentTieringConfiguration
PutBucketInventoryConfiguration
PutBucketLifecycleConfiguration
PutBucketLogging
PutBucketMetricsConfiguration
PutBucketNotificationConfiguration
PutBucketOwnershipControls
PutBucketPolicy
PutBucketReplication
PutBucketRequestPayment
PutBucketTagging
PutBucketVersioning
PutBucketWebsite
PutObject
PutObjectAcl
PutObjectLegalHold
PutObjectLockConfiguration
PutObjectRetention
PutObjectTagging
PutPublicAccessBlock
RestoreObject
SelectObjectContent
UploadPart
UploadPartCopy
WriteGetObjectResponse
No vulnerabilities found.
Reason
30 commit(s) and 3 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0
Reason
security policy file detected
Details
- Info: security policy file detected: github.com/aws/.github/SECURITY.md:1
- Info: Found linked content: github.com/aws/.github/SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/aws/.github/SECURITY.md:1
- Info: Found text in security policy: github.com/aws/.github/SECURITY.md:1
Reason
binaries present in source code
Details
- Warn: binary detected: codegen/gradle/wrapper/gradle-wrapper.jar:1
- Warn: binary detected: tests/react-native/End2End/android/gradle/wrapper/gradle-wrapper.jar:1
Reason
Found 2/30 approved changesets -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/stale_issues.yml:12
- Warn: no topLevel permission defined: .github/workflows/codegen-ci.yml:1
- Warn: no topLevel permission defined: .github/workflows/commit-message-lint.yml:1
- Warn: no topLevel permission defined: .github/workflows/git-sync.yml:1
- Warn: no topLevel permission defined: .github/workflows/handle-stale-discussions.yml:1
- Warn: no topLevel permission defined: .github/workflows/issue-regression-labeler.yml:1
- Warn: no topLevel permission defined: .github/workflows/lock.yml:1
- Warn: no topLevel permission defined: .github/workflows/pre-commit-hooks.yml:1
- Warn: no topLevel permission defined: .github/workflows/stale_issues.yml:1
- Info: no jobLevel write permissions found
Reason
Project has not signed or included provenance with any releases.
Details
- Warn: release artifact v3.705.0 not signed: https://api.github.com/repos/aws/aws-sdk-js-v3/releases/188788671
- Warn: release artifact v3.704.0 not signed: https://api.github.com/repos/aws/aws-sdk-js-v3/releases/188628672
- Warn: release artifact v3.703.0 not signed: https://api.github.com/repos/aws/aws-sdk-js-v3/releases/188395659
- Warn: release artifact v3.702.0 not signed: https://api.github.com/repos/aws/aws-sdk-js-v3/releases/187899616
- Warn: release artifact v3.701.0 not signed: https://api.github.com/repos/aws/aws-sdk-js-v3/releases/187617766
- Warn: release artifact v3.705.0 does not have provenance: https://api.github.com/repos/aws/aws-sdk-js-v3/releases/188788671
- Warn: release artifact v3.704.0 does not have provenance: https://api.github.com/repos/aws/aws-sdk-js-v3/releases/188628672
- Warn: release artifact v3.703.0 does not have provenance: https://api.github.com/repos/aws/aws-sdk-js-v3/releases/188395659
- Warn: release artifact v3.702.0 does not have provenance: https://api.github.com/repos/aws/aws-sdk-js-v3/releases/187899616
- Warn: release artifact v3.701.0 does not have provenance: https://api.github.com/repos/aws/aws-sdk-js-v3/releases/187617766
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 2 are checked with a SAST tool
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codegen-ci.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/codegen-ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codegen-ci.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/codegen-ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/commit-message-lint.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/commit-message-lint.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/commit-message-lint.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/commit-message-lint.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/git-sync.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/git-sync.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/handle-stale-discussions.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/handle-stale-discussions.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/issue-regression-labeler.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/issue-regression-labeler.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/lock.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/lock.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pre-commit-hooks.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/pre-commit-hooks.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pre-commit-hooks.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/pre-commit-hooks.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/stale_issues.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/stale_issues.yml/main?enable=pin
- Info: 0 out of 6 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 5 third-party GitHubAction dependencies pinned
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
14 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986
- Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
- Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
- Warn: Project is vulnerable to: GHSA-96g7-g7g9-jxw8
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
- Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Score
3.9
/10
Last Scanned on 2024-12-02
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More