Package Exports
- @aws-lite/s3
- @aws-lite/s3/src/index.mjs
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@aws-lite/s3) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@aws-lite/s3
Official
aws-liteplugin for S3
Maintained by: @architect
Install
npm i @aws-lite/s3Optionally install types:
npm i -D @aws-lite/s3-typesReference
Reference documentation with examples at aws-lite.org
Methods
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:
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:
ListBuckets
Properties:
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
PutObject
Properties:
Bucket(string) [required]- S3 bucket name
Key(string) [required]- S3 key / file name
File(string) [required]- File path to be read and uploaded from the local filesystem
MinChunkSize(number)- Minimum size (in bytes) to utilize 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:
Methods yet to be implemented
Please help out by opening a PR!
AbortMultipartUploadCompleteMultipartUploadCopyObjectCreateBucketCreateMultipartUploadDeleteBucketDeleteBucketAnalyticsConfigurationDeleteBucketCorsDeleteBucketEncryptionDeleteBucketIntelligentTieringConfigurationDeleteBucketInventoryConfigurationDeleteBucketLifecycleDeleteBucketMetricsConfigurationDeleteBucketOwnershipControlsDeleteBucketPolicyDeleteBucketReplicationDeleteBucketTaggingDeleteBucketWebsiteDeleteObjectDeleteObjectsDeleteObjectTaggingDeletePublicAccessBlockGetBucketAccelerateConfigurationGetBucketAclGetBucketAnalyticsConfigurationGetBucketCorsGetBucketEncryptionGetBucketIntelligentTieringConfigurationGetBucketInventoryConfigurationGetBucketLifecycleGetBucketLifecycleConfigurationGetBucketLocationGetBucketLoggingGetBucketMetricsConfigurationGetBucketNotificationGetBucketNotificationConfigurationGetBucketOwnershipControlsGetBucketPolicyGetBucketPolicyStatusGetBucketReplicationGetBucketRequestPaymentGetBucketTaggingGetBucketVersioningGetBucketWebsiteGetObjectAclGetObjectAttributesGetObjectLegalHoldGetObjectLockConfigurationGetObjectRetentionGetObjectTaggingGetObjectTorrentGetPublicAccessBlockHeadBucketListBucketAnalyticsConfigurationsListBucketIntelligentTieringConfigurationsListBucketInventoryConfigurationsListBucketMetricsConfigurationsListMultipartUploadsListObjectsListObjectVersionsListPartsPutBucketAccelerateConfigurationPutBucketAclPutBucketAnalyticsConfigurationPutBucketCorsPutBucketEncryptionPutBucketIntelligentTieringConfigurationPutBucketInventoryConfigurationPutBucketLifecyclePutBucketLifecycleConfigurationPutBucketLoggingPutBucketMetricsConfigurationPutBucketNotificationPutBucketNotificationConfigurationPutBucketOwnershipControlsPutBucketPolicyPutBucketReplicationPutBucketRequestPaymentPutBucketTaggingPutBucketVersioningPutBucketWebsitePutObjectAclPutObjectLegalHoldPutObjectLockConfigurationPutObjectRetentionPutObjectTaggingPutPublicAccessBlockRestoreObjectSelectObjectContentUploadPartUploadPartCopyWriteGetObjectResponse