@aws-sdk/client-s3

/// <reference types="node" /> import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client"; import { Readable } from "stream"; import { S3ServiceException as __BaseException } from "./S3ServiceException"; /** * Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will * wait before permanently removing all parts of the upload. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config"> * Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy</a> in the * Amazon S3 User Guide. */ export interface AbortIncompleteMultipartUpload { /** * Specifies the number of days after which Amazon S3 aborts an incomplete multipart * upload. */ DaysAfterInitiation?: number; } export declare enum RequestCharged { requester = "requester" } export interface AbortMultipartUploadOutput { /** * If present, indicates that the requester was successfully charged for the * request. */ RequestCharged?: RequestCharged | string; } export declare enum RequestPayer { requester = "requester" } export interface AbortMultipartUploadRequest { /** * The bucket name to which the upload was taking place. * 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> 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 <code> * AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com</code>. 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> 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 */ Bucket: string | undefined; /** * Key of the object for which the multipart upload was initiated. */ Key: string | undefined; /** * Upload ID that identifies the multipart upload. */ UploadId: string | undefined; /** * 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in * Requester Pays Buckets</a> in the Amazon S3 User Guide. */ RequestPayer?: RequestPayer | 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 <code>403 Forbidden</code> (access denied). */ ExpectedBucketOwner?: string; } /** * The specified multipart upload does not exist. */ export declare class NoSuchUpload extends __BaseException { readonly name: "NoSuchUpload"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<NoSuchUpload, __BaseException>); } export declare enum BucketAccelerateStatus { Enabled = "Enabled", Suspended = "Suspended" } /** * Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Amazon S3 * Transfer Acceleration</a> in the Amazon S3 User Guide. */ export interface AccelerateConfiguration { /** * Specifies the transfer acceleration status of the bucket. */ Status?: BucketAccelerateStatus | string; } export declare enum Type { AmazonCustomerByEmail = "AmazonCustomerByEmail", CanonicalUser = "CanonicalUser", Group = "Group" } /** * Container for the person being granted permissions. */ export interface Grantee { /** * Screen name of the grantee. */ DisplayName?: string; /** * Email address of the grantee. * <note> * Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: * <ul> * <li> * US East (N. Virginia) * </li> * <li> * US West (N. California) * </li> * <li> * US West (Oregon) * </li> * <li> * Asia Pacific (Singapore) * </li> * <li> * Asia Pacific (Sydney) * </li> * <li> * Asia Pacific (Tokyo) * </li> * <li> * Europe (Ireland) * </li> * <li> * South America (São Paulo) * </li> * </ul> * For a list of all the Amazon S3 supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a> in the Amazon Web Services General Reference. * </note> */ EmailAddress?: string; /** * The canonical user ID of the grantee. */ ID?: string; /** * URI of the grantee group. */ URI?: string; /** * Type of grantee */ Type: Type | string | undefined; } export declare enum Permission { FULL_CONTROL = "FULL_CONTROL", READ = "READ", READ_ACP = "READ_ACP", WRITE = "WRITE", WRITE_ACP = "WRITE_ACP" } /** * Container for grant information. */ export interface Grant { /** * The person being granted permissions. */ Grantee?: Grantee; /** * Specifies the permission given to the grantee. */ Permission?: Permission | string; } /** * Container for the owner's display name and ID. */ export interface Owner { /** * Container for the display name of the owner. */ DisplayName?: string; /** * Container for the ID of the owner. */ ID?: string; } /** * Contains the elements that set the ACL permissions for an object per grantee. */ export interface AccessControlPolicy { /** * A list of grants. */ Grants?: Grant[]; /** * Container for the bucket owner's display name and ID. */ Owner?: Owner; } export declare enum OwnerOverride { Destination = "Destination" } /** * A container for information about access control for replicas. */ export interface AccessControlTranslation { /** * Specifies the replica ownership. For default and valid values, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html">PUT bucket * replication</a> in the Amazon S3 API Reference. */ Owner: OwnerOverride | string | undefined; } export declare enum ServerSideEncryption { AES256 = "AES256", aws_kms = "aws:kms" } export interface CompleteMultipartUploadOutput { /** * The URI that identifies the newly created object. */ Location?: string; /** * The name of the bucket that contains the newly created object. Does not return the access point ARN or access point alias if used. * 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> 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 <code> * AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com</code>. 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the Amazon S3 User Guide. */ Bucket?: string; /** * The object key of the newly created object. */ Key?: string; /** * If the object expiration is configured, this will contain the expiration date * (<code>expiry-date</code>) and rule ID (<code>rule-id</code>). The value of * <code>rule-id</code> is URL-encoded. */ Expiration?: string; /** * Entity tag that identifies the newly created object's data. Objects with different * object data will have different entity tags. The entity tag is an opaque string. The entity * tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5 * digest of the object data, it will contain one or more nonhexadecimal characters and/or * will consist of less than 32 or more than 32 hexadecimal digits. For more information about * how the entity tag is calculated, see * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking * object integrity</a> in the Amazon S3 User Guide. */ ETag?: string; /** * The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded * with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated * with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> * Checking object integrity</a> in the Amazon S3 User Guide. */ ChecksumCRC32?: string; /** * The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded * with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated * with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> * Checking object integrity</a> in the Amazon S3 User Guide. */ ChecksumCRC32C?: string; /** * The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded * with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated * with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> * Checking object integrity</a> in the Amazon S3 User Guide. */ ChecksumSHA1?: string; /** * The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded * with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated * with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> * Checking object integrity</a> in the Amazon S3 User Guide. */ ChecksumSHA256?: string; /** * If you specified server-side encryption either with an Amazon S3-managed encryption key or an * Amazon Web Services KMS key in your initiate multipart upload request, the response * includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the * object. */ ServerSideEncryption?: ServerSideEncryption | string; /** * Version ID of the newly created object, in case the bucket has versioning turned * on. */ VersionId?: string; /** * If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric * customer managed key that was used for the object. */ SSEKMSKeyId?: string; /** * Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS). */ BucketKeyEnabled?: boolean; /** * If present, indicates that the requester was successfully charged for the * request. */ RequestCharged?: RequestCharged | string; } /** * Details of the parts that were uploaded. */ export interface CompletedPart { /** * Entity tag returned when the part was uploaded. */ ETag?: string; /** * The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded * with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated * with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> * Checking object integrity</a> in the Amazon S3 User Guide. */ ChecksumCRC32?: string; /** * The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded * with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated * with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> * Checking object integrity</a> in the Amazon S3 User Guide. */ ChecksumCRC32C?: string; /** * The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded * with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated * with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> * Checking object integrity</a> in the Amazon S3 User Guide. */ ChecksumSHA1?: string; /** * The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded * with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated * with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> * Checking object integrity</a> in the Amazon S3 User Guide. */ ChecksumSHA256?: string; /** * Part number that identifies the part. This is a positive integer between 1 and * 10,000. */ PartNumber?: number; } /** * The container for the completed multipart upload details. */ export interface CompletedMultipartUpload { /** * Array of CompletedPart data types. * If you do not supply a valid <code>Part</code> with your request, the service sends back an HTTP * 400 response. */ Parts?: CompletedPart[]; } export interface CompleteMultipartUploadRequest { /** * Name of the bucket to which the multipart upload 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> 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 <code> * AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com</code>. 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> 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 */ Bucket: string | undefined; /** * Object key for which the multipart upload was initiated. */ Key: string | undefined; /** * The container for the multipart upload request information. */ MultipartUpload?: CompletedMultipartUpload; /** * ID for the initiated multipart upload. */ UploadId: string | undefined; /** * 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 * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the * Amazon S3 User Guide. */ 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 CRC32C checksum of the object. For more information, see * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the * Amazon S3 User Guide. */ 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, 160-bit SHA-1 digest of the object. For more information, see * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the * Amazon S3 User Guide. */ 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, 256-bit SHA-256 digest of the object. For more information, see * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the * Amazon S3 User Guide. */ ChecksumSHA256?: 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in * Requester Pays Buckets</a> in the Amazon S3 User Guide. */ RequestPayer?: RequestPayer | 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 <code>403 Forbidden</code> (access denied). */ ExpectedBucketOwner?: string; /** * The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created * using a checksum algorithm. For more information, * see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Protecting data using SSE-C keys</a> in the * Amazon S3 User Guide. */ SSECustomerAlgorithm?: string; /** * The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. * For more information, see * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Protecting data using SSE-C keys</a> in the * Amazon S3 User Guide. */ SSECustomerKey?: string; /** * The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum * algorithm. For more information, * see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Protecting data using SSE-C keys</a> in the * Amazon S3 User Guide. */ SSECustomerKeyMD5?: string; } /** * Container for all response elements. */ export interface CopyObjectResult { /** * Returns the ETag of the new object. The ETag reflects only changes to the contents of an object, not its metadata. */ ETag?: string; /** * Creation date of the object. */ LastModified?: Date; /** * The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded * with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated * with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> * Checking object integrity</a> in the Amazon S3 User Guide. */ ChecksumCRC32?: string; /** * The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded * with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated * with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> * Checking object integrity</a> in the Amazon S3 User Guide. */ ChecksumCRC32C?: string; /** * The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded * with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated * with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> * Checking object integrity</a> in the Amazon S3 User Guide. */ ChecksumSHA1?: string; /** * The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded * with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated * with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> * Checking object integrity</a> in the Amazon S3 User Guide. */ ChecksumSHA256?: string; } export interface CopyObjectOutput { /** * Container for all response elements. */ CopyObjectResult?: CopyObjectResult; /** * If the object expiration is configured, the response includes this header. */ Expiration?: string; /** * Version of the copied object in the destination bucket. */ CopySourceVersionId?: string; /** * Version ID of the newly created copy. */ VersionId?: string; /** * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, * AES256, aws:kms). */ ServerSideEncryption?: ServerSideEncryption | string; /** * If server-side encryption with a customer-provided encryption key was requested, the * response will include this header confirming the encryption algorithm used. */ SSECustomerAlgorithm?: string; /** * If server-side encryption with a customer-provided encryption key was requested, the * response will include this header to provide round-trip message integrity verification of * the customer-provided encryption key. */ SSECustomerKeyMD5?: string; /** * If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric * customer managed key that was used for the object. */ SSEKMSKeyId?: string; /** * If present, 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. */ SSEKMSEncryptionContext?: string; /** * Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS). */ BucketKeyEnabled?: boolean; /** * If present, indicates that the requester was successfully charged for the * request. */ RequestCharged?: RequestCharged | string; } export declare enum ObjectCannedACL { authenticated_read = "authenticated-read", aws_exec_read = "aws-exec-read", bucket_owner_full_control = "bucket-owner-full-control", bucket_owner_read = "bucket-owner-read", private = "private", public_read = "public-read", public_read_write = "public-read-write" } export declare enum ChecksumAlgorithm { CRC32 = "CRC32", CRC32C = "CRC32C", SHA1 = "SHA1", SHA256 = "SHA256" } export declare enum MetadataDirective { COPY = "COPY", REPLACE = "REPLACE" } export declare enum ObjectLockLegalHoldStatus { OFF = "OFF", ON = "ON" } export declare enum ObjectLockMode { COMPLIANCE = "COMPLIANCE", GOVERNANCE = "GOVERNANCE" } export declare enum StorageClass { DEEP_ARCHIVE = "DEEP_ARCHIVE", GLACIER = "GLACIER", GLACIER_IR = "GLACIER_IR", INTELLIGENT_TIERING = "INTELLIGENT_TIERING", ONEZONE_IA = "ONEZONE_IA", OUTPOSTS = "OUTPOSTS", REDUCED_REDUNDANCY = "REDUCED_REDUNDANCY", STANDARD = "STANDARD", STANDARD_IA = "STANDARD_IA" } export declare enum TaggingDirective { COPY = "COPY", REPLACE = "REPLACE" } export interface CopyObjectRequest { /** * The canned ACL to apply to the object. * This action is not supported by Amazon S3 on Outposts. */ ACL?: ObjectCannedACL | string; /** * The name of the destination bucket. * 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> 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 <code> * AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com</code>. 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> 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 */ Bucket: string | undefined; /** * Specifies caching behavior along the request/reply chain. */ CacheControl?: string; /** * Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in * the Amazon S3 User Guide. */ ChecksumAlgorithm?: ChecksumAlgorithm | string; /** * Specifies presentational information for the object. */ ContentDisposition?: 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. */ ContentEncoding?: string; /** * The language the content is in. */ ContentLanguage?: string; /** * A standard MIME type describing the format of the object data. */ ContentType?: string; /** * Specifies the source object for the copy operation. You specify the value in one of two * formats, depending on whether you want to access the source object through an <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html">access point</a>: * <ul> * <li> * For objects not accessed through an access point, specify the name of the source bucket * and the key of the source object, separated by a slash (/). For example, to copy the * object <code>reports/january.pdf</code> from the bucket * <code>awsexamplebucket</code>, use <code>awsexamplebucket/reports/january.pdf</code>. * The value must be URL-encoded. * </li> * <li> * For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format <code>arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key></code>. For example, to copy the object <code>reports/january.pdf</code> through access point <code>my-access-point</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf</code>. The value must be URL encoded. * <note> * Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region. * </note> * Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key></code>. For example, to copy the object <code>reports/january.pdf</code> through outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf</code>. The value must be URL-encoded. * </li> * </ul> * To copy a specific version of an object, append <code>?versionId=<version-id></code> * to the value (for example, * <code>awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893</code>). * If you don't specify a version ID, Amazon S3 copies the latest version of the source * object. */ CopySource: string | undefined; /** * Copies the object if its entity tag (ETag) matches the specified tag. */ CopySourceIfMatch?: string; /** * Copies the object if it has been modified since the specified time. */ CopySourceIfModifiedSince?: Date; /** * Copies the object if its entity tag (ETag) is different than the specified ETag. */ CopySourceIfNoneMatch?: string; /** * Copies the object if it hasn't been modified since the specified time. */ CopySourceIfUnmodifiedSince?: Date; /** * The date and time at which the object is no longer cacheable. */ Expires?: Date; /** * Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the * object. * This action is not supported by Amazon S3 on Outposts. */ GrantFullControl?: string; /** * Allows grantee to read the object data and its * metadata. * This action is not supported by Amazon S3 on Outposts. */ GrantRead?: string; /** * Allows grantee to read the object ACL. * This action is not supported by Amazon S3 on Outposts. */ GrantReadACP?: string; /** * Allows grantee to write the ACL for the applicable * object. * This action is not supported by Amazon S3 on Outposts. */ GrantWriteACP?: string; /** * The key of the destination object. */ Key: string | undefined; /** * A map of metadata to store with the object in S3. */ Metadata?: Record<string, string>; /** * Specifies whether the metadata is copied from the source object or replaced with * metadata provided in the request. */ MetadataDirective?: MetadataDirective | string; /** * Specifies whether the object tag-set are copied from the source object or replaced with * tag-set provided in the request. */ TaggingDirective?: TaggingDirective | string; /** * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, * AES256, aws:kms). */ ServerSideEncryption?: ServerSideEncryption | 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> in the * Amazon S3 User Guide. */ StorageClass?: StorageClass | 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. */ WebsiteRedirectLocation?: string; /** * Specifies the algorithm to use to when encrypting the object (for example, * AES256). */ SSECustomerAlgorithm?: 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 * <code>x-amz-server-side-encryption-customer-algorithm</code> header. */ SSECustomerKey?: 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. */ SSECustomerKeyMD5?: string; /** * Specifies the Amazon Web Services KMS key ID to use for object encryption. All GET and PUT requests for * an object protected by Amazon Web Services KMS will fail if not made via SSL or using SigV4. For * information about configuring using any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, * see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version">Specifying the * Signature Version in Request Authentication</a> in the Amazon S3 User Guide. */ SSEKMSKeyId?: 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. */ SSEKMSEncryptionContext?: string; /** * 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 <code>true</code> causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. * Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key. */ BucketKeyEnabled?: boolean; /** * Specifies the algorithm to use when decrypting the source object (for example, * AES256). */ CopySourceSSECustomerAlgorithm?: string; /** * Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source * object. The encryption key provided in this header must be one that was used when the * source object was created. */ CopySourceSSECustomerKey?: 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. */ CopySourceSSECustomerKeyMD5?: 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in * Requester Pays Buckets</a> in the Amazon S3 User Guide. */ RequestPayer?: RequestPayer | string; /** * The tag-set for the object destination object this value must be used in conjunction * with the <code>TaggingDirective</code>. The tag-set must be encoded as URL Query * parameters. */ Tagging?: string; /** * The Object Lock mode that you want to apply to the copied object. */ ObjectLockMode?: ObjectLockMode | string; /** * The date and time when you want the copied object's Object Lock to expire. */ ObjectLockRetainUntilDate?: Date; /** * Specifies whether you want to apply a legal hold to the copied object. */ ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus | string; /** * The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied). */ ExpectedBucketOwner?: string; /** * The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied). */ ExpectedSourceBucketOwner?: string; } /** * The source object of the COPY action is not in the active tier and is only stored in * Amazon S3 Glacier. */ export declare class ObjectNotInActiveTierError extends __BaseException { readonly name: "ObjectNotInActiveTierError"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<ObjectNotInActiveTierError, __BaseException>); } /** * The requested bucket name is not available. The bucket namespace is shared by all users * of the system. Select a different name and try again. */ export declare class BucketAlreadyExists extends __BaseException { readonly name: "BucketAlreadyExists"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<BucketAlreadyExists, __BaseException>); } /** * The bucket you tried to create already exists, and you own it. Amazon S3 returns this error * in all Amazon Web Services Regions except in the North Virginia Region. For legacy compatibility, if you * re-create an existing bucket that you already own in the North Virginia Region, Amazon S3 * returns 200 OK and resets the bucket access control lists (ACLs). */ export declare class BucketAlreadyOwnedByYou extends __BaseException { readonly name: "BucketAlreadyOwnedByYou"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<BucketAlreadyOwnedByYou, __BaseException>); } export interface CreateBucketOutput { /** * A forward slash followed by the name of the bucket. */ Location?: string; } export declare enum BucketCannedACL { authenticated_read = "authenticated-read", private = "private", public_read = "public-read", public_read_write = "public-read-write" } export declare enum BucketLocationConstraint { EU = "EU", af_south_1 = "af-south-1", ap_east_1 = "ap-east-1", ap_northeast_1 = "ap-northeast-1", ap_northeast_2 = "ap-northeast-2", ap_northeast_3 = "ap-northeast-3", ap_south_1 = "ap-south-1", ap_southeast_1 = "ap-southeast-1", ap_southeast_2 = "ap-southeast-2", ap_southeast_3 = "ap-southeast-3", ca_central_1 = "ca-central-1", cn_north_1 = "cn-north-1", cn_northwest_1 = "cn-northwest-1", eu_central_1 = "eu-central-1", eu_north_1 = "eu-north-1", eu_south_1 = "eu-south-1", eu_west_1 = "eu-west-1", eu_west_2 = "eu-west-2", eu_west_3 = "eu-west-3", me_south_1 = "me-south-1", sa_east_1 = "sa-east-1", us_east_2 = "us-east-2", us_gov_east_1 = "us-gov-east-1", us_gov_west_1 = "us-gov-west-1", us_west_1 = "us-west-1", us_west_2 = "us-west-2" } /** * The configuration information for the bucket. */ export interface CreateBucketConfiguration { /** * Specifies the Region where the bucket will be created. If you don't specify a Region, * the bucket is created in the US East (N. Virginia) Region (us-east-1). */ LocationConstraint?: BucketLocationConstraint | string; } export declare enum ObjectOwnership { BucketOwnerEnforced = "BucketOwnerEnforced", BucketOwnerPreferred = "BucketOwnerPreferred", ObjectWriter = "ObjectWriter" } export interface CreateBucketRequest { /** * The canned ACL to apply to the bucket. */ ACL?: BucketCannedACL | string; /** * The name of the bucket to create. */ Bucket: string | undefined; /** * The configuration information for the bucket. */ CreateBucketConfiguration?: CreateBucketConfiguration; /** * Allows grantee the read, write, read ACP, and write ACP permissions on the * bucket. */ GrantFullControl?: string; /** * Allows grantee to list the objects in the bucket. */ GrantRead?: string; /** * Allows grantee to read the bucket ACL. */ GrantReadACP?: string; /** * Allows grantee to create new objects in the bucket. * For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects. */ GrantWrite?: string; /** * Allows grantee to write the ACL for the applicable bucket. */ GrantWriteACP?: string; /** * Specifies whether you want S3 Object Lock to be enabled for the new bucket. */ ObjectLockEnabledForBucket?: boolean; /** * The container element for object ownership for a bucket's ownership controls. * BucketOwnerPreferred - Objects uploaded to the bucket change ownership to the bucket * owner if the objects are uploaded with the <code>bucket-owner-full-control</code> canned * ACL. * ObjectWriter - The uploading account will own the object if the object is uploaded with * the <code>bucket-owner-full-control</code> canned ACL. * BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer affect permissions. * The bucket owner automatically owns and has full control over every object in the bucket. The bucket only * accepts PUT requests that don't specify an ACL or bucket owner full control * ACLs, such as the <code>bucket-owner-full-control</code> canned * ACL or an equivalent form of this ACL expressed in the XML format. */ ObjectOwnership?: ObjectOwnership | string; } export interface CreateMultipartUploadOutput { /** * If the bucket has a lifecycle rule configured with an action to abort incomplete * multipart uploads and the prefix in the lifecycle rule matches the object name in the * request, the response includes this header. The header indicates when the initiated * multipart upload becomes eligible for an abort operation. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config"> * Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy</a>. * * The response also includes the <code>x-amz-abort-rule-id</code> header that provides the * ID of the lifecycle configuration rule that defines this action. */ AbortDate?: Date; /** * This header is returned along with the <code>x-amz-abort-date</code> header. It * identifies the applicable lifecycle configuration rule that defines the action to abort * incomplete multipart uploads.<