@aws-sdk/client-s3

import { SENSITIVE_STRING, SmithyException as __SmithyException } from "@aws-sdk/smithy-client"; import { MetadataBearer as $MetadataBearer } from "@aws-sdk/types"; import { Readable } from "stream"; /** * 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 Simple Storage Service Developer Guide. */ export interface AbortIncompleteMultipartUpload { /** * Specifies the number of days after which Amazon S3 aborts an incomplete multipart * upload. */ DaysAfterInitiation?: number; } export namespace AbortIncompleteMultipartUpload { export const filterSensitiveLog = (obj: AbortIncompleteMultipartUpload): any => ({ ...obj, }); } export type RequestCharged = "requester"; export interface AbortMultipartUploadOutput { /** * If present, indicates that the requester was successfully charged for the * request. */ RequestCharged?: RequestCharged | string; } export namespace AbortMultipartUploadOutput { export const filterSensitiveLog = (obj: AbortMultipartUploadOutput): any => ({ ...obj, }); } export type RequestPayer = "requester"; export interface AbortMultipartUploadRequest { /** * The bucket name to which the upload was taking place. * When using this API 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 operation with an access point through the AWS 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/dev/using-access-points.html">Using Access Points</a> in the Amazon Simple Storage Service Developer Guide. * When using this API 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 operation using S3 on Outposts through the AWS 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/dev/S3onOutposts.html">Using S3 on Outposts</a> in the Amazon Simple Storage Service Developer Guide. */ 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 * Requestor Pays Buckets</a> in the Amazon S3 Developer Guide. */ RequestPayer?: RequestPayer | string; /** * The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error. */ ExpectedBucketOwner?: string; } export namespace AbortMultipartUploadRequest { export const filterSensitiveLog = (obj: AbortMultipartUploadRequest): any => ({ ...obj, }); } /** * The specified multipart upload does not exist. */ export interface NoSuchUpload extends __SmithyException, $MetadataBearer { name: "NoSuchUpload"; $fault: "client"; } export namespace NoSuchUpload { export const filterSensitiveLog = (obj: NoSuchUpload): any => ({ ...obj, }); } export type BucketAccelerateStatus = "Enabled" | "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 Simple Storage Service Developer * Guide. */ export interface AccelerateConfiguration { /** * Specifies the transfer acceleration status of the bucket. */ Status?: BucketAccelerateStatus | string; } export namespace AccelerateConfiguration { export const filterSensitiveLog = (obj: AccelerateConfiguration): any => ({ ...obj, }); } export type Type = "AmazonCustomerByEmail" | "CanonicalUser" | "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 AWS 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 AWS 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 namespace Grantee { export const filterSensitiveLog = (obj: Grantee): any => ({ ...obj, }); } export type Permission = "FULL_CONTROL" | "READ" | "READ_ACP" | "WRITE" | "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; } export namespace Grant { export const filterSensitiveLog = (obj: Grant): any => ({ ...obj, }); } /** * 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; } export namespace Owner { export const filterSensitiveLog = (obj: Owner): any => ({ ...obj, }); } /** * 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 namespace AccessControlPolicy { export const filterSensitiveLog = (obj: AccessControlPolicy): any => ({ ...obj, }); } export type OwnerOverride = "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 Simple Storage Service API Reference. */ Owner: OwnerOverride | string | undefined; } export namespace AccessControlTranslation { export const filterSensitiveLog = (obj: AccessControlTranslation): any => ({ ...obj, }); } export type ServerSideEncryption = "AES256" | "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. * When using this API 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 operation with an access point through the AWS 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/dev/using-access-points.html">Using Access Points</a> in the Amazon Simple Storage Service Developer Guide. * When using this API 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 operation using S3 on Outposts through the AWS 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/dev/S3onOutposts.html">Using S3 on Outposts</a> in the Amazon Simple Storage Service Developer 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 * (expiry-date) and rule ID (rule-id). The value of rule-id 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. */ ETag?: string; /** * If you specified server-side encryption either with an Amazon S3-managed encryption key or an * AWS KMS customer master key (CMK) 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 AWS Key Management Service (AWS KMS) symmetric * customer managed customer master key (CMK) that was used for the object. */ SSEKMSKeyId?: string; /** * Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS). */ BucketKeyEnabled?: boolean; /** * If present, indicates that the requester was successfully charged for the * request. */ RequestCharged?: RequestCharged | string; } export namespace CompleteMultipartUploadOutput { export const filterSensitiveLog = (obj: CompleteMultipartUploadOutput): any => ({ ...obj, ...(obj.SSEKMSKeyId && { SSEKMSKeyId: SENSITIVE_STRING }), }); } /** * Details of the parts that were uploaded. */ export interface CompletedPart { /** * Entity tag returned when the part was uploaded. */ ETag?: string; /** * Part number that identifies the part. This is a positive integer between 1 and * 10,000. */ PartNumber?: number; } export namespace CompletedPart { export const filterSensitiveLog = (obj: CompletedPart): any => ({ ...obj, }); } /** * The container for the completed multipart upload details. */ export interface CompletedMultipartUpload { /** * Array of CompletedPart data types. */ Parts?: CompletedPart[]; } export namespace CompletedMultipartUpload { export const filterSensitiveLog = (obj: CompletedMultipartUpload): any => ({ ...obj, }); } export interface CompleteMultipartUploadRequest { /** * Name of the bucket to which the multipart upload was initiated. */ 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; /** * 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 * Requestor Pays Buckets</a> in the Amazon S3 Developer Guide. */ RequestPayer?: RequestPayer | string; /** * The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error. */ ExpectedBucketOwner?: string; } export namespace CompleteMultipartUploadRequest { export const filterSensitiveLog = (obj: CompleteMultipartUploadRequest): any => ({ ...obj, }); } /** * 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. The source and destination ETag is identical for a successfully * copied object. */ ETag?: string; /** * Returns the date that the object was last modified. */ LastModified?: Date; } export namespace CopyObjectResult { export const filterSensitiveLog = (obj: CopyObjectResult): any => ({ ...obj, }); } 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 AWS Key Management Service (AWS KMS) symmetric * customer managed customer master key (CMK) that was used for the object. */ SSEKMSKeyId?: string; /** * If present, specifies the AWS 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 AWS KMS (SSE-KMS). */ BucketKeyEnabled?: boolean; /** * If present, indicates that the requester was successfully charged for the * request. */ RequestCharged?: RequestCharged | string; } export namespace CopyObjectOutput { export const filterSensitiveLog = (obj: CopyObjectOutput): any => ({ ...obj, ...(obj.SSEKMSKeyId && { SSEKMSKeyId: SENSITIVE_STRING }), ...(obj.SSEKMSEncryptionContext && { SSEKMSEncryptionContext: SENSITIVE_STRING }), }); } export type ObjectCannedACL = | "authenticated-read" | "aws-exec-read" | "bucket-owner-full-control" | "bucket-owner-read" | "private" | "public-read" | "public-read-write"; export type MetadataDirective = "COPY" | "REPLACE"; export type ObjectLockLegalHoldStatus = "OFF" | "ON"; export type ObjectLockMode = "COMPLIANCE" | "GOVERNANCE"; export type StorageClass = | "DEEP_ARCHIVE" | "GLACIER" | "INTELLIGENT_TIERING" | "ONEZONE_IA" | "OUTPOSTS" | "REDUCED_REDUNDANCY" | "STANDARD" | "STANDARD_IA"; export type TaggingDirective = "COPY" | "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 API 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 operation with an access point through the AWS 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/dev/using-access-points.html">Using Access Points</a> in the Amazon Simple Storage Service Developer Guide. * When using this API 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 operation using S3 on Outposts through the AWS 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/dev/S3onOutposts.html">Using S3 on Outposts</a> in the Amazon Simple Storage Service Developer Guide. */ Bucket: string | undefined; /** * Specifies caching behavior along the request/reply chain. */ CacheControl?: 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/dev/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 AWS 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?: { [key: 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 * Service Developer 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 AWS KMS key ID to use for object encryption. All GET and PUT requests for * an object protected by AWS KMS will fail if not made via SSL or using SigV4. For * information about configuring using any of the officially supported AWS SDKs and AWS 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 Developer * Guide. */ SSEKMSKeyId?: string; /** * Specifies the AWS 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 operation 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 * Requestor Pays Buckets</a> in the Amazon S3 Developer 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 will fail with an HTTP <code>403 (Access Denied)</code> error. */ ExpectedBucketOwner?: string; /** * The account id of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error. */ ExpectedSourceBucketOwner?: string; } export namespace CopyObjectRequest { export const filterSensitiveLog = (obj: CopyObjectRequest): any => ({ ...obj, ...(obj.SSECustomerKey && { SSECustomerKey: SENSITIVE_STRING }), ...(obj.SSEKMSKeyId && { SSEKMSKeyId: SENSITIVE_STRING }), ...(obj.SSEKMSEncryptionContext && { SSEKMSEncryptionContext: SENSITIVE_STRING }), ...(obj.CopySourceSSECustomerKey && { CopySourceSSECustomerKey: SENSITIVE_STRING }), }); } /** * The source object of the COPY operation is not in the active tier and is only stored in * Amazon S3 Glacier. */ export interface ObjectNotInActiveTierError extends __SmithyException, $MetadataBearer { name: "ObjectNotInActiveTierError"; $fault: "client"; } export namespace ObjectNotInActiveTierError { export const filterSensitiveLog = (obj: ObjectNotInActiveTierError): any => ({ ...obj, }); } /** * 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 interface BucketAlreadyExists extends __SmithyException, $MetadataBearer { name: "BucketAlreadyExists"; $fault: "client"; } export namespace BucketAlreadyExists { export const filterSensitiveLog = (obj: BucketAlreadyExists): any => ({ ...obj, }); } /** * The bucket you tried to create already exists, and you own it. Amazon S3 returns this error * in all AWS 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 interface BucketAlreadyOwnedByYou extends __SmithyException, $MetadataBearer { name: "BucketAlreadyOwnedByYou"; $fault: "client"; } export namespace BucketAlreadyOwnedByYou { export const filterSensitiveLog = (obj: BucketAlreadyOwnedByYou): any => ({ ...obj, }); } export interface CreateBucketOutput { /** * Specifies the Region where the bucket will be created. If you are creating a bucket on * the US East (N. Virginia) Region (us-east-1), you do not need to specify the * location. */ Location?: string; } export namespace CreateBucketOutput { export const filterSensitiveLog = (obj: CreateBucketOutput): any => ({ ...obj, }); } export type BucketCannedACL = "authenticated-read" | "private" | "public-read" | "public-read-write"; export type BucketLocationConstraint = | "EU" | "af-south-1" | "ap-east-1" | "ap-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ca-central-1" | "cn-north-1" | "cn-northwest-1" | "eu-central-1" | "eu-north-1" | "eu-south-1" | "eu-west-1" | "eu-west-2" | "eu-west-3" | "me-south-1" | "sa-east-1" | "us-east-2" | "us-gov-east-1" | "us-gov-west-1" | "us-west-1" | "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 namespace CreateBucketConfiguration { export const filterSensitiveLog = (obj: CreateBucketConfiguration): any => ({ ...obj, }); } 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, overwrite, and delete any object in the bucket. */ 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; } export namespace CreateBucketRequest { export const filterSensitiveLog = (obj: CreateBucketRequest): any => ({ ...obj, }); } 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. */ AbortRuleId?: string; /** * The name of the bucket to which the multipart upload was initiated. * When using this API 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 operation with an access point through the AWS 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/dev/using-access-points.html">Using Access Points</a> in the Amazon Simple Storage Service Developer Guide. * When using this API 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 operation using S3 on Outposts through the AWS 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/dev/S3onOutposts.html">Using S3 on Outposts</a> in the Amazon Simple Storage Service Developer Guide. */ Bucket?: string; /** * Object key for which the multipart upload was initiated. */ Key?: string; /** * ID for the initiated multipart upload. */ UploadId?: 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 AWS Key Management Service (AWS KMS) symmetric * customer managed customer master key (CMK) that was used for the object. */ SSEKMSKeyId?: string; /** * If present, specifies the AWS 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 multipart upload uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS). */ BucketKeyEnabled?: boolean; /** * If present, indicates that the requester was successfully charged for the * request. */ RequestCharged?: RequestCharged | string; } export namespace CreateMultipartUploadOutput { export const filterSensitiveLog = (obj: CreateMultipartUploadOutput): any => ({ ...obj, ...(obj.SSEKMSKeyId && { SSEKMSKeyId: SENSITIVE_STRING }), ...(obj.SSEKMSEncryptionContext && { SSEKMSEncryptionContext: SENSITIVE_STRING }), }); } export interface CreateMultipartUploadRequest { /** * 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 bucket to which to initiate the upload * When using this API 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 operation with an access point through the AWS 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/dev/using-access-points.html">Using Access Points</a> in the Amazon Simple Storage Service Developer Guide. * When using this API 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 operation using S3 on Outposts through the AWS 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/dev/S3onOutposts.html">Using S3 on Outposts</a> in the Amazon Simple Storage Service Developer Guide. */ Bucket: string | undefined; /** * Specifies caching behavior along the request/reply chain. */ CacheControl?: 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; /** * 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; /** * Object key for which the multipart upload is to be initiated. */ Key: string | undefined; /** * A map of metadata to store with the object in S3. */ Metadata?: { [key: string]: 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 * Service Developer 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 ID of the symmetric customer managed AWS KMS CMK to use for object * encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not * made via SSL or using SigV4. For information about configuring using any of the officially * supported AWS SDKs and AWS CLI, see <a href="https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version">Specifying the Signature Version in Request Authentication</a> * in the Amazon S3 Developer Guide. */ SSEKMSKeyId?: string; /** * Specifies the AWS 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 an object operation doesn’t affect bucket-level settings for S3 Bucket Key. */ BucketKeyEnabled?: boolean; /** * 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 * Requestor Pays Buckets</a> in the Amazon S3 Developer Guide. */ RequestPayer?: RequestPayer | string; /** * The tag-set for the object. The tag-set must be encoded as URL Query parameters. */ Tagging?: string; /** * Specifies the Object Lock mode that you want to apply to the uploaded object. */ ObjectLockMode?: ObjectLockMode | string; /** * Specifies the date and time when you want the Object Lock to expire. */ ObjectLockRetainUntilDate?: Date; /** * Specifies whether you want to apply a Legal Hold to the uploaded object. */ ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus | string; /** * The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error. */ ExpectedBucketOwner?: string; } export namespace CreateMultipartUploadRequest { export const filterSensitiveLog = (obj: CreateMultipartUploadRequest): any => ({ ...obj, ...(obj.SSECustomerKey && { SSECustomerKey: SENSITIVE_STRING }), ...(obj.SSEKMSKeyId && { SSEKMSKeyId: SENSITIVE_STRING }), ...(obj.SSEKMSEncryptionContext && { SSEKMSEncryptionContext: SENSITIVE_STRING }), }); } export interface DeleteBucketRequest { /** * Specifies the bucket being deleted. */ Bucket: string | undefined; /** * The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error. */ ExpectedBucketOwner?: string; } export namespace DeleteBucketRequest { export const filterSensitiveLog = (obj: DeleteBucketRequest): any => ({ ...obj, }); } export interface DeleteBucketAnalyticsConfigurationRequest { /** * The name of the bucket from which an analytics configuration is deleted. */ Bucket: string | undefined; /** * The ID that identifies the analytics configuration. */ Id: string | undefined; /** * The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error. */ ExpectedBucketOwner?: string; } export namespace DeleteBucketAnalyticsConfigurationRequest { export const filterSensitiveLog = (obj: DeleteBucketAnalyticsConfigurationRequest): any => ({ ...obj, }); } export interface DeleteBucketCorsRequest { /** * Specifies the bucket whose <code>cors</code> configuration is being deleted. */ Bucket: string | undefined; /** * The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error. */ ExpectedBucketOwner?: string; } export namespace DeleteBucketCorsReq