Official `aws-lite` plugin for S3
npm install @aws-lite/s3@aws-lite/s3> Official aws-lite plugin for S3
> Maintained by: @architect
``sh`
npm i @aws-lite/s3
Optionally install types:
`sh`
npm i -D @aws-lite/s3-types
Reference documentation with examples at aws-lite.org
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
- (string)x-amz-request-payer
- Sets request header:
Properties:
- Bucket (string) [required]
- S3 bucket name
- Key (string) [required]
- S3 key / file name
- UploadId (string) [required]
- ID of the multipart upload
- MultipartUpload (object)
- MultipartUpload object containing details about the completed uploadsChecksumCRC32
- More details (AWS)
- (string)x-amz-checksum-crc32
- Sets request header:
- (string)x-amz-checksum-crc32c
- Sets request header:
- (string)x-amz-checksum-sha1
- Sets request header:
- (string)x-amz-checksum-sha256
- Sets request header:
- (string)x-amz-request-payer
- Sets request header:
- (string)x-amz-expected-bucket-owner
- Sets request header:
- (string)x-amz-server-side-encryption-customer-algorithm
- Sets request header:
- (string)x-amz-server-side-encryption-customer-key
- Sets request header:
- (string)x-amz-server-side-encryption-customer-key-md5
- Sets request header:
Properties:
- Bucket (string) [required]
- Name of the S3 bucket destination
- Key (string) [required]
- S3 key / file name of the destination
- ACL (string)
- Sets request header: x-amz-acl
- (string)cache-control
- Sets request header:
- (string)x-amz-sdk-checksum-algorithm
- Sets request header:
- (string)content-disposition
- Sets request header:
- (string)content-encoding
- Sets request header:
- (string)content-language
- Sets request header:
- (string)content-type
- Sets request header:
- (string)x-amz-copy-source
- Sets request header:
- (string)x-amz-copy-source-if-match
- Sets request header:
- (string)x-amz-copy-source-if-modified-since
- Sets request header:
- (string)x-amz-copy-source-if-none-match
- Sets request header:
- (string)x-amz-copy-source-if-unmodified-since
- Sets request header:
- (string)expires
- Sets request header:
- (string)x-amz-grant-full-control
- Sets request header:
- (string)x-amz-grant-read
- Sets request header:
- (string)x-amz-grant-read-acp
- Sets request header:
- (string)x-amz-grant-write-acp
- Sets request header:
- (string)x-amz-metadata-directive
- Sets request header:
- (string)x-amz-tagging-directive
- Sets request header:
- (string)x-amz-server-side-encryption
- Sets request header:
- (string)x-amz-storage-class
- Sets request header:
- (string)x-amz-website-redirect-location
- Sets request header:
- (string)x-amz-server-side-encryption-customer-algorithm
- Sets request header:
- (string)x-amz-server-side-encryption-customer-key
- Sets request header:
- (string)x-amz-server-side-encryption-customer-key-md5
- Sets request header:
- (string)x-amz-server-side-encryption-aws-kms-key-id
- Sets request header:
- (string)x-amz-server-side-encryption-context
- Sets request header:
- (string)x-amz-server-side-encryption-bucket-key-enabled
- Sets request header:
- (string)x-amz-copy-source-server-side-encryption-customer-algorithm
- Sets request header:
- (string)x-amz-copy-source-server-side-encryption-customer-key
- Sets request header:
- (string)x-amz-copy-source-server-side-encryption-customer-key-MD5
- Sets request header:
- (string)x-amz-request-payer
- Sets request header:
- (string)x-amz-tagging
- Sets request header:
- (string)x-amz-object-lock-mode
- Sets request header:
- (string)x-amz-object-lock-retain-until-date
- Sets request header:
- (string)x-amz-object-lock-legal-hold
- Sets request header:
- (string)x-amz-expected-bucket-owner
- Sets request header:
- (string)x-amz-source-expected-bucket-owner
- Sets request header:
Properties:
- Bucket (string) [required]
- S3 bucket name
- CreateBucketConfiguration (object)
- Complete bucket configuration object
- More details (AWS)
- ACL (string)
- Sets request header: x-amz-acl
- (string)x-amz-grant-full-control
- Sets request header:
- (string)x-amz-grant-read
- Sets request header:
- (string)x-amz-grant-read-acp
- Sets request header:
- (string)x-amz-grant-write
- Sets request header:
- (string)x-amz-grant-write-acp
- Sets request header:
- (string)x-amz-bucket-object-lock-enabled
- Sets request header:
- (string)x-amz-object-ownership
- Sets request header:
Properties:
- Bucket (string) [required]
- S3 bucket name
- Key (string) [required]
- S3 key / file name
- ACL (string)
- Sets request header: x-amz-acl
- (string)cache-control
- Sets request header:
- (string)content-disposition
- Sets request header:
- (string)content-encoding
- Sets request header:
- (string)content-language
- Sets request header:
- (string)content-type
- Sets request header:
- (string)expires
- Sets request header:
- (string)x-amz-grant-full-control
- Sets request header:
- (string)x-amz-grant-read
- Sets request header:
- (string)x-amz-grant-read-acp
- Sets request header:
- (string)x-amz-grant-write-acp
- Sets request header:
- (string)x-amz-server-side-encryption
- Sets request header:
- (string)x-amz-storage-class
- Sets request header:
- (string)x-amz-website-redirect-location
- Sets request header:
- (string)x-amz-server-side-encryption-customer-algorithm
- Sets request header:
- (string)x-amz-server-side-encryption-customer-key-md5
- Sets request header:
- (string)x-amz-server-side-encryption-aws-kms-key-id
- Sets request header:
- (string)x-amz-server-side-encryption-context
- Sets request header:
- (string)x-amz-server-side-encryption-bucket-key-enabled
- Sets request header:
- (string)x-amz-request-payer
- Sets request header:
- (string)x-amz-tagging
- Sets request header:
- (string)x-amz-object-lock-mode
- Sets request header:
- (string)x-amz-object-lock-retain-until-date
- Sets request header:
- (string)x-amz-object-lock-legal-hold
- Sets request header:
- (string)x-amz-expected-bucket-owner
- Sets request header:
- (string)x-amz-sdk-checksum-algorithm
- Sets request header:
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Properties:
- Bucket (string) [required]
- S3 bucket name
- Id (string) [required]
- ID of the object
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Properties:
- Bucket (string) [required]
- S3 bucket name
- Id (string) [required]
- ID of the object
Properties:
- Bucket (string) [required]
- S3 bucket name
- Id (string) [required]
- ID of the object
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Properties:
- Bucket (string) [required]
- S3 bucket name
- Id (string) [required]
- ID of the object
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
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
- (string)x-amz-request-payer
- Sets request header:
- (string)x-amz-bypass-governance-retention
- Sets request header:
- (string)x-amz-expected-bucket-owner
- Sets request header:
Properties:
- Bucket (string) [required]
- S3 bucket name
- Delete (object) [required]
- Object deletion request
- MFA (string)
- Sets request header: x-amz-mfa
- (string)x-amz-request-payer
- Sets request header:
- (string)x-amz-bypass-governance-retention
- Sets request header:
- (string)x-amz-expected-bucket-owner
- Sets request header:
- (string)x-amz-sdk-checksum-algorithm
- Sets request header:
- (string)content-md5
- Sets request header:
Properties:
- Bucket (string) [required]
- S3 bucket name
- Key (string) [required]
- S3 key / file name
- VersionId (string)
- Reference a specific version of the object
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
- (string)x-amz-request-payer
- Sets request header:
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
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
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Properties:
- Bucket (string) [required]
- S3 bucket name
- Id (string) [required]
- Id of the intelligent tiering configuration
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
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
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
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
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
- (string)if-modified-since
- Sets request header:
- (string)if-none-match
- Sets request header:
- (string)if-unmodified-since
- Sets request header:
- (string)range
- Sets request header:
- (string)x-amz-server-side-encryption-customer-algorithm
- Sets request header:
- (string)x-amz-server-side-encryption-customer-key
- Sets request header:
- (string)x-amz-server-side-encryption-customer-key-md5
- Sets request header:
- (string)x-amz-request-payer
- Sets request header:
- (string)x-amz-expected-bucket-owner
- Sets request header:
- (string)x-amz-checksum-mode
- Sets request header:
- (string)cache-control
- Sets response header:
- (string)content-disposition
- Sets response header:
- (string)content-encoding
- Sets response header:
- (string)content-language
- Sets response header:
- (string)content-type
- Sets response header:
- (string)expires
- Sets response header:
- (boolean)true
- Set to to return payload as a bufferstreamResponsePayload
- (boolean)true
- Set to to return payload as a Node.js stream
Properties:
- Bucket (string) [required]
- S3 bucket name
- Key (string) [required]
- S3 key / file name
- VersionId (string)
- Reference a specific version of the object
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
- (string)x-amz-request-payer
- Sets request header:
Properties:
- Bucket (string) [required]
- S3 bucket name
- Key (string) [required]
- S3 key / file name
- ObjectAttributes (array) [required]
- Specify attributes to be returned, can be one or more of: ETag, Checksum, ObjectParts, StorageClass, ObjectSize
- More details (AWS)
- (string)MaxParts
- Reference a specific version of the object
- (number)PartNumberMarker
- Maximum number of parts to be returned in the response
- (string)x-amz-part-number-marker
- Sets request header:
- (string)x-amz-server-side-encryption-customer-algorithm
- Sets request header:
- (string)x-amz-server-side-encryption-customer-key
- Sets request header:
- (string)x-amz-server-side-encryption-customer-key-md5
- Sets request header:
- (string)x-amz-request-payer
- Sets request header:
- (string)x-amz-expected-bucket-owner
- Sets request header:
Properties:
- Bucket (string) [required]
- S3 bucket name
- Key (string) [required]
- S3 key / file name
- VersionId (string)
- Reference a specific version of the object
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
- (string)x-amz-request-payer
- Sets request header:
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Properties:
- Bucket (string) [required]
- S3 bucket name
- Key (string) [required]
- S3 key / file name
- VersionId (string)
- Reference a specific version of the object
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
- (string)x-amz-request-payer
- Sets request header:
Properties:
- Bucket (string) [required]
- S3 bucket name
- Key (string) [required]
- S3 key / file name
- VersionId (string)
- Reference a specific version of the object
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
- (string)x-amz-request-payer
- Sets request header:
Properties:
- Bucket (string) [required]
- S3 bucket name
- Key (string) [required]
- S3 key / file name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
- (string)x-amz-request-payer
- Sets request header:
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
Properties:
- Bucket (string) [required]
- S3 bucket name
- ExpectedBucketOwner (string)
- Sets request header: x-amz-expected-bucket-owner
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
- (string)if-modified-since
- Sets request header:
- (string)if-none-match
- Sets request header:
- (string)if-unmodified-since
- Sets request header:
- (string)range
- Sets request header:
- (string)x-amz-server-side-encryption-customer-algorithm
- Sets request header:
- (string)x-amz-server-side-encryption-customer-key
- Sets request header:
- (string)x-amz-server-side-encryption-customer-key-md5
- Sets request header:
- (string)x-amz-request-payer
- Sets request header:
- (string)x-amz-expected-bucket-owner
- Sets request header:
- (string)x-amz-checksum-mode
- Sets request header:
Properties:
- Bucket (string) [required]
- S3 bucket name
- ContinuationToken (string)
- Pagination cursor token (returned as NextContinuationToken
- (boolean, string)ExpectedBucketOwner
- Enable automatic result pagination; use this instead of making your own individual pagination requests
- (string)x-amz-expected-bucket-owner
- Sets request header:
Properties:
- Bucket (string) [required]
- S3 bucket name
- ContinuationToken (string)
- Pagination cursor token (returned as NextContinuationToken
- (boolean, string)ExpectedBucketOwner
- Enable automatic result pagination; use this instead of making your own individual pagination requests
- (string)x-amz-expected-bucket-owner
- Sets request header:
Properties:
- Bucket (string) [required]
- S3 bucket name
- ContinuationToken (string)
- Pagination cursor token (returned as NextContinuationToken
- (boolean, string)ExpectedBucketOwner
- Enable automatic result pagination; use this instead of making your own individual pagination requests
- (string)x-amz-expected-bucket-owner
- Sets request header:
Properties:
- Bucket (string) [required]
- S3 bucket name
- ContinuationToken (string)
- Pagination cursor token (returned as NextContinuationToken
- (boolean, string)ExpectedBucketOwner
- Enable automatic result pagination; use this instead of making your own individual pagination requests
- (string)x-amz-expected-bucket-owner
- Sets request header:
Properties:
Properties:
- Bucket (string) [required]
- S3 bucket name
- Delimiter (string)
- Delimiter character used to group keys
- EncodingType (string)
- Object key encoding type (must be url)KeyMarker
- (string)MaxUploads
- Pagination cursor
- (number)UploadIdMarker
- Maximum number of uploads between 1 and 1000 (inclusive) to return in the response
- (string)ExpectedBucketOwner
- Deal with this later
- (string)x-amz-expected-bucket-owner
- Sets request header:
- (string)x-amz-request-payer
- Sets request header:
- (boolean, string)
- Enable automatic result pagination; use this instead of making your own individual pagination requests
Properties:
- Bucket (string) [required]
- S3 bucket name
- ContinuationToken (string)
- Pagination cursor token (returned as NextContinuationToken
- (string)EncodingType
- Delimiter character used to group keys
- (string)url
- Object key encoding type (must be )FetchOwner
- (string)MaxKeys
- Return owner field with results
- (number)Prefix
- Set the maximum number of keys returned per response
- (string)StartAfter
- Limit response to keys that begin with the specified prefix
- (string)RequestPayer
- Starts listing after any specified key in the bucket
- (string)x-amz-request-payer
- Sets request header:
- (string)x-amz-expected-bucket-owner
- Sets request header:
- (string)x-amz-optional-object-attributes
- Sets request header:
- (boolean, string)
- Enable automatic result pagination; use this instead of making your own individual pagination requests
Properties:
- Bucket (string) [required]
- S3 bucket name
- Delimiter (string)
- Delimiter character used to group keys
- EncodingType (string)
- Object key encoding type (must be url)KeyMarker
- (string)MaxKeys
- Pagination cursor
- (number)Prefix
- Maximum number of keys (at most 1000) to be returned in the response
- (string)VersionIdMarker
- Limit response to keys that begin with the specified prefix
- (string)paginate
- Specify the version to begin listing from
- More details (AWS)
- (boolean, string)ExpectedBucketOwner
- Enable automatic result pagination; use this instead of making your own individual pagination requests
- (string)x-amz-expected-bucket-owner
- Sets request header:
- (string)x-amz-request-payer
- Sets request header:
- (string)x-amz-optional-object-attributes
- Sets request header:
Properties:
- Bucket (string) [required]
- S3 bucket name
- Key (string) [required]
- S3 key / file name
- UploadId (string) [required]
- ID of the multipart upload
- MaxParts (number)
- Maximum number of parts (at most 1000) to be returned in the response
- PartNumberMarker (string)
- Pagination cursor
- paginate (boolean, string)
- Enable automatic result pagination; use this instead of making your own individual pagination requests
- RequestPayer (string)
- Sets request header: x-amz-request-payer
- (string)x-amz-expected-bucket-owner
- Sets request header:
- (string)x-amz-server-side-encryption-customer-algorithm
- Sets request header:
- (string)x-amz-server-side-encryption-customer-key
- Sets request header:
- (string)x-amz-server-side-encryption-customer-key-md5
- Sets request header:
Properties:
- AccelerateConfiguration (object) [required]
- Object specifying acceleration configurations; can contain one of: Status: 'Enabled', Status: 'Suspended'
- More details (AWS)
- (string) [required]ChecksumAlgorithm
- S3 bucket name
- (string)x-amz-sdk-checksum-algorithm
- Sets request header:
- (string)x-amz-expected-bucket-owner
- Sets request header:
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
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
- (string)x-amz-sdk-checksum-algorithm
- Sets request header:
- (string)x-amz-expected-bucket-owner
- Sets request header:
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
- (string)x-amz-sdk-checksum-algorithm
- Sets request header:
- (string)x-amz-expected-bucket-owner
- Sets request header:
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)
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)
- (string)x-amz-expected-bucket-owner
- Sets request header:
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
- (string)x-amz-expected-bucket-owner
- Sets request header:
- (string)content-md5
- Sets request header:
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
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
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
- (string)x-amz-expected-bucket-owner
- Sets request header:
Properties:
- Bucket (string) [required]
- S3 bucket name
- Policy (object) [required]
- Object defining the policy
- More details (AWS)
- ContentMD5 (string)
- Sets request header: content-md5
- (string)x-amz-sdk-checksum-algorithm
- Sets request header:
- (string)x-amz-confirm-remove-self-bucket-access
- Sets request header:
- (string)x-amz-expected-bucket-owner
- Sets request header:
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
- (string)x-amz-sdk-checksum-algorithm
- Sets request header:
- (string)x-amz-bucket-object-lock-token
- Sets request header:
- (string)x-amz-expected-bucket-owner
- Sets request header:
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
- (string)content-md5
- Sets request header:
- (string)x-amz-sdk-checksum-algorithm
- Sets request header:
- (string)x-amz-expected-bucket-owner
- Sets request header:
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
- (string)x-amz-sdk-checksum-algorithm
- Sets request header:
- (string)x-amz-expected-bucket-owner
- Sets request header:
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
- (string)x-amz-sdk-checksum-algorithm
- Sets request header:
- (string)x-amz-mfa
- Sets request header:
- (string)x-amz-expected-bucket-owner
- Sets request header:
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
- (string)x-amz-sdk-checksum-algorithm
- Sets request header:
- (string)x-amz-expected-bucket-owner
- Sets request header:
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
- (string)x-amz-server-side-encryption-bucket-key-enabled
- Sets request header:
- (string)cache-control
- Sets request header:
- (string)x-amz-sdk-checksum-algorithm
- Sets request header:
- (string)x-amz-checksum-crc32
- Sets request header:
- (string)x-amz-checksum-crc32c
- Sets request header:
- (string)x-amz-checksum-sha1
- Sets request header:
- (string)x-amz-checksum-sha256
- Sets request header:
- (string)content-disposition
- Sets request header:
- (string)content-encoding
- Sets request header:
- (string)content-language
- Sets request header:
- (string)content-length
- Sets request header:
- (string)content-md5
- Sets request header:
- (string)content-type
- Sets request header:
- (string)x-amz-expected-bucket-owner
- Sets request header:
- (string)expires
- Sets request header:
- (string)x-amz-grant-full-control
- Sets request header:
- (string)x-amz-grant-read
- Sets request header:
- (string)x-amz-grant-read-acp
- Sets request header:
- (string)x-amz-grant-write-acp
- Sets request header:
- (string)x-amz-object-lock-legal-hold
- Sets request header:
- (string)x-amz-object-lock-mode
- Sets request header:
- (string)x-amz-object-lock-retain-until-date
- Sets request header:
- (string)x-amz-request-payer
- Sets request header:
- (string)x-amz-server-side-encryption
- Sets request header:
- (string)x-amz-server-side-encryption-customer-algorithm
- Sets request header:
- (string)x-amz-server-side-encryption-customer-key
- Sets request header:
- (string)x-amz-server-side-encryption-customer-key-md5
- Sets request header:
- (string)x-amz-server-side-encryption-context
- Sets request header:
- (string)x-amz-server-side-encryption-aws-kms-key-id
- Sets request header:
- (string)x-amz-storage-class
- Sets request header:
- (string)x-amz-tagging
- Sets request header:
- (string)x-amz-website-redirect-location
- Sets request header:
- (object)
- Key / value pairs of object metadata; must conform to S3 metadata guidelines
- More details (AWS)
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
- (string)x-amz-request-payer
- Sets request header:
- (string)content-md5
- Sets request header:
- (string)x-amz-sdk-checksum-algorithm
- Sets request header:
- (string)x-amz-expected-bucket-owner
- Sets request header:
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
- (string)x-amz-bucket-object-lock-token
- Sets request header:
- (string)content-md5
- Sets request header:
- (string)x-amz-sdk-checksum-algorithm
- Sets request header:
- (string)x-amz-expected-bucket-owner
- Sets request header:
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
- (string)x-amz-bypass-governance-retention
- Sets request header:
- (string)content-md5
- Sets request header:
- (string)x-amz-sdk-checksum-algorithm
- Sets request header:
- (string)x-amz-expected-bucket-owner
- Sets request header:
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
- (string)x-amz-sdk-checksum-algorithm
- Sets request header:
- (string)x-amz-expected-bucket-owner
- Sets request header:
- (string)x-amz-request-payer
- Sets request header:
Properties:
- Bucket (string) [required]
- S3 bucket name
- PublicAccessBlockConfiguration (object) [required]
- Object defining the public access block configuration
- More details (AWS)
- ContentMD5 (string)
- Sets request header: content-md5
- (string)x-amz-sdk-checksum-algorithm
- Sets request header:
- (string)x-amz-expected-bucket-owner
- Sets request header:
Properties:
- Bucket (string) [required]
- S3 bucket name
- Key (string) [required]
- S3 key / file name
- RestoreRequest (object) [required]
- Object defining the restore request
- More details (AWS)
- VersionId (string)
- Reference a specific version of the object
- RequestPayer (string)
- Sets request header: x-amz-request-payer
- (string)x-amz-sdk-checksum-algorithm
- Sets request header:
- (string)x-amz-expected-bucket-owner
- Sets request header:
Properties:
- Bucket (string) [required]
- S3 bucket name
- Key (string) [required]
- S3 key / file name
- Body (buffer, stream, string)
- String or buffer to be uploaded; per S3, size should be 5MB or greater
- File (string)
- File path to be read and uploaded from the local filesystem; per S3, size should be 5MB or greater
- ChunkSize (number)
- Size of each chunk to upload in byes (also aliased to partSize); default is 10 MBConcurrency
- (number)queueSize
- Maximum concurrent uploads (also aliased to ); default is 5, setting to 1 synchronously, sequentially uploads chunks; memory consumption is (ChunkSize + 1) * Concurrency
- (string)x-amz-acl
- Sets request header:
- (string)x-amz-server-side-encryption-bucket-key-enabled
- Sets request header:
- (string)cache-control
- Sets request header:
- (string)x-amz-sdk-checksum-algorithm
- Sets request header:
- (string)x-amz-checksum-crc32
- Sets request header:
- (string)x-amz-checksum-crc32c
- Sets request header:
- (string)x-amz-checksum-sha1
- Sets request header:
- (string)x-amz-checksum-sha256
- Sets request header:
- (string)content-disposition
- Sets request header:
- (string)content-encoding
- Sets request header:
- (string)content-language
- Sets request header:
- (string)content-type
- Sets request header:
- (string)x-amz-expected-bucket-owner
- Sets request header:
- (string)expires
- Sets request header:
- (string)x-amz-grant-full-control
- Sets request header:
- (string)x-amz-grant-read
- Sets request header:
- (string)x-amz-grant-read-acp
- Sets request header:
- (string)x-amz-grant-write-acp
- Sets request header:
- (string)x-amz-object-lock-legal-hold
- Sets request header:
- (string)x-amz-object-lock-mode
- Sets request header:
- (string)x-amz-object-lock-retain-until-date
- Sets request header:
- (string)x-amz-request-payer
- Sets request header:
- (string)x-amz-server-side-encryption
- Sets request header:
- (string)x-amz-server-side-encryption-customer-algorithm
- Sets request header:
- (string)x-amz-server-side-encryption-customer-key
- Sets request header:
- (string)x-amz-server-side-encryption-customer-key-md5
- Sets request header:
- (string)x-amz-server-side-encryption-context
- Sets request header:
- (string)x-amz-server-side-encryption-aws-kms-key-id
- Sets request header:
- (string)x-amz-storage-class
- Sets request header:
- (string)x-amz-tagging
- Sets request header:
- (string)x-amz-website-redirect-location
- Sets request header:
- (object)
- Key / value pairs of object metadata; must conform to S3 metadata guidelines
- More details (AWS)
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
- (string)content-md5
- Sets request header:
- (string)x-amz-sdk-checksum-algorithm
- Sets request header:
- (string)x-amz-checksum-crc32
- Sets request header:
- (string)x-amz-checksum-crc32c
- Sets request header:
- (string)x-amz-checksum-sha1
- Sets request header:
- (string)x-amz-checksum-sha256
- Sets request header:
- (string)x-amz-server-side-encryption-customer-algorithm
- Sets request header:
- (string)x-amz-server-side-encryption-customer-key
- Sets request header:
- (string)x-amz-server-side-encryption-customer-key-md5
- Sets request header:
- (string)x-amz-request-payer
- Sets request header:
- (string)x-amz-expected-bucket-owner
- Sets request header:
> Please help out by opening a PR!
- CreateSession
- GetBucketLifecycle
- GetBucketNotification
- ListDirectoryBuckets
- ListObjects
- PutBucketAcl
- PutBucketLifecycle
- PutBucketLogging
- PutBucketNotification
- PutObjectAcl
- UploadPartCopy
- WriteGetObjectResponse
- More information about the aws-lite plugin API
- Learn about contributing to this and other aws-lite` plugins