Class S3Util

Clase Utilitaria para interactuar con S3.

Hierarchy

S3Util

Index

Constructors

constructor

Methods

getObject putObject

Constructors

constructor

new S3Util(region?: {
region?: string;
}): S3Util
Constructor de la clase.
Parameters
- region: {
  region?: string;
  } = {}
  
  es la región de AWS donde se encuentra la tabla de S3, por defecto es us-east-1.
  - Optional region?: string
Returns S3Util
- Defined in src/aws/S3Util.ts:31

Methods

getObject

getObject(getObjectRequest: {
    Bucket: undefined | string;
    ChecksumMode?: string;
    ExpectedBucketOwner?: string;
    IfMatch?: string;
    IfModifiedSince?: Date;
    IfNoneMatch?: string;
    IfUnmodifiedSince?: Date;
    Key: undefined | string;
    PartNumber?: number;
    Range?: string;
    RequestPayer?: string;
    ResponseCacheControl?: string;
    ResponseContentDisposition?: string;
    ResponseContentEncoding?: string;
    ResponseContentLanguage?: string;
    ResponseContentType?: string;
    ResponseExpires?: Date;
    SSECustomerAlgorithm?: string;
    SSECustomerKey?: string;
    SSECustomerKeyMD5?: string;
    VersionId?: string;
}): Promise<{
    AcceptRanges?: string;
    Body?: Readable | ReadableStream<any> | Blob;
    BucketKeyEnabled?: boolean;
    CacheControl?: string;
    ChecksumCRC32?: string;
    ChecksumCRC32C?: string;
    ChecksumSHA1?: string;
    ChecksumSHA256?: string;
    ContentDisposition?: string;
    ContentEncoding?: string;
    ContentLanguage?: string;
    ContentLength?: number;
    ContentRange?: string;
    ContentType?: string;
    DeleteMarker?: boolean;
    ETag?: string;
    Expiration?: string;
    Expires?: Date;
    LastModified?: Date;
    Metadata?: Record<string, string>;
    MissingMeta?: number;
    ObjectLockLegalHoldStatus?: string;
    ObjectLockMode?: string;
    ObjectLockRetainUntilDate?: Date;
    PartsCount?: number;
    ReplicationStatus?: string;
    RequestCharged?: string;
    Restore?: string;
    SSECustomerAlgorithm?: string;
    SSECustomerKeyMD5?: string;
    SSEKMSKeyId?: string;
    ServerSideEncryption?: string;
    StorageClass?: string;
    TagCount?: number;
    VersionId?: string;
    WebsiteRedirectLocation?: string;
}>
Obtiene un elemento de la base de datos de S3 utilizando la entrada proporcionada.

Returns
Una promesa que se resolverá con el objeto guardado en el bucket de S3.

Throws
Si hay un error al interactuar con el bucket de S3.
Parameters
- getObjectRequest: {
      Bucket: undefined | string;
      ChecksumMode?: string;
      ExpectedBucketOwner?: string;
      IfMatch?: string;
      IfModifiedSince?: Date;
      IfNoneMatch?: string;
      IfUnmodifiedSince?: Date;
      Key: undefined | string;
      PartNumber?: number;
      Range?: string;
      RequestPayer?: string;
      ResponseCacheControl?: string;
      ResponseContentDisposition?: string;
      ResponseContentEncoding?: string;
      ResponseContentLanguage?: string;
      ResponseContentType?: string;
      ResponseExpires?: Date;
      SSECustomerAlgorithm?: string;
      SSECustomerKey?: string;
      SSECustomerKeyMD5?: string;
      VersionId?: string;
  }
  
  La entrada que se utilizará para obtener un objeto del bucket de S3.
  - Bucket: undefined | string
    
    The bucket name containing the object.
    
    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
    
    When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.
    
    When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
    
    Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues
  - Optional ChecksumMode?: string
    
    To retrieve the checksum, this mode must be enabled.
  - Optional ExpectedBucketOwner?: string
    
    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
  - Optional IfMatch?: string
    
    Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.
  - Optional IfModifiedSince?: Date
    
    Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.
  - Optional IfNoneMatch?: string
    
    Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.
  - Optional IfUnmodifiedSince?: Date
    
    Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.
  - Key: undefined | string
    
    Key of the object to get.
  - Optional PartNumber?: number
    
    Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.
  - Optional Range?: string
    
    Downloads the specified range bytes of an object. For more information about the HTTP Range header, see https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
    
    Amazon S3 doesn't support retrieving multiple ranges of data per GET request.
  - Optional RequestPayer?: string
    
    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
  - Optional ResponseCacheControl?: string
    
    Sets the Cache-Control header of the response.
  - Optional ResponseContentDisposition?: string
    
    Sets the Content-Disposition header of the response
  - Optional ResponseContentEncoding?: string
    
    Sets the Content-Encoding header of the response.
  - Optional ResponseContentLanguage?: string
    
    Sets the Content-Language header of the response.
  - Optional ResponseContentType?: string
    
    Sets the Content-Type header of the response.
  - Optional ResponseExpires?: Date
    
    Sets the Expires header of the response.
  - Optional SSECustomerAlgorithm?: string
    
    Specifies the algorithm to use to when decrypting the object (for example, AES256).
  - Optional SSECustomerKey?: string
    
    Specifies the customer-provided encryption key for Amazon S3 used to encrypt the data. This value is used to decrypt the object when recovering it and must match the one used when storing the data. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.
  - Optional SSECustomerKeyMD5?: string
    
    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
  - Optional VersionId?: string
    
    VersionId used to reference a specific version of the object.
Returns Promise<{
    AcceptRanges?: string;
    Body?: Readable | ReadableStream<any> | Blob;
    BucketKeyEnabled?: boolean;
    CacheControl?: string;
    ChecksumCRC32?: string;
    ChecksumCRC32C?: string;
    ChecksumSHA1?: string;
    ChecksumSHA256?: string;
    ContentDisposition?: string;
    ContentEncoding?: string;
    ContentLanguage?: string;
    ContentLength?: number;
    ContentRange?: string;
    ContentType?: string;
    DeleteMarker?: boolean;
    ETag?: string;
    Expiration?: string;
    Expires?: Date;
    LastModified?: Date;
    Metadata?: Record<string, string>;
    MissingMeta?: number;
    ObjectLockLegalHoldStatus?: string;
    ObjectLockMode?: string;
    ObjectLockRetainUntilDate?: Date;
    PartsCount?: number;
    ReplicationStatus?: string;
    RequestCharged?: string;
    Restore?: string;
    SSECustomerAlgorithm?: string;
    SSECustomerKeyMD5?: string;
    SSEKMSKeyId?: string;
    ServerSideEncryption?: string;
    StorageClass?: string;
    TagCount?: number;
    VersionId?: string;
    WebsiteRedirectLocation?: string;
}>
- Defined in src/aws/S3Util.ts:65

putObject

putObject(putObjectRequest: {
    ACL?: string;
    Body?: Readable | ReadableStream<any> | Blob;
    Bucket: undefined | string;
    BucketKeyEnabled?: boolean;
    CacheControl?: string;
    ChecksumAlgorithm?: string;
    ChecksumCRC32?: string;
    ChecksumCRC32C?: string;
    ChecksumSHA1?: string;
    ChecksumSHA256?: string;
    ContentDisposition?: string;
    ContentEncoding?: string;
    ContentLanguage?: string;
    ContentLength?: number;
    ContentMD5?: string;
    ContentType?: string;
    ExpectedBucketOwner?: string;
    Expires?: Date;
    GrantFullControl?: string;
    GrantRead?: string;
    GrantReadACP?: string;
    GrantWriteACP?: string;
    Key: undefined | string;
    Metadata?: Record<string, string>;
    ObjectLockLegalHoldStatus?: string;
    ObjectLockMode?: string;
    ObjectLockRetainUntilDate?: Date;
    RequestPayer?: string;
    SSECustomerAlgorithm?: string;
    SSECustomerKey?: string;
    SSECustomerKeyMD5?: string;
    SSEKMSEncryptionContext?: string;
    SSEKMSKeyId?: string;
    ServerSideEncryption?: string;
    StorageClass?: string;
    Tagging?: string;
    WebsiteRedirectLocation?: string;
}): Promise<{
    BucketKeyEnabled?: boolean;
    ChecksumCRC32?: string;
    ChecksumCRC32C?: string;
    ChecksumSHA1?: string;
    ChecksumSHA256?: string;
    ETag?: string;
    Expiration?: string;
    RequestCharged?: string;
    SSECustomerAlgorithm?: string;
    SSECustomerKeyMD5?: string;
    SSEKMSEncryptionContext?: string;
    SSEKMSKeyId?: string;
    ServerSideEncryption?: string;
    VersionId?: string;
}>
Obtiene un elemento de la base de datos de S3 utilizando la entrada proporcionada.

Returns
Una promesa que se resolverá con el objeto guardado en el bucket de S3.

Throws
Si hay un error al interactuar con el bucket de S3.
Parameters
- putObjectRequest: {
      ACL?: string;
      Body?: Readable | ReadableStream<any> | Blob;
      Bucket: undefined | string;
      BucketKeyEnabled?: boolean;
      CacheControl?: string;
      ChecksumAlgorithm?: string;
      ChecksumCRC32?: string;
      ChecksumCRC32C?: string;
      ChecksumSHA1?: string;
      ChecksumSHA256?: string;
      ContentDisposition?: string;
      ContentEncoding?: string;
      ContentLanguage?: string;
      ContentLength?: number;
      ContentMD5?: string;
      ContentType?: string;
      ExpectedBucketOwner?: string;
      Expires?: Date;
      GrantFullControl?: string;
      GrantRead?: string;
      GrantReadACP?: string;
      GrantWriteACP?: string;
      Key: undefined | string;
      Metadata?: Record<string, string>;
      ObjectLockLegalHoldStatus?: string;
      ObjectLockMode?: string;
      ObjectLockRetainUntilDate?: Date;
      RequestPayer?: string;
      SSECustomerAlgorithm?: string;
      SSECustomerKey?: string;
      SSECustomerKeyMD5?: string;
      SSEKMSEncryptionContext?: string;
      SSEKMSKeyId?: string;
      ServerSideEncryption?: string;
      StorageClass?: string;
      Tagging?: string;
      WebsiteRedirectLocation?: string;
  }
  
  La entrada que se utilizará para guardar un objeto en el bucket de S3.
  - Optional ACL?: string
    
    The canned ACL to apply to the object. For more information, see Canned ACL.
    
    This action is not supported by Amazon S3 on Outposts.
  - Optional Body?: Readable | ReadableStream<any> | Blob
    
    Object data.
  - Bucket: undefined | string
    
    The bucket name to which the PUT action was initiated.
    
    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
    
    When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
    
    Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues
  - Optional BucketKeyEnabled?: boolean
    
    Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.
    
    Specifying this header with a PUT action doesn’t affect bucket-level settings for S3 Bucket Key.
  - Optional CacheControl?: string
    
    Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
  - Optional ChecksumAlgorithm?: string
    
    Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
  - Optional ChecksumCRC32?: string
    
    This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
  - Optional ChecksumCRC32C?: string
    
    This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
  - Optional ChecksumSHA1?: string
    
    This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
  - Optional ChecksumSHA256?: string
    
    This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
  - Optional ContentDisposition?: string
    
    Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.
  - Optional ContentEncoding?: string
    
    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.
  - Optional ContentLanguage?: string
    
    The language the content is in.
  - Optional ContentLength?: number
    
    Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.
  - Optional ContentMD5?: string
    
    The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.
  - Optional ContentType?: string
    
    A standard MIME type describing the format of the contents. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.
  - Optional ExpectedBucketOwner?: string
    
    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
  - Optional Expires?: Date
    
    The date and time at which the object is no longer cacheable. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.
  - Optional GrantFullControl?: string
    
    Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
    
    This action is not supported by Amazon S3 on Outposts.
  - Optional GrantRead?: string
    
    Allows grantee to read the object data and its metadata.
    
    This action is not supported by Amazon S3 on Outposts.
  - Optional GrantReadACP?: string
    
    Allows grantee to read the object ACL.
    
    This action is not supported by Amazon S3 on Outposts.
  - Optional GrantWriteACP?: string
    
    Allows grantee to write the ACL for the applicable object.
    
    This action is not supported by Amazon S3 on Outposts.
  - Key: undefined | string
    
    Object key for which the PUT action was initiated.
  - Optional Metadata?: Record<string, string>
    
    A map of metadata to store with the object in S3.
  - Optional ObjectLockLegalHoldStatus?: string
    
    Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.
  - Optional ObjectLockMode?: string
    
    The Object Lock mode that you want to apply to this object.
  - Optional ObjectLockRetainUntilDate?: Date
    
    The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp parameter.
  - Optional RequestPayer?: string
    
    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
  - Optional SSECustomerAlgorithm?: string
    
    Specifies the algorithm to use to when encrypting the object (for example, AES256).
  - Optional SSECustomerKey?: string
    
    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.
  - Optional SSECustomerKeyMD5?: string
    
    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
  - Optional SSEKMSEncryptionContext?: string
    
    Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
  - Optional SSEKMSKeyId?: string
    
    If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetrical customer managed key that was used for the object. If you specify x-amz-server-side-encryption:aws:kms, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key to protect the data. If the KMS key does not exist in the same account issuing the command, you must use the full ARN and not just the ID.
  - Optional ServerSideEncryption?: string
    
    The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
  - Optional StorageClass?: string
    
    By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.
  - Optional Tagging?: string
    
    The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")
  - Optional WebsiteRedirectLocation?: string
    
    If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see Object Key and Metadata.
    
    In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:
    
    x-amz-website-redirect-location: /anotherPage.html
    
    In the following example, the request header sets the object redirect to another website:
    
    x-amz-website-redirect-location: http://www.example.com/
    
    For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.
Returns Promise<{
    BucketKeyEnabled?: boolean;
    ChecksumCRC32?: string;
    ChecksumCRC32C?: string;
    ChecksumSHA1?: string;
    ChecksumSHA256?: string;
    ETag?: string;
    Expiration?: string;
    RequestCharged?: string;
    SSECustomerAlgorithm?: string;
    SSECustomerKeyMD5?: string;
    SSEKMSEncryptionContext?: string;
    SSEKMSKeyId?: string;
    ServerSideEncryption?: string;
    VersionId?: string;
}>
- Defined in src/aws/S3Util.ts:41

Class S3Util

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

region: { region?: string; } = {}

Optional region?: string

Returns S3Util

Methods

getObject

Returns

Throws

Parameters

Bucket: undefined | string

Optional ChecksumMode?: string

Optional ExpectedBucketOwner?: string

Optional IfMatch?: string

Optional IfModifiedSince?: Date

Optional IfNoneMatch?: string

Optional IfUnmodifiedSince?: Date

Key: undefined | string

Optional PartNumber?: number

Optional Range?: string

Optional RequestPayer?: string

Optional ResponseCacheControl?: string

Optional ResponseContentDisposition?: string

Optional ResponseContentEncoding?: string

Optional ResponseContentLanguage?: string

Optional ResponseContentType?: string

Optional ResponseExpires?: Date

Optional SSECustomerAlgorithm?: string

Optional SSECustomerKey?: string

Optional SSECustomerKeyMD5?: string

Optional VersionId?: string

putObject

Returns

Throws

Parameters

Optional ACL?: string

Optional Body?: Readable | ReadableStream<any> | Blob

Bucket: undefined | string

Optional BucketKeyEnabled?: boolean

Optional CacheControl?: string

Optional ChecksumAlgorithm?: string

Optional ChecksumCRC32?: string

Optional ChecksumCRC32C?: string

Optional ChecksumSHA1?: string

Optional ChecksumSHA256?: string

Optional ContentDisposition?: string

Optional ContentEncoding?: string

Optional ContentLanguage?: string

Optional ContentLength?: number

Optional ContentMD5?: string

Optional ContentType?: string

Optional ExpectedBucketOwner?: string

Optional Expires?: Date

Optional GrantFullControl?: string

Optional GrantRead?: string

Optional GrantReadACP?: string

Optional GrantWriteACP?: string

Key: undefined | string

Optional Metadata?: Record<string, string>

Optional ObjectLockLegalHoldStatus?: string

Optional ObjectLockMode?: string

Optional ObjectLockRetainUntilDate?: Date

Optional RequestPayer?: string

Optional SSECustomerAlgorithm?: string

Optional SSECustomerKey?: string

Optional SSECustomerKeyMD5?: string

Optional SSEKMSEncryptionContext?: string

Optional SSEKMSKeyId?: string

Optional ServerSideEncryption?: string

Optional StorageClass?: string

Optional Tagging?: string

Optional WebsiteRedirectLocation?: string

Settings

Member Visibility

region: {
region?: string;
} = {}

`Optional` region?: string

`Optional` ChecksumMode?: string

`Optional` ExpectedBucketOwner?: string

`Optional` IfMatch?: string

`Optional` IfModifiedSince?: Date

`Optional` IfNoneMatch?: string

`Optional` IfUnmodifiedSince?: Date

`Optional` PartNumber?: number

`Optional` Range?: string

`Optional` RequestPayer?: string

`Optional` ResponseCacheControl?: string

`Optional` ResponseContentDisposition?: string

`Optional` ResponseContentEncoding?: string

`Optional` ResponseContentLanguage?: string

`Optional` ResponseContentType?: string

`Optional` ResponseExpires?: Date

`Optional` SSECustomerAlgorithm?: string

`Optional` SSECustomerKey?: string

`Optional` SSECustomerKeyMD5?: string

`Optional` VersionId?: string

`Optional` ACL?: string

`Optional` Body?: Readable | ReadableStream<any> | Blob

`Optional` BucketKeyEnabled?: boolean

`Optional` CacheControl?: string

`Optional` ChecksumAlgorithm?: string

`Optional` ChecksumCRC32?: string

`Optional` ChecksumCRC32C?: string

`Optional` ChecksumSHA1?: string

`Optional` ChecksumSHA256?: string

`Optional` ContentDisposition?: string

`Optional` ContentEncoding?: string

`Optional` ContentLanguage?: string

`Optional` ContentLength?: number

`Optional` ContentMD5?: string

`Optional` ContentType?: string

`Optional` ExpectedBucketOwner?: string

`Optional` Expires?: Date

`Optional` GrantFullControl?: string

`Optional` GrantRead?: string

`Optional` GrantReadACP?: string

`Optional` GrantWriteACP?: string

`Optional` Metadata?: Record<string, string>

`Optional` ObjectLockLegalHoldStatus?: string

`Optional` ObjectLockMode?: string

`Optional` ObjectLockRetainUntilDate?: Date

`Optional` RequestPayer?: string

`Optional` SSECustomerAlgorithm?: string

`Optional` SSECustomerKey?: string

`Optional` SSECustomerKeyMD5?: string

`Optional` SSEKMSEncryptionContext?: string

`Optional` SSEKMSKeyId?: string

`Optional` ServerSideEncryption?: string

`Optional` StorageClass?: string

`Optional` Tagging?: string

`Optional` WebsiteRedirectLocation?: string