S3

@aws-lite/s3

Maintained by: @architect

Install

npm i @aws-lite/s3

Optionally install types:

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

Methods

AbortMultipartUpload

Canonical AWS API doc

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

RequestPayer (string)

Sets request header: x-amz-request-payer

Example

await aws.S3.AbortMultipartUpload({
  Bucket: String, // required
  Key: String, // required
  UploadId: String, // required
  ExpectedBucketOwner: String,
  RequestPayer: String,
})

CompleteMultipartUpload

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

Key (string) [required]

S3 key / file name

UploadId (string) [required]

ID of the multipart upload

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

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

MultipartUpload (object)

MultipartUpload object containing details about the completed uploads

Example
await aws.S3.CompleteMultipartUpload({
  Bucket: String, // required
  Key: String, // required
  UploadId: String, // required
  ChecksumCRC32: String,
  ChecksumCRC32C: String,
  ChecksumSHA1: String,
  ChecksumSHA256: String,
  ExpectedBucketOwner: String,
  MultipartUpload: Object,
  RequestPayer: String,
  SSECustomerAlgorithm: String,
  SSECustomerKey: String,
  SSECustomerKeyMD5: String,
})

CreateBucket

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ACL (string)

Sets request header: x-amz-acl

CreateBucketConfiguration (object)

Complete bucket configuration object

Example
await aws.S3.CreateBucket({
  Bucket: String, // required
  ACL: String,
  CreateBucketConfiguration: Object,
  GrantFullControl: String,
  GrantRead: String,
  GrantReadACP: String,
  GrantWrite: String,
  GrantWriteACP: String,
  ObjectLockEnabledForBucket: String,
  ObjectOwnership: String,
})

CreateMultipartUpload

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

Key (string) [required]

S3 key / file name

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

ContentDisposition (string)

Sets request header: content-disposition

ContentEncoding (string)

Sets request header: content-encoding

ContentLanguage (string)

Sets request header: content-language

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

SSECustomerAlgorithm (string)

Sets request header: x-amz-server-side-encryption-customer-algorithm

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

ServerSideEncryption (string)

Sets request header: x-amz-server-side-encryption

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

Example

await aws.S3.CreateMultipartUpload({
  Bucket: String, // required
  Key: String, // required
  ACL: String,
  BucketKeyEnabled: String,
  CacheControl: String,
  ChecksumAlgorithm: String,
  ContentDisposition: String,
  ContentEncoding: String,
  ContentLanguage: String,
  ContentType: String,
  ExpectedBucketOwner: String,
  Expires: String,
  GrantFullControl: String,
  GrantRead: String,
  GrantReadACP: String,
  GrantWriteACP: String,
  ObjectLockLegalHoldStatus: String,
  ObjectLockMode: String,
  ObjectLockRetainUntilDate: String,
  RequestPayer: String,
  SSECustomerAlgorithm: String,
  SSECustomerKeyMD5: String,
  SSEKMSEncryptionContext: String,
  SSEKMSKeyId: String,
  ServerSideEncryption: String,
  StorageClass: String,
  Tagging: String,
  WebsiteRedirectLocation: String,
})

DeleteBucket

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.DeleteBucket({
  Bucket: String, // required
  ExpectedBucketOwner: String,
})

DeleteBucketAnalyticsConfiguration

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

Id (string) [required]

ID of the object

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.DeleteBucketAnalyticsConfiguration({
  Bucket: String, // required
  Id: String, // required
  ExpectedBucketOwner: String,
})

DeleteBucketCors

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.DeleteBucketCors({
  Bucket: String, // required
  ExpectedBucketOwner: String,
})

DeleteBucketEncryption

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.DeleteBucketEncryption({
  Bucket: String, // required
  ExpectedBucketOwner: String,
})

DeleteBucketIntelligentTieringConfiguration

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

Id (string) [required]

ID of the object

Example

await aws.S3.DeleteBucketIntelligentTieringConfiguration({
  Bucket: String, // required
  Id: String, // required
})

DeleteBucketInventoryConfiguration

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

Id (string) [required]

ID of the object

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.DeleteBucketInventoryConfiguration({
  Bucket: String, // required
  Id: String, // required
  ExpectedBucketOwner: String,
})

DeleteBucketLifecycle

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.DeleteBucketLifecycle({
  Bucket: String, // required
  ExpectedBucketOwner: String,
})

DeleteBucketMetricsConfiguration

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

Id (string) [required]

ID of the object

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.DeleteBucketMetricsConfiguration({
  Bucket: String, // required
  Id: String, // required
  ExpectedBucketOwner: String,
})

DeleteBucketOwnershipControls

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.DeleteBucketOwnershipControls({
  Bucket: String, // required
  ExpectedBucketOwner: String,
})

DeleteBucketPolicy

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.DeleteBucketPolicy({
  Bucket: String, // required
  ExpectedBucketOwner: String,
})

DeleteBucketReplication

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.DeleteBucketReplication({
  Bucket: String, // required
  ExpectedBucketOwner: String,
})

DeleteBucketTagging

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.DeleteBucketTagging({
  Bucket: String, // required
  ExpectedBucketOwner: String,
})

DeleteBucketWebsite

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.DeleteBucketWebsite({
  Bucket: String, // required
  ExpectedBucketOwner: String,
})

DeleteObject

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

Key (string) [required]

S3 key / file name

BypassGovernanceRetention (string)

Sets request header: x-amz-bypass-governance-retention

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

MFA (string)

Sets request header: x-amz-mfa

RequestPayer (string)

Sets request header: x-amz-request-payer

VersionId (string)

Reference a specific version of the object

Example

await aws.S3.DeleteObject({
  Bucket: String, // required
  Key: String, // required
  BypassGovernanceRetention: String,
  ExpectedBucketOwner: String,
  MFA: String,
  RequestPayer: String,
  VersionId: String,
})

DeleteObjects

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

Delete (object) [required]

Object deletion request

BypassGovernanceRetention (string)

Sets request header: x-amz-bypass-governance-retention

ChecksumAlgorithm (string)

Sets request header: x-amz-sdk-checksum-algorithm

ContentMD5 (string)

Sets request header: content-md5

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

MFA (string)

Sets request header: x-amz-mfa

RequestPayer (string)

Sets request header: x-amz-request-payer

Example

await aws.S3.DeleteObjects({
  Bucket: String, // required
  Delete: Object, // required
  BypassGovernanceRetention: String,
  ChecksumAlgorithm: String,
  ContentMD5: String,
  ExpectedBucketOwner: String,
  MFA: String,
  RequestPayer: String,
})

GetBucketAccelerateConfiguration

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

RequestPayer (string)

Sets request header: x-amz-request-payer

Example

await aws.S3.GetBucketAccelerateConfiguration({
  Bucket: String, // required
  ExpectedBucketOwner: String,
  RequestPayer: String,
})

GetBucketAcl

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.GetBucketAcl({
  Bucket: String, // required
  ExpectedBucketOwner: String,
})

GetBucketAnalyticsConfiguration

Canonical AWS API doc

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

Example

await aws.S3.GetBucketAnalyticsConfiguration({
  Bucket: String, // required
  Id: String, // required
  ExpectedBucketOwner: String,
})

GetBucketCors

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.GetBucketCors({
  Bucket: String, // required
  ExpectedBucketOwner: String,
})

GetBucketEncryption

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.GetBucketEncryption({
  Bucket: String, // required
  ExpectedBucketOwner: String,
})

GetBucketIntelligentTieringConfiguration

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

Id (string) [required]

Id of the intelligent tiering configuration

Example

await aws.S3.GetBucketIntelligentTieringConfiguration({
  Bucket: String, // required
  Id: String, // required
})

GetBucketInventoryConfiguration

Canonical AWS API doc

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

Example

await aws.S3.GetBucketInventoryConfiguration({
  Bucket: String, // required
  Id: String, // required
  ExpectedBucketOwner: String,
})

GetBucketLifecycleConfiguration

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.GetBucketLifecycleConfiguration({
  Bucket: String, // required
  ExpectedBucketOwner: String,
})

GetBucketLocation

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.GetBucketLocation({
  Bucket: String, // required
  ExpectedBucketOwner: String,
})

GetBucketLogging

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.GetBucketLogging({
  Bucket: String, // required
  ExpectedBucketOwner: String,
})

GetBucketMetricsConfiguration

Canonical AWS API doc

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

Example

await aws.S3.GetBucketMetricsConfiguration({
  Bucket: String, // required
  Id: String, // required
  ExpectedBucketOwner: String,
})

GetBucketNotificationConfiguration

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.GetBucketNotificationConfiguration({
  Bucket: String, // required
  ExpectedBucketOwner: String,
})

GetBucketOwnershipControls

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.GetBucketOwnershipControls({
  Bucket: String, // required
  ExpectedBucketOwner: String,
})

GetBucketPolicy

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.GetBucketPolicy({
  Bucket: String, // required
  ExpectedBucketOwner: String,
})

GetBucketPolicyStatus

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.GetBucketPolicyStatus({
  Bucket: String, // required
  ExpectedBucketOwner: String,
})

GetBucketReplication

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.GetBucketReplication({
  Bucket: String, // required
  ExpectedBucketOwner: String,
})

GetBucketRequestPayment

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.GetBucketRequestPayment({
  Bucket: String, // required
  ExpectedBucketOwner: String,
})

GetBucketTagging

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.GetBucketTagging({
  Bucket: String, // required
  ExpectedBucketOwner: String,
})

GetBucketVersioning

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.GetBucketVersioning({
  Bucket: String, // required
  ExpectedBucketOwner: String,
})

GetBucketWebsite

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.GetBucketWebsite({
  Bucket: String, // required
  ExpectedBucketOwner: String,
})

GetObject

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

Key (string) [required]

S3 key / file name

ChecksumMode (string)

Sets request header: x-amz-checksum-mode

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

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

PartNumber (number)

Part number (between 1 - 10,000) of the object

Range (string)

Sets request header: range

RequestPayer (string)

Sets request header: x-amz-request-payer

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

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

VersionId (string)

Reference a specific version of the object

rawResponsePayload (boolean)

Set to true to return payload as a buffer

streamResponsePayload (boolean)

Set to true to return payload as a Node.js stream

Example

await aws.S3.GetObject({
  Bucket: String, // required
  Key: String, // required
  ChecksumMode: String,
  ExpectedBucketOwner: String,
  IfMatch: String,
  IfModifiedSince: String,
  IfNoneMatch: String,
  IfUnmodifiedSince: String,
  PartNumber: Number,
  Range: String,
  RequestPayer: String,
  ResponseCacheControl: String,
  ResponseContentDisposition: String,
  ResponseContentEncoding: String,
  ResponseContentLanguage: String,
  ResponseContentType: String,
  ResponseExpires: String,
  SSECustomerAlgorithm: String,
  SSECustomerKey: String,
  SSECustomerKeyMD5: String,
  VersionId: String,
  rawResponsePayload: Boolean,
  streamResponsePayload: Boolean,
})

HeadBucket

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.HeadBucket({
  Bucket: String, // required
  ExpectedBucketOwner: String,
})

HeadObject

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

Key (string) [required]

S3 key / file name

ChecksumMode (string)

Sets request header: x-amz-checksum-mode

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

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

PartNumber (number)

Part number (between 1 - 10,000) of the object

Range (string)

Sets request header: range

RequestPayer (string)

Sets request header: x-amz-request-payer

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

VersionId (string)

Reference a specific version of the object

Example

await aws.S3.HeadObject({
  Bucket: String, // required
  Key: String, // required
  ChecksumMode: String,
  ExpectedBucketOwner: String,
  IfMatch: String,
  IfModifiedSince: String,
  IfNoneMatch: String,
  IfUnmodifiedSince: String,
  PartNumber: Number,
  Range: String,
  RequestPayer: String,
  SSECustomerAlgorithm: String,
  SSECustomerKey: String,
  SSECustomerKeyMD5: String,
  VersionId: String,
})

ListBucketAnalyticsConfigurations

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ContinuationToken (string)

Pagination cursor token (returned as NextContinuationToken

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

paginate (boolean)

Enable automatic result pagination; use this instead of making your own individual pagination requests

Example

await aws.S3.ListBucketAnalyticsConfigurations({
  Bucket: String, // required
  ContinuationToken: String,
  ExpectedBucketOwner: String,
  paginate: Boolean,
})

ListBucketIntelligentTieringConfigurations

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ContinuationToken (string)

Pagination cursor token (returned as NextContinuationToken

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

paginate (boolean)

Enable automatic result pagination; use this instead of making your own individual pagination requests

Example

await aws.S3.ListBucketIntelligentTieringConfigurations({
  Bucket: String, // required
  ContinuationToken: String,
  ExpectedBucketOwner: String,
  paginate: Boolean,
})

ListBucketInventoryConfigurations

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ContinuationToken (string)

Pagination cursor token (returned as NextContinuationToken

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

paginate (boolean)

Enable automatic result pagination; use this instead of making your own individual pagination requests

Example

await aws.S3.ListBucketInventoryConfigurations({
  Bucket: String, // required
  ContinuationToken: String,
  ExpectedBucketOwner: String,
  paginate: Boolean,
})

ListBucketMetricsConfigurations

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ContinuationToken (string)

Pagination cursor token (returned as NextContinuationToken

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

paginate (boolean)

Enable automatic result pagination; use this instead of making your own individual pagination requests

Example

await aws.S3.ListBucketMetricsConfigurations({
  Bucket: String, // required
  ContinuationToken: String,
  ExpectedBucketOwner: String,
  paginate: Boolean,
})

ListBuckets

Canonical AWS API doc

Properties

Example

await aws.S3.ListBuckets()

ListMultipartUploads

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

Delimiter (string)

Delimiter character used to group keys

EncodingType (string)

Object key encoding type (must be url)

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

KeyMarker (string)

Pagination cursor

MaxUploads (number)

Maximum number of uploads between 1 and 1000 (inclusive) to return in the response

RequestPayer (string)

Sets request header: x-amz-request-payer

UploadIdMarker (string)

Deal with this later

paginate (boolean)

Enable automatic result pagination; use this instead of making your own individual pagination requests

Example

await aws.S3.ListMultipartUploads({
  Bucket: String, // required
  Delimiter: String,
  EncodingType: String,
  ExpectedBucketOwner: String,
  KeyMarker: String,
  MaxUploads: Number,
  RequestPayer: String,
  UploadIdMarker: String,
  paginate: Boolean,
})

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)

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

FetchOwner (string)

Return owner field with results

MaxKeys (number)

Set the maximum number of keys returned per response

OptionalObjectAttributes (string)

Sets request header: x-amz-optional-object-attributes

Prefix (string)

Limit response to keys that begin with the specified prefix

RequestPayer (string)

Sets request header: x-amz-request-payer

StartAfter (string)

Starts listing after any specified key in the bucket

paginate (boolean)

Enable automatic result pagination; use this instead of making your own individual pagination requests

Example

await aws.S3.ListObjectsV2({
  Bucket: String, // required
  ContinuationToken: String,
  Delimiter: String,
  EncodingType: String,
  ExpectedBucketOwner: String,
  FetchOwner: String,
  MaxKeys: Number,
  OptionalObjectAttributes: String,
  Prefix: String,
  RequestPayer: String,
  StartAfter: String,
  paginate: Boolean,
})

PutBucketAccelerateConfiguration

Canonical AWS API doc

Properties

AccelerateConfiguration (object) [required]

Object specifying acceleration configurations; can contain one of: Status: 'Enabled', Status: 'Suspended'

Example
await aws.S3.PutBucketAccelerateConfiguration({
  AccelerateConfiguration: Object, // required
  Bucket: String, // required
  ChecksumAlgorithm: String,
  ExpectedBucketOwner: String,
})

PutBucketAnalyticsConfiguration

Canonical AWS API doc

Properties

AnalyticsConfiguration (object) [required]

Object defining the analytics configuration

Example
await aws.S3.PutBucketAnalyticsConfiguration({
  AnalyticsConfiguration: Object, // required
  Bucket: String, // required
  Id: String, // required
  ExpectedBucketOwner: String,
})

PutBucketCors

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

CORSConfiguration (object) [required]

Object defining the CORS configuration

Example
await aws.S3.PutBucketCors({
  Bucket: String, // required
  CORSConfiguration: Object, // required
  ChecksumAlgorithm: String,
  ContentMD5: String,
  ExpectedBucketOwner: String,
})

PutBucketEncryption

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ServerSideEncryptionConfiguration (object) [required]

Object defining the server side encryption configuration

Example
await aws.S3.PutBucketEncryption({
  Bucket: String, // required
  ServerSideEncryptionConfiguration: Object, // required
  ChecksumAlgorithm: String,
  ContentMD5: String,
  ExpectedBucketOwner: String,
})

PutBucketIntelligentTieringConfiguration

Canonical AWS API doc

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

Example
await aws.S3.PutBucketIntelligentTieringConfiguration({
  Bucket: String, // required
  Id: String, // required
  IntelligentTieringConfiguration: Object, // required
})

PutBucketInventoryConfiguration

Canonical AWS API doc

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

Example
await aws.S3.PutBucketInventoryConfiguration({
  Bucket: String, // required
  Id: String, // required
  InventoryConfiguration: Object, // required
  ExpectedBucketOwner: String,
})

PutBucketLifecycleConfiguration

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

LifecycleConfiguration (object) [required]

Object defining the lifecycle configuration

Example
await aws.S3.PutBucketLifecycleConfiguration({
  Bucket: String, // required
  LifecycleConfiguration: Object, // required
  ChecksumAlgorithm: String,
  ContentMD5: String,
  ExpectedBucketOwner: String,
})

PutBucketMetricsConfiguration

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

Id (string) [required]

ID of the object

MetricsConfiguration (object) [required]

Object defining the metrics configuration

Example
await aws.S3.PutBucketMetricsConfiguration({
  Bucket: String, // required
  Id: String, // required
  MetricsConfiguration: Object, // required
  ExpectedBucketOwner: String,
})

PutBucketNotificationConfiguration

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

NotificationConfiguration (object) [required]

Object defining the notification configuration

Example
await aws.S3.PutBucketNotificationConfiguration({
  Bucket: String, // required
  NotificationConfiguration: Object, // required
  ExpectedBucketOwner: String,
})

PutBucketOwnershipControls

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

OwnershipControls (object) [required]

Object defining the ownership controls

Example
await aws.S3.PutBucketOwnershipControls({
  Bucket: String, // required
  OwnershipControls: Object, // required
  ContentMD5: String,
  ExpectedBucketOwner: String,
})

PutBucketPolicy

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

Policy (object) [required]

Object defining the policy

Example
await aws.S3.PutBucketPolicy({
  Bucket: String, // required
  Policy: Object, // required
  ChecksumAlgorithm: String,
  ConfirmRemoveSelfBucketAccess: String,
  ContentMD5: String,
  ExpectedBucketOwner: String,
})

PutBucketReplication

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ReplicationConfiguration (object) [required]

Object defining the replication configuration

Example
await aws.S3.PutBucketReplication({
  Bucket: String, // required
  ReplicationConfiguration: Object, // required
  ChecksumAlgorithm: String,
  ContentMD5: String,
  ExpectedBucketOwner: String,
  Token: String,
})

PutBucketRequestPayment

Canonical AWS API doc

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

ChecksumAlgorithm (string)

Sets request header: x-amz-sdk-checksum-algorithm

ContentMD5 (string)

Sets request header: content-md5

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Example

await aws.S3.PutBucketRequestPayment({
  Bucket: String, // required
  RequestPaymentConfiguration: Object, // required
  ChecksumAlgorithm: String,
  ContentMD5: String,
  ExpectedBucketOwner: String,
})

PutBucketTagging

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

Tagging (object) [required]

Object defining the tag set

Example
await aws.S3.PutBucketTagging({
  Bucket: String, // required
  Tagging: Object, // required
  ChecksumAlgorithm: String,
  ContentMD5: String,
  ExpectedBucketOwner: String,
})

PutBucketVersioning

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

VersioningConfiguration (object) [required]

Object defining the versioning configuration

Example
await aws.S3.PutBucketVersioning({
  Bucket: String, // required
  VersioningConfiguration: Object, // required
  ChecksumAlgorithm: String,
  ContentMD5: String,
  ExpectedBucketOwner: String,
  MFA: String,
})

PutBucketWebsite

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

WebsiteConfiguration (object) [required]

Object defining the website configuration

Example
await aws.S3.PutBucketWebsite({
  Bucket: String, // required
  WebsiteConfiguration: Object, // required
  ChecksumAlgorithm: String,
  ContentMD5: String,
  ExpectedBucketOwner: String,
})

PutObject

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

Key (string) [required]

S3 key / file name

ACL (string)

Sets request header: x-amz-acl

ApplyChecksum (boolean)

Sign payload; enabling this option may significantly increase memory and latency

Body (buffer, stream, string)

String or buffer to be uploaded

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

File (string)

File path to be read and uploaded from the local filesystem

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

Metadata (object)

Key / value pairs of object metadata; must conform to S3 metadata guidelines

Example
await aws.S3.PutObject({
  Bucket: String, // required
  Key: String, // required
  ACL: String,
  ApplyChecksum: Boolean,
  Body: Buffer || Stream || String,
  BucketKeyEnabled: String,
  CacheControl: String,
  ChecksumAlgorithm: String,
  ChecksumCRC32: String,
  ChecksumCRC32C: String,
  ChecksumSHA1: String,
  ChecksumSHA256: String,
  ContentDisposition: String,
  ContentEncoding: String,
  ContentLanguage: String,
  ContentLength: String,
  ContentMD5: String,
  ContentType: String,
  ExpectedBucketOwner: String,
  Expires: String,
  File: String,
  GrantFullControl: String,
  GrantRead: String,
  GrantReadACP: String,
  GrantWriteACP: String,
  Metadata: Object,
  MinChunkSize: Number,
  ObjectLockLegalHoldStatus: String,
  ObjectLockMode: String,
  ObjectLockRetainUntilDate: String,
  RequestPayer: String,
  SSECustomerAlgorithm: String,
  SSECustomerKey: String,
  SSECustomerKeyMD5: String,
  SSEKMSEncryptionContext: String,
  SSEKMSKeyId: String,
  ServerSideEncryption: String,
  StorageClass: String,
  Tagging: String,
  WebsiteRedirectLocation: String,
})

PutObjectLegalHold

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

Key (string) [required]

S3 key / file name

LegalHold (object) [required]

Object containing the field Status (string) which can be one of: ON, OFF

ChecksumAlgorithm (string)

Sets request header: x-amz-sdk-checksum-algorithm

ContentMD5 (string)

Sets request header: content-md5

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

RequestPayer (string)

Sets request header: x-amz-request-payer

VersionId (string)

Reference a specific version of the object

Example

await aws.S3.PutObjectLegalHold({
  Bucket: String, // required
  Key: String, // required
  LegalHold: Object, // required
  ChecksumAlgorithm: String,
  ContentMD5: String,
  ExpectedBucketOwner: String,
  RequestPayer: String,
  VersionId: String,
})

PutObjectLockConfiguration

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

ObjectLockConfiguration (object) [required]

Object defining the object lock configuration

Example
await aws.S3.PutObjectLockConfiguration({
  Bucket: String, // required
  ObjectLockConfiguration: Object, // required
  ChecksumAlgorithm: String,
  ContentMD5: String,
  ExpectedBucketOwner: String,
  RequestPayer: String,
  Token: String,
})

PutObjectRetention

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

Key (string) [required]

S3 key / file name

Retention (object) [required]

Object specifying the object retention parameters

Example
await aws.S3.PutObjectRetention({
  Bucket: String, // required
  Key: String, // required
  Retention: Object, // required
  BypassGovernanceRetention: String,
  ChecksumAlgorithm: String,
  ContentMD5: String,
  ExpectedBucketOwner: String,
  RequestPayer: String,
  VersionId: String,
})

PutObjectTagging

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

Key (string) [required]

S3 key / file name

Tagging (object) [required]

Object containing the tag set

Example
await aws.S3.PutObjectTagging({
  Bucket: String, // required
  Key: String, // required
  Tagging: Object, // required
  ChecksumAlgorithm: String,
  ContentMD5: String,
  ExpectedBucketOwner: String,
  RequestPayer: String,
  VersionId: String,
})

Upload

Properties

Bucket (string) [required]

S3 bucket name

Key (string) [required]

S3 key / file name

ACL (string)

Sets request header: x-amz-acl

Body (buffer, stream, string)

String or buffer to be uploaded; per S3, size should be 5MB or greater

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

ChunkSize (number)

Size of each chunk to upload in byes (also aliased to partSize); default is 10 MB

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

ContentDisposition (string)

Sets request header: content-disposition

ContentEncoding (string)

Sets request header: content-encoding

ContentLanguage (string)

Sets request header: content-language

ContentType (string)

Sets request header: content-type

ExpectedBucketOwner (string)

Sets request header: x-amz-expected-bucket-owner

Expires (string)

Sets request header: expires

File (string)

File path to be read and uploaded from the local filesystem; per S3, size should be 5MB or greater

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

Metadata (object)

Key / value pairs of object metadata; must conform to S3 metadata guidelines

Example
await aws.S3.Upload({
  Bucket: String, // required
  Key: String, // required
  ACL: String,
  Body: Buffer || Stream || String,
  BucketKeyEnabled: String,
  CacheControl: String,
  ChecksumAlgorithm: String,
  ChecksumCRC32: String,
  ChecksumCRC32C: String,
  ChecksumSHA1: String,
  ChecksumSHA256: String,
  ChunkSize: Number,
  Concurrency: Number,
  ContentDisposition: String,
  ContentEncoding: String,
  ContentLanguage: String,
  ContentType: String,
  ExpectedBucketOwner: String,
  Expires: String,
  File: String,
  GrantFullControl: String,
  GrantRead: String,
  GrantReadACP: String,
  GrantWriteACP: String,
  Metadata: Object,
  ObjectLockLegalHoldStatus: String,
  ObjectLockMode: String,
  ObjectLockRetainUntilDate: String,
  RequestPayer: String,
  SSECustomerAlgorithm: String,
  SSECustomerKey: String,
  SSECustomerKeyMD5: String,
  SSEKMSEncryptionContext: String,
  SSEKMSKeyId: String,
  ServerSideEncryption: String,
  StorageClass: String,
  Tagging: String,
  WebsiteRedirectLocation: String,
})

UploadPart

Canonical AWS API doc

Properties

Bucket (string) [required]

S3 bucket name

Key (string) [required]

S3 key / file name

Body (buffer, stream, string)

Stream of data to be uploaded

Example
await aws.S3.UploadPart({
  Bucket: String, // required
  Key: String, // required
  Body: Buffer || Stream || String,
  ChecksumAlgorithm: String,
  ChecksumCRC32: String,
  ChecksumCRC32C: String,
  ChecksumSHA1: String,
  ChecksumSHA256: String,
  ContentLength: String,
  ContentMD5: String,
  ExpectedBucketOwner: String,
  PartNumber: Number,
  RequestPayer: String,
  SSECustomerAlgorithm: String,
  SSECustomerKey: String,
  SSECustomerKeyMD5: String,
})

Methods yet to be implemented

Please help out by opening a PR!

aws-lite is an Apache 2.0-licensed open source project under the umbrella of OpenJS Foundation Architect. aws-lite is not in any way affiliated with Amazon Web Services, Inc. (AWS). All names and trademarks are the property of their respective owners.