@aws-lite/s3 NPM

`@aws-lite/s3`

Official aws-lite plugin for S3
Maintained by: @architect

Install

npm i @aws-lite/s3

Optionally install types:

npm i -D @aws-lite/s3-types

Reference

Reference documentation with examples at aws-lite.org

Methods

`CreateBucket`

Canonical AWS API doc

Properties:

Bucket (string) required
- S3 bucket name
CreateBucketConfiguration (object)
- Complete bucket configuration object
- More details (AWS)
ACL (string)
- Sets request header: x-amz-acl
GrantFullControl (string)
- Sets request header: x-amz-grant-full-control
GrantRead (string)
- Sets request header: x-amz-grant-read
GrantReadACP (string)
- Sets request header: x-amz-grant-read-acp
GrantWrite (string)
- Sets request header: x-amz-grant-write
GrantWriteACP (string)
- Sets request header: x-amz-grant-write-acp
ObjectLockEnabledForBucket (string)
- Sets request header: x-amz-bucket-object-lock-enabled
ObjectOwnership (string)
- Sets request header: x-amz-object-ownership

`DeleteBucket`

Canonical AWS API doc

Properties:

Bucket (string) required
- S3 bucket name
ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner

`DeleteObject`

Canonical AWS API doc

Properties:

Bucket (string) required
- S3 bucket name
Key (string) required
- S3 key / file name
VersionId (string)
- Reference a specific version of the object
MFA (string)
- Sets request header: x-amz-mfa
RequestPayer (string)
- Sets request header: x-amz-request-payer
BypassGovernanceRetention (string)
- Sets request header: x-amz-bypass-governance-retention
ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner

`DeleteObjects`

Canonical AWS API doc

Properties:

Bucket (string) required
- S3 bucket name
Delete (object) required
- Object deletion request
MFA (string)
- Sets request header: x-amz-mfa
RequestPayer (string)
- Sets request header: x-amz-request-payer
BypassGovernanceRetention (string)
- Sets request header: x-amz-bypass-governance-retention
ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
ChecksumAlgorithm (string)
- Sets request header: x-amz-sdk-checksum-algorithm
ContentMD5 (string)
- Sets request header: content-md5

`GetObject`

Canonical AWS API doc

Properties:

Bucket (string) required
- S3 bucket name
Key (string) required
- S3 key / file name
PartNumber (number)
- Part number (between 1 - 10,000) of the object
VersionId (string)
- Reference a specific version of the object
IfMatch (string)
- Sets request header: if-match
IfModifiedSince (string)
- Sets request header: if-modified-since
IfNoneMatch (string)
- Sets request header: if-none-match
IfUnmodifiedSince (string)
- Sets request header: if-unmodified-since
Range (string)
- Sets request header: range
SSECustomerAlgorithm (string)
- Sets request header: x-amz-server-side-encryption-customer-algorithm
SSECustomerKey (string)
- Sets request header: x-amz-server-side-encryption-customer-key
SSECustomerKeyMD5 (string)
- Sets request header: x-amz-server-side-encryption-customer-key-md5
RequestPayer (string)
- Sets request header: x-amz-request-payer
ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
ChecksumMode (string)
- Sets request header: x-amz-checksum-mode
ResponseCacheControl (string)
- Sets response header: cache-control
ResponseContentDisposition (string)
- Sets response header: content-disposition
ResponseContentEncoding (string)
- Sets response header: content-encoding
ResponseContentLanguage (string)
- Sets response header: content-language
ResponseContentType (string)
- Sets response header: content-type
ResponseExpires (string)
- Sets response header: expires
rawResponsePayload (boolean)
- Set to true to return payload as a buffer
streamResponsePayload (boolean)
- Set to true to return payload as a Node.js stream

`HeadObject`

Canonical AWS API doc

Properties:

Bucket (string) required
- S3 bucket name
Key (string) required
- S3 key / file name
PartNumber (number)
- Part number (between 1 - 10,000) of the object
VersionId (string)
- Reference a specific version of the object
IfMatch (string)
- Sets request header: if-match
IfModifiedSince (string)
- Sets request header: if-modified-since
IfNoneMatch (string)
- Sets request header: if-none-match
IfUnmodifiedSince (string)
- Sets request header: if-unmodified-since
Range (string)
- Sets request header: range
SSECustomerAlgorithm (string)
- Sets request header: x-amz-server-side-encryption-customer-algorithm
SSECustomerKey (string)
- Sets request header: x-amz-server-side-encryption-customer-key
SSECustomerKeyMD5 (string)
- Sets request header: x-amz-server-side-encryption-customer-key-md5
RequestPayer (string)
- Sets request header: x-amz-request-payer
ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
ChecksumMode (string)
- Sets request header: x-amz-checksum-mode

`HeadBucket`

Canonical AWS API doc

Properties:

Bucket (string) required
- S3 bucket name
ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner

`ListBuckets`

Canonical AWS API doc

Properties:

`ListObjectsV2`

Canonical AWS API doc

Properties:

Bucket (string) required
- S3 bucket name
ContinuationToken (string)
- Pagination cursor token (returned as NextContinuationToken
Delimiter (string)
- Delimiter character used to group keys
EncodingType (string)
- Object key encoding type (must be url)
FetchOwner (string)
- Return owner field with results
MaxKeys (number)
- Set the maximum number of keys returned per response
Prefix (string)
- Limit response to keys that begin with the specified prefix
StartAfter (string)
- Starts listing after any specified key in the bucket
RequestPayer (string)
- Sets request header: x-amz-request-payer
ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
OptionalObjectAttributes (string)
- Sets request header: x-amz-optional-object-attributes
paginate (boolean)
- Enable automatic result pagination; use this instead of making your own individual pagination requests

`PutObject`

Canonical AWS API doc

Properties:

Bucket (string) required
- S3 bucket name
Key (string) required
- S3 key / file name
Body (string, buffer)
- String or buffer to be uploaded
File (string)
- File path to be read and uploaded from the local filesystem
ApplyChecksum (boolean)
- Sign payload; enabling this option may significantly increase memory and latency
MinChunkSize (number)
- Minimum size (in bytes) to utilize signed, AWS-chunk-encoded uploads to S3
ACL (string)
- Sets request header: x-amz-acl
BucketKeyEnabled (string)
- Sets request header: x-amz-server-side-encryption-bucket-key-enabled
CacheControl (string)
- Sets request header: cache-control
ChecksumAlgorithm (string)
- Sets request header: x-amz-sdk-checksum-algorithm
ChecksumCRC32 (string)
- Sets request header: x-amz-checksum-crc32
ChecksumCRC32C (string)
- Sets request header: x-amz-checksum-crc32c
ChecksumSHA1 (string)
- Sets request header: x-amz-checksum-sha1
ChecksumSHA256 (string)
- Sets request header: x-amz-checksum-sha256
ContentDisposition (string)
- Sets request header: content-disposition
ContentEncoding (string)
- Sets request header: content-encoding
ContentLanguage (string)
- Sets request header: content-language
ContentLength (string)
- Sets request header: content-length
ContentMD5 (string)
- Sets request header: content-md5
ContentType (string)
- Sets request header: content-type
ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Expires (string)
- Sets request header: expires
GrantFullControl (string)
- Sets request header: x-amz-grant-full-control
GrantRead (string)
- Sets request header: x-amz-grant-read
GrantReadACP (string)
- Sets request header: x-amz-grant-read-acp
GrantWriteACP (string)
- Sets request header: x-amz-grant-write-acp
ObjectLockLegalHoldStatus (string)
- Sets request header: x-amz-object-lock-legal-hold
ObjectLockMode (string)
- Sets request header: x-amz-object-lock-mode
ObjectLockRetainUntilDate (string)
- Sets request header: x-amz-object-lock-retain-until-date
RequestPayer (string)
- Sets request header: x-amz-request-payer
ServerSideEncryption (string)
- Sets request header: x-amz-server-side-encryption
SSECustomerAlgorithm (string)
- Sets request header: x-amz-server-side-encryption-customer-algorithm
SSECustomerKey (string)
- Sets request header: x-amz-server-side-encryption-customer-key
SSECustomerKeyMD5 (string)
- Sets request header: x-amz-server-side-encryption-customer-key-md5
SSEKMSEncryptionContext (string)
- Sets request header: x-amz-server-side-encryption-context
SSEKMSKeyId (string)
- Sets request header: x-amz-server-side-encryption-aws-kms-key-id
StorageClass (string)
- Sets request header: x-amz-storage-class
Tagging (string)
- Sets request header: x-amz-tagging
WebsiteRedirectLocation (string)
- Sets request header: x-amz-website-redirect-location