@aws-sdk/client-s3

import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client"; import { StreamingBlobTypes } from "@smithy/types"; 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 Configuration</a> in * the Amazon S3 User Guide. * @public */ export interface AbortIncompleteMultipartUpload { /** * Specifies the number of days after which Amazon S3 aborts an incomplete multipart * upload. * @public */ DaysAfterInitiation?: number; } /** * @public * @enum */ export declare const RequestCharged: { readonly requester: "requester"; }; /** * @public */ export type RequestCharged = (typeof RequestCharged)[keyof typeof RequestCharged]; /** * @public */ export interface AbortMultipartUploadOutput { /** * If present, indicates that the requester was successfully charged for the * request. * <note> * This functionality is not supported for directory buckets. * </note> * @public */ RequestCharged?: RequestCharged; } /** * @public * @enum */ export declare const RequestPayer: { readonly requester: "requester"; }; /** * @public */ export type RequestPayer = (typeof RequestPayer)[keyof typeof RequestPayer]; /** * @public */ export interface AbortMultipartUploadRequest { /** * The bucket name to which the upload was taking place. * * Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> * Bucket_name.s3express-az_id.region.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <code> * bucket_base_name--az-id--x-s3</code> (for example, <code> * DOC-EXAMPLE-BUCKET--usw2-az1--x-s3</code>). For information about bucket naming * restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming * rules</a> in the Amazon S3 User Guide. * * Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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. * <note> * Access points and Object Lambda access points are not supported by directory buckets. * </note> * * S3 on Outposts - When you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point 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">What is 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 * @public */ Bucket: string | undefined; /** * Key of the object for which the multipart upload was initiated. * @public */ Key: string | undefined; /** * Upload ID that identifies the multipart upload. * @public */ 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. If either the source or * destination S3 bucket has Requester Pays enabled, the requester will pay for * corresponding charges to copy the object. 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. * <note> * This functionality is not supported for directory buckets. * </note> * @public */ RequestPayer?: RequestPayer; /** * The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied). * @public */ ExpectedBucketOwner?: string; } /** * The specified multipart upload does not exist. * @public */ export declare class NoSuchUpload extends __BaseException { readonly name: "NoSuchUpload"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<NoSuchUpload, __BaseException>); } /** * @public * @enum */ export declare const BucketAccelerateStatus: { readonly Enabled: "Enabled"; readonly Suspended: "Suspended"; }; /** * @public */ export type BucketAccelerateStatus = (typeof BucketAccelerateStatus)[keyof typeof BucketAccelerateStatus]; /** * 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. * @public */ export interface AccelerateConfiguration { /** * Specifies the transfer acceleration status of the bucket. * @public */ Status?: BucketAccelerateStatus; } /** * @public * @enum */ export declare const Type: { readonly AmazonCustomerByEmail: "AmazonCustomerByEmail"; readonly CanonicalUser: "CanonicalUser"; readonly Group: "Group"; }; /** * @public */ export type Type = (typeof Type)[keyof typeof Type]; /** * Container for the person being granted permissions. * @public */ export interface Grantee { /** * Screen name of the grantee. * @public */ 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> * @public */ EmailAddress?: string; /** * The canonical user ID of the grantee. * @public */ ID?: string; /** * URI of the grantee group. * @public */ URI?: string; /** * Type of grantee * @public */ Type: Type | undefined; } /** * @public * @enum */ export declare const Permission: { readonly FULL_CONTROL: "FULL_CONTROL"; readonly READ: "READ"; readonly READ_ACP: "READ_ACP"; readonly WRITE: "WRITE"; readonly WRITE_ACP: "WRITE_ACP"; }; /** * @public */ export type Permission = (typeof Permission)[keyof typeof Permission]; /** * Container for grant information. * @public */ export interface Grant { /** * The person being granted permissions. * @public */ Grantee?: Grantee; /** * Specifies the permission given to the grantee. * @public */ Permission?: Permission; } /** * Container for the owner's display name and ID. * @public */ export interface Owner { /** * Container for the display name of the owner. This value 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> * <note> * This functionality is not supported for directory buckets. * </note> * @public */ DisplayName?: string; /** * Container for the ID of the owner. * @public */ ID?: string; } /** * Contains the elements that set the ACL permissions for an object per grantee. * @public */ export interface AccessControlPolicy { /** * A list of grants. * @public */ Grants?: Grant[]; /** * Container for the bucket owner's display name and ID. * @public */ Owner?: Owner; } /** * @public * @enum */ export declare const OwnerOverride: { readonly Destination: "Destination"; }; /** * @public */ export type OwnerOverride = (typeof OwnerOverride)[keyof typeof OwnerOverride]; /** * A container for information about access control for replicas. * @public */ 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. * @public */ Owner: OwnerOverride | undefined; } /** * @public * @enum */ export declare const ServerSideEncryption: { readonly AES256: "AES256"; readonly aws_kms: "aws:kms"; readonly aws_kms_dsse: "aws:kms:dsse"; }; /** * @public */ export type ServerSideEncryption = (typeof ServerSideEncryption)[keyof typeof ServerSideEncryption]; /** * @public */ export interface CompleteMultipartUploadOutput { /** * The URI that identifies the newly created object. * @public */ 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. * <note> * Access points are not supported by directory buckets. * </note> * @public */ Bucket?: string; /** * The object key of the newly created object. * @public */ 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. * <note> * This functionality is not supported for directory buckets. * </note> * @public */ 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. * @public */ ETag?: string; /** * The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded * with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. 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. * @public */ ChecksumCRC32?: string; /** * The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded * with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. 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. * @public */ 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. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. 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. * @public */ 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. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. 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. * @public */ ChecksumSHA256?: string; /** * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, * <code>AES256</code>, <code>aws:kms</code>). * @public */ ServerSideEncryption?: ServerSideEncryption; /** * Version ID of the newly created object, in case the bucket has versioning turned * on. * <note> * This functionality is not supported for directory buckets. * </note> * @public */ VersionId?: string; /** * If present, indicates the ID of the KMS key that was used for object encryption. * @public */ SSEKMSKeyId?: string; /** * Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption * with Key Management Service (KMS) keys (SSE-KMS). * @public */ BucketKeyEnabled?: boolean; /** * If present, indicates that the requester was successfully charged for the * request. * <note> * This functionality is not supported for directory buckets. * </note> * @public */ RequestCharged?: RequestCharged; } /** * Details of the parts that were uploaded. * @public */ export interface CompletedPart { /** * Entity tag returned when the part was uploaded. * @public */ ETag?: string; /** * The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded * with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. 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. * @public */ ChecksumCRC32?: string; /** * The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded * with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. 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. * @public */ 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. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. 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. * @public */ 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. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. 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. * @public */ ChecksumSHA256?: string; /** * Part number that identifies the part. This is a positive integer between 1 and * 10,000. * <note> * <ul> * <li> * * General purpose buckets - In <code>CompleteMultipartUpload</code>, when a additional checksum (including <code>x-amz-checksum-crc32</code>, <code>x-amz-checksum-crc32c</code>, <code>x-amz-checksum-sha1</code>, or * <code>x-amz-checksum-sha256</code>) is applied to each part, the <code>PartNumber</code> must start at 1 and * the part numbers must be consecutive. Otherwise, Amazon S3 generates an HTTP <code>400 Bad Request</code> status code and an <code>InvalidPartOrder</code> error code. * </li> * <li> * * Directory buckets - In <code>CompleteMultipartUpload</code>, the <code>PartNumber</code> must start at 1 and * the part numbers must be consecutive. * </li> * </ul> * </note> * @public */ PartNumber?: number; } /** * The container for the completed multipart upload details. * @public */ 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. * @public */ Parts?: CompletedPart[]; } /** * @public */ export interface CompleteMultipartUploadRequest { /** * Name of the bucket to which the multipart upload was initiated. * * Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> * Bucket_name.s3express-az_id.region.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <code> * bucket_base_name--az-id--x-s3</code> (for example, <code> * DOC-EXAMPLE-BUCKET--usw2-az1--x-s3</code>). For information about bucket naming * restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming * rules</a> in the Amazon S3 User Guide. * * Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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. * <note> * Access points and Object Lambda access points are not supported by directory buckets. * </note> * * S3 on Outposts - When you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point 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">What is 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 * @public */ Bucket: string | undefined; /** * Object key for which the multipart upload was initiated. * @public */ Key: string | undefined; /** * The container for the multipart upload request information. * @public */ MultipartUpload?: CompletedMultipartUpload; /** * ID for the initiated multipart upload. * @public */ 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 CRC-32 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. * @public */ 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 CRC-32C 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. * @public */ 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. * @public */ 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. * @public */ 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. If either the source or * destination S3 bucket has Requester Pays enabled, the requester will pay for * corresponding charges to copy the object. 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. * <note> * This functionality is not supported for directory buckets. * </note> * @public */ RequestPayer?: RequestPayer; /** * The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied). * @public */ ExpectedBucketOwner?: string; /** * Uploads the object only if the object key name does not already exist in the bucket specified. Otherwise, Amazon S3 returns a <code>412 Precondition Failed</code> error. * If a conflicting operation occurs during the upload S3 returns a <code>409 ConditionalRequestConflict</code> response. On a 409 failure you should re-initiate the multipart upload with <code>CreateMultipartUpload</code> and re-upload each part. * Expects the '*' (asterisk) character. * For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>, or <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html">Conditional requests</a> in the Amazon S3 User Guide. * @public */ IfNoneMatch?: string; /** * The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is * required only when the object was created using a checksum algorithm or if * your bucket policy requires the use of SSE-C. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html#ssec-require-condition-key">Protecting data * using SSE-C keys</a> in the Amazon S3 User Guide. * <note> * This functionality is not supported for directory buckets. * </note> * @public */ 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. * <note> * This functionality is not supported for directory buckets. * </note> * @public */ 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. * <note> * This functionality is not supported for directory buckets. * </note> * @public */ SSECustomerKeyMD5?: string; } /** * Container for all response elements. * @public */ export interface CopyObjectResult { /** * Returns the ETag of the new object. The ETag reflects only changes to the contents of an * object, not its metadata. * @public */ ETag?: string; /** * Creation date of the object. * @public */ LastModified?: Date; /** * The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded * with 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. * @public */ ChecksumCRC32?: string; /** * The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded * with 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. * @public */ 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. 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. * @public */ 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. 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. * @public */ ChecksumSHA256?: string; } /** * @public */ export interface CopyObjectOutput { /** * Container for all response elements. * @public */ CopyObjectResult?: CopyObjectResult; /** * If the object expiration is configured, the response includes this header. * <note> * This functionality is not supported for directory buckets. * </note> * @public */ Expiration?: string; /** * Version ID of the source object that was copied. * <note> * This functionality is not supported when the source object is in a directory bucket. * </note> * @public */ CopySourceVersionId?: string; /** * Version ID of the newly created copy. * <note> * This functionality is not supported for directory buckets. * </note> * @public */ VersionId?: string; /** * The server-side encryption algorithm used when you store this object in Amazon S3 (for example, * <code>AES256</code>, <code>aws:kms</code>, <code>aws:kms:dsse</code>). * @public */ ServerSideEncryption?: ServerSideEncryption; /** * If server-side encryption with a customer-provided encryption key was requested, the * response will include this header to confirm the encryption algorithm that's used. * <note> * This functionality is not supported for directory buckets. * </note> * @public */ SSECustomerAlgorithm?: string; /** * If server-side encryption with a customer-provided encryption key was requested, the * response will include this header to provide the round-trip message integrity verification of * the customer-provided encryption key. * <note> * This functionality is not supported for directory buckets. * </note> * @public */ SSECustomerKeyMD5?: string; /** * If present, indicates the ID of the KMS key that was used for object encryption. * @public */ SSEKMSKeyId?: string; /** * If present, indicates 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. * @public */ SSEKMSEncryptionContext?: string; /** * Indicates whether the copied object uses an S3 Bucket Key for server-side encryption * with Key Management Service (KMS) keys (SSE-KMS). * @public */ BucketKeyEnabled?: boolean; /** * If present, indicates that the requester was successfully charged for the * request. * <note> * This functionality is not supported for directory buckets. * </note> * @public */ RequestCharged?: RequestCharged; } /** * @public * @enum */ export declare const ObjectCannedACL: { readonly authenticated_read: "authenticated-read"; readonly aws_exec_read: "aws-exec-read"; readonly bucket_owner_full_control: "bucket-owner-full-control"; readonly bucket_owner_read: "bucket-owner-read"; readonly private: "private"; readonly public_read: "public-read"; readonly public_read_write: "public-read-write"; }; /** * @public */ export type ObjectCannedACL = (typeof ObjectCannedACL)[keyof typeof ObjectCannedACL]; /** * @public * @enum */ export declare const ChecksumAlgorithm: { readonly CRC32: "CRC32"; readonly CRC32C: "CRC32C"; readonly SHA1: "SHA1"; readonly SHA256: "SHA256"; }; /** * @public */ export type ChecksumAlgorithm = (typeof ChecksumAlgorithm)[keyof typeof ChecksumAlgorithm]; /** * @public * @enum */ export declare const MetadataDirective: { readonly COPY: "COPY"; readonly REPLACE: "REPLACE"; }; /** * @public */ export type MetadataDirective = (typeof MetadataDirective)[keyof typeof MetadataDirective]; /** * @public * @enum */ export declare const ObjectLockLegalHoldStatus: { readonly OFF: "OFF"; readonly ON: "ON"; }; /** * @public */ export type ObjectLockLegalHoldStatus = (typeof ObjectLockLegalHoldStatus)[keyof typeof ObjectLockLegalHoldStatus]; /** * @public * @enum */ export declare const ObjectLockMode: { readonly COMPLIANCE: "COMPLIANCE"; readonly GOVERNANCE: "GOVERNANCE"; }; /** * @public */ export type ObjectLockMode = (typeof ObjectLockMode)[keyof typeof ObjectLockMode]; /** * @public * @enum */ export declare const StorageClass: { readonly DEEP_ARCHIVE: "DEEP_ARCHIVE"; readonly EXPRESS_ONEZONE: "EXPRESS_ONEZONE"; readonly GLACIER: "GLACIER"; readonly GLACIER_IR: "GLACIER_IR"; readonly INTELLIGENT_TIERING: "INTELLIGENT_TIERING"; readonly ONEZONE_IA: "ONEZONE_IA"; readonly OUTPOSTS: "OUTPOSTS"; readonly REDUCED_REDUNDANCY: "REDUCED_REDUNDANCY"; readonly SNOW: "SNOW"; readonly STANDARD: "STANDARD"; readonly STANDARD_IA: "STANDARD_IA"; }; /** * @public */ export type StorageClass = (typeof StorageClass)[keyof typeof StorageClass]; /** * @public * @enum */ export declare const TaggingDirective: { readonly COPY: "COPY"; readonly REPLACE: "REPLACE"; }; /** * @public */ export type TaggingDirective = (typeof TaggingDirective)[keyof typeof TaggingDirective]; /** * @public */ export interface CopyObjectRequest { /** * The canned access control list (ACL) to apply to the object. * When you copy an object, the ACL metadata is not preserved and is set * to <code>private</code> by default. Only the owner has full access * control. To override the default ACL setting, * specify a new ACL when you generate a copy request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using * ACLs</a>. * If the destination bucket that you're copying objects to uses the bucket owner enforced * setting for S3 Object Ownership, ACLs are disabled and no longer affect * permissions. Buckets that use this setting only accept <code>PUT</code> requests * that don't specify an ACL or <code>PUT</code> requests that specify 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. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling * ownership of objects and disabling ACLs</a> in the * Amazon S3 User Guide. * <note> * <ul> * <li> * If your destination bucket uses the bucket owner enforced setting for Object Ownership, * all objects written to the bucket by any account will be owned by the bucket * owner. * </li> * <li> * This functionality is not supported for directory buckets. * </li> * <li> * This functionality is not supported for Amazon S3 on Outposts. * </li> * </ul> * </note> * @public */ ACL?: ObjectCannedACL; /** * The name of the destination bucket. * * Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> * Bucket_name.s3express-az_id.region.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <code> * bucket_base_name--az-id--x-s3</code> (for example, <code> * DOC-EXAMPLE-BUCKET--usw2-az1--x-s3</code>). For information about bucket naming * restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming * rules</a> in the Amazon S3 User Guide. * * Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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. * <note> * Access points and Object Lambda access points are not supported by directory buckets. * </note> * * S3 on Outposts - When you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point 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">What is 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 * @public */ Bucket: string | undefined; /** * Specifies the caching behavior along the request/reply chain. * @public */ CacheControl?: string; /** * Indicates the algorithm that 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. * When you copy an object, if the source object has a checksum, that checksum value will be copied to * the new object by default. If the <code>CopyObject</code> request does not include this <code>x-amz-checksum-algorithm</code> header, the checksum algorithm will be copied from the source object to the destination object (if it's present on the source object). You can optionally * specify a different checksum algorithm to use with the * <code>x-amz-checksum-algorithm</code> header. Unrecognized or unsupported values will respond with the HTTP status code <code>400 Bad Request</code>. * <note> * For directory buckets, when you use Amazon Web Services SDKs, <code>CRC32</code> is the default checksum algorithm that's used for performance. * </note> * @public */ ChecksumAlgorithm?: ChecksumAlgorithm; /** * Specifies presentational information for the object. Indicates whether an object should be displayed in a web browser or downloaded as a file. It allows specifying the desired filename for the downloaded file. * @public */ 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. * <note> * For directory buckets, only the <code>aws-chunked</code> value is supported in this header field. * </note> * @public */ ContentEncoding?: string; /** * The language the content is in. * @public */ ContentLanguage?: string; /** * A standard MIME type that describes the format of the object data. * @public */ ContentType?: string; /** * Specifies the source object for the copy operation. The source object * can be up to 5 GB. If the source object is an object that was uploaded by using a multipart upload, the object copy will be a single part object after the source object is copied to the destination bucket. * You specify the value of the copy source 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 general purpose bucket * <code>awsexamplebucket</code>, use <code>awsexamplebucket/reports/january.pdf</code>. * The value must be URL-encoded. To copy the * object <code>reports/january.pdf</code> from the directory bucket * <code>awsexamplebucket--use1-az5--x-s3</code>, use <code>awsexamplebucket--use1-az5--x-s3/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> * <ul> * <li> * Amazon S3 supports copy operations using Acces