Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
By Sarah Gooding - Sep 20, 2024
@aws-lite/s3
Advanced tools
@aws-lite/s3
Official
aws-liteplugin 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
AbortMultipartUpload
Properties:
Bucket(string) [required]- S3 bucket name
Key(string) [required]- S3 key / file name
UploadId(string) [required]- ID of the multipart upload
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
RequestPayer(string)- Sets request header:
x-amz-request-payer
- Sets request header:
CompleteMultipartUpload
Properties:
Bucket(string) [required]- S3 bucket name
Key(string) [required]- S3 key / file name
UploadId(string) [required]- ID of the multipart upload
MultipartUpload(object)MultipartUploadobject containing details about the completed uploads- More details (AWS)
ChecksumCRC32(string)- Sets request header:
x-amz-checksum-crc32
- Sets request header:
ChecksumCRC32C(string)- Sets request header:
x-amz-checksum-crc32c
- Sets request header:
ChecksumSHA1(string)- Sets request header:
x-amz-checksum-sha1
- Sets request header:
ChecksumSHA256(string)- Sets request header:
x-amz-checksum-sha256
- Sets request header:
RequestPayer(string)- Sets request header:
x-amz-request-payer
- Sets request header:
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
SSECustomerAlgorithm(string)- Sets request header:
x-amz-server-side-encryption-customer-algorithm
- Sets request header:
SSECustomerKey(string)- Sets request header:
x-amz-server-side-encryption-customer-key
- Sets request header:
SSECustomerKeyMD5(string)- Sets request header:
x-amz-server-side-encryption-customer-key-md5
- Sets request header:
CreateBucket
Properties:
Bucket(string) [required]- S3 bucket name
CreateBucketConfiguration(object)- Complete bucket configuration object
- More details (AWS)
ACL(string)- Sets request header:
x-amz-acl
- Sets request header:
GrantFullControl(string)- Sets request header:
x-amz-grant-full-control
- Sets request header:
GrantRead(string)- Sets request header:
x-amz-grant-read
- Sets request header:
GrantReadACP(string)- Sets request header:
x-amz-grant-read-acp
- Sets request header:
GrantWrite(string)- Sets request header:
x-amz-grant-write
- Sets request header:
GrantWriteACP(string)- Sets request header:
x-amz-grant-write-acp
- Sets request header:
ObjectLockEnabledForBucket(string)- Sets request header:
x-amz-bucket-object-lock-enabled
- Sets request header:
ObjectOwnership(string)- Sets request header:
x-amz-object-ownership
- Sets request header:
CreateMultipartUpload
Properties:
Bucket(string) [required]- S3 bucket name
Key(string) [required]- S3 key / file name
ACL(string)- Sets request header:
x-amz-acl
- Sets request header:
CacheControl(string)- Sets request header:
cache-control
- Sets request header:
ContentDisposition(string)- Sets request header:
content-disposition
- Sets request header:
ContentEncoding(string)- Sets request header:
content-encoding
- Sets request header:
ContentLanguage(string)- Sets request header:
content-language
- Sets request header:
ContentType(string)- Sets request header:
content-type
- Sets request header:
Expires(string)- Sets request header:
expires
- Sets request header:
GrantFullControl(string)- Sets request header:
x-amz-grant-full-control
- Sets request header:
GrantRead(string)- Sets request header:
x-amz-grant-read
- Sets request header:
GrantReadACP(string)- Sets request header:
x-amz-grant-read-acp
- Sets request header:
GrantWriteACP(string)- Sets request header:
x-amz-grant-write-acp
- Sets request header:
ServerSideEncryption(string)- Sets request header:
x-amz-server-side-encryption
- Sets request header:
StorageClass(string)- Sets request header:
x-amz-storage-class
- Sets request header:
WebsiteRedirectLocation(string)- Sets request header:
x-amz-website-redirect-location
- Sets request header:
SSECustomerAlgorithm(string)- Sets request header:
x-amz-server-side-encryption-customer-algorithm
- Sets request header:
SSECustomerKeyMD5(string)- Sets request header:
x-amz-server-side-encryption-customer-key-md5
- Sets request header:
SSEKMSKeyId(string)- Sets request header:
x-amz-server-side-encryption-aws-kms-key-id
- Sets request header:
SSEKMSEncryptionContext(string)- Sets request header:
x-amz-server-side-encryption-context
- Sets request header:
BucketKeyEnabled(string)- Sets request header:
x-amz-server-side-encryption-bucket-key-enabled
- Sets request header:
RequestPayer(string)- Sets request header:
x-amz-request-payer
- Sets request header:
Tagging(string)- Sets request header:
x-amz-tagging
- Sets request header:
ObjectLockMode(string)- Sets request header:
x-amz-object-lock-mode
- Sets request header:
ObjectLockRetainUntilDate(string)- Sets request header:
x-amz-object-lock-retain-until-date
- Sets request header:
ObjectLockLegalHoldStatus(string)- Sets request header:
x-amz-object-lock-legal-hold
- Sets request header:
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
ChecksumAlgorithm(string)- Sets request header:
x-amz-sdk-checksum-algorithm
- Sets request header:
DeleteBucket
Properties:
Bucket(string) [required]- S3 bucket name
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
DeleteBucketAnalyticsConfiguration
Properties:
Bucket(string) [required]- S3 bucket name
Id(string) [required]- ID of the object
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
DeleteBucketCors
Properties:
Bucket(string) [required]- S3 bucket name
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
DeleteBucketEncryption
Properties:
Bucket(string) [required]- S3 bucket name
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
DeleteBucketIntelligentTieringConfiguration
Properties:
Bucket(string) [required]- S3 bucket name
Id(string) [required]- ID of the object
DeleteBucketInventoryConfiguration
Properties:
Bucket(string) [required]- S3 bucket name
Id(string) [required]- ID of the object
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
DeleteBucketLifecycle
Properties:
Bucket(string) [required]- S3 bucket name
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
DeleteBucketMetricsConfiguration
Properties:
Bucket(string) [required]- S3 bucket name
Id(string) [required]- ID of the object
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
DeleteBucketOwnershipControls
Properties:
Bucket(string) [required]- S3 bucket name
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
DeleteBucketPolicy
Properties:
Bucket(string) [required]- S3 bucket name
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
DeleteBucketReplication
Properties:
Bucket(string) [required]- S3 bucket name
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
DeleteBucketTagging
Properties:
Bucket(string) [required]- S3 bucket name
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
DeleteBucketWebsite
Properties:
Bucket(string) [required]- S3 bucket name
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
DeleteObject
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
- Sets request header:
RequestPayer(string)- Sets request header:
x-amz-request-payer
- Sets request header:
BypassGovernanceRetention(string)- Sets request header:
x-amz-bypass-governance-retention
- Sets request header:
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
DeleteObjects
Properties:
Bucket(string) [required]- S3 bucket name
Delete(object) [required]- Object deletion request
MFA(string)- Sets request header:
x-amz-mfa
- Sets request header:
RequestPayer(string)- Sets request header:
x-amz-request-payer
- Sets request header:
BypassGovernanceRetention(string)- Sets request header:
x-amz-bypass-governance-retention
- Sets request header:
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
ChecksumAlgorithm(string)- Sets request header:
x-amz-sdk-checksum-algorithm
- Sets request header:
ContentMD5(string)- Sets request header:
content-md5
- Sets request header:
GetBucketAccelerateConfiguration
Properties:
Bucket(string) [required]- S3 bucket name
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
RequestPayer(string)- Sets request header:
x-amz-request-payer
- Sets request header:
GetBucketAcl
Properties:
Bucket(string) [required]- S3 bucket name
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
GetBucketAnalyticsConfiguration
Properties:
Bucket(string) [required]- S3 bucket name
Id(string) [required]- Id of the analytics configuration
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
GetBucketCors
Properties:
Bucket(string) [required]- S3 bucket name
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
GetBucketEncryption
Properties:
Bucket(string) [required]- S3 bucket name
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
GetBucketIntelligentTieringConfiguration
Properties:
Bucket(string) [required]- S3 bucket name
Id(string) [required]- Id of the intelligent tiering configuration
GetBucketInventoryConfiguration
Properties:
Bucket(string) [required]- S3 bucket name
Id(string) [required]- Id of the inventory configuration
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
GetBucketLifecycleConfiguration
Properties:
Bucket(string) [required]- S3 bucket name
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
GetBucketLocation
Properties:
Bucket(string) [required]- S3 bucket name
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
GetBucketLogging
Properties:
Bucket(string) [required]- S3 bucket name
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
GetBucketMetricsConfiguration
Properties:
Bucket(string) [required]- S3 bucket name
Id(string) [required]- Id of the metrics configuration
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
GetBucketNotificationConfiguration
Properties:
Bucket(string) [required]- S3 bucket name
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
GetBucketOwnershipControls
Properties:
Bucket(string) [required]- S3 bucket name
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
GetBucketPolicy
Properties:
Bucket(string) [required]- S3 bucket name
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
GetBucketPolicyStatus
Properties:
Bucket(string) [required]- S3 bucket name
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
GetBucketReplication
Properties:
Bucket(string) [required]- S3 bucket name
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
GetBucketRequestPayment
Properties:
Bucket(string) [required]- S3 bucket name
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
GetBucketTagging
Properties:
Bucket(string) [required]- S3 bucket name
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
GetBucketVersioning
Properties:
Bucket(string) [required]- S3 bucket name
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
GetBucketWebsite
Properties:
Bucket(string) [required]- S3 bucket name
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
GetObject
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
- Sets request header:
IfModifiedSince(string)- Sets request header:
if-modified-since
- Sets request header:
IfNoneMatch(string)- Sets request header:
if-none-match
- Sets request header:
IfUnmodifiedSince(string)- Sets request header:
if-unmodified-since
- Sets request header:
Range(string)- Sets request header:
range
- Sets request header:
SSECustomerAlgorithm(string)- Sets request header:
x-amz-server-side-encryption-customer-algorithm
- Sets request header:
SSECustomerKey(string)- Sets request header:
x-amz-server-side-encryption-customer-key
- Sets request header:
SSECustomerKeyMD5(string)- Sets request header:
x-amz-server-side-encryption-customer-key-md5
- Sets request header:
RequestPayer(string)- Sets request header:
x-amz-request-payer
- Sets request header:
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
ChecksumMode(string)- Sets request header:
x-amz-checksum-mode
- Sets request header:
ResponseCacheControl(string)- Sets response header:
cache-control
- Sets response header:
ResponseContentDisposition(string)- Sets response header:
content-disposition
- Sets response header:
ResponseContentEncoding(string)- Sets response header:
content-encoding
- Sets response header:
ResponseContentLanguage(string)- Sets response header:
content-language
- Sets response header:
ResponseContentType(string)- Sets response header:
content-type
- Sets response header:
ResponseExpires(string)- Sets response header:
expires
- Sets response header:
rawResponsePayload(boolean)- Set to
trueto return payload as a buffer
- Set to
streamResponsePayload(boolean)- Set to
trueto return payload as a Node.js stream
- Set to
HeadBucket
Properties:
Bucket(string) [required]- S3 bucket name
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
HeadObject
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
- Sets request header:
IfModifiedSince(string)- Sets request header:
if-modified-since
- Sets request header:
IfNoneMatch(string)- Sets request header:
if-none-match
- Sets request header:
IfUnmodifiedSince(string)- Sets request header:
if-unmodified-since
- Sets request header:
Range(string)- Sets request header:
range
- Sets request header:
SSECustomerAlgorithm(string)- Sets request header:
x-amz-server-side-encryption-customer-algorithm
- Sets request header:
SSECustomerKey(string)- Sets request header:
x-amz-server-side-encryption-customer-key
- Sets request header:
SSECustomerKeyMD5(string)- Sets request header:
x-amz-server-side-encryption-customer-key-md5
- Sets request header:
RequestPayer(string)- Sets request header:
x-amz-request-payer
- Sets request header:
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
ChecksumMode(string)- Sets request header:
x-amz-checksum-mode
- Sets request header:
ListBucketAnalyticsConfigurations
Properties:
Bucket(string) [required]- S3 bucket name
ContinuationToken(string)- Pagination cursor token (returned as
NextContinuationToken
- Pagination cursor token (returned as
paginate(boolean)- Enable automatic result pagination; use this instead of making your own individual pagination requests
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
ListBucketIntelligentTieringConfigurations
Properties:
Bucket(string) [required]- S3 bucket name
ContinuationToken(string)- Pagination cursor token (returned as
NextContinuationToken
- Pagination cursor token (returned as
paginate(boolean)- Enable automatic result pagination; use this instead of making your own individual pagination requests
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
ListBucketInventoryConfigurations
Properties:
Bucket(string) [required]- S3 bucket name
ContinuationToken(string)- Pagination cursor token (returned as
NextContinuationToken
- Pagination cursor token (returned as
paginate(boolean)- Enable automatic result pagination; use this instead of making your own individual pagination requests
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
ListBucketMetricsConfigurations
Properties:
Bucket(string) [required]- S3 bucket name
ContinuationToken(string)- Pagination cursor token (returned as
NextContinuationToken
- Pagination cursor token (returned as
paginate(boolean)- Enable automatic result pagination; use this instead of making your own individual pagination requests
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
ListBuckets
Properties:
ListMultipartUploads
Properties:
Bucket(string) [required]- S3 bucket name
Delimiter(string)- Delimiter character used to group keys
EncodingType(string)- Object key encoding type (must be
url)
- Object key encoding type (must be
KeyMarker(string)- Pagination cursor
MaxUploads(number)- Maximum number of uploads between 1 and 1000 (inclusive) to return in the response
UploadIdMarker(string)- Deal with this later
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
RequestPayer(string)- Sets request header:
x-amz-request-payer
- Sets request header:
paginate(boolean)- Enable automatic result pagination; use this instead of making your own individual pagination requests
ListObjectsV2
Properties:
Bucket(string) [required]- S3 bucket name
ContinuationToken(string)- Pagination cursor token (returned as
NextContinuationToken
- Pagination cursor token (returned as
Delimiter(string)- Delimiter character used to group keys
EncodingType(string)- Object key encoding type (must be
url)
- Object key encoding type (must be
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
- Sets request header:
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
OptionalObjectAttributes(string)- Sets request header:
x-amz-optional-object-attributes
- Sets request header:
paginate(boolean)- Enable automatic result pagination; use this instead of making your own individual pagination requests
PutBucketAccelerateConfiguration
Properties:
AccelerateConfiguration(object) [required]- Object specifying acceleration configurations; can contain one of:
Status: 'Enabled',Status: 'Suspended' - More details (AWS)
- Object specifying acceleration configurations; can contain one of:
Bucket(string) [required]- S3 bucket name
ChecksumAlgorithm(string)- Sets request header:
x-amz-sdk-checksum-algorithm
- Sets request header:
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
PutBucketAnalyticsConfiguration
Properties:
Bucket(string) [required]- S3 bucket name
Id(string) [required]- Id of the analytics configuration
AnalyticsConfiguration(object) [required]- Object defining the analytics configuration
- More details (AWS)
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
PutBucketCors
Properties:
Bucket(string) [required]- S3 bucket name
CORSConfiguration(object) [required]- Object defining the CORS configuration
- More details (AWS)
ContentMD5(string)- Sets request header:
content-md5
- Sets request header:
ChecksumAlgorithm(string)- Sets request header:
x-amz-sdk-checksum-algorithm
- Sets request header:
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
PutBucketEncryption
Properties:
Bucket(string) [required]- S3 bucket name
ServerSideEncryptionConfiguration(object) [required]- Object defining the server side encryption configuration
- More details (AWS)
ContentMD5(string)- Sets request header:
content-md5
- Sets request header:
ChecksumAlgorithm(string)- Sets request header:
x-amz-sdk-checksum-algorithm
- Sets request header:
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
PutBucketIntelligentTieringConfiguration
Properties:
Bucket(string) [required]- S3 bucket name
Id(string) [required]- Id of the intelligent tiering configuration
IntelligentTieringConfiguration(object) [required]- Object defining the intelligent tiering configuration; required fields are:
Id,Status,Tierings - More details (AWS)
- Object defining the intelligent tiering configuration; required fields are:
PutBucketInventoryConfiguration
Properties:
Bucket(string) [required]- S3 bucket name
Id(string) [required]- ID of the object
InventoryConfiguration(object) [required]- Object defining the inventory configuration; required config fields are:
Id,IsEnabled,IncludedObjectVersion,Destination,Schedule - More details (AWS)
- Object defining the inventory configuration; required config fields are:
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
PutBucketLifecycleConfiguration
Properties:
Bucket(string) [required]- S3 bucket name
LifecycleConfiguration(object) [required]- Object defining the lifecycle configuration
- More details (AWS)
ChecksumAlgorithm(string)- Sets request header:
x-amz-sdk-checksum-algorithm
- Sets request header:
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
ContentMD5(string)- Sets request header:
content-md5
- Sets request header:
PutBucketMetricsConfiguration
Properties:
Bucket(string) [required]- S3 bucket name
Id(string) [required]- ID of the object
MetricsConfiguration(object) [required]- Object defining the metrics configuration
- More details (AWS)
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
PutBucketNotificationConfiguration
Properties:
Bucket(string) [required]- S3 bucket name
NotificationConfiguration(object) [required]- Object defining the notification configuration
- More details (AWS)
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
PutBucketOwnershipControls
Properties:
Bucket(string) [required]- S3 bucket name
OwnershipControls(object) [required]- Object defining the ownership controls
- More details (AWS)
ContentMD5(string)- Sets request header:
content-md5
- Sets request header:
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
PutBucketPolicy
Properties:
Bucket(string) [required]- S3 bucket name
Policy(object) [required]- Object defining the policy
- More details (AWS)
ContentMD5(string)- Sets request header:
content-md5
- Sets request header:
ChecksumAlgorithm(string)- Sets request header:
x-amz-sdk-checksum-algorithm
- Sets request header:
ConfirmRemoveSelfBucketAccess(string)- Sets request header:
x-amz-confirm-remove-self-bucket-access
- Sets request header:
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
PutBucketReplication
Properties:
Bucket(string) [required]- S3 bucket name
ReplicationConfiguration(object) [required]- Object defining the replication configuration
- More details (AWS)
ContentMD5(string)- Sets request header:
content-md5
- Sets request header:
ChecksumAlgorithm(string)- Sets request header:
x-amz-sdk-checksum-algorithm
- Sets request header:
Token(string)- Sets request header:
x-amz-bucket-object-lock-token
- Sets request header:
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
PutBucketRequestPayment
Properties:
Bucket(string) [required]- S3 bucket name
RequestPaymentConfiguration(object) [required]- Object defining the payment configuration; must contain
Payer, which can be one of:Requester,BucketOwner
- Object defining the payment configuration; must contain
ContentMD5(string)- Sets request header:
content-md5
- Sets request header:
ChecksumAlgorithm(string)- Sets request header:
x-amz-sdk-checksum-algorithm
- Sets request header:
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
PutBucketTagging
Properties:
Bucket(string) [required]- S3 bucket name
Tagging(object) [required]- Object defining the tag set
- More details (AWS)
ContentMD5(string)- Sets request header:
content-md5
- Sets request header:
ChecksumAlgorithm(string)- Sets request header:
x-amz-sdk-checksum-algorithm
- Sets request header:
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
PutBucketVersioning
Properties:
Bucket(string) [required]- S3 bucket name
VersioningConfiguration(object) [required]- Object defining the versioning configuration
- More details (AWS)
ContentMD5(string)- Sets request header:
content-md5
- Sets request header:
ChecksumAlgorithm(string)- Sets request header:
x-amz-sdk-checksum-algorithm
- Sets request header:
MFA(string)- Sets request header:
x-amz-mfa
- Sets request header:
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
PutBucketWebsite
Properties:
Bucket(string) [required]- S3 bucket name
WebsiteConfiguration(object) [required]- Object defining the website configuration
- More details (AWS)
ContentMD5(string)- Sets request header:
content-md5
- Sets request header:
ChecksumAlgorithm(string)- Sets request header:
x-amz-sdk-checksum-algorithm
- Sets request header:
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
PutObject
Properties:
Bucket(string) [required]- S3 bucket name
Key(string) [required]- S3 key / file name
Body(buffer, stream, string)- 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
- Sets request header:
BucketKeyEnabled(string)- Sets request header:
x-amz-server-side-encryption-bucket-key-enabled
- Sets request header:
CacheControl(string)- Sets request header:
cache-control
- Sets request header:
ChecksumAlgorithm(string)- Sets request header:
x-amz-sdk-checksum-algorithm
- Sets request header:
ChecksumCRC32(string)- Sets request header:
x-amz-checksum-crc32
- Sets request header:
ChecksumCRC32C(string)- Sets request header:
x-amz-checksum-crc32c
- Sets request header:
ChecksumSHA1(string)- Sets request header:
x-amz-checksum-sha1
- Sets request header:
ChecksumSHA256(string)- Sets request header:
x-amz-checksum-sha256
- Sets request header:
ContentDisposition(string)- Sets request header:
content-disposition
- Sets request header:
ContentEncoding(string)- Sets request header:
content-encoding
- Sets request header:
ContentLanguage(string)- Sets request header:
content-language
- Sets request header:
ContentLength(string)- Sets request header:
content-length
- Sets request header:
ContentMD5(string)- Sets request header:
content-md5
- Sets request header:
ContentType(string)- Sets request header:
content-type
- Sets request header:
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
Expires(string)- Sets request header:
expires
- Sets request header:
GrantFullControl(string)- Sets request header:
x-amz-grant-full-control
- Sets request header:
GrantRead(string)- Sets request header:
x-amz-grant-read
- Sets request header:
GrantReadACP(string)- Sets request header:
x-amz-grant-read-acp
- Sets request header:
GrantWriteACP(string)- Sets request header:
x-amz-grant-write-acp
- Sets request header:
ObjectLockLegalHoldStatus(string)- Sets request header:
x-amz-object-lock-legal-hold
- Sets request header:
ObjectLockMode(string)- Sets request header:
x-amz-object-lock-mode
- Sets request header:
ObjectLockRetainUntilDate(string)- Sets request header:
x-amz-object-lock-retain-until-date
- Sets request header:
RequestPayer(string)- Sets request header:
x-amz-request-payer
- Sets request header:
ServerSideEncryption(string)- Sets request header:
x-amz-server-side-encryption
- Sets request header:
SSECustomerAlgorithm(string)- Sets request header:
x-amz-server-side-encryption-customer-algorithm
- Sets request header:
SSECustomerKey(string)- Sets request header:
x-amz-server-side-encryption-customer-key
- Sets request header:
SSECustomerKeyMD5(string)- Sets request header:
x-amz-server-side-encryption-customer-key-md5
- Sets request header:
SSEKMSEncryptionContext(string)- Sets request header:
x-amz-server-side-encryption-context
- Sets request header:
SSEKMSKeyId(string)- Sets request header:
x-amz-server-side-encryption-aws-kms-key-id
- Sets request header:
StorageClass(string)- Sets request header:
x-amz-storage-class
- Sets request header:
Tagging(string)- Sets request header:
x-amz-tagging
- Sets request header:
WebsiteRedirectLocation(string)- Sets request header:
x-amz-website-redirect-location
- Sets request header:
Metadata(object)- Key / value pairs of object metadata; must conform to S3 metadata guidelines
- More details (AWS)
PutObjectLegalHold
Properties:
Bucket(string) [required]- S3 bucket name
Key(string) [required]- S3 key / file name
VersionId(string)- Reference a specific version of the object
LegalHold(object) [required]- Object containing the field
Status(string) which can be one of:ON,OFF
- Object containing the field
RequestPayer(string)- Sets request header:
x-amz-request-payer
- Sets request header:
ContentMD5(string)- Sets request header:
content-md5
- Sets request header:
ChecksumAlgorithm(string)- Sets request header:
x-amz-sdk-checksum-algorithm
- Sets request header:
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
PutObjectLockConfiguration
Properties:
Bucket(string) [required]- S3 bucket name
ObjectLockConfiguration(object) [required]- Object defining the object lock configuration
- More details (AWS)
RequestPayer(string)- Sets request header:
x-amz-request-payer
- Sets request header:
Token(string)- Sets request header:
x-amz-bucket-object-lock-token
- Sets request header:
ContentMD5(string)- Sets request header:
content-md5
- Sets request header:
ChecksumAlgorithm(string)- Sets request header:
x-amz-sdk-checksum-algorithm
- Sets request header:
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
PutObjectRetention
Properties:
Bucket(string) [required]- S3 bucket name
Key(string) [required]- S3 key / file name
VersionId(string)- Reference a specific version of the object
Retention(object) [required]- Object specifying the object retention parameters
- More details (AWS)
RequestPayer(string)- Sets request header:
x-amz-request-payer
- Sets request header:
BypassGovernanceRetention(string)- Sets request header:
x-amz-bypass-governance-retention
- Sets request header:
ContentMD5(string)- Sets request header:
content-md5
- Sets request header:
ChecksumAlgorithm(string)- Sets request header:
x-amz-sdk-checksum-algorithm
- Sets request header:
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
PutObjectTagging
Properties:
Bucket(string) [required]- S3 bucket name
Key(string) [required]- S3 key / file name
VersionId(string)- Reference a specific version of the object
Tagging(object) [required]- Object containing the tag set
- More details (AWS)
ContentMD5(string)- Sets request header:
content-md5
- Sets request header:
ChecksumAlgorithm(string)- Sets request header:
x-amz-sdk-checksum-algorithm
- Sets request header:
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
RequestPayer(string)- Sets request header:
x-amz-request-payer
- Sets request header:
Upload
Properties:
Bucket(string) [required]- S3 bucket name
Key(string) [required]- S3 key / file name
Body(buffer, stream, string)- String or buffer to be uploaded
File(string)- File path to be read and uploaded from the local filesystem
ChunkSize(number)- Size of each chunk to upload in byes (also aliased to
partSize); default is 10 MB
- Size of each chunk to upload in byes (also aliased to
Concurrency(number)- Maximum concurrent uploads (also aliased to
queueSize); default is 5, setting to 1 synchronously, sequentially uploads chunks; memory consumption is (ChunkSize+ 1) *Concurrency
- Maximum concurrent uploads (also aliased to
ACL(string)- Sets request header:
x-amz-acl
- Sets request header:
BucketKeyEnabled(string)- Sets request header:
x-amz-server-side-encryption-bucket-key-enabled
- Sets request header:
CacheControl(string)- Sets request header:
cache-control
- Sets request header:
ChecksumAlgorithm(string)- Sets request header:
x-amz-sdk-checksum-algorithm
- Sets request header:
ChecksumCRC32(string)- Sets request header:
x-amz-checksum-crc32
- Sets request header:
ChecksumCRC32C(string)- Sets request header:
x-amz-checksum-crc32c
- Sets request header:
ChecksumSHA1(string)- Sets request header:
x-amz-checksum-sha1
- Sets request header:
ChecksumSHA256(string)- Sets request header:
x-amz-checksum-sha256
- Sets request header:
ContentDisposition(string)- Sets request header:
content-disposition
- Sets request header:
ContentEncoding(string)- Sets request header:
content-encoding
- Sets request header:
ContentLanguage(string)- Sets request header:
content-language
- Sets request header:
ContentType(string)- Sets request header:
content-type
- Sets request header:
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
Expires(string)- Sets request header:
expires
- Sets request header:
GrantFullControl(string)- Sets request header:
x-amz-grant-full-control
- Sets request header:
GrantRead(string)- Sets request header:
x-amz-grant-read
- Sets request header:
GrantReadACP(string)- Sets request header:
x-amz-grant-read-acp
- Sets request header:
GrantWriteACP(string)- Sets request header:
x-amz-grant-write-acp
- Sets request header:
ObjectLockLegalHoldStatus(string)- Sets request header:
x-amz-object-lock-legal-hold
- Sets request header:
ObjectLockMode(string)- Sets request header:
x-amz-object-lock-mode
- Sets request header:
ObjectLockRetainUntilDate(string)- Sets request header:
x-amz-object-lock-retain-until-date
- Sets request header:
RequestPayer(string)- Sets request header:
x-amz-request-payer
- Sets request header:
ServerSideEncryption(string)- Sets request header:
x-amz-server-side-encryption
- Sets request header:
SSECustomerAlgorithm(string)- Sets request header:
x-amz-server-side-encryption-customer-algorithm
- Sets request header:
SSECustomerKey(string)- Sets request header:
x-amz-server-side-encryption-customer-key
- Sets request header:
SSECustomerKeyMD5(string)- Sets request header:
x-amz-server-side-encryption-customer-key-md5
- Sets request header:
SSEKMSEncryptionContext(string)- Sets request header:
x-amz-server-side-encryption-context
- Sets request header:
SSEKMSKeyId(string)- Sets request header:
x-amz-server-side-encryption-aws-kms-key-id
- Sets request header:
StorageClass(string)- Sets request header:
x-amz-storage-class
- Sets request header:
Tagging(string)- Sets request header:
x-amz-tagging
- Sets request header:
WebsiteRedirectLocation(string)- Sets request header:
x-amz-website-redirect-location
- Sets request header:
Metadata(object)- Key / value pairs of object metadata; must conform to S3 metadata guidelines
- More details (AWS)
UploadPart
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
Body(buffer, stream, string)- Stream of data to be uploaded
- More details (AWS)
ContentLength(string)- Sets request header:
content-length
- Sets request header:
ContentMD5(string)- Sets request header:
content-md5
- Sets request header:
ChecksumAlgorithm(string)- Sets request header:
x-amz-sdk-checksum-algorithm
- Sets request header:
ChecksumCRC32(string)- Sets request header:
x-amz-checksum-crc32
- Sets request header:
ChecksumCRC32C(string)- Sets request header:
x-amz-checksum-crc32c
- Sets request header:
ChecksumSHA1(string)- Sets request header:
x-amz-checksum-sha1
- Sets request header:
ChecksumSHA256(string)- Sets request header:
x-amz-checksum-sha256
- Sets request header:
SSECustomerAlgorithm(string)- Sets request header:
x-amz-server-side-encryption-customer-algorithm
- Sets request header:
SSECustomerKey(string)- Sets request header:
x-amz-server-side-encryption-customer-key
- Sets request header:
SSECustomerKeyMD5(string)- Sets request header:
x-amz-server-side-encryption-customer-key-md5
- Sets request header:
RequestPayer(string)- Sets request header:
x-amz-request-payer
- Sets request header:
ExpectedBucketOwner(string)- Sets request header:
x-amz-expected-bucket-owner
- Sets request header:
Methods yet to be implemented
Please help out by opening a PR!
CopyObjectCreateSessionDeleteObjectTaggingDeletePublicAccessBlockGetBucketLifecycleGetBucketNotificationGetObjectAclGetObjectAttributesGetObjectLegalHoldGetObjectLockConfigurationGetObjectRetentionGetObjectTaggingGetObjectTorrentGetPublicAccessBlockListDirectoryBucketsListObjectsListObjectVersionsListPartsPutBucketAclPutBucketLifecyclePutBucketLoggingPutBucketNotificationPutObjectAclPutPublicAccessBlockRestoreObjectSelectObjectContentUploadPartCopyWriteGetObjectResponse
Learn more
FAQs
Official `aws-lite` plugin for S3
The npm package @aws-lite/s3 receives a total of 2,071 weekly downloads. As such, @aws-lite/s3 popularity was classified as popular.
We found that @aws-lite/s3 demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Package last updated on 11 Jun 2024
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Related posts
Security News
Understanding License Exceptions: What Developers Need to Know
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
By Sarah Gooding - Sep 20, 2024
Security News
Developer Accuses Tencent of Copyright Violation After Python Utility’s License Changed from GPLv3 to BSD
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.
By Sarah Gooding - Sep 18, 2024