Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will\n * wait before permanently removing all parts of the upload. For more information, see \n * Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the\n * Amazon Simple Storage Service Developer Guide.
\n */\nexport interface AbortIncompleteMultipartUpload {\n /**\n *Specifies the number of days after which Amazon S3 aborts an incomplete multipart\n * upload.
\n */\n DaysAfterInitiation?: number;\n}\n\nexport namespace AbortIncompleteMultipartUpload {\n export const filterSensitiveLog = (obj: AbortIncompleteMultipartUpload): any => ({\n ...obj,\n });\n}\n\nexport type RequestCharged = \"requester\";\n\nexport interface AbortMultipartUploadOutput {\n /**\n *If present, indicates that the requester was successfully charged for the\n * request.
\n */\n RequestCharged?: RequestCharged | string;\n}\n\nexport namespace AbortMultipartUploadOutput {\n export const filterSensitiveLog = (obj: AbortMultipartUploadOutput): any => ({\n ...obj,\n });\n}\n\nexport type RequestPayer = \"requester\";\n\nexport interface AbortMultipartUploadRequest {\n /**\n *The bucket name to which the upload was taking place.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n *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 Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket: string | undefined;\n\n /**\n *Key of the object for which the multipart upload was initiated.
\n */\n Key: string | undefined;\n\n /**\n *Upload ID that identifies the multipart upload.
\n */\n UploadId: string | undefined;\n\n /**\n *Confirms that the requester knows that they will be charged for the request. Bucket\n * owners need not specify this parameter in their requests. For information about downloading\n * objects from requester pays buckets, see Downloading Objects in\n * Requestor Pays Buckets in the Amazon S3 Developer Guide.
\n */\n RequestPayer?: RequestPayer | string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The specified multipart upload does not exist.
\n */\nexport interface NoSuchUpload extends __SmithyException, $MetadataBearer {\n name: \"NoSuchUpload\";\n $fault: \"client\";\n}\n\nexport namespace NoSuchUpload {\n export const filterSensitiveLog = (obj: NoSuchUpload): any => ({\n ...obj,\n });\n}\n\nexport type BucketAccelerateStatus = \"Enabled\" | \"Suspended\";\n\n/**\n *Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see\n * Amazon S3\n * Transfer Acceleration in the Amazon Simple Storage Service Developer\n * Guide.
\n */\nexport interface AccelerateConfiguration {\n /**\n *Specifies the transfer acceleration status of the bucket.
\n */\n Status?: BucketAccelerateStatus | string;\n}\n\nexport namespace AccelerateConfiguration {\n export const filterSensitiveLog = (obj: AccelerateConfiguration): any => ({\n ...obj,\n });\n}\n\nexport type Type = \"AmazonCustomerByEmail\" | \"CanonicalUser\" | \"Group\";\n\n/**\n *Container for the person being granted permissions.
\n */\nexport interface Grantee {\n /**\n *Screen name of the grantee.
\n */\n DisplayName?: string;\n\n /**\n *Email address of the grantee.
\n *Using email addresses to specify a grantee is only supported in the following AWS Regions:
\n *US East (N. Virginia)
\n *US West (N. California)
\n *US West (Oregon)
\n *Asia Pacific (Singapore)
\n *Asia Pacific (Sydney)
\n *Asia Pacific (Tokyo)
\n *Europe (Ireland)
\n *South America (São Paulo)
\n *For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
\n *The canonical user ID of the grantee.
\n */\n ID?: string;\n\n /**\n *URI of the grantee group.
\n */\n URI?: string;\n\n /**\n *Type of grantee
\n */\n Type: Type | string | undefined;\n}\n\nexport namespace Grantee {\n export const filterSensitiveLog = (obj: Grantee): any => ({\n ...obj,\n });\n}\n\nexport type Permission = \"FULL_CONTROL\" | \"READ\" | \"READ_ACP\" | \"WRITE\" | \"WRITE_ACP\";\n\n/**\n *Container for grant information.
\n */\nexport interface Grant {\n /**\n *The person being granted permissions.
\n */\n Grantee?: Grantee;\n\n /**\n *Specifies the permission given to the grantee.
\n */\n Permission?: Permission | string;\n}\n\nexport namespace Grant {\n export const filterSensitiveLog = (obj: Grant): any => ({\n ...obj,\n });\n}\n\n/**\n *Container for the owner's display name and ID.
\n */\nexport interface Owner {\n /**\n *Container for the display name of the owner.
\n */\n DisplayName?: string;\n\n /**\n *Container for the ID of the owner.
\n */\n ID?: string;\n}\n\nexport namespace Owner {\n export const filterSensitiveLog = (obj: Owner): any => ({\n ...obj,\n });\n}\n\n/**\n *Contains the elements that set the ACL permissions for an object per grantee.
\n */\nexport interface AccessControlPolicy {\n /**\n *A list of grants.
\n */\n Grants?: Grant[];\n\n /**\n *Container for the bucket owner's display name and ID.
\n */\n Owner?: Owner;\n}\n\nexport namespace AccessControlPolicy {\n export const filterSensitiveLog = (obj: AccessControlPolicy): any => ({\n ...obj,\n });\n}\n\nexport type OwnerOverride = \"Destination\";\n\n/**\n *A container for information about access control for replicas.
\n */\nexport interface AccessControlTranslation {\n /**\n *Specifies the replica ownership. For default and valid values, see PUT bucket\n * replication in the Amazon Simple Storage Service API Reference.
\n */\n Owner: OwnerOverride | string | undefined;\n}\n\nexport namespace AccessControlTranslation {\n export const filterSensitiveLog = (obj: AccessControlTranslation): any => ({\n ...obj,\n });\n}\n\nexport type ServerSideEncryption = \"AES256\" | \"aws:kms\";\n\nexport interface CompleteMultipartUploadOutput {\n /**\n *The URI that identifies the newly created object.
\n */\n Location?: string;\n\n /**\n *The name of the bucket that contains the newly created object.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n *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 Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket?: string;\n\n /**\n *The object key of the newly created object.
\n */\n Key?: string;\n\n /**\n *If the object expiration is configured, this will contain the expiration date\n * (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded.
\n */\n Expiration?: string;\n\n /**\n *Entity tag that identifies the newly created object's data. Objects with different\n * object data will have different entity tags. The entity tag is an opaque string. The entity\n * tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5\n * digest of the object data, it will contain one or more nonhexadecimal characters and/or\n * will consist of less than 32 or more than 32 hexadecimal digits.
\n */\n ETag?: string;\n\n /**\n *If you specified server-side encryption either with an Amazon S3-managed encryption key or an\n * AWS KMS customer master key (CMK) in your initiate multipart upload request, the response\n * includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the\n * object.
\n */\n ServerSideEncryption?: ServerSideEncryption | string;\n\n /**\n *Version ID of the newly created object, in case the bucket has versioning turned\n * on.
\n */\n VersionId?: string;\n\n /**\n *If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n * customer managed customer master key (CMK) that was used for the object.
\n */\n SSEKMSKeyId?: string;\n\n /**\n *Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).
\n */\n BucketKeyEnabled?: boolean;\n\n /**\n *If present, indicates that the requester was successfully charged for the\n * request.
\n */\n RequestCharged?: RequestCharged | string;\n}\n\nexport namespace CompleteMultipartUploadOutput {\n export const filterSensitiveLog = (obj: CompleteMultipartUploadOutput): any => ({\n ...obj,\n ...(obj.SSEKMSKeyId && { SSEKMSKeyId: SENSITIVE_STRING }),\n });\n}\n\n/**\n *Details of the parts that were uploaded.
\n */\nexport interface CompletedPart {\n /**\n *Entity tag returned when the part was uploaded.
\n */\n ETag?: string;\n\n /**\n *Part number that identifies the part. This is a positive integer between 1 and\n * 10,000.
\n */\n PartNumber?: number;\n}\n\nexport namespace CompletedPart {\n export const filterSensitiveLog = (obj: CompletedPart): any => ({\n ...obj,\n });\n}\n\n/**\n *The container for the completed multipart upload details.
\n */\nexport interface CompletedMultipartUpload {\n /**\n *Array of CompletedPart data types.
\n */\n Parts?: CompletedPart[];\n}\n\nexport namespace CompletedMultipartUpload {\n export const filterSensitiveLog = (obj: CompletedMultipartUpload): any => ({\n ...obj,\n });\n}\n\nexport interface CompleteMultipartUploadRequest {\n /**\n *Name of the bucket to which the multipart upload was initiated.
\n */\n Bucket: string | undefined;\n\n /**\n *Object key for which the multipart upload was initiated.
\n */\n Key: string | undefined;\n\n /**\n *The container for the multipart upload request information.
\n */\n MultipartUpload?: CompletedMultipartUpload;\n\n /**\n *ID for the initiated multipart upload.
\n */\n UploadId: string | undefined;\n\n /**\n *Confirms that the requester knows that they will be charged for the request. Bucket\n * owners need not specify this parameter in their requests. For information about downloading\n * objects from requester pays buckets, see Downloading Objects in\n * Requestor Pays Buckets in the Amazon S3 Developer Guide.
\n */\n RequestPayer?: RequestPayer | string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Container for all response elements.
\n */\nexport interface CopyObjectResult {\n /**\n *Returns the ETag of the new object. The ETag reflects only changes to the contents of an\n * object, not its metadata. The source and destination ETag is identical for a successfully\n * copied object.
\n */\n ETag?: string;\n\n /**\n *Returns the date that the object was last modified.
\n */\n LastModified?: Date;\n}\n\nexport namespace CopyObjectResult {\n export const filterSensitiveLog = (obj: CopyObjectResult): any => ({\n ...obj,\n });\n}\n\nexport interface CopyObjectOutput {\n /**\n *Container for all response elements.
\n */\n CopyObjectResult?: CopyObjectResult;\n\n /**\n *If the object expiration is configured, the response includes this header.
\n */\n Expiration?: string;\n\n /**\n *Version of the copied object in the destination bucket.
\n */\n CopySourceVersionId?: string;\n\n /**\n *Version ID of the newly created copy.
\n */\n VersionId?: string;\n\n /**\n *The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n * AES256, aws:kms).
\n */\n ServerSideEncryption?: ServerSideEncryption | string;\n\n /**\n *If server-side encryption with a customer-provided encryption key was requested, the\n * response will include this header confirming the encryption algorithm used.
\n */\n SSECustomerAlgorithm?: string;\n\n /**\n *If server-side encryption with a customer-provided encryption key was requested, the\n * response will include this header to provide round-trip message integrity verification of\n * the customer-provided encryption key.
\n */\n SSECustomerKeyMD5?: string;\n\n /**\n *If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n * customer managed customer master key (CMK) that was used for the object.
\n */\n SSEKMSKeyId?: string;\n\n /**\n *If present, specifies the AWS KMS Encryption Context to use for object encryption. The\n * value of this header is a base64-encoded UTF-8 string holding JSON with the encryption\n * context key-value pairs.
\n */\n SSEKMSEncryptionContext?: string;\n\n /**\n *Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).
\n */\n BucketKeyEnabled?: boolean;\n\n /**\n *If present, indicates that the requester was successfully charged for the\n * request.
\n */\n RequestCharged?: RequestCharged | string;\n}\n\nexport namespace CopyObjectOutput {\n export const filterSensitiveLog = (obj: CopyObjectOutput): any => ({\n ...obj,\n ...(obj.SSEKMSKeyId && { SSEKMSKeyId: SENSITIVE_STRING }),\n ...(obj.SSEKMSEncryptionContext && { SSEKMSEncryptionContext: SENSITIVE_STRING }),\n });\n}\n\nexport type ObjectCannedACL =\n | \"authenticated-read\"\n | \"aws-exec-read\"\n | \"bucket-owner-full-control\"\n | \"bucket-owner-read\"\n | \"private\"\n | \"public-read\"\n | \"public-read-write\";\n\nexport type MetadataDirective = \"COPY\" | \"REPLACE\";\n\nexport type ObjectLockLegalHoldStatus = \"OFF\" | \"ON\";\n\nexport type ObjectLockMode = \"COMPLIANCE\" | \"GOVERNANCE\";\n\nexport type StorageClass =\n | \"DEEP_ARCHIVE\"\n | \"GLACIER\"\n | \"INTELLIGENT_TIERING\"\n | \"ONEZONE_IA\"\n | \"OUTPOSTS\"\n | \"REDUCED_REDUNDANCY\"\n | \"STANDARD\"\n | \"STANDARD_IA\";\n\nexport type TaggingDirective = \"COPY\" | \"REPLACE\";\n\nexport interface CopyObjectRequest {\n /**\n *The canned ACL to apply to the object.
\n *This action is not supported by Amazon S3 on Outposts.
\n */\n ACL?: ObjectCannedACL | string;\n\n /**\n *The name of the destination bucket.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n *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 Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket: string | undefined;\n\n /**\n *Specifies caching behavior along the request/reply chain.
\n */\n CacheControl?: string;\n\n /**\n *Specifies presentational information for the object.
\n */\n ContentDisposition?: string;\n\n /**\n *Specifies what content encodings have been applied to the object and thus what decoding\n * mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n * field.
\n */\n ContentEncoding?: string;\n\n /**\n *The language the content is in.
\n */\n ContentLanguage?: string;\n\n /**\n *A standard MIME type describing the format of the object data.
\n */\n ContentType?: string;\n\n /**\n *Specifies the source object for the copy operation. You specify the value in one of two\n * formats, depending on whether you want to access the source object through an access\n * point:
\n *For objects not accessed through an access point, specify the name of the source\n * bucket and the key of the source object, separated by a slash (/). For example, to\n * copy the object reports/january.pdf from the bucket\n * awsexamplebucket, use\n * awsexamplebucket/reports/january.pdf. The value must be URL\n * encoded.
For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.
Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same AWS Region.
\n *Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL encoded.
To copy a specific version of an object, append ?versionId=\n * to the value (for example,\n * awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893).\n * If you don't specify a version ID, Amazon S3 copies the latest version of the source\n * object.
Copies the object if its entity tag (ETag) matches the specified tag.
\n */\n CopySourceIfMatch?: string;\n\n /**\n *Copies the object if it has been modified since the specified time.
\n */\n CopySourceIfModifiedSince?: Date;\n\n /**\n *Copies the object if its entity tag (ETag) is different than the specified ETag.
\n */\n CopySourceIfNoneMatch?: string;\n\n /**\n *Copies the object if it hasn't been modified since the specified time.
\n */\n CopySourceIfUnmodifiedSince?: Date;\n\n /**\n *The date and time at which the object is no longer cacheable.
\n */\n Expires?: Date;\n\n /**\n *Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the\n * object.
\n *This action is not supported by Amazon S3 on Outposts.
\n */\n GrantFullControl?: string;\n\n /**\n *Allows grantee to read the object data and its\n * metadata.
\n *This action is not supported by Amazon S3 on Outposts.
\n */\n GrantRead?: string;\n\n /**\n *Allows grantee to read the object ACL.
\n *This action is not supported by Amazon S3 on Outposts.
\n */\n GrantReadACP?: string;\n\n /**\n *Allows grantee to write the ACL for the applicable\n * object.
\n *This action is not supported by Amazon S3 on Outposts.
\n */\n GrantWriteACP?: string;\n\n /**\n *The key of the destination object.
\n */\n Key: string | undefined;\n\n /**\n *A map of metadata to store with the object in S3.
\n */\n Metadata?: { [key: string]: string };\n\n /**\n *Specifies whether the metadata is copied from the source object or replaced with\n * metadata provided in the request.
\n */\n MetadataDirective?: MetadataDirective | string;\n\n /**\n *Specifies whether the object tag-set are copied from the source object or replaced with\n * tag-set provided in the request.
\n */\n TaggingDirective?: TaggingDirective | string;\n\n /**\n *The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n * AES256, aws:kms).
\n */\n ServerSideEncryption?: ServerSideEncryption | string;\n\n /**\n *By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n * STANDARD storage class provides high durability and high availability. Depending on\n * performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n * the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3\n * Service Developer Guide.
\n */\n StorageClass?: StorageClass | string;\n\n /**\n *If the bucket is configured as a website, redirects requests for this object to another\n * object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n * the object metadata.
\n */\n WebsiteRedirectLocation?: string;\n\n /**\n *Specifies the algorithm to use to when encrypting the object (for example,\n * AES256).
\n */\n SSECustomerAlgorithm?: string;\n\n /**\n *Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n * value is used to store the object and then it is discarded; Amazon S3 does not store the\n * encryption key. The key must be appropriate for use with the algorithm specified in the\n * x-amz-server-side-encryption-customer-algorithm header.
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n * this header for a message integrity check to ensure that the encryption key was transmitted\n * without error.
\n */\n SSECustomerKeyMD5?: string;\n\n /**\n *Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for\n * an object protected by AWS KMS will fail if not made via SSL or using SigV4. For\n * information about configuring using any of the officially supported AWS SDKs and AWS CLI,\n * see Specifying the\n * Signature Version in Request Authentication in the Amazon S3 Developer\n * Guide.
\n */\n SSEKMSKeyId?: string;\n\n /**\n *Specifies the AWS KMS Encryption Context to use for object encryption. The value of this\n * header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value\n * pairs.
\n */\n SSEKMSEncryptionContext?: string;\n\n /**\n *Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.
Specifying this header with a COPY operation doesn’t affect bucket-level settings for S3 Bucket Key.
\n */\n BucketKeyEnabled?: boolean;\n\n /**\n *Specifies the algorithm to use when decrypting the source object (for example,\n * AES256).
\n */\n CopySourceSSECustomerAlgorithm?: string;\n\n /**\n *Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source\n * object. The encryption key provided in this header must be one that was used when the\n * source object was created.
\n */\n CopySourceSSECustomerKey?: string;\n\n /**\n *Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n * this header for a message integrity check to ensure that the encryption key was transmitted\n * without error.
\n */\n CopySourceSSECustomerKeyMD5?: string;\n\n /**\n *Confirms that the requester knows that they will be charged for the request. Bucket\n * owners need not specify this parameter in their requests. For information about downloading\n * objects from requester pays buckets, see Downloading Objects in\n * Requestor Pays Buckets in the Amazon S3 Developer Guide.
\n */\n RequestPayer?: RequestPayer | string;\n\n /**\n *The tag-set for the object destination object this value must be used in conjunction\n * with the TaggingDirective. The tag-set must be encoded as URL Query\n * parameters.
The Object Lock mode that you want to apply to the copied object.
\n */\n ObjectLockMode?: ObjectLockMode | string;\n\n /**\n *The date and time when you want the copied object's Object Lock to expire.
\n */\n ObjectLockRetainUntilDate?: Date;\n\n /**\n *Specifies whether you want to apply a Legal Hold to the copied object.
\n */\n ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus | string;\n\n /**\n *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 403 (Access Denied) error.
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 403 (Access Denied) error.
The source object of the COPY operation is not in the active tier and is only stored in\n * Amazon S3 Glacier.
\n */\nexport interface ObjectNotInActiveTierError extends __SmithyException, $MetadataBearer {\n name: \"ObjectNotInActiveTierError\";\n $fault: \"client\";\n}\n\nexport namespace ObjectNotInActiveTierError {\n export const filterSensitiveLog = (obj: ObjectNotInActiveTierError): any => ({\n ...obj,\n });\n}\n\n/**\n *The requested bucket name is not available. The bucket namespace is shared by all users\n * of the system. Select a different name and try again.
\n */\nexport interface BucketAlreadyExists extends __SmithyException, $MetadataBearer {\n name: \"BucketAlreadyExists\";\n $fault: \"client\";\n}\n\nexport namespace BucketAlreadyExists {\n export const filterSensitiveLog = (obj: BucketAlreadyExists): any => ({\n ...obj,\n });\n}\n\n/**\n *The bucket you tried to create already exists, and you own it. Amazon S3 returns this error\n * in all AWS Regions except in the North Virginia Region. For legacy compatibility, if you\n * re-create an existing bucket that you already own in the North Virginia Region, Amazon S3\n * returns 200 OK and resets the bucket access control lists (ACLs).
\n */\nexport interface BucketAlreadyOwnedByYou extends __SmithyException, $MetadataBearer {\n name: \"BucketAlreadyOwnedByYou\";\n $fault: \"client\";\n}\n\nexport namespace BucketAlreadyOwnedByYou {\n export const filterSensitiveLog = (obj: BucketAlreadyOwnedByYou): any => ({\n ...obj,\n });\n}\n\nexport interface CreateBucketOutput {\n /**\n *Specifies the Region where the bucket will be created. If you are creating a bucket on\n * the US East (N. Virginia) Region (us-east-1), you do not need to specify the\n * location.
\n */\n Location?: string;\n}\n\nexport namespace CreateBucketOutput {\n export const filterSensitiveLog = (obj: CreateBucketOutput): any => ({\n ...obj,\n });\n}\n\nexport type BucketCannedACL = \"authenticated-read\" | \"private\" | \"public-read\" | \"public-read-write\";\n\nexport type BucketLocationConstraint =\n | \"EU\"\n | \"af-south-1\"\n | \"ap-east-1\"\n | \"ap-northeast-1\"\n | \"ap-northeast-2\"\n | \"ap-northeast-3\"\n | \"ap-south-1\"\n | \"ap-southeast-1\"\n | \"ap-southeast-2\"\n | \"ca-central-1\"\n | \"cn-north-1\"\n | \"cn-northwest-1\"\n | \"eu-central-1\"\n | \"eu-north-1\"\n | \"eu-south-1\"\n | \"eu-west-1\"\n | \"eu-west-2\"\n | \"eu-west-3\"\n | \"me-south-1\"\n | \"sa-east-1\"\n | \"us-east-2\"\n | \"us-gov-east-1\"\n | \"us-gov-west-1\"\n | \"us-west-1\"\n | \"us-west-2\";\n\n/**\n *The configuration information for the bucket.
\n */\nexport interface CreateBucketConfiguration {\n /**\n *Specifies the Region where the bucket will be created. If you don't specify a Region,\n * the bucket is created in the US East (N. Virginia) Region (us-east-1).
\n */\n LocationConstraint?: BucketLocationConstraint | string;\n}\n\nexport namespace CreateBucketConfiguration {\n export const filterSensitiveLog = (obj: CreateBucketConfiguration): any => ({\n ...obj,\n });\n}\n\nexport interface CreateBucketRequest {\n /**\n *The canned ACL to apply to the bucket.
\n */\n ACL?: BucketCannedACL | string;\n\n /**\n *The name of the bucket to create.
\n */\n Bucket: string | undefined;\n\n /**\n *The configuration information for the bucket.
\n */\n CreateBucketConfiguration?: CreateBucketConfiguration;\n\n /**\n *Allows grantee the read, write, read ACP, and write ACP permissions on the\n * bucket.
\n */\n GrantFullControl?: string;\n\n /**\n *Allows grantee to list the objects in the bucket.
\n */\n GrantRead?: string;\n\n /**\n *Allows grantee to read the bucket ACL.
\n */\n GrantReadACP?: string;\n\n /**\n *Allows grantee to create, overwrite, and delete any object in the bucket.
\n */\n GrantWrite?: string;\n\n /**\n *Allows grantee to write the ACL for the applicable bucket.
\n */\n GrantWriteACP?: string;\n\n /**\n *Specifies whether you want S3 Object Lock to be enabled for the new bucket.
\n */\n ObjectLockEnabledForBucket?: boolean;\n}\n\nexport namespace CreateBucketRequest {\n export const filterSensitiveLog = (obj: CreateBucketRequest): any => ({\n ...obj,\n });\n}\n\nexport interface CreateMultipartUploadOutput {\n /**\n *If the bucket has a lifecycle rule configured with an action to abort incomplete\n * multipart uploads and the prefix in the lifecycle rule matches the object name in the\n * request, the response includes this header. The header indicates when the initiated\n * multipart upload becomes eligible for an abort operation. For more information, see \n * Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.
\n *\n *The response also includes the x-amz-abort-rule-id header that provides the\n * ID of the lifecycle configuration rule that defines this action.
This header is returned along with the x-amz-abort-date header. It\n * identifies the applicable lifecycle configuration rule that defines the action to abort\n * incomplete multipart uploads.
The name of the bucket to which the multipart upload was initiated.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n *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 Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket?: string;\n\n /**\n *Object key for which the multipart upload was initiated.
\n */\n Key?: string;\n\n /**\n *ID for the initiated multipart upload.
\n */\n UploadId?: string;\n\n /**\n *The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n * AES256, aws:kms).
\n */\n ServerSideEncryption?: ServerSideEncryption | string;\n\n /**\n *If server-side encryption with a customer-provided encryption key was requested, the\n * response will include this header confirming the encryption algorithm used.
\n */\n SSECustomerAlgorithm?: string;\n\n /**\n *If server-side encryption with a customer-provided encryption key was requested, the\n * response will include this header to provide round-trip message integrity verification of\n * the customer-provided encryption key.
\n */\n SSECustomerKeyMD5?: string;\n\n /**\n *If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n * customer managed customer master key (CMK) that was used for the object.
\n */\n SSEKMSKeyId?: string;\n\n /**\n *If present, specifies the AWS KMS Encryption Context to use for object encryption. The\n * value of this header is a base64-encoded UTF-8 string holding JSON with the encryption\n * context key-value pairs.
\n */\n SSEKMSEncryptionContext?: string;\n\n /**\n *Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).
\n */\n BucketKeyEnabled?: boolean;\n\n /**\n *If present, indicates that the requester was successfully charged for the\n * request.
\n */\n RequestCharged?: RequestCharged | string;\n}\n\nexport namespace CreateMultipartUploadOutput {\n export const filterSensitiveLog = (obj: CreateMultipartUploadOutput): any => ({\n ...obj,\n ...(obj.SSEKMSKeyId && { SSEKMSKeyId: SENSITIVE_STRING }),\n ...(obj.SSEKMSEncryptionContext && { SSEKMSEncryptionContext: SENSITIVE_STRING }),\n });\n}\n\nexport interface CreateMultipartUploadRequest {\n /**\n *The canned ACL to apply to the object.
\n *This action is not supported by Amazon S3 on Outposts.
\n */\n ACL?: ObjectCannedACL | string;\n\n /**\n *The name of the bucket to which to initiate the upload
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n *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 Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket: string | undefined;\n\n /**\n *Specifies caching behavior along the request/reply chain.
\n */\n CacheControl?: string;\n\n /**\n *Specifies presentational information for the object.
\n */\n ContentDisposition?: string;\n\n /**\n *Specifies what content encodings have been applied to the object and thus what decoding\n * mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n * field.
\n */\n ContentEncoding?: string;\n\n /**\n *The language the content is in.
\n */\n ContentLanguage?: string;\n\n /**\n *A standard MIME type describing the format of the object data.
\n */\n ContentType?: string;\n\n /**\n *The date and time at which the object is no longer cacheable.
\n */\n Expires?: Date;\n\n /**\n *Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the\n * object.
\n *This action is not supported by Amazon S3 on Outposts.
\n */\n GrantFullControl?: string;\n\n /**\n *Allows grantee to read the object data and its\n * metadata.
\n *This action is not supported by Amazon S3 on Outposts.
\n */\n GrantRead?: string;\n\n /**\n *Allows grantee to read the object ACL.
\n *This action is not supported by Amazon S3 on Outposts.
\n */\n GrantReadACP?: string;\n\n /**\n *Allows grantee to write the ACL for the applicable\n * object.
\n *This action is not supported by Amazon S3 on Outposts.
\n */\n GrantWriteACP?: string;\n\n /**\n *Object key for which the multipart upload is to be initiated.
\n */\n Key: string | undefined;\n\n /**\n *A map of metadata to store with the object in S3.
\n */\n Metadata?: { [key: string]: string };\n\n /**\n *The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n * AES256, aws:kms).
\n */\n ServerSideEncryption?: ServerSideEncryption | string;\n\n /**\n *By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n * STANDARD storage class provides high durability and high availability. Depending on\n * performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n * the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3\n * Service Developer Guide.
\n */\n StorageClass?: StorageClass | string;\n\n /**\n *If the bucket is configured as a website, redirects requests for this object to another\n * object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n * the object metadata.
\n */\n WebsiteRedirectLocation?: string;\n\n /**\n *Specifies the algorithm to use to when encrypting the object (for example,\n * AES256).
\n */\n SSECustomerAlgorithm?: string;\n\n /**\n *Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n * value is used to store the object and then it is discarded; Amazon S3 does not store the\n * encryption key. The key must be appropriate for use with the algorithm specified in the\n * x-amz-server-side-encryption-customer-algorithm header.
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n * this header for a message integrity check to ensure that the encryption key was transmitted\n * without error.
\n */\n SSECustomerKeyMD5?: string;\n\n /**\n *Specifies the ID of the symmetric customer managed AWS KMS CMK to use for object\n * encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not\n * made via SSL or using SigV4. For information about configuring using any of the officially\n * supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication\n * in the Amazon S3 Developer Guide.
\n */\n SSEKMSKeyId?: string;\n\n /**\n *Specifies the AWS KMS Encryption Context to use for object encryption. The value of this\n * header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value\n * pairs.
\n */\n SSEKMSEncryptionContext?: string;\n\n /**\n *Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.
Specifying this header with an object operation doesn’t affect bucket-level settings for S3 Bucket Key.
\n */\n BucketKeyEnabled?: boolean;\n\n /**\n *Confirms that the requester knows that they will be charged for the request. Bucket\n * owners need not specify this parameter in their requests. For information about downloading\n * objects from requester pays buckets, see Downloading Objects in\n * Requestor Pays Buckets in the Amazon S3 Developer Guide.
\n */\n RequestPayer?: RequestPayer | string;\n\n /**\n *The tag-set for the object. The tag-set must be encoded as URL Query parameters.
\n */\n Tagging?: string;\n\n /**\n *Specifies the Object Lock mode that you want to apply to the uploaded object.
\n */\n ObjectLockMode?: ObjectLockMode | string;\n\n /**\n *Specifies the date and time when you want the Object Lock to expire.
\n */\n ObjectLockRetainUntilDate?: Date;\n\n /**\n *Specifies whether you want to apply a Legal Hold to the uploaded object.
\n */\n ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus | string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Specifies the bucket being deleted.
\n */\n Bucket: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The name of the bucket from which an analytics configuration is deleted.
\n */\n Bucket: string | undefined;\n\n /**\n *The ID that identifies the analytics configuration.
\n */\n Id: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Specifies the bucket whose cors configuration is being deleted.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The name of the bucket containing the server-side encryption configuration to\n * delete.
\n */\n Bucket: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.
\n */\n Bucket: string | undefined;\n\n /**\n *The ID used to identify the S3 Intelligent-Tiering configuration.
\n */\n Id: string | undefined;\n}\n\nexport namespace DeleteBucketIntelligentTieringConfigurationRequest {\n export const filterSensitiveLog = (obj: DeleteBucketIntelligentTieringConfigurationRequest): any => ({\n ...obj,\n });\n}\n\nexport interface DeleteBucketInventoryConfigurationRequest {\n /**\n *The name of the bucket containing the inventory configuration to delete.
\n */\n Bucket: string | undefined;\n\n /**\n *The ID used to identify the inventory configuration.
\n */\n Id: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The bucket name of the lifecycle to delete.
\n */\n Bucket: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The name of the bucket containing the metrics configuration to delete.
\n */\n Bucket: string | undefined;\n\n /**\n *The ID used to identify the metrics configuration.
\n */\n Id: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The Amazon S3 bucket whose OwnershipControls you want to delete.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The bucket name.
\n */\n Bucket: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The bucket name.
\n */\n Bucket: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The bucket that has the tag set to be removed.
\n */\n Bucket: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The bucket name for which you want to remove the website configuration.
\n */\n Bucket: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Specifies whether the versioned object that was permanently deleted was (true) or was\n * not (false) a delete marker.
\n */\n DeleteMarker?: boolean;\n\n /**\n *Returns the version ID of the delete marker created as a result of the DELETE\n * operation.
\n */\n VersionId?: string;\n\n /**\n *If present, indicates that the requester was successfully charged for the\n * request.
\n */\n RequestCharged?: RequestCharged | string;\n}\n\nexport namespace DeleteObjectOutput {\n export const filterSensitiveLog = (obj: DeleteObjectOutput): any => ({\n ...obj,\n });\n}\n\nexport interface DeleteObjectRequest {\n /**\n *The bucket name of the bucket containing the object.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n *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 Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket: string | undefined;\n\n /**\n *Key name of the object to delete.
\n */\n Key: string | undefined;\n\n /**\n *The concatenation of the authentication device's serial number, a space, and the value\n * that is displayed on your authentication device. Required to permanently delete a versioned\n * object if versioning is configured with MFA delete enabled.
\n */\n MFA?: string;\n\n /**\n *VersionId used to reference a specific version of the object.
\n */\n VersionId?: string;\n\n /**\n *Confirms that the requester knows that they will be charged for the request. Bucket\n * owners need not specify this parameter in their requests. For information about downloading\n * objects from requester pays buckets, see Downloading Objects in\n * Requestor Pays Buckets in the Amazon S3 Developer Guide.
\n */\n RequestPayer?: RequestPayer | string;\n\n /**\n *Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process\n * this operation.
\n */\n BypassGovernanceRetention?: boolean;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Information about the deleted object.
\n */\nexport interface DeletedObject {\n /**\n *The name of the deleted object.
\n */\n Key?: string;\n\n /**\n *The version ID of the deleted object.
\n */\n VersionId?: string;\n\n /**\n *Specifies whether the versioned object that was permanently deleted was (true) or was\n * not (false) a delete marker. In a simple DELETE, this header indicates whether (true) or\n * not (false) a delete marker was created.
\n */\n DeleteMarker?: boolean;\n\n /**\n *The version ID of the delete marker created as a result of the DELETE operation. If you\n * delete a specific object version, the value returned by this header is the version ID of\n * the object version deleted.
\n */\n DeleteMarkerVersionId?: string;\n}\n\nexport namespace DeletedObject {\n export const filterSensitiveLog = (obj: DeletedObject): any => ({\n ...obj,\n });\n}\n\n/**\n *Container for all error elements.
\n */\nexport interface _Error {\n /**\n *The error key.
\n */\n Key?: string;\n\n /**\n *The version ID of the error.
\n */\n VersionId?: string;\n\n /**\n *The error code is a string that uniquely identifies an error condition. It is meant to\n * be read and understood by programs that detect and handle errors by type.
\n *\n * Amazon S3 error codes\n *
\n *\n * Code: AccessDenied
\n *\n * Description: Access Denied
\n *\n * HTTP Status Code: 403 Forbidden
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: AccountProblem
\n *\n * Description: There is a problem with your AWS account\n * that prevents the operation from completing successfully. Contact AWS Support\n * for further assistance.
\n *\n * HTTP Status Code: 403 Forbidden
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: AllAccessDisabled
\n *\n * Description: All access to this Amazon S3 resource has been\n * disabled. Contact AWS Support for further assistance.
\n *\n * HTTP Status Code: 403 Forbidden
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: AmbiguousGrantByEmailAddress
\n *\n * Description: The email address you provided is\n * associated with more than one account.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: AuthorizationHeaderMalformed
\n *\n * Description: The authorization header you provided is\n * invalid.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * HTTP Status Code: N/A
\n *\n * Code: BadDigest
\n *\n * Description: The Content-MD5 you specified did not\n * match what we received.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: BucketAlreadyExists
\n *\n * Description: The requested bucket name is not\n * available. The bucket namespace is shared by all users of the system. Please\n * select a different name and try again.
\n *\n * HTTP Status Code: 409 Conflict
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: BucketAlreadyOwnedByYou
\n *\n * Description: The bucket you tried to create already\n * exists, and you own it. Amazon S3 returns this error in all AWS Regions except in\n * the North Virginia Region. For legacy compatibility, if you re-create an\n * existing bucket that you already own in the North Virginia Region, Amazon S3 returns\n * 200 OK and resets the bucket access control lists (ACLs).
\n *\n * Code: 409 Conflict (in all Regions except the North\n * Virginia Region)
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: BucketNotEmpty
\n *\n * Description: The bucket you tried to delete is not\n * empty.
\n *\n * HTTP Status Code: 409 Conflict
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: CredentialsNotSupported
\n *\n * Description: This request does not support\n * credentials.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: CrossLocationLoggingProhibited
\n *\n * Description: Cross-location logging not allowed.\n * Buckets in one geographic location cannot log information to a bucket in\n * another location.
\n *\n * HTTP Status Code: 403 Forbidden
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: EntityTooSmall
\n *\n * Description: Your proposed upload is smaller than the\n * minimum allowed object size.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: EntityTooLarge
\n *\n * Description: Your proposed upload exceeds the maximum\n * allowed object size.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: ExpiredToken
\n *\n * Description: The provided token has expired.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: IllegalVersioningConfigurationException
\n *\n * Description: Indicates that the versioning\n * configuration specified in the request is invalid.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: IncompleteBody
\n *\n * Description: You did not provide the number of bytes\n * specified by the Content-Length HTTP header
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: IncorrectNumberOfFilesInPostRequest
\n *\n * Description: POST requires exactly one file upload per\n * request.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: InlineDataTooLarge
\n *\n * Description: Inline data exceeds the maximum allowed\n * size.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: InternalError
\n *\n * Description: We encountered an internal error. Please\n * try again.
\n *\n * HTTP Status Code: 500 Internal Server Error
\n *\n * SOAP Fault Code Prefix: Server
\n *\n * Code: InvalidAccessKeyId
\n *\n * Description: The AWS access key ID you provided does\n * not exist in our records.
\n *\n * HTTP Status Code: 403 Forbidden
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: InvalidAddressingHeader
\n *\n * Description: You must specify the Anonymous\n * role.
\n *\n * HTTP Status Code: N/A
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: InvalidArgument
\n *\n * Description: Invalid Argument
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: InvalidBucketName
\n *\n * Description: The specified bucket is not valid.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: InvalidBucketState
\n *\n * Description: The request is not valid with the current\n * state of the bucket.
\n *\n * HTTP Status Code: 409 Conflict
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: InvalidDigest
\n *\n * Description: The Content-MD5 you specified is not\n * valid.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: InvalidEncryptionAlgorithmError
\n *\n * Description: The encryption request you specified is\n * not valid. The valid value is AES256.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: InvalidLocationConstraint
\n *\n * Description: The specified location constraint is not\n * valid. For more information about Regions, see How to Select a\n * Region for Your Buckets.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: InvalidObjectState
\n *\n * Description: The operation is not valid for the current\n * state of the object.
\n *\n * HTTP Status Code: 403 Forbidden
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: InvalidPart
\n *\n * Description: One or more of the specified parts could\n * not be found. The part might not have been uploaded, or the specified entity\n * tag might not have matched the part's entity tag.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: InvalidPartOrder
\n *\n * Description: The list of parts was not in ascending\n * order. Parts list must be specified in order by part number.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: InvalidPayer
\n *\n * Description: All access to this object has been\n * disabled. Please contact AWS Support for further assistance.
\n *\n * HTTP Status Code: 403 Forbidden
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: InvalidPolicyDocument
\n *\n * Description: The content of the form does not meet the\n * conditions specified in the policy document.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: InvalidRange
\n *\n * Description: The requested range cannot be\n * satisfied.
\n *\n * HTTP Status Code: 416 Requested Range Not\n * Satisfiable
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: InvalidRequest
\n *\n * Description: Please use AWS4-HMAC-SHA256.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * Code: N/A
\n *\n * Code: InvalidRequest
\n *\n * Description: SOAP requests must be made over an HTTPS\n * connection.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: InvalidRequest
\n *\n * Description: Amazon S3 Transfer Acceleration is not\n * supported for buckets with non-DNS compliant names.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * Code: N/A
\n *\n * Code: InvalidRequest
\n *\n * Description: Amazon S3 Transfer Acceleration is not\n * supported for buckets with periods (.) in their names.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * Code: N/A
\n *\n * Code: InvalidRequest
\n *\n * Description: Amazon S3 Transfer Accelerate endpoint only\n * supports virtual style requests.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * Code: N/A
\n *\n * Code: InvalidRequest
\n *\n * Description: Amazon S3 Transfer Accelerate is not configured\n * on this bucket.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * Code: N/A
\n *\n * Code: InvalidRequest
\n *\n * Description: Amazon S3 Transfer Accelerate is disabled on\n * this bucket.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * Code: N/A
\n *\n * Code: InvalidRequest
\n *\n * Description: Amazon S3 Transfer Acceleration is not\n * supported on this bucket. Contact AWS Support for more information.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * Code: N/A
\n *\n * Code: InvalidRequest
\n *\n * Description: Amazon S3 Transfer Acceleration cannot be\n * enabled on this bucket. Contact AWS Support for more information.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * Code: N/A
\n *\n * Code: InvalidSecurity
\n *\n * Description: The provided security credentials are not\n * valid.
\n *\n * HTTP Status Code: 403 Forbidden
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: InvalidSOAPRequest
\n *\n * Description: The SOAP request body is invalid.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: InvalidStorageClass
\n *\n * Description: The storage class you specified is not\n * valid.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: InvalidTargetBucketForLogging
\n *\n * Description: The target bucket for logging does not\n * exist, is not owned by you, or does not have the appropriate grants for the\n * log-delivery group.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: InvalidToken
\n *\n * Description: The provided token is malformed or\n * otherwise invalid.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: InvalidURI
\n *\n * Description: Couldn't parse the specified URI.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: KeyTooLongError
\n *\n * Description: Your key is too long.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: MalformedACLError
\n *\n * Description: The XML you provided was not well-formed\n * or did not validate against our published schema.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: MalformedPOSTRequest
\n *\n * Description: The body of your POST request is not\n * well-formed multipart/form-data.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: MalformedXML
\n *\n * Description: This happens when the user sends malformed\n * XML (XML that doesn't conform to the published XSD) for the configuration. The\n * error message is, \"The XML you provided was not well-formed or did not validate\n * against our published schema.\"
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: MaxMessageLengthExceeded
\n *\n * Description: Your request was too big.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: MaxPostPreDataLengthExceededError
\n *\n * Description: Your POST request fields preceding the\n * upload file were too large.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: MetadataTooLarge
\n *\n * Description: Your metadata headers exceed the maximum\n * allowed metadata size.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: MethodNotAllowed
\n *\n * Description: The specified method is not allowed\n * against this resource.
\n *\n * HTTP Status Code: 405 Method Not Allowed
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: MissingAttachment
\n *\n * Description: A SOAP attachment was expected, but none\n * were found.
\n *\n * HTTP Status Code: N/A
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: MissingContentLength
\n *\n * Description: You must provide the Content-Length HTTP\n * header.
\n *\n * HTTP Status Code: 411 Length Required
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: MissingRequestBodyError
\n *\n * Description: This happens when the user sends an empty\n * XML document as a request. The error message is, \"Request body is empty.\"\n *
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: MissingSecurityElement
\n *\n * Description: The SOAP 1.1 request is missing a security\n * element.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: MissingSecurityHeader
\n *\n * Description: Your request is missing a required\n * header.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: NoLoggingStatusForKey
\n *\n * Description: There is no such thing as a logging status\n * subresource for a key.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: NoSuchBucket
\n *\n * Description: The specified bucket does not\n * exist.
\n *\n * HTTP Status Code: 404 Not Found
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: NoSuchBucketPolicy
\n *\n * Description: The specified bucket does not have a\n * bucket policy.
\n *\n * HTTP Status Code: 404 Not Found
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: NoSuchKey
\n *\n * Description: The specified key does not exist.
\n *\n * HTTP Status Code: 404 Not Found
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: NoSuchLifecycleConfiguration
\n *\n * Description: The lifecycle configuration does not\n * exist.
\n *\n * HTTP Status Code: 404 Not Found
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: NoSuchUpload
\n *\n * Description: The specified multipart upload does not\n * exist. The upload ID might be invalid, or the multipart upload might have been\n * aborted or completed.
\n *\n * HTTP Status Code: 404 Not Found
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: NoSuchVersion
\n *\n * Description: Indicates that the version ID specified in\n * the request does not match an existing version.
\n *\n * HTTP Status Code: 404 Not Found
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: NotImplemented
\n *\n * Description: A header you provided implies\n * functionality that is not implemented.
\n *\n * HTTP Status Code: 501 Not Implemented
\n *\n * SOAP Fault Code Prefix: Server
\n *\n * Code: NotSignedUp
\n *\n * Description: Your account is not signed up for the Amazon S3\n * service. You must sign up before you can use Amazon S3. You can sign up at the\n * following URL: https://aws.amazon.com/s3
\n *\n * HTTP Status Code: 403 Forbidden
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: OperationAborted
\n *\n * Description: A conflicting conditional operation is\n * currently in progress against this resource. Try again.
\n *\n * HTTP Status Code: 409 Conflict
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: PermanentRedirect
\n *\n * Description: The bucket you are attempting to access\n * must be addressed using the specified endpoint. Send all future requests to\n * this endpoint.
\n *\n * HTTP Status Code: 301 Moved Permanently
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: PreconditionFailed
\n *\n * Description: At least one of the preconditions you\n * specified did not hold.
\n *\n * HTTP Status Code: 412 Precondition Failed
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: Redirect
\n *\n * Description: Temporary redirect.
\n *\n * HTTP Status Code: 307 Moved Temporarily
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: RestoreAlreadyInProgress
\n *\n * Description: Object restore is already in\n * progress.
\n *\n * HTTP Status Code: 409 Conflict
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: RequestIsNotMultiPartContent
\n *\n * Description: Bucket POST must be of the enclosure-type\n * multipart/form-data.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: RequestTimeout
\n *\n * Description: Your socket connection to the server was\n * not read from or written to within the timeout period.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: RequestTimeTooSkewed
\n *\n * Description: The difference between the request time\n * and the server's time is too large.
\n *\n * HTTP Status Code: 403 Forbidden
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: RequestTorrentOfBucketError
\n *\n * Description: Requesting the torrent file of a bucket is\n * not permitted.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: SignatureDoesNotMatch
\n *\n * Description: The request signature we calculated does\n * not match the signature you provided. Check your AWS secret access key and\n * signing method. For more information, see REST Authentication and\n * SOAP Authentication\n * for details.
\n *\n * HTTP Status Code: 403 Forbidden
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: ServiceUnavailable
\n *\n * Description: Reduce your request rate.
\n *\n * HTTP Status Code: 503 Service Unavailable
\n *\n * SOAP Fault Code Prefix: Server
\n *\n * Code: SlowDown
\n *\n * Description: Reduce your request rate.
\n *\n * HTTP Status Code: 503 Slow Down
\n *\n * SOAP Fault Code Prefix: Server
\n *\n * Code: TemporaryRedirect
\n *\n * Description: You are being redirected to the bucket\n * while DNS updates.
\n *\n * HTTP Status Code: 307 Moved Temporarily
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: TokenRefreshRequired
\n *\n * Description: The provided token must be\n * refreshed.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: TooManyBuckets
\n *\n * Description: You have attempted to create more buckets\n * than allowed.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: UnexpectedContent
\n *\n * Description: This request does not support\n * content.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: UnresolvableGrantByEmailAddress
\n *\n * Description: The email address you provided does not\n * match any account on record.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *\n * Code: UserKeyMustBeSpecified
\n *\n * Description: The bucket POST must contain the specified\n * field name. If it is specified, check the order of the fields.
\n *\n * HTTP Status Code: 400 Bad Request
\n *\n * SOAP Fault Code Prefix: Client
\n *The error message contains a generic description of the error condition in English. It\n * is intended for a human audience. Simple programs display the message directly to the end\n * user if they encounter an error condition they don't know how or don't care to handle.\n * Sophisticated programs with more exhaustive error handling and proper internationalization\n * are more likely to ignore the error message.
\n */\n Message?: string;\n}\n\nexport namespace _Error {\n export const filterSensitiveLog = (obj: _Error): any => ({\n ...obj,\n });\n}\n\nexport interface DeleteObjectsOutput {\n /**\n *Container element for a successful delete. It identifies the object that was\n * successfully deleted.
\n */\n Deleted?: DeletedObject[];\n\n /**\n *If present, indicates that the requester was successfully charged for the\n * request.
\n */\n RequestCharged?: RequestCharged | string;\n\n /**\n *Container for a failed delete operation that describes the object that Amazon S3 attempted to\n * delete and the error it encountered.
\n */\n Errors?: _Error[];\n}\n\nexport namespace DeleteObjectsOutput {\n export const filterSensitiveLog = (obj: DeleteObjectsOutput): any => ({\n ...obj,\n });\n}\n\n/**\n *Object Identifier is unique value to identify objects.
\n */\nexport interface ObjectIdentifier {\n /**\n *Key name of the object to delete.
\n */\n Key: string | undefined;\n\n /**\n *VersionId for the specific version of the object to delete.
\n */\n VersionId?: string;\n}\n\nexport namespace ObjectIdentifier {\n export const filterSensitiveLog = (obj: ObjectIdentifier): any => ({\n ...obj,\n });\n}\n\n/**\n *Container for the objects to delete.
\n */\nexport interface Delete {\n /**\n *The objects to delete.
\n */\n Objects: ObjectIdentifier[] | undefined;\n\n /**\n *Element to enable quiet mode for the request. When you add this element, you must set\n * its value to true.
\n */\n Quiet?: boolean;\n}\n\nexport namespace Delete {\n export const filterSensitiveLog = (obj: Delete): any => ({\n ...obj,\n });\n}\n\nexport interface DeleteObjectsRequest {\n /**\n *The bucket name containing the objects to delete.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n *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 Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket: string | undefined;\n\n /**\n *Container for the request.
\n */\n Delete: Delete | undefined;\n\n /**\n *The concatenation of the authentication device's serial number, a space, and the value\n * that is displayed on your authentication device. Required to permanently delete a versioned\n * object if versioning is configured with MFA delete enabled.
\n */\n MFA?: string;\n\n /**\n *Confirms that the requester knows that they will be charged for the request. Bucket\n * owners need not specify this parameter in their requests. For information about downloading\n * objects from requester pays buckets, see Downloading Objects in\n * Requestor Pays Buckets in the Amazon S3 Developer Guide.
\n */\n RequestPayer?: RequestPayer | string;\n\n /**\n *Specifies whether you want to delete this object even if it has a Governance-type Object\n * Lock in place. You must have sufficient permissions to perform this operation.
\n */\n BypassGovernanceRetention?: boolean;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The versionId of the object the tag-set was removed from.
\n */\n VersionId?: string;\n}\n\nexport namespace DeleteObjectTaggingOutput {\n export const filterSensitiveLog = (obj: DeleteObjectTaggingOutput): any => ({\n ...obj,\n });\n}\n\nexport interface DeleteObjectTaggingRequest {\n /**\n *The bucket name containing the objects from which to remove the tags.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n *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 Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket: string | undefined;\n\n /**\n *Name of the object key.
\n */\n Key: string | undefined;\n\n /**\n *The versionId of the object that the tag-set will be removed from.
\n */\n VersionId?: string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The Amazon S3 bucket whose PublicAccessBlock configuration you want to delete.\n *
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The accelerate configuration of the bucket.
\n */\n Status?: BucketAccelerateStatus | string;\n}\n\nexport namespace GetBucketAccelerateConfigurationOutput {\n export const filterSensitiveLog = (obj: GetBucketAccelerateConfigurationOutput): any => ({\n ...obj,\n });\n}\n\nexport interface GetBucketAccelerateConfigurationRequest {\n /**\n *The name of the bucket for which the accelerate configuration is retrieved.
\n */\n Bucket: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Container for the bucket owner's display name and ID.
\n */\n Owner?: Owner;\n\n /**\n *A list of grants.
\n */\n Grants?: Grant[];\n}\n\nexport namespace GetBucketAclOutput {\n export const filterSensitiveLog = (obj: GetBucketAclOutput): any => ({\n ...obj,\n });\n}\n\nexport interface GetBucketAclRequest {\n /**\n *Specifies the S3 bucket whose ACL is being requested.
\n */\n Bucket: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
A container of a key value name pair.
\n */\nexport interface Tag {\n /**\n *Name of the object key.
\n */\n Key: string | undefined;\n\n /**\n *Value of the tag.
\n */\n Value: string | undefined;\n}\n\nexport namespace Tag {\n export const filterSensitiveLog = (obj: Tag): any => ({\n ...obj,\n });\n}\n\n/**\n *A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter.\n * The operator must have at least two predicates in any combination, and an object must match\n * all of the predicates for the filter to apply.
\n */\nexport interface AnalyticsAndOperator {\n /**\n *The prefix to use when evaluating an AND predicate: The prefix that an object must have\n * to be included in the metrics results.
\n */\n Prefix?: string;\n\n /**\n *The list of tags to use when evaluating an AND predicate.
\n */\n Tags?: Tag[];\n}\n\nexport namespace AnalyticsAndOperator {\n export const filterSensitiveLog = (obj: AnalyticsAndOperator): any => ({\n ...obj,\n });\n}\n\n/**\n *The filter used to describe a set of objects for analyses. A filter must have exactly\n * one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided,\n * all objects will be considered in any analysis.
\n */\nexport type AnalyticsFilter =\n | AnalyticsFilter.AndMember\n | AnalyticsFilter.PrefixMember\n | AnalyticsFilter.TagMember\n | AnalyticsFilter.$UnknownMember;\n\nexport namespace AnalyticsFilter {\n /**\n *The prefix to use when evaluating an analytics filter.
\n */\n export interface PrefixMember {\n Prefix: string;\n Tag?: never;\n And?: never;\n $unknown?: never;\n }\n\n /**\n *The tag to use when evaluating an analytics filter.
\n */\n export interface TagMember {\n Prefix?: never;\n Tag: Tag;\n And?: never;\n $unknown?: never;\n }\n\n /**\n *A conjunction (logical AND) of predicates, which is used in evaluating an analytics\n * filter. The operator must have at least two predicates.
\n */\n export interface AndMember {\n Prefix?: never;\n Tag?: never;\n And: AnalyticsAndOperator;\n $unknown?: never;\n }\n\n export interface $UnknownMember {\n Prefix?: never;\n Tag?: never;\n And?: never;\n $unknown: [string, any];\n }\n\n export interface VisitorContains information about where to publish the analytics results.
\n */\nexport interface AnalyticsS3BucketDestination {\n /**\n *Specifies the file format used when exporting data to Amazon S3.
\n */\n Format: AnalyticsS3ExportFileFormat | string | undefined;\n\n /**\n *The account ID that owns the destination S3 bucket. If no account ID is provided, the\n * owner is not validated before exporting data.
\n *Although this value is optional, we strongly recommend that you set it to help\n * prevent problems if the destination bucket ownership changes.
\n *The Amazon Resource Name (ARN) of the bucket to which data is exported.
\n */\n Bucket: string | undefined;\n\n /**\n *The prefix to use when exporting data. The prefix is prepended to all results.
\n */\n Prefix?: string;\n}\n\nexport namespace AnalyticsS3BucketDestination {\n export const filterSensitiveLog = (obj: AnalyticsS3BucketDestination): any => ({\n ...obj,\n });\n}\n\n/**\n *Where to publish the analytics results.
\n */\nexport interface AnalyticsExportDestination {\n /**\n *A destination signifying output to an S3 bucket.
\n */\n S3BucketDestination: AnalyticsS3BucketDestination | undefined;\n}\n\nexport namespace AnalyticsExportDestination {\n export const filterSensitiveLog = (obj: AnalyticsExportDestination): any => ({\n ...obj,\n });\n}\n\nexport type StorageClassAnalysisSchemaVersion = \"V_1\";\n\n/**\n *Container for data related to the storage class analysis for an Amazon S3 bucket for\n * export.
\n */\nexport interface StorageClassAnalysisDataExport {\n /**\n *The version of the output schema to use when exporting data. Must be\n * V_1.
The place to store the data for an analysis.
\n */\n Destination: AnalyticsExportDestination | undefined;\n}\n\nexport namespace StorageClassAnalysisDataExport {\n export const filterSensitiveLog = (obj: StorageClassAnalysisDataExport): any => ({\n ...obj,\n });\n}\n\n/**\n *Specifies data related to access patterns to be collected and made available to analyze\n * the tradeoffs between different storage classes for an Amazon S3 bucket.
\n */\nexport interface StorageClassAnalysis {\n /**\n *Specifies how data related to the storage class analysis for an Amazon S3 bucket should be\n * exported.
\n */\n DataExport?: StorageClassAnalysisDataExport;\n}\n\nexport namespace StorageClassAnalysis {\n export const filterSensitiveLog = (obj: StorageClassAnalysis): any => ({\n ...obj,\n });\n}\n\n/**\n *Specifies the configuration and any analyses for the analytics filter of an Amazon S3\n * bucket.
\n */\nexport interface AnalyticsConfiguration {\n /**\n *The ID that identifies the analytics configuration.
\n */\n Id: string | undefined;\n\n /**\n *The filter used to describe a set of objects for analyses. A filter must have exactly\n * one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided,\n * all objects will be considered in any analysis.
\n */\n Filter?: AnalyticsFilter;\n\n /**\n *Contains data related to access patterns to be collected and made available to analyze\n * the tradeoffs between different storage classes.
\n */\n StorageClassAnalysis: StorageClassAnalysis | undefined;\n}\n\nexport namespace AnalyticsConfiguration {\n export const filterSensitiveLog = (obj: AnalyticsConfiguration): any => ({\n ...obj,\n ...(obj.Filter && { Filter: AnalyticsFilter.filterSensitiveLog(obj.Filter) }),\n });\n}\n\nexport interface GetBucketAnalyticsConfigurationOutput {\n /**\n *The configuration and any analyses for the analytics filter.
\n */\n AnalyticsConfiguration?: AnalyticsConfiguration;\n}\n\nexport namespace GetBucketAnalyticsConfigurationOutput {\n export const filterSensitiveLog = (obj: GetBucketAnalyticsConfigurationOutput): any => ({\n ...obj,\n ...(obj.AnalyticsConfiguration && {\n AnalyticsConfiguration: AnalyticsConfiguration.filterSensitiveLog(obj.AnalyticsConfiguration),\n }),\n });\n}\n\nexport interface GetBucketAnalyticsConfigurationRequest {\n /**\n *The name of the bucket from which an analytics configuration is retrieved.
\n */\n Bucket: string | undefined;\n\n /**\n *The ID that identifies the analytics configuration.
\n */\n Id: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Specifies a cross-origin access rule for an Amazon S3 bucket.
\n */\nexport interface CORSRule {\n /**\n *Headers that are specified in the Access-Control-Request-Headers header.\n * These headers are allowed in a preflight OPTIONS request. In response to any preflight\n * OPTIONS request, Amazon S3 returns any requested headers that are allowed.
An HTTP method that you allow the origin to execute. Valid values are GET,\n * PUT, HEAD, POST, and DELETE.
One or more origins you want customers to be able to access the bucket from.
\n */\n AllowedOrigins: string[] | undefined;\n\n /**\n *One or more headers in the response that you want customers to be able to access from\n * their applications (for example, from a JavaScript XMLHttpRequest\n * object).
The time in seconds that your browser is to cache the preflight response for the\n * specified resource.
\n */\n MaxAgeSeconds?: number;\n}\n\nexport namespace CORSRule {\n export const filterSensitiveLog = (obj: CORSRule): any => ({\n ...obj,\n });\n}\n\nexport interface GetBucketCorsOutput {\n /**\n *A set of origins and methods (cross-origin access that you want to allow). You can add\n * up to 100 rules to the configuration.
\n */\n CORSRules?: CORSRule[];\n}\n\nexport namespace GetBucketCorsOutput {\n export const filterSensitiveLog = (obj: GetBucketCorsOutput): any => ({\n ...obj,\n });\n}\n\nexport interface GetBucketCorsRequest {\n /**\n *The bucket name for which to get the cors configuration.
\n */\n Bucket: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Describes the default server-side encryption to apply to new objects in the bucket. If a\n * PUT Object request doesn't specify any server-side encryption, this default encryption will\n * be applied. For more information, see PUT Bucket encryption in\n * the Amazon Simple Storage Service API Reference.
\n */\nexport interface ServerSideEncryptionByDefault {\n /**\n *Server-side encryption algorithm to use for the default encryption.
\n */\n SSEAlgorithm: ServerSideEncryption | string | undefined;\n\n /**\n *AWS Key Management Service (KMS) customer master key ID to use for the default\n * encryption. This parameter is allowed if and only if SSEAlgorithm is set to\n * aws:kms.
You can specify the key ID or the Amazon Resource Name (ARN) of the CMK. However, if you\n * are using encryption with cross-account operations, you must use a fully qualified CMK ARN.\n * For more information, see Using encryption for cross-account operations.
\n *\n * For example:\n *
\n *Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n *
Key ARN:\n * arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n *
Amazon S3 only supports symmetric CMKs and not asymmetric CMKs. For more information, see\n * Using Symmetric and\n * Asymmetric Keys in the AWS Key Management Service Developer\n * Guide.
\n *Specifies the default server-side encryption configuration.
\n */\nexport interface ServerSideEncryptionRule {\n /**\n *Specifies the default server-side encryption to apply to new objects in the bucket. If a\n * PUT Object request doesn't specify any server-side encryption, this default encryption will\n * be applied.
\n */\n ApplyServerSideEncryptionByDefault?: ServerSideEncryptionByDefault;\n\n /**\n *Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the BucketKeyEnabled element to true causes Amazon S3 to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled.
For more information, see Amazon S3 Bucket Keys in the Amazon Simple Storage Service Developer Guide.
\n */\n BucketKeyEnabled?: boolean;\n}\n\nexport namespace ServerSideEncryptionRule {\n export const filterSensitiveLog = (obj: ServerSideEncryptionRule): any => ({\n ...obj,\n ...(obj.ApplyServerSideEncryptionByDefault && {\n ApplyServerSideEncryptionByDefault: ServerSideEncryptionByDefault.filterSensitiveLog(\n obj.ApplyServerSideEncryptionByDefault\n ),\n }),\n });\n}\n\n/**\n *Specifies the default server-side-encryption configuration.
\n */\nexport interface ServerSideEncryptionConfiguration {\n /**\n *Container for information about a particular server-side encryption configuration\n * rule.
\n */\n Rules: ServerSideEncryptionRule[] | undefined;\n}\n\nexport namespace ServerSideEncryptionConfiguration {\n export const filterSensitiveLog = (obj: ServerSideEncryptionConfiguration): any => ({\n ...obj,\n ...(obj.Rules && { Rules: obj.Rules.map((item) => ServerSideEncryptionRule.filterSensitiveLog(item)) }),\n });\n}\n\nexport interface GetBucketEncryptionOutput {\n /**\n *Specifies the default server-side-encryption configuration.
\n */\n ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;\n}\n\nexport namespace GetBucketEncryptionOutput {\n export const filterSensitiveLog = (obj: GetBucketEncryptionOutput): any => ({\n ...obj,\n ...(obj.ServerSideEncryptionConfiguration && {\n ServerSideEncryptionConfiguration: ServerSideEncryptionConfiguration.filterSensitiveLog(\n obj.ServerSideEncryptionConfiguration\n ),\n }),\n });\n}\n\nexport interface GetBucketEncryptionRequest {\n /**\n *The name of the bucket from which the server-side encryption configuration is\n * retrieved.
\n */\n Bucket: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
A container for specifying S3 Intelligent-Tiering filters. The filters determine the\n * subset of objects to which the rule applies.
\n */\nexport interface IntelligentTieringAndOperator {\n /**\n *An object key name prefix that identifies the subset of objects to which the\n * configuration applies.
\n */\n Prefix?: string;\n\n /**\n *All of these tags must exist in the object's tag set in order for the configuration to\n * apply.
\n */\n Tags?: Tag[];\n}\n\nexport namespace IntelligentTieringAndOperator {\n export const filterSensitiveLog = (obj: IntelligentTieringAndOperator): any => ({\n ...obj,\n });\n}\n\n/**\n *The Filter is used to identify objects that the S3 Intelligent-Tiering\n * configuration applies to.
An object key name prefix that identifies the subset of objects to which the rule\n * applies.
\n */\n Prefix?: string;\n\n /**\n *A container of a key value name pair.
\n */\n Tag?: Tag;\n\n /**\n *A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter.\n * The operator must have at least two predicates, and an object must match all of the\n * predicates in order for the filter to apply.
\n */\n And?: IntelligentTieringAndOperator;\n}\n\nexport namespace IntelligentTieringFilter {\n export const filterSensitiveLog = (obj: IntelligentTieringFilter): any => ({\n ...obj,\n });\n}\n\nexport type IntelligentTieringStatus = \"Disabled\" | \"Enabled\";\n\nexport type IntelligentTieringAccessTier = \"ARCHIVE_ACCESS\" | \"DEEP_ARCHIVE_ACCESS\";\n\n/**\n *The S3 Intelligent-Tiering storage class is designed to optimize storage costs by\n * automatically moving data to the most cost-effective storage access tier, without\n * additional operational overhead.
\n */\nexport interface Tiering {\n /**\n *The number of consecutive days of no access after which an object will be eligible to be\n * transitioned to the corresponding tier. The minimum number of days specified for\n * Archive Access tier must be at least 90 days and Deep Archive Access tier must be at least\n * 180 days. The maximum can be up to 2 years (730 days).
\n */\n Days: number | undefined;\n\n /**\n *S3 Intelligent-Tiering access tier. See Storage class for\n * automatically optimizing frequently and infrequently accessed objects for a list\n * of access tiers in the S3 Intelligent-Tiering storage class.
\n */\n AccessTier: IntelligentTieringAccessTier | string | undefined;\n}\n\nexport namespace Tiering {\n export const filterSensitiveLog = (obj: Tiering): any => ({\n ...obj,\n });\n}\n\n/**\n *Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.
\n *For information about the S3 Intelligent-Tiering storage class, see Storage class for\n * automatically optimizing frequently and infrequently accessed objects.
\n */\nexport interface IntelligentTieringConfiguration {\n /**\n *The ID used to identify the S3 Intelligent-Tiering configuration.
\n */\n Id: string | undefined;\n\n /**\n *Specifies a bucket filter. The configuration only includes objects that meet the\n * filter's criteria.
\n */\n Filter?: IntelligentTieringFilter;\n\n /**\n *Specifies the status of the configuration.
\n */\n Status: IntelligentTieringStatus | string | undefined;\n\n /**\n *Specifies the S3 Intelligent-Tiering storage class tier of the configuration.
\n */\n Tierings: Tiering[] | undefined;\n}\n\nexport namespace IntelligentTieringConfiguration {\n export const filterSensitiveLog = (obj: IntelligentTieringConfiguration): any => ({\n ...obj,\n });\n}\n\nexport interface GetBucketIntelligentTieringConfigurationOutput {\n /**\n *Container for S3 Intelligent-Tiering configuration.
\n */\n IntelligentTieringConfiguration?: IntelligentTieringConfiguration;\n}\n\nexport namespace GetBucketIntelligentTieringConfigurationOutput {\n export const filterSensitiveLog = (obj: GetBucketIntelligentTieringConfigurationOutput): any => ({\n ...obj,\n });\n}\n\nexport interface GetBucketIntelligentTieringConfigurationRequest {\n /**\n *The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.
\n */\n Bucket: string | undefined;\n\n /**\n *The ID used to identify the S3 Intelligent-Tiering configuration.
\n */\n Id: string | undefined;\n}\n\nexport namespace GetBucketIntelligentTieringConfigurationRequest {\n export const filterSensitiveLog = (obj: GetBucketIntelligentTieringConfigurationRequest): any => ({\n ...obj,\n });\n}\n\n/**\n *Specifies the use of SSE-KMS to encrypt delivered inventory reports.
\n */\nexport interface SSEKMS {\n /**\n *Specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed\n * customer master key (CMK) to use for encrypting inventory reports.
\n */\n KeyId: string | undefined;\n}\n\nexport namespace SSEKMS {\n export const filterSensitiveLog = (obj: SSEKMS): any => ({\n ...obj,\n ...(obj.KeyId && { KeyId: SENSITIVE_STRING }),\n });\n}\n\n/**\n *Specifies the use of SSE-S3 to encrypt delivered inventory reports.
\n */\nexport interface SSES3 {}\n\nexport namespace SSES3 {\n export const filterSensitiveLog = (obj: SSES3): any => ({\n ...obj,\n });\n}\n\n/**\n *Contains the type of server-side encryption used to encrypt the inventory\n * results.
\n */\nexport interface InventoryEncryption {\n /**\n *Specifies the use of SSE-S3 to encrypt delivered inventory reports.
\n */\n SSES3?: SSES3;\n\n /**\n *Specifies the use of SSE-KMS to encrypt delivered inventory reports.
\n */\n SSEKMS?: SSEKMS;\n}\n\nexport namespace InventoryEncryption {\n export const filterSensitiveLog = (obj: InventoryEncryption): any => ({\n ...obj,\n ...(obj.SSEKMS && { SSEKMS: SSEKMS.filterSensitiveLog(obj.SSEKMS) }),\n });\n}\n\nexport type InventoryFormat = \"CSV\" | \"ORC\" | \"Parquet\";\n\n/**\n *Contains the bucket name, file format, bucket owner (optional), and prefix (optional)\n * where inventory results are published.
\n */\nexport interface InventoryS3BucketDestination {\n /**\n *The account ID that owns the destination S3 bucket. If no account ID is provided, the\n * owner is not validated before exporting data.
\n *Although this value is optional, we strongly recommend that you set it to help\n * prevent problems if the destination bucket ownership changes.
\n *The Amazon Resource Name (ARN) of the bucket where inventory results will be\n * published.
\n */\n Bucket: string | undefined;\n\n /**\n *Specifies the output format of the inventory results.
\n */\n Format: InventoryFormat | string | undefined;\n\n /**\n *The prefix that is prepended to all inventory results.
\n */\n Prefix?: string;\n\n /**\n *Contains the type of server-side encryption used to encrypt the inventory\n * results.
\n */\n Encryption?: InventoryEncryption;\n}\n\nexport namespace InventoryS3BucketDestination {\n export const filterSensitiveLog = (obj: InventoryS3BucketDestination): any => ({\n ...obj,\n ...(obj.Encryption && { Encryption: InventoryEncryption.filterSensitiveLog(obj.Encryption) }),\n });\n}\n\n/**\n *Specifies the inventory configuration for an Amazon S3 bucket.
\n */\nexport interface InventoryDestination {\n /**\n *Contains the bucket name, file format, bucket owner (optional), and prefix (optional)\n * where inventory results are published.
\n */\n S3BucketDestination: InventoryS3BucketDestination | undefined;\n}\n\nexport namespace InventoryDestination {\n export const filterSensitiveLog = (obj: InventoryDestination): any => ({\n ...obj,\n ...(obj.S3BucketDestination && {\n S3BucketDestination: InventoryS3BucketDestination.filterSensitiveLog(obj.S3BucketDestination),\n }),\n });\n}\n\n/**\n *Specifies an inventory filter. The inventory only includes objects that meet the\n * filter's criteria.
\n */\nexport interface InventoryFilter {\n /**\n *The prefix that an object must have to be included in the inventory results.
\n */\n Prefix: string | undefined;\n}\n\nexport namespace InventoryFilter {\n export const filterSensitiveLog = (obj: InventoryFilter): any => ({\n ...obj,\n });\n}\n\nexport type InventoryIncludedObjectVersions = \"All\" | \"Current\";\n\nexport type InventoryOptionalField =\n | \"ETag\"\n | \"EncryptionStatus\"\n | \"IntelligentTieringAccessTier\"\n | \"IsMultipartUploaded\"\n | \"LastModifiedDate\"\n | \"ObjectLockLegalHoldStatus\"\n | \"ObjectLockMode\"\n | \"ObjectLockRetainUntilDate\"\n | \"ReplicationStatus\"\n | \"Size\"\n | \"StorageClass\";\n\nexport type InventoryFrequency = \"Daily\" | \"Weekly\";\n\n/**\n *Specifies the schedule for generating inventory results.
\n */\nexport interface InventorySchedule {\n /**\n *Specifies how frequently inventory results are produced.
\n */\n Frequency: InventoryFrequency | string | undefined;\n}\n\nexport namespace InventorySchedule {\n export const filterSensitiveLog = (obj: InventorySchedule): any => ({\n ...obj,\n });\n}\n\n/**\n *Specifies the inventory configuration for an Amazon S3 bucket. For more information, see\n * GET Bucket inventory in the Amazon Simple Storage Service API Reference.\n *
\n */\nexport interface InventoryConfiguration {\n /**\n *Contains information about where to publish the inventory results.
\n */\n Destination: InventoryDestination | undefined;\n\n /**\n *Specifies whether the inventory is enabled or disabled. If set to True, an\n * inventory list is generated. If set to False, no inventory list is\n * generated.
Specifies an inventory filter. The inventory only includes objects that meet the\n * filter's criteria.
\n */\n Filter?: InventoryFilter;\n\n /**\n *The ID used to identify the inventory configuration.
\n */\n Id: string | undefined;\n\n /**\n *Object versions to include in the inventory list. If set to All, the list\n * includes all the object versions, which adds the version-related fields\n * VersionId, IsLatest, and DeleteMarker to the\n * list. If set to Current, the list does not contain these version-related\n * fields.
Contains the optional fields that are included in the inventory results.
\n */\n OptionalFields?: (InventoryOptionalField | string)[];\n\n /**\n *Specifies the schedule for generating inventory results.
\n */\n Schedule: InventorySchedule | undefined;\n}\n\nexport namespace InventoryConfiguration {\n export const filterSensitiveLog = (obj: InventoryConfiguration): any => ({\n ...obj,\n ...(obj.Destination && { Destination: InventoryDestination.filterSensitiveLog(obj.Destination) }),\n });\n}\n\nexport interface GetBucketInventoryConfigurationOutput {\n /**\n *Specifies the inventory configuration.
\n */\n InventoryConfiguration?: InventoryConfiguration;\n}\n\nexport namespace GetBucketInventoryConfigurationOutput {\n export const filterSensitiveLog = (obj: GetBucketInventoryConfigurationOutput): any => ({\n ...obj,\n ...(obj.InventoryConfiguration && {\n InventoryConfiguration: InventoryConfiguration.filterSensitiveLog(obj.InventoryConfiguration),\n }),\n });\n}\n\nexport interface GetBucketInventoryConfigurationRequest {\n /**\n *The name of the bucket containing the inventory configuration to retrieve.
\n */\n Bucket: string | undefined;\n\n /**\n *The ID used to identify the inventory configuration.
\n */\n Id: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Container for the expiration for the lifecycle of the object.
\n */\nexport interface LifecycleExpiration {\n /**\n *Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601\n * Format.
\n */\n Date?: Date;\n\n /**\n *Indicates the lifetime, in days, of the objects that are subject to the rule. The value\n * must be a non-zero positive integer.
\n */\n Days?: number;\n\n /**\n *Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set\n * to true, the delete marker will be expired; if set to false the policy takes no action.\n * This cannot be specified with Days or Date in a Lifecycle Expiration Policy.
\n */\n ExpiredObjectDeleteMarker?: boolean;\n}\n\nexport namespace LifecycleExpiration {\n export const filterSensitiveLog = (obj: LifecycleExpiration): any => ({\n ...obj,\n });\n}\n\n/**\n *This is used in a Lifecycle Rule Filter to apply a logical AND to two or more\n * predicates. The Lifecycle Rule will apply to any object matching all of the predicates\n * configured inside the And operator.
\n */\nexport interface LifecycleRuleAndOperator {\n /**\n *Prefix identifying one or more objects to which the rule applies.
\n */\n Prefix?: string;\n\n /**\n *All of these tags must exist in the object's tag set in order for the rule to\n * apply.
\n */\n Tags?: Tag[];\n}\n\nexport namespace LifecycleRuleAndOperator {\n export const filterSensitiveLog = (obj: LifecycleRuleAndOperator): any => ({\n ...obj,\n });\n}\n\n/**\n *The Filter is used to identify objects that a Lifecycle Rule applies to. A\n * Filter must have exactly one of Prefix, Tag, or\n * And specified.
Prefix identifying one or more objects to which the rule applies.
\n */\n export interface PrefixMember {\n Prefix: string;\n Tag?: never;\n And?: never;\n $unknown?: never;\n }\n\n /**\n *This tag must exist in the object's tag set in order for the rule to apply.
\n */\n export interface TagMember {\n Prefix?: never;\n Tag: Tag;\n And?: never;\n $unknown?: never;\n }\n\n /**\n *This is used in a Lifecycle Rule Filter to apply a logical AND to two or more\n * predicates. The Lifecycle Rule will apply to any object matching all of the predicates\n * configured inside the And operator.
\n */\n export interface AndMember {\n Prefix?: never;\n Tag?: never;\n And: LifecycleRuleAndOperator;\n $unknown?: never;\n }\n\n export interface $UnknownMember {\n Prefix?: never;\n Tag?: never;\n And?: never;\n $unknown: [string, any];\n }\n\n export interface VisitorSpecifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently\n * deletes the noncurrent object versions. You set this lifecycle configuration action on a\n * bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent\n * object versions at a specific period in the object's lifetime.
\n */\nexport interface NoncurrentVersionExpiration {\n /**\n *Specifies the number of days an object is noncurrent before Amazon S3 can perform the\n * associated action. For information about the noncurrent days calculations, see How\n * Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple\n * Storage Service Developer Guide.
\n */\n NoncurrentDays?: number;\n}\n\nexport namespace NoncurrentVersionExpiration {\n export const filterSensitiveLog = (obj: NoncurrentVersionExpiration): any => ({\n ...obj,\n });\n}\n\nexport type TransitionStorageClass = \"DEEP_ARCHIVE\" | \"GLACIER\" | \"INTELLIGENT_TIERING\" | \"ONEZONE_IA\" | \"STANDARD_IA\";\n\n/**\n *Container for the transition rule that describes when noncurrent objects transition to\n * the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING,\n * GLACIER, or DEEP_ARCHIVE storage class. If your bucket is\n * versioning-enabled (or versioning is suspended), you can set this action to request that\n * Amazon S3 transition noncurrent object versions to the STANDARD_IA,\n * ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, or\n * DEEP_ARCHIVE storage class at a specific period in the object's\n * lifetime.
Specifies the number of days an object is noncurrent before Amazon S3 can perform the\n * associated action. For information about the noncurrent days calculations, see How\n * Amazon S3 Calculates How Long an Object Has Been Noncurrent in the\n * Amazon Simple Storage Service Developer Guide.
\n */\n NoncurrentDays?: number;\n\n /**\n *The class of storage used to store the object.
\n */\n StorageClass?: TransitionStorageClass | string;\n}\n\nexport namespace NoncurrentVersionTransition {\n export const filterSensitiveLog = (obj: NoncurrentVersionTransition): any => ({\n ...obj,\n });\n}\n\nexport type ExpirationStatus = \"Disabled\" | \"Enabled\";\n\n/**\n *Specifies when an object transitions to a specified storage class. For more information\n * about Amazon S3 lifecycle configuration rules, see Transitioning\n * Objects Using Amazon S3 Lifecycle in the Amazon Simple Storage Service Developer Guide.
\n */\nexport interface Transition {\n /**\n *Indicates when objects are transitioned to the specified storage class. The date value\n * must be in ISO 8601 format. The time is always midnight UTC.
\n */\n Date?: Date;\n\n /**\n *Indicates the number of days after creation when objects are transitioned to the\n * specified storage class. The value must be a positive integer.
\n */\n Days?: number;\n\n /**\n *The storage class to which you want the object to transition.
\n */\n StorageClass?: TransitionStorageClass | string;\n}\n\nexport namespace Transition {\n export const filterSensitiveLog = (obj: Transition): any => ({\n ...obj,\n });\n}\n\n/**\n *A lifecycle rule for individual objects in an Amazon S3 bucket.
\n */\nexport interface LifecycleRule {\n /**\n *Specifies the expiration for the lifecycle of the object in the form of date, days and,\n * whether the object has a delete marker.
\n */\n Expiration?: LifecycleExpiration;\n\n /**\n *Unique identifier for the rule. The value cannot be longer than 255 characters.
\n */\n ID?: string;\n\n /**\n * @deprecated\n *\n *Prefix identifying one or more objects to which the rule applies. This is\n * No longer used; use Filter instead.
The Filter is used to identify objects that a Lifecycle Rule applies to. A\n * Filter must have exactly one of Prefix, Tag, or\n * And specified.
If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not\n * currently being applied.
\n */\n Status: ExpirationStatus | string | undefined;\n\n /**\n *Specifies when an Amazon S3 object transitions to a specified storage class.
\n */\n Transitions?: Transition[];\n\n /**\n *Specifies the transition rule for the lifecycle rule that describes when noncurrent\n * objects transition to a specific storage class. If your bucket is versioning-enabled (or\n * versioning is suspended), you can set this action to request that Amazon S3 transition\n * noncurrent object versions to a specific storage class at a set period in the object's\n * lifetime.
\n */\n NoncurrentVersionTransitions?: NoncurrentVersionTransition[];\n\n /**\n *Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently\n * deletes the noncurrent object versions. You set this lifecycle configuration action on a\n * bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent\n * object versions at a specific period in the object's lifetime.
\n */\n NoncurrentVersionExpiration?: NoncurrentVersionExpiration;\n\n /**\n *Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will\n * wait before permanently removing all parts of the upload. For more information, see \n * Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the\n * Amazon Simple Storage Service Developer Guide.
\n */\n AbortIncompleteMultipartUpload?: AbortIncompleteMultipartUpload;\n}\n\nexport namespace LifecycleRule {\n export const filterSensitiveLog = (obj: LifecycleRule): any => ({\n ...obj,\n ...(obj.Filter && { Filter: LifecycleRuleFilter.filterSensitiveLog(obj.Filter) }),\n });\n}\n\nexport interface GetBucketLifecycleConfigurationOutput {\n /**\n *Container for a lifecycle rule.
\n */\n Rules?: LifecycleRule[];\n}\n\nexport namespace GetBucketLifecycleConfigurationOutput {\n export const filterSensitiveLog = (obj: GetBucketLifecycleConfigurationOutput): any => ({\n ...obj,\n ...(obj.Rules && { Rules: obj.Rules.map((item) => LifecycleRule.filterSensitiveLog(item)) }),\n });\n}\n\nexport interface GetBucketLifecycleConfigurationRequest {\n /**\n *The name of the bucket for which to get the lifecycle information.
\n */\n Bucket: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Specifies the Region where the bucket resides. For a list of all the Amazon S3 supported\n * location constraints by Region, see Regions and Endpoints.\n * Buckets in Region us-east-1 have a LocationConstraint of\n * null.
The name of the bucket for which to get the location.
\n */\n Bucket: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Container for granting information.
\n */\nexport interface TargetGrant {\n /**\n *Container for the person being granted permissions.
\n */\n Grantee?: Grantee;\n\n /**\n *Logging permissions assigned to the grantee for the bucket.
\n */\n Permission?: BucketLogsPermission | string;\n}\n\nexport namespace TargetGrant {\n export const filterSensitiveLog = (obj: TargetGrant): any => ({\n ...obj,\n });\n}\n\n/**\n *Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys\n * for a bucket. For more information, see PUT Bucket logging in the\n * Amazon Simple Storage Service API Reference.
\n */\nexport interface LoggingEnabled {\n /**\n *Specifies the bucket where you want Amazon S3 to store server access logs. You can have your\n * logs delivered to any bucket that you own, including the same bucket that is being logged.\n * You can also configure multiple buckets to deliver their logs to the same target bucket. In\n * this case, you should choose a different TargetPrefix for each source bucket\n * so that the delivered log files can be distinguished by key.
Container for granting information.
\n */\n TargetGrants?: TargetGrant[];\n\n /**\n *A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a\n * single bucket, you can use a prefix to distinguish which log files came from which\n * bucket.
\n */\n TargetPrefix: string | undefined;\n}\n\nexport namespace LoggingEnabled {\n export const filterSensitiveLog = (obj: LoggingEnabled): any => ({\n ...obj,\n });\n}\n\nexport interface GetBucketLoggingOutput {\n /**\n *Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys\n * for a bucket. For more information, see PUT Bucket logging in the\n * Amazon Simple Storage Service API Reference.
\n */\n LoggingEnabled?: LoggingEnabled;\n}\n\nexport namespace GetBucketLoggingOutput {\n export const filterSensitiveLog = (obj: GetBucketLoggingOutput): any => ({\n ...obj,\n });\n}\n\nexport interface GetBucketLoggingRequest {\n /**\n *The bucket name for which to get the logging information.
\n */\n Bucket: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter.\n * The operator must have at least two predicates, and an object must match all of the\n * predicates in order for the filter to apply.
\n */\nexport interface MetricsAndOperator {\n /**\n *The prefix used when evaluating an AND predicate.
\n */\n Prefix?: string;\n\n /**\n *The list of tags used when evaluating an AND predicate.
\n */\n Tags?: Tag[];\n}\n\nexport namespace MetricsAndOperator {\n export const filterSensitiveLog = (obj: MetricsAndOperator): any => ({\n ...obj,\n });\n}\n\n/**\n *Specifies a metrics configuration filter. The metrics configuration only includes\n * objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction\n * (MetricsAndOperator).
\n */\nexport type MetricsFilter =\n | MetricsFilter.AndMember\n | MetricsFilter.PrefixMember\n | MetricsFilter.TagMember\n | MetricsFilter.$UnknownMember;\n\nexport namespace MetricsFilter {\n /**\n *The prefix used when evaluating a metrics filter.
\n */\n export interface PrefixMember {\n Prefix: string;\n Tag?: never;\n And?: never;\n $unknown?: never;\n }\n\n /**\n *The tag used when evaluating a metrics filter.
\n */\n export interface TagMember {\n Prefix?: never;\n Tag: Tag;\n And?: never;\n $unknown?: never;\n }\n\n /**\n *A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter.\n * The operator must have at least two predicates, and an object must match all of the\n * predicates in order for the filter to apply.
\n */\n export interface AndMember {\n Prefix?: never;\n Tag?: never;\n And: MetricsAndOperator;\n $unknown?: never;\n }\n\n export interface $UnknownMember {\n Prefix?: never;\n Tag?: never;\n And?: never;\n $unknown: [string, any];\n }\n\n export interface VisitorSpecifies a metrics configuration for the CloudWatch request metrics (specified by the\n * metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics\n * configuration, note that this is a full replacement of the existing metrics configuration.\n * If you don't include the elements you want to keep, they are erased. For more information,\n * see PUT Bucket\n * metrics in the Amazon Simple Storage Service API Reference.
\n */\nexport interface MetricsConfiguration {\n /**\n *The ID used to identify the metrics configuration.
\n */\n Id: string | undefined;\n\n /**\n *Specifies a metrics configuration filter. The metrics configuration will only include\n * objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction\n * (MetricsAndOperator).
\n */\n Filter?: MetricsFilter;\n}\n\nexport namespace MetricsConfiguration {\n export const filterSensitiveLog = (obj: MetricsConfiguration): any => ({\n ...obj,\n ...(obj.Filter && { Filter: MetricsFilter.filterSensitiveLog(obj.Filter) }),\n });\n}\n\nexport interface GetBucketMetricsConfigurationOutput {\n /**\n *Specifies the metrics configuration.
\n */\n MetricsConfiguration?: MetricsConfiguration;\n}\n\nexport namespace GetBucketMetricsConfigurationOutput {\n export const filterSensitiveLog = (obj: GetBucketMetricsConfigurationOutput): any => ({\n ...obj,\n ...(obj.MetricsConfiguration && {\n MetricsConfiguration: MetricsConfiguration.filterSensitiveLog(obj.MetricsConfiguration),\n }),\n });\n}\n\nexport interface GetBucketMetricsConfigurationRequest {\n /**\n *The name of the bucket containing the metrics configuration to retrieve.
\n */\n Bucket: string | undefined;\n\n /**\n *The ID used to identify the metrics configuration.
\n */\n Id: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The name of the bucket for which to get the notification configuration.
\n */\n Bucket: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix or\n * prefix of the key name.
\n */\nexport interface FilterRule {\n /**\n *The object key name prefix or suffix identifying one or more objects to which the\n * filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and\n * suffixes are not supported. For more information, see Configuring Event Notifications\n * in the Amazon Simple Storage Service Developer Guide.
\n */\n Name?: FilterRuleName | string;\n\n /**\n *The value that the filter searches for in object key names.
\n */\n Value?: string;\n}\n\nexport namespace FilterRule {\n export const filterSensitiveLog = (obj: FilterRule): any => ({\n ...obj,\n });\n}\n\n/**\n *A container for object key name prefix and suffix filtering rules.
\n */\nexport interface S3KeyFilter {\n /**\n *A list of containers for the key-value pair that defines the criteria for the filter\n * rule.
\n */\n FilterRules?: FilterRule[];\n}\n\nexport namespace S3KeyFilter {\n export const filterSensitiveLog = (obj: S3KeyFilter): any => ({\n ...obj,\n });\n}\n\n/**\n *Specifies object key name filtering rules. For information about key name filtering, see\n * Configuring\n * Event Notifications in the Amazon Simple Storage Service Developer\n * Guide.
\n */\nexport interface NotificationConfigurationFilter {\n /**\n *A container for object key name prefix and suffix filtering rules.
\n */\n Key?: S3KeyFilter;\n}\n\nexport namespace NotificationConfigurationFilter {\n export const filterSensitiveLog = (obj: NotificationConfigurationFilter): any => ({\n ...obj,\n });\n}\n\n/**\n *A container for specifying the configuration for AWS Lambda notifications.
\n */\nexport interface LambdaFunctionConfiguration {\n /**\n *An optional unique identifier for configurations in a notification configuration. If you\n * don't provide one, Amazon S3 will assign an ID.
\n */\n Id?: string;\n\n /**\n *The Amazon Resource Name (ARN) of the AWS Lambda function that Amazon S3 invokes when the\n * specified event type occurs.
\n */\n LambdaFunctionArn: string | undefined;\n\n /**\n *The Amazon S3 bucket event for which to invoke the AWS Lambda function. For more information,\n * see Supported\n * Event Types in the Amazon Simple Storage Service Developer Guide.
\n */\n Events: (Event | string)[] | undefined;\n\n /**\n *Specifies object key name filtering rules. For information about key name filtering, see\n * Configuring\n * Event Notifications in the Amazon Simple Storage Service Developer\n * Guide.
\n */\n Filter?: NotificationConfigurationFilter;\n}\n\nexport namespace LambdaFunctionConfiguration {\n export const filterSensitiveLog = (obj: LambdaFunctionConfiguration): any => ({\n ...obj,\n });\n}\n\n/**\n *Specifies the configuration for publishing messages to an Amazon Simple Queue Service\n * (Amazon SQS) queue when Amazon S3 detects specified events.
\n */\nexport interface QueueConfiguration {\n /**\n *An optional unique identifier for configurations in a notification configuration. If you\n * don't provide one, Amazon S3 will assign an ID.
\n */\n Id?: string;\n\n /**\n *The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message\n * when it detects events of the specified type.
\n */\n QueueArn: string | undefined;\n\n /**\n *A collection of bucket events for which to send notifications
\n */\n Events: (Event | string)[] | undefined;\n\n /**\n *Specifies object key name filtering rules. For information about key name filtering, see\n * Configuring\n * Event Notifications in the Amazon Simple Storage Service Developer\n * Guide.
\n */\n Filter?: NotificationConfigurationFilter;\n}\n\nexport namespace QueueConfiguration {\n export const filterSensitiveLog = (obj: QueueConfiguration): any => ({\n ...obj,\n });\n}\n\n/**\n *A container for specifying the configuration for publication of messages to an Amazon\n * Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.
\n */\nexport interface TopicConfiguration {\n /**\n *An optional unique identifier for configurations in a notification configuration. If you\n * don't provide one, Amazon S3 will assign an ID.
\n */\n Id?: string;\n\n /**\n *The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message\n * when it detects events of the specified type.
\n */\n TopicArn: string | undefined;\n\n /**\n *The Amazon S3 bucket event about which to send notifications. For more information, see\n * Supported\n * Event Types in the Amazon Simple Storage Service Developer Guide.
\n */\n Events: (Event | string)[] | undefined;\n\n /**\n *Specifies object key name filtering rules. For information about key name filtering, see\n * Configuring\n * Event Notifications in the Amazon Simple Storage Service Developer\n * Guide.
\n */\n Filter?: NotificationConfigurationFilter;\n}\n\nexport namespace TopicConfiguration {\n export const filterSensitiveLog = (obj: TopicConfiguration): any => ({\n ...obj,\n });\n}\n\n/**\n *A container for specifying the notification configuration of the bucket. If this element\n * is empty, notifications are turned off for the bucket.
\n */\nexport interface NotificationConfiguration {\n /**\n *The topic to which notifications are sent and the events for which notifications are\n * generated.
\n */\n TopicConfigurations?: TopicConfiguration[];\n\n /**\n *The Amazon Simple Queue Service queues to publish messages to and the events for which\n * to publish messages.
\n */\n QueueConfigurations?: QueueConfiguration[];\n\n /**\n *Describes the AWS Lambda functions to invoke and the events for which to invoke\n * them.
\n */\n LambdaFunctionConfigurations?: LambdaFunctionConfiguration[];\n}\n\nexport namespace NotificationConfiguration {\n export const filterSensitiveLog = (obj: NotificationConfiguration): any => ({\n ...obj,\n });\n}\n\nexport type ObjectOwnership = \"BucketOwnerPreferred\" | \"ObjectWriter\";\n\n/**\n *The container element for an ownership control rule.
\n */\nexport interface OwnershipControlsRule {\n /**\n *The container element for object ownership for a bucket's ownership controls.
\n *BucketOwnerPreferred - Objects uploaded to the bucket change ownership to the bucket\n * owner if the objects are uploaded with the bucket-owner-full-control canned\n * ACL.
ObjectWriter - The uploading account will own the object if the object is uploaded with\n * the bucket-owner-full-control canned ACL.
The container element for a bucket's ownership controls.
\n */\nexport interface OwnershipControls {\n /**\n *The container element for an ownership control rule.
\n */\n Rules: OwnershipControlsRule[] | undefined;\n}\n\nexport namespace OwnershipControls {\n export const filterSensitiveLog = (obj: OwnershipControls): any => ({\n ...obj,\n });\n}\n\nexport interface GetBucketOwnershipControlsOutput {\n /**\n *The OwnershipControls (BucketOwnerPreferred or ObjectWriter) currently in\n * effect for this Amazon S3 bucket.
The name of the Amazon S3 bucket whose OwnershipControls you want to retrieve.\n *
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The bucket policy as a JSON document.
\n */\n Policy?: string;\n}\n\nexport namespace GetBucketPolicyOutput {\n export const filterSensitiveLog = (obj: GetBucketPolicyOutput): any => ({\n ...obj,\n });\n}\n\nexport interface GetBucketPolicyRequest {\n /**\n *The bucket name for which to get the bucket policy.
\n */\n Bucket: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The container element for a bucket's policy status.
\n */\nexport interface PolicyStatus {\n /**\n *The policy status for this bucket. TRUE indicates that this bucket is\n * public. FALSE indicates that the bucket is not public.
The policy status for the specified bucket.
\n */\n PolicyStatus?: PolicyStatus;\n}\n\nexport namespace GetBucketPolicyStatusOutput {\n export const filterSensitiveLog = (obj: GetBucketPolicyStatusOutput): any => ({\n ...obj,\n });\n}\n\nexport interface GetBucketPolicyStatusRequest {\n /**\n *The name of the Amazon S3 bucket whose policy status you want to retrieve.
\n */\n Bucket: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Specifies whether Amazon S3 replicates delete markers. If you specify a Filter\n * in your replication configuration, you must also include a\n * DeleteMarkerReplication element. If your Filter includes a\n * Tag element, the DeleteMarkerReplication\n * Status must be set to Disabled, because Amazon S3 does not support replicating\n * delete markers for tag-based rules. For an example configuration, see Basic Rule Configuration.
For more information about delete marker replication, see Basic Rule\n * Configuration.
\n *If you are using an earlier version of the replication configuration, Amazon S3 handles\n * replication of delete markers differently. For more information, see Backward Compatibility.
\n *Indicates whether to replicate delete markers.
\n *Indicates whether to replicate delete markers.
\n *Specifies encryption-related information for an Amazon S3 bucket that is a destination for\n * replicated objects.
\n */\nexport interface EncryptionConfiguration {\n /**\n *Specifies the ID (Key ARN or Alias ARN) of the customer managed customer master key\n * (CMK) stored in AWS Key Management Service (KMS) for the destination bucket. Amazon S3 uses\n * this key to encrypt replica objects. Amazon S3 only supports symmetric customer managed CMKs.\n * For more information, see Using Symmetric and\n * Asymmetric Keys in the AWS Key Management Service Developer\n * Guide.
\n */\n ReplicaKmsKeyID?: string;\n}\n\nexport namespace EncryptionConfiguration {\n export const filterSensitiveLog = (obj: EncryptionConfiguration): any => ({\n ...obj,\n });\n}\n\n/**\n * A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics\n * EventThreshold.
Contains an integer specifying time in minutes.
\n *Valid values: 15 minutes.
\n */\n Minutes?: number;\n}\n\nexport namespace ReplicationTimeValue {\n export const filterSensitiveLog = (obj: ReplicationTimeValue): any => ({\n ...obj,\n });\n}\n\nexport type MetricsStatus = \"Disabled\" | \"Enabled\";\n\n/**\n *A container specifying replication metrics-related settings enabling replication\n * metrics and events.
\n */\nexport interface Metrics {\n /**\n *Specifies whether the replication metrics are enabled.
\n */\n Status: MetricsStatus | string | undefined;\n\n /**\n * A container specifying the time threshold for emitting the\n * s3:Replication:OperationMissedThreshold event.
A container specifying S3 Replication Time Control (S3 RTC) related information, including whether S3 RTC is\n * enabled and the time when all objects and operations on objects must be replicated. Must be\n * specified together with a Metrics block.
Specifies whether the replication time is enabled.
\n */\n Status: ReplicationTimeStatus | string | undefined;\n\n /**\n *A container specifying the time by which replication should be complete for all objects\n * and operations on objects.
\n */\n Time: ReplicationTimeValue | undefined;\n}\n\nexport namespace ReplicationTime {\n export const filterSensitiveLog = (obj: ReplicationTime): any => ({\n ...obj,\n });\n}\n\n/**\n *Specifies information about where to publish analysis or configuration results for an\n * Amazon S3 bucket and S3 Replication Time Control (S3 RTC).
\n */\nexport interface Destination {\n /**\n *The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the\n * results.
\n */\n Bucket: string | undefined;\n\n /**\n *Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to\n * change replica ownership to the AWS account that owns the destination bucket by specifying\n * the AccessControlTranslation property, this is the account ID of the\n * destination bucket owner. For more information, see Replication Additional\n * Configuration: Changing the Replica Owner in the Amazon Simple Storage\n * Service Developer Guide.
The storage class to use when replicating objects, such as S3 Standard or reduced\n * redundancy. By default, Amazon S3 uses the storage class of the source object to create the\n * object replica.
\n *For valid values, see the StorageClass element of the PUT Bucket\n * replication action in the Amazon Simple Storage Service API Reference.
Specify this only in a cross-account scenario (where source and destination bucket\n * owners are not the same), and you want to change replica ownership to the AWS account that\n * owns the destination bucket. If this is not specified in the replication configuration, the\n * replicas are owned by same AWS account that owns the source object.
\n */\n AccessControlTranslation?: AccessControlTranslation;\n\n /**\n *A container that provides information about encryption. If\n * SourceSelectionCriteria is specified, you must specify this element.
A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time\n * when all objects and operations on objects must be replicated. Must be specified together\n * with a Metrics block.
A container specifying replication metrics-related settings enabling replication\n * metrics and events.
\n */\n Metrics?: Metrics;\n}\n\nexport namespace Destination {\n export const filterSensitiveLog = (obj: Destination): any => ({\n ...obj,\n });\n}\n\nexport type ExistingObjectReplicationStatus = \"Disabled\" | \"Enabled\";\n\n/**\n *Optional configuration to replicate existing source bucket objects. For more\n * information, see Replicating Existing Objects in the Amazon S3 Developer Guide.\n *
\n */\nexport interface ExistingObjectReplication {\n /**\n * \n */\n Status: ExistingObjectReplicationStatus | string | undefined;\n}\n\nexport namespace ExistingObjectReplication {\n export const filterSensitiveLog = (obj: ExistingObjectReplication): any => ({\n ...obj,\n });\n}\n\n/**\n *A container for specifying rule filters. The filters determine the subset of objects to\n * which the rule applies. This element is required only if you specify more than one filter.
\n *For example:
\n *If you specify both a Prefix and a Tag filter, wrap\n * these filters in an And tag.
If you specify a filter based on multiple tags, wrap the Tag elements\n * in an And tag
An object key name prefix that identifies the subset of objects to which the rule\n * applies.
\n */\n Prefix?: string;\n\n /**\n *An array of tags containing key and value pairs.
\n */\n Tags?: Tag[];\n}\n\nexport namespace ReplicationRuleAndOperator {\n export const filterSensitiveLog = (obj: ReplicationRuleAndOperator): any => ({\n ...obj,\n });\n}\n\n/**\n *A filter that identifies the subset of objects to which the replication rule applies. A\n * Filter must specify exactly one Prefix, Tag, or\n * an And child element.
An object key name prefix that identifies the subset of objects to which the rule\n * applies.
\n */\n export interface PrefixMember {\n Prefix: string;\n Tag?: never;\n And?: never;\n $unknown?: never;\n }\n\n /**\n *A container for specifying a tag key and value.
\n *The rule applies only to objects that have the tag in their tag set.
\n */\n export interface TagMember {\n Prefix?: never;\n Tag: Tag;\n And?: never;\n $unknown?: never;\n }\n\n /**\n *A container for specifying rule filters. The filters determine the subset of objects to\n * which the rule applies. This element is required only if you specify more than one filter.\n * For example:
\n *If you specify both a Prefix and a Tag filter, wrap\n * these filters in an And tag.
If you specify a filter based on multiple tags, wrap the Tag elements\n * in an And tag.
A filter that you can specify for selection for modifications on replicas. Amazon S3 doesn't\n * replicate replica modifications by default. In the latest version of replication\n * configuration (when Filter is specified), you can specify this element and set\n * the status to Enabled to replicate modifications on replicas.
If you don't specify the Filter element, Amazon S3 assumes that the\n * replication configuration is the earlier version, V1. In the earlier version, this\n * element is not allowed.
Specifies whether Amazon S3 replicates modifications on replicas.
\n */\n Status: ReplicaModificationsStatus | string | undefined;\n}\n\nexport namespace ReplicaModifications {\n export const filterSensitiveLog = (obj: ReplicaModifications): any => ({\n ...obj,\n });\n}\n\nexport type SseKmsEncryptedObjectsStatus = \"Disabled\" | \"Enabled\";\n\n/**\n *A container for filter information for the selection of S3 objects encrypted with AWS\n * KMS.
\n */\nexport interface SseKmsEncryptedObjects {\n /**\n *Specifies whether Amazon S3 replicates objects created with server-side encryption using a\n * customer master key (CMK) stored in AWS Key Management Service.
\n */\n Status: SseKmsEncryptedObjectsStatus | string | undefined;\n}\n\nexport namespace SseKmsEncryptedObjects {\n export const filterSensitiveLog = (obj: SseKmsEncryptedObjects): any => ({\n ...obj,\n });\n}\n\n/**\n *A container that describes additional filters for identifying the source objects that\n * you want to replicate. You can choose to enable or disable the replication of these\n * objects. Currently, Amazon S3 supports only the filter that you can specify for objects created\n * with server-side encryption using a customer master key (CMK) stored in AWS Key Management\n * Service (SSE-KMS).
\n */\nexport interface SourceSelectionCriteria {\n /**\n * A container for filter information for the selection of Amazon S3 objects encrypted with AWS\n * KMS. If you include SourceSelectionCriteria in the replication configuration,\n * this element is required.
A filter that you can specify for selections for modifications on replicas. Amazon S3 doesn't\n * replicate replica modifications by default. In the latest version of replication\n * configuration (when Filter is specified), you can specify this element and set\n * the status to Enabled to replicate modifications on replicas.
If you don't specify the Filter element, Amazon S3 assumes that the\n * replication configuration is the earlier version, V1. In the earlier version, this\n * element is not allowed
Specifies which Amazon S3 objects to replicate and where to store the replicas.
\n */\nexport interface ReplicationRule {\n /**\n *A unique identifier for the rule. The maximum value is 255 characters.
\n */\n ID?: string;\n\n /**\n *The priority indicates which rule has precedence whenever two or more replication rules\n * conflict. Amazon S3 will attempt to replicate objects according to all replication rules.\n * However, if there are two or more rules with the same destination bucket, then objects will\n * be replicated according to the rule with the highest priority. The higher the number, the\n * higher the priority.
\n *For more information, see Replication in the\n * Amazon Simple Storage Service Developer Guide.
\n */\n Priority?: number;\n\n /**\n * @deprecated\n *\n *An object key name prefix that identifies the object or objects to which the rule\n * applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket,\n * specify an empty string.
\n */\n Prefix?: string;\n\n /**\n *A filter that identifies the subset of objects to which the replication rule applies. A\n * Filter must specify exactly one Prefix, Tag, or\n * an And child element.
Specifies whether the rule is enabled.
\n */\n Status: ReplicationRuleStatus | string | undefined;\n\n /**\n *A container that describes additional filters for identifying the source objects that\n * you want to replicate. You can choose to enable or disable the replication of these\n * objects. Currently, Amazon S3 supports only the filter that you can specify for objects created\n * with server-side encryption using a customer master key (CMK) stored in AWS Key Management\n * Service (SSE-KMS).
\n */\n SourceSelectionCriteria?: SourceSelectionCriteria;\n\n /**\n * \n */\n ExistingObjectReplication?: ExistingObjectReplication;\n\n /**\n *A container for information about the replication destination and its configurations\n * including enabling the S3 Replication Time Control (S3 RTC).
\n */\n Destination: Destination | undefined;\n\n /**\n *Specifies whether Amazon S3 replicates delete markers. If you specify a Filter\n * in your replication configuration, you must also include a\n * DeleteMarkerReplication element. If your Filter includes a\n * Tag element, the DeleteMarkerReplication\n * Status must be set to Disabled, because Amazon S3 does not support replicating\n * delete markers for tag-based rules. For an example configuration, see Basic Rule Configuration.
For more information about delete marker replication, see Basic Rule\n * Configuration.
\n *If you are using an earlier version of the replication configuration, Amazon S3 handles\n * replication of delete markers differently. For more information, see Backward Compatibility.
\n *A container for replication rules. You can add up to 1,000 rules. The maximum size of a\n * replication configuration is 2 MB.
\n */\nexport interface ReplicationConfiguration {\n /**\n *The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n * Amazon S3 assumes when replicating objects. For more information, see How to Set Up\n * Replication in the Amazon Simple Storage Service Developer Guide.
\n */\n Role: string | undefined;\n\n /**\n *A container for one or more replication rules. A replication configuration must have at\n * least one rule and can contain a maximum of 1,000 rules.
\n */\n Rules: ReplicationRule[] | undefined;\n}\n\nexport namespace ReplicationConfiguration {\n export const filterSensitiveLog = (obj: ReplicationConfiguration): any => ({\n ...obj,\n ...(obj.Rules && { Rules: obj.Rules.map((item) => ReplicationRule.filterSensitiveLog(item)) }),\n });\n}\n\nexport interface GetBucketReplicationOutput {\n /**\n *A container for replication rules. You can add up to 1,000 rules. The maximum size of a\n * replication configuration is 2 MB.
\n */\n ReplicationConfiguration?: ReplicationConfiguration;\n}\n\nexport namespace GetBucketReplicationOutput {\n export const filterSensitiveLog = (obj: GetBucketReplicationOutput): any => ({\n ...obj,\n ...(obj.ReplicationConfiguration && {\n ReplicationConfiguration: ReplicationConfiguration.filterSensitiveLog(obj.ReplicationConfiguration),\n }),\n });\n}\n\nexport interface GetBucketReplicationRequest {\n /**\n *The bucket name for which to get the replication information.
\n */\n Bucket: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Specifies who pays for the download and request fees.
\n */\n Payer?: Payer | string;\n}\n\nexport namespace GetBucketRequestPaymentOutput {\n export const filterSensitiveLog = (obj: GetBucketRequestPaymentOutput): any => ({\n ...obj,\n });\n}\n\nexport interface GetBucketRequestPaymentRequest {\n /**\n *The name of the bucket for which to get the payment request configuration
\n */\n Bucket: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Contains the tag set.
\n */\n TagSet: Tag[] | undefined;\n}\n\nexport namespace GetBucketTaggingOutput {\n export const filterSensitiveLog = (obj: GetBucketTaggingOutput): any => ({\n ...obj,\n });\n}\n\nexport interface GetBucketTaggingRequest {\n /**\n *The name of the bucket for which to get the tagging information.
\n */\n Bucket: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The versioning state of the bucket.
\n */\n Status?: BucketVersioningStatus | string;\n\n /**\n *Specifies whether MFA delete is enabled in the bucket versioning configuration. This\n * element is only returned if the bucket has been configured with MFA delete. If the bucket\n * has never been so configured, this element is not returned.
\n */\n MFADelete?: MFADeleteStatus | string;\n}\n\nexport namespace GetBucketVersioningOutput {\n export const filterSensitiveLog = (obj: GetBucketVersioningOutput): any => ({\n ...obj,\n });\n}\n\nexport interface GetBucketVersioningRequest {\n /**\n *The name of the bucket for which to get the versioning information.
\n */\n Bucket: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The error information.
\n */\nexport interface ErrorDocument {\n /**\n *The object key name to use when a 4XX class error occurs.
\n */\n Key: string | undefined;\n}\n\nexport namespace ErrorDocument {\n export const filterSensitiveLog = (obj: ErrorDocument): any => ({\n ...obj,\n });\n}\n\n/**\n *Container for the Suffix element.
A suffix that is appended to a request that is for a directory on the website endpoint\n * (for example,if the suffix is index.html and you make a request to samplebucket/images/ the\n * data that is returned will be for the object with the key name images/index.html) The\n * suffix must not be empty and must not include a slash character.
\n */\n Suffix: string | undefined;\n}\n\nexport namespace IndexDocument {\n export const filterSensitiveLog = (obj: IndexDocument): any => ({\n ...obj,\n });\n}\n\nexport type Protocol = \"http\" | \"https\";\n\n/**\n *Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3\n * bucket.
\n */\nexport interface RedirectAllRequestsTo {\n /**\n *Name of the host where requests are redirected.
\n */\n HostName: string | undefined;\n\n /**\n *Protocol to use when redirecting requests. The default is the protocol that is used in\n * the original request.
\n */\n Protocol?: Protocol | string;\n}\n\nexport namespace RedirectAllRequestsTo {\n export const filterSensitiveLog = (obj: RedirectAllRequestsTo): any => ({\n ...obj,\n });\n}\n\n/**\n *A container for describing a condition that must be met for the specified redirect to\n * apply. For example, 1. If request is for pages in the /docs folder, redirect\n * to the /documents folder. 2. If request results in HTTP error 4xx, redirect\n * request to another host where you might process the error.
The HTTP error code when the redirect is applied. In the event of an error, if the error\n * code equals this value, then the specified redirect is applied. Required when parent\n * element Condition is specified and sibling KeyPrefixEquals is not\n * specified. If both are specified, then both must be true for the redirect to be\n * applied.
The object key name prefix when the redirect is applied. For example, to redirect\n * requests for ExamplePage.html, the key prefix will be\n * ExamplePage.html. To redirect request for all pages with the prefix\n * docs/, the key prefix will be /docs, which identifies all\n * objects in the docs/ folder. Required when the parent element\n * Condition is specified and sibling HttpErrorCodeReturnedEquals\n * is not specified. If both conditions are specified, both must be true for the redirect to\n * be applied.
Specifies how requests are redirected. In the event of an error, you can specify a\n * different error code to return.
\n */\nexport interface Redirect {\n /**\n *The host name to use in the redirect request.
\n */\n HostName?: string;\n\n /**\n *The HTTP redirect code to use on the response. Not required if one of the siblings is\n * present.
\n */\n HttpRedirectCode?: string;\n\n /**\n *Protocol to use when redirecting requests. The default is the protocol that is used in\n * the original request.
\n */\n Protocol?: Protocol | string;\n\n /**\n *The object key prefix to use in the redirect request. For example, to redirect requests\n * for all pages with prefix docs/ (objects in the docs/ folder) to\n * documents/, you can set a condition block with KeyPrefixEquals\n * set to docs/ and in the Redirect set ReplaceKeyPrefixWith to\n * /documents. Not required if one of the siblings is present. Can be present\n * only if ReplaceKeyWith is not provided.
The specific object key to use in the redirect request. For example, redirect request to\n * error.html. Not required if one of the siblings is present. Can be present\n * only if ReplaceKeyPrefixWith is not provided.
Specifies the redirect behavior and when a redirect is applied. For more information\n * about routing rules, see Configuring advanced conditional redirects in the\n * Amazon Simple Storage Service Developer Guide.
\n */\nexport interface RoutingRule {\n /**\n *A container for describing a condition that must be met for the specified redirect to\n * apply. For example, 1. If request is for pages in the /docs folder, redirect\n * to the /documents folder. 2. If request results in HTTP error 4xx, redirect\n * request to another host where you might process the error.
Container for redirect information. You can redirect requests to another host, to\n * another page, or with another protocol. In the event of an error, you can specify a\n * different error code to return.
\n */\n Redirect: Redirect | undefined;\n}\n\nexport namespace RoutingRule {\n export const filterSensitiveLog = (obj: RoutingRule): any => ({\n ...obj,\n });\n}\n\nexport interface GetBucketWebsiteOutput {\n /**\n *Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3\n * bucket.
\n */\n RedirectAllRequestsTo?: RedirectAllRequestsTo;\n\n /**\n *The name of the index document for the website (for example\n * index.html).
The object key name of the website error document to use for 4XX class errors.
\n */\n ErrorDocument?: ErrorDocument;\n\n /**\n *Rules that define when a redirect is applied and the redirect behavior.
\n */\n RoutingRules?: RoutingRule[];\n}\n\nexport namespace GetBucketWebsiteOutput {\n export const filterSensitiveLog = (obj: GetBucketWebsiteOutput): any => ({\n ...obj,\n });\n}\n\nexport interface GetBucketWebsiteRequest {\n /**\n *The bucket name for which to get the website configuration.
\n */\n Bucket: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Object data.
\n */\n Body?: Readable | ReadableStream | Blob;\n\n /**\n *Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If\n * false, this response header does not appear in the response.
\n */\n DeleteMarker?: boolean;\n\n /**\n *Indicates that a range of bytes was specified.
\n */\n AcceptRanges?: string;\n\n /**\n *If the object expiration is configured (see PUT Bucket lifecycle), the response includes\n * this header. It includes the expiry-date and rule-id key-value pairs providing object\n * expiration information. The value of the rule-id is URL encoded.
\n */\n Expiration?: string;\n\n /**\n *Provides information about object restoration operation and expiration time of the\n * restored object copy.
\n */\n Restore?: string;\n\n /**\n *Last modified date of the object
\n */\n LastModified?: Date;\n\n /**\n *Size of the body in bytes.
\n */\n ContentLength?: number;\n\n /**\n *An ETag is an opaque identifier assigned by a web server to a specific version of a\n * resource found at a URL.
\n */\n ETag?: string;\n\n /**\n *This is set to the number of metadata entries not returned in x-amz-meta\n * headers. This can happen if you create metadata using an API like SOAP that supports more\n * flexible metadata than the REST API. For example, using SOAP, you can create metadata whose\n * values are not legal HTTP headers.
Version of the object.
\n */\n VersionId?: string;\n\n /**\n *Specifies caching behavior along the request/reply chain.
\n */\n CacheControl?: string;\n\n /**\n *Specifies presentational information for the object.
\n */\n ContentDisposition?: string;\n\n /**\n *Specifies what content encodings have been applied to the object and thus what decoding\n * mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n * field.
\n */\n ContentEncoding?: string;\n\n /**\n *The language the content is in.
\n */\n ContentLanguage?: string;\n\n /**\n *The portion of the object returned in the response.
\n */\n ContentRange?: string;\n\n /**\n *A standard MIME type describing the format of the object data.
\n */\n ContentType?: string;\n\n /**\n *The date and time at which the object is no longer cacheable.
\n */\n Expires?: Date;\n\n /**\n *If the bucket is configured as a website, redirects requests for this object to another\n * object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n * the object metadata.
\n */\n WebsiteRedirectLocation?: string;\n\n /**\n *The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n * AES256, aws:kms).
\n */\n ServerSideEncryption?: ServerSideEncryption | string;\n\n /**\n *A map of metadata to store with the object in S3.
\n */\n Metadata?: { [key: string]: string };\n\n /**\n *If server-side encryption with a customer-provided encryption key was requested, the\n * response will include this header confirming the encryption algorithm used.
\n */\n SSECustomerAlgorithm?: string;\n\n /**\n *If server-side encryption with a customer-provided encryption key was requested, the\n * response will include this header to provide round-trip message integrity verification of\n * the customer-provided encryption key.
\n */\n SSECustomerKeyMD5?: string;\n\n /**\n *If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n * customer managed customer master key (CMK) that was used for the object.
\n */\n SSEKMSKeyId?: string;\n\n /**\n *Indicates whether the object uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).
\n */\n BucketKeyEnabled?: boolean;\n\n /**\n *Provides storage class information of the object. Amazon S3 returns this header for all\n * objects except for S3 Standard storage class objects.
\n */\n StorageClass?: StorageClass | string;\n\n /**\n *If present, indicates that the requester was successfully charged for the\n * request.
\n */\n RequestCharged?: RequestCharged | string;\n\n /**\n *Amazon S3 can return this if your request involves a bucket that is either a source or\n * destination in a replication rule.
\n */\n ReplicationStatus?: ReplicationStatus | string;\n\n /**\n *The count of parts this object has.
\n */\n PartsCount?: number;\n\n /**\n *The number of tags, if any, on the object.
\n */\n TagCount?: number;\n\n /**\n *The Object Lock mode currently in place for this object.
\n */\n ObjectLockMode?: ObjectLockMode | string;\n\n /**\n *The date and time when this object's Object Lock will expire.
\n */\n ObjectLockRetainUntilDate?: Date;\n\n /**\n *Indicates whether this object has an active legal hold. This field is only returned if\n * you have permission to view an object's legal hold status.
\n */\n ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus | string;\n}\n\nexport namespace GetObjectOutput {\n export const filterSensitiveLog = (obj: GetObjectOutput): any => ({\n ...obj,\n ...(obj.SSEKMSKeyId && { SSEKMSKeyId: SENSITIVE_STRING }),\n });\n}\n\nexport interface GetObjectRequest {\n /**\n *The bucket name containing the object.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n *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 Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket: string | undefined;\n\n /**\n *Return the object only if its entity tag (ETag) is the same as the one specified,\n * otherwise return a 412 (precondition failed).
\n */\n IfMatch?: string;\n\n /**\n *Return the object only if it has been modified since the specified time, otherwise\n * return a 304 (not modified).
\n */\n IfModifiedSince?: Date;\n\n /**\n *Return the object only if its entity tag (ETag) is different from the one specified,\n * otherwise return a 304 (not modified).
\n */\n IfNoneMatch?: string;\n\n /**\n *Return the object only if it has not been modified since the specified time, otherwise\n * return a 412 (precondition failed).
\n */\n IfUnmodifiedSince?: Date;\n\n /**\n *Key of the object to get.
\n */\n Key: string | undefined;\n\n /**\n *Downloads the specified range bytes of an object. For more information about the HTTP\n * Range header, see https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
\n *Amazon S3 doesn't support retrieving multiple ranges of data per GET\n * request.
Sets the Cache-Control header of the response.
Sets the Content-Disposition header of the response
Sets the Content-Encoding header of the response.
Sets the Content-Language header of the response.
Sets the Content-Type header of the response.
Sets the Expires header of the response.
VersionId used to reference a specific version of the object.
\n */\n VersionId?: string;\n\n /**\n *Specifies the algorithm to use to when encrypting the object (for example,\n * AES256).
\n */\n SSECustomerAlgorithm?: string;\n\n /**\n *Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n * value is used to store the object and then it is discarded; Amazon S3 does not store the\n * encryption key. The key must be appropriate for use with the algorithm specified in the\n * x-amz-server-side-encryption-customer-algorithm header.
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n * this header for a message integrity check to ensure that the encryption key was transmitted\n * without error.
\n */\n SSECustomerKeyMD5?: string;\n\n /**\n *Confirms that the requester knows that they will be charged for the request. Bucket\n * owners need not specify this parameter in their requests. For information about downloading\n * objects from requester pays buckets, see Downloading Objects in\n * Requestor Pays Buckets in the Amazon S3 Developer Guide.
\n */\n RequestPayer?: RequestPayer | string;\n\n /**\n *Part number of the object being read. This is a positive integer between 1 and 10,000.\n * Effectively performs a 'ranged' GET request for the part specified. Useful for downloading\n * just a part of an object.
\n */\n PartNumber?: number;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Object is archived and inaccessible until restored.
\n */\nexport interface InvalidObjectState extends __SmithyException, $MetadataBearer {\n name: \"InvalidObjectState\";\n $fault: \"client\";\n StorageClass?: StorageClass | string;\n AccessTier?: IntelligentTieringAccessTier | string;\n}\n\nexport namespace InvalidObjectState {\n export const filterSensitiveLog = (obj: InvalidObjectState): any => ({\n ...obj,\n });\n}\n\n/**\n *The specified key does not exist.
\n */\nexport interface NoSuchKey extends __SmithyException, $MetadataBearer {\n name: \"NoSuchKey\";\n $fault: \"client\";\n}\n\nexport namespace NoSuchKey {\n export const filterSensitiveLog = (obj: NoSuchKey): any => ({\n ...obj,\n });\n}\n\nexport interface GetObjectAclOutput {\n /**\n *Container for the bucket owner's display name and ID.
\n */\n Owner?: Owner;\n\n /**\n *A list of grants.
\n */\n Grants?: Grant[];\n\n /**\n *If present, indicates that the requester was successfully charged for the\n * request.
\n */\n RequestCharged?: RequestCharged | string;\n}\n\nexport namespace GetObjectAclOutput {\n export const filterSensitiveLog = (obj: GetObjectAclOutput): any => ({\n ...obj,\n });\n}\n\nexport interface GetObjectAclRequest {\n /**\n *The bucket name that contains the object for which to get the ACL information.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket: string | undefined;\n\n /**\n *The key of the object for which to get the ACL information.
\n */\n Key: string | undefined;\n\n /**\n *VersionId used to reference a specific version of the object.
\n */\n VersionId?: string;\n\n /**\n *Confirms that the requester knows that they will be charged for the request. Bucket\n * owners need not specify this parameter in their requests. For information about downloading\n * objects from requester pays buckets, see Downloading Objects in\n * Requestor Pays Buckets in the Amazon S3 Developer Guide.
\n */\n RequestPayer?: RequestPayer | string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
A Legal Hold configuration for an object.
\n */\nexport interface ObjectLockLegalHold {\n /**\n *Indicates whether the specified object has a Legal Hold in place.
\n */\n Status?: ObjectLockLegalHoldStatus | string;\n}\n\nexport namespace ObjectLockLegalHold {\n export const filterSensitiveLog = (obj: ObjectLockLegalHold): any => ({\n ...obj,\n });\n}\n\nexport interface GetObjectLegalHoldOutput {\n /**\n *The current Legal Hold status for the specified object.
\n */\n LegalHold?: ObjectLockLegalHold;\n}\n\nexport namespace GetObjectLegalHoldOutput {\n export const filterSensitiveLog = (obj: GetObjectLegalHoldOutput): any => ({\n ...obj,\n });\n}\n\nexport interface GetObjectLegalHoldRequest {\n /**\n *The bucket name containing the object whose Legal Hold status you want to retrieve.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket: string | undefined;\n\n /**\n *The key name for the object whose Legal Hold status you want to retrieve.
\n */\n Key: string | undefined;\n\n /**\n *The version ID of the object whose Legal Hold status you want to retrieve.
\n */\n VersionId?: string;\n\n /**\n *Confirms that the requester knows that they will be charged for the request. Bucket\n * owners need not specify this parameter in their requests. For information about downloading\n * objects from requester pays buckets, see Downloading Objects in\n * Requestor Pays Buckets in the Amazon S3 Developer Guide.
\n */\n RequestPayer?: RequestPayer | string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The container element for specifying the default Object Lock retention settings for new\n * objects placed in the specified bucket.
\n */\nexport interface DefaultRetention {\n /**\n *The default Object Lock retention mode you want to apply to new objects placed in the\n * specified bucket.
\n */\n Mode?: ObjectLockRetentionMode | string;\n\n /**\n *The number of days that you want to specify for the default retention period.
\n */\n Days?: number;\n\n /**\n *The number of years that you want to specify for the default retention period.
\n */\n Years?: number;\n}\n\nexport namespace DefaultRetention {\n export const filterSensitiveLog = (obj: DefaultRetention): any => ({\n ...obj,\n });\n}\n\n/**\n *The container element for an Object Lock rule.
\n */\nexport interface ObjectLockRule {\n /**\n *The default retention period that you want to apply to new objects placed in the\n * specified bucket.
\n */\n DefaultRetention?: DefaultRetention;\n}\n\nexport namespace ObjectLockRule {\n export const filterSensitiveLog = (obj: ObjectLockRule): any => ({\n ...obj,\n });\n}\n\n/**\n *The container element for Object Lock configuration parameters.
\n */\nexport interface ObjectLockConfiguration {\n /**\n *Indicates whether this bucket has an Object Lock configuration enabled.
\n */\n ObjectLockEnabled?: ObjectLockEnabled | string;\n\n /**\n *The Object Lock rule in place for the specified object.
\n */\n Rule?: ObjectLockRule;\n}\n\nexport namespace ObjectLockConfiguration {\n export const filterSensitiveLog = (obj: ObjectLockConfiguration): any => ({\n ...obj,\n });\n}\n\nexport interface GetObjectLockConfigurationOutput {\n /**\n *The specified bucket's Object Lock configuration.
\n */\n ObjectLockConfiguration?: ObjectLockConfiguration;\n}\n\nexport namespace GetObjectLockConfigurationOutput {\n export const filterSensitiveLog = (obj: GetObjectLockConfigurationOutput): any => ({\n ...obj,\n });\n}\n\nexport interface GetObjectLockConfigurationRequest {\n /**\n *The bucket whose Object Lock configuration you want to retrieve.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
A Retention configuration for an object.
\n */\nexport interface ObjectLockRetention {\n /**\n *Indicates the Retention mode for the specified object.
\n */\n Mode?: ObjectLockRetentionMode | string;\n\n /**\n *The date on which this Object Lock Retention will expire.
\n */\n RetainUntilDate?: Date;\n}\n\nexport namespace ObjectLockRetention {\n export const filterSensitiveLog = (obj: ObjectLockRetention): any => ({\n ...obj,\n });\n}\n\nexport interface GetObjectRetentionOutput {\n /**\n *The container element for an object's retention settings.
\n */\n Retention?: ObjectLockRetention;\n}\n\nexport namespace GetObjectRetentionOutput {\n export const filterSensitiveLog = (obj: GetObjectRetentionOutput): any => ({\n ...obj,\n });\n}\n\nexport interface GetObjectRetentionRequest {\n /**\n *The bucket name containing the object whose retention settings you want to retrieve.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket: string | undefined;\n\n /**\n *The key name for the object whose retention settings you want to retrieve.
\n */\n Key: string | undefined;\n\n /**\n *The version ID for the object whose retention settings you want to retrieve.
\n */\n VersionId?: string;\n\n /**\n *Confirms that the requester knows that they will be charged for the request. Bucket\n * owners need not specify this parameter in their requests. For information about downloading\n * objects from requester pays buckets, see Downloading Objects in\n * Requestor Pays Buckets in the Amazon S3 Developer Guide.
\n */\n RequestPayer?: RequestPayer | string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The versionId of the object for which you got the tagging information.
\n */\n VersionId?: string;\n\n /**\n *Contains the tag set.
\n */\n TagSet: Tag[] | undefined;\n}\n\nexport namespace GetObjectTaggingOutput {\n export const filterSensitiveLog = (obj: GetObjectTaggingOutput): any => ({\n ...obj,\n });\n}\n\nexport interface GetObjectTaggingRequest {\n /**\n *The bucket name containing the object for which to get the tagging information.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n *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 Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket: string | undefined;\n\n /**\n *Object key for which to get the tagging information.
\n */\n Key: string | undefined;\n\n /**\n *The versionId of the object for which to get the tagging information.
\n */\n VersionId?: string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
A Bencoded dictionary as defined by the BitTorrent specification
\n */\n Body?: Readable | ReadableStream | Blob;\n\n /**\n *If present, indicates that the requester was successfully charged for the\n * request.
\n */\n RequestCharged?: RequestCharged | string;\n}\n\nexport namespace GetObjectTorrentOutput {\n export const filterSensitiveLog = (obj: GetObjectTorrentOutput): any => ({\n ...obj,\n });\n}\n\nexport interface GetObjectTorrentRequest {\n /**\n *The name of the bucket containing the object for which to get the torrent files.
\n */\n Bucket: string | undefined;\n\n /**\n *The object key for which to get the information.
\n */\n Key: string | undefined;\n\n /**\n *Confirms that the requester knows that they will be charged for the request. Bucket\n * owners need not specify this parameter in their requests. For information about downloading\n * objects from requester pays buckets, see Downloading Objects in\n * Requestor Pays Buckets in the Amazon S3 Developer Guide.
\n */\n RequestPayer?: RequestPayer | string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can\n * enable the configuration options in any combination. For more information about when Amazon S3\n * considers a bucket or object public, see The Meaning of \"Public\" in the Amazon Simple Storage Service Developer Guide.
\n */\nexport interface PublicAccessBlockConfiguration {\n /**\n *Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket\n * and objects in this bucket. Setting this element to TRUE causes the following\n * behavior:
PUT Bucket acl and PUT Object acl calls fail if the specified ACL is\n * public.
\n *PUT Object calls fail if the request includes a public ACL.
\n *PUT Bucket calls fail if the request includes a public ACL.
\n *Enabling this setting doesn't affect existing policies or ACLs.
\n */\n BlockPublicAcls?: boolean;\n\n /**\n *Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this\n * bucket. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on\n * this bucket and objects in this bucket.
Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't\n * prevent new public ACLs from being set.
\n */\n IgnorePublicAcls?: boolean;\n\n /**\n *Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this\n * element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the\n * specified bucket policy allows public access.
Enabling this setting doesn't affect existing bucket policies.
\n */\n BlockPublicPolicy?: boolean;\n\n /**\n *Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting\n * this element to TRUE restricts access to this bucket to only AWS service\n * principals and authorized users within this account if the bucket has a public\n * policy.
Enabling this setting doesn't affect previously stored bucket policies, except that\n * public and cross-account access within any public bucket policy, including non-public\n * delegation to specific accounts, is blocked.
\n */\n RestrictPublicBuckets?: boolean;\n}\n\nexport namespace PublicAccessBlockConfiguration {\n export const filterSensitiveLog = (obj: PublicAccessBlockConfiguration): any => ({\n ...obj,\n });\n}\n\nexport interface GetPublicAccessBlockOutput {\n /**\n *The PublicAccessBlock configuration currently in effect for this Amazon S3\n * bucket.
The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want\n * to retrieve.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The bucket name.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n *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 Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The specified bucket does not exist.
\n */\nexport interface NoSuchBucket extends __SmithyException, $MetadataBearer {\n name: \"NoSuchBucket\";\n $fault: \"client\";\n}\n\nexport namespace NoSuchBucket {\n export const filterSensitiveLog = (obj: NoSuchBucket): any => ({\n ...obj,\n });\n}\n\nexport type ArchiveStatus = \"ARCHIVE_ACCESS\" | \"DEEP_ARCHIVE_ACCESS\";\n\nexport interface HeadObjectOutput {\n /**\n *Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If\n * false, this response header does not appear in the response.
\n */\n DeleteMarker?: boolean;\n\n /**\n *Indicates that a range of bytes was specified.
\n */\n AcceptRanges?: string;\n\n /**\n *If the object expiration is configured (see PUT Bucket lifecycle), the response includes\n * this header. It includes the expiry-date and rule-id key-value pairs providing object\n * expiration information. The value of the rule-id is URL encoded.
\n */\n Expiration?: string;\n\n /**\n *If the object is an archived object (an object whose storage class is GLACIER), the\n * response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.
\n *\n *If an archive copy is already restored, the header value indicates when Amazon S3 is\n * scheduled to delete the object copy. For example:
\n *\n *\n * x-amz-restore: ongoing-request=\"false\", expiry-date=\"Fri, 23 Dec 2012 00:00:00\n * GMT\"\n *
If the object restoration is in progress, the header returns the value\n * ongoing-request=\"true\".
For more information about archiving objects, see Transitioning Objects: General Considerations.
\n */\n Restore?: string;\n\n /**\n *The archive state of the head object.
\n */\n ArchiveStatus?: ArchiveStatus | string;\n\n /**\n *Last modified date of the object
\n */\n LastModified?: Date;\n\n /**\n *Size of the body in bytes.
\n */\n ContentLength?: number;\n\n /**\n *An ETag is an opaque identifier assigned by a web server to a specific version of a\n * resource found at a URL.
\n */\n ETag?: string;\n\n /**\n *This is set to the number of metadata entries not returned in x-amz-meta\n * headers. This can happen if you create metadata using an API like SOAP that supports more\n * flexible metadata than the REST API. For example, using SOAP, you can create metadata whose\n * values are not legal HTTP headers.
Version of the object.
\n */\n VersionId?: string;\n\n /**\n *Specifies caching behavior along the request/reply chain.
\n */\n CacheControl?: string;\n\n /**\n *Specifies presentational information for the object.
\n */\n ContentDisposition?: string;\n\n /**\n *Specifies what content encodings have been applied to the object and thus what decoding\n * mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n * field.
\n */\n ContentEncoding?: string;\n\n /**\n *The language the content is in.
\n */\n ContentLanguage?: string;\n\n /**\n *A standard MIME type describing the format of the object data.
\n */\n ContentType?: string;\n\n /**\n *The date and time at which the object is no longer cacheable.
\n */\n Expires?: Date;\n\n /**\n *If the bucket is configured as a website, redirects requests for this object to another\n * object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n * the object metadata.
\n */\n WebsiteRedirectLocation?: string;\n\n /**\n *If the object is stored using server-side encryption either with an AWS KMS customer\n * master key (CMK) or an Amazon S3-managed encryption key, the response includes this header with\n * the value of the server-side encryption algorithm used when storing this object in Amazon\n * S3 (for example, AES256, aws:kms).
\n */\n ServerSideEncryption?: ServerSideEncryption | string;\n\n /**\n *A map of metadata to store with the object in S3.
\n */\n Metadata?: { [key: string]: string };\n\n /**\n *If server-side encryption with a customer-provided encryption key was requested, the\n * response will include this header confirming the encryption algorithm used.
\n */\n SSECustomerAlgorithm?: string;\n\n /**\n *If server-side encryption with a customer-provided encryption key was requested, the\n * response will include this header to provide round-trip message integrity verification of\n * the customer-provided encryption key.
\n */\n SSECustomerKeyMD5?: string;\n\n /**\n *If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n * customer managed customer master key (CMK) that was used for the object.
\n */\n SSEKMSKeyId?: string;\n\n /**\n *Indicates whether the object uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).
\n */\n BucketKeyEnabled?: boolean;\n\n /**\n *Provides storage class information of the object. Amazon S3 returns this header for all\n * objects except for S3 Standard storage class objects.
\n *\n *For more information, see Storage\n * Classes.
\n */\n StorageClass?: StorageClass | string;\n\n /**\n *If present, indicates that the requester was successfully charged for the\n * request.
\n */\n RequestCharged?: RequestCharged | string;\n\n /**\n *Amazon S3 can return this header if your request involves a bucket that is either a source or\n * a destination in a replication rule.
\n *\n *In replication, you have a source bucket on which you configure replication and\n * destination bucket or buckets where Amazon S3 stores object replicas. When you request an object\n * (GetObject) or object metadata (HeadObject) from these\n * buckets, Amazon S3 will return the x-amz-replication-status header in the response\n * as follows:
If requesting an object from the source bucket — Amazon S3 will return the\n * x-amz-replication-status header if the object in your request is\n * eligible for replication.
For example, suppose that in your replication configuration, you specify object\n * prefix TaxDocs requesting Amazon S3 to replicate objects with key prefix\n * TaxDocs. Any objects you upload with this key name prefix, for\n * example TaxDocs/document1.pdf, are eligible for replication. For any\n * object request with this key name prefix, Amazon S3 will return the\n * x-amz-replication-status header with value PENDING, COMPLETED or\n * FAILED indicating object replication status.
If requesting an object from a destination bucket — Amazon S3 will return the\n * x-amz-replication-status header with value REPLICA if the object in\n * your request is a replica that Amazon S3 created and there is no replica modification\n * replication in progress.
When replicating objects to multiple destination buckets the\n * x-amz-replication-status header acts differently. The header of the\n * source object will only return a value of COMPLETED when replication is successful to\n * all destinations. The header will remain at value PENDING until replication has\n * completed for all destinations. If one or more destinations fails replication the\n * header will return FAILED.
For more information, see Replication.
\n */\n ReplicationStatus?: ReplicationStatus | string;\n\n /**\n *The count of parts this object has.
\n */\n PartsCount?: number;\n\n /**\n *The Object Lock mode, if any, that's in effect for this object. This header is only\n * returned if the requester has the s3:GetObjectRetention permission. For more\n * information about S3 Object Lock, see Object\n * Lock.
The date and time when the Object Lock retention period expires. This header is only\n * returned if the requester has the s3:GetObjectRetention permission.
Specifies whether a legal hold is in effect for this object. This header is only\n * returned if the requester has the s3:GetObjectLegalHold permission. This\n * header is not returned if the specified version of this object has never had a legal hold\n * applied. For more information about S3 Object Lock, see Object Lock.
The name of the bucket containing the object.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n *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 Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket: string | undefined;\n\n /**\n *Return the object only if its entity tag (ETag) is the same as the one specified,\n * otherwise return a 412 (precondition failed).
\n */\n IfMatch?: string;\n\n /**\n *Return the object only if it has been modified since the specified time, otherwise\n * return a 304 (not modified).
\n */\n IfModifiedSince?: Date;\n\n /**\n *Return the object only if its entity tag (ETag) is different from the one specified,\n * otherwise return a 304 (not modified).
\n */\n IfNoneMatch?: string;\n\n /**\n *Return the object only if it has not been modified since the specified time, otherwise\n * return a 412 (precondition failed).
\n */\n IfUnmodifiedSince?: Date;\n\n /**\n *The object key.
\n */\n Key: string | undefined;\n\n /**\n *Downloads the specified range bytes of an object. For more information about the HTTP\n * Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
\n *Amazon S3 doesn't support retrieving multiple ranges of data per GET\n * request.
VersionId used to reference a specific version of the object.
\n */\n VersionId?: string;\n\n /**\n *Specifies the algorithm to use to when encrypting the object (for example,\n * AES256).
\n */\n SSECustomerAlgorithm?: string;\n\n /**\n *Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n * value is used to store the object and then it is discarded; Amazon S3 does not store the\n * encryption key. The key must be appropriate for use with the algorithm specified in the\n * x-amz-server-side-encryption-customer-algorithm header.
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n * this header for a message integrity check to ensure that the encryption key was transmitted\n * without error.
\n */\n SSECustomerKeyMD5?: string;\n\n /**\n *Confirms that the requester knows that they will be charged for the request. Bucket\n * owners need not specify this parameter in their requests. For information about downloading\n * objects from requester pays buckets, see Downloading Objects in\n * Requestor Pays Buckets in the Amazon S3 Developer Guide.
\n */\n RequestPayer?: RequestPayer | string;\n\n /**\n *Part number of the object being read. This is a positive integer between 1 and 10,000.\n * Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about\n * the size of the part and the number of parts in this object.
\n */\n PartNumber?: number;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Indicates whether the returned list of analytics configurations is complete. A value of\n * true indicates that the list is not complete and the NextContinuationToken will be provided\n * for a subsequent request.
\n */\n IsTruncated?: boolean;\n\n /**\n *The marker that is used as a starting point for this analytics configuration list\n * response. This value is present if it was sent in the request.
\n */\n ContinuationToken?: string;\n\n /**\n *\n * NextContinuationToken is sent when isTruncated is true, which\n * indicates that there are more analytics configurations to list. The next request must\n * include this NextContinuationToken. The token is obfuscated and is not a\n * usable value.
The list of analytics configurations for a bucket.
\n */\n AnalyticsConfigurationList?: AnalyticsConfiguration[];\n}\n\nexport namespace ListBucketAnalyticsConfigurationsOutput {\n export const filterSensitiveLog = (obj: ListBucketAnalyticsConfigurationsOutput): any => ({\n ...obj,\n ...(obj.AnalyticsConfigurationList && {\n AnalyticsConfigurationList: obj.AnalyticsConfigurationList.map((item) =>\n AnalyticsConfiguration.filterSensitiveLog(item)\n ),\n }),\n });\n}\n\nexport interface ListBucketAnalyticsConfigurationsRequest {\n /**\n *The name of the bucket from which analytics configurations are retrieved.
\n */\n Bucket: string | undefined;\n\n /**\n *The ContinuationToken that represents a placeholder from where this request should\n * begin.
\n */\n ContinuationToken?: string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Indicates whether the returned list of analytics configurations is complete. A value of\n * true indicates that the list is not complete and the NextContinuationToken will be provided\n * for a subsequent request.
\n */\n IsTruncated?: boolean;\n\n /**\n *The ContinuationToken that represents a placeholder from where this request should\n * begin.
\n */\n ContinuationToken?: string;\n\n /**\n *The marker used to continue this inventory configuration listing. Use the\n * NextContinuationToken from this response to continue the listing in a\n * subsequent request. The continuation token is an opaque value that Amazon S3 understands.
The list of S3 Intelligent-Tiering configurations for a bucket.
\n */\n IntelligentTieringConfigurationList?: IntelligentTieringConfiguration[];\n}\n\nexport namespace ListBucketIntelligentTieringConfigurationsOutput {\n export const filterSensitiveLog = (obj: ListBucketIntelligentTieringConfigurationsOutput): any => ({\n ...obj,\n });\n}\n\nexport interface ListBucketIntelligentTieringConfigurationsRequest {\n /**\n *The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.
\n */\n Bucket: string | undefined;\n\n /**\n *The ContinuationToken that represents a placeholder from where this request should\n * begin.
\n */\n ContinuationToken?: string;\n}\n\nexport namespace ListBucketIntelligentTieringConfigurationsRequest {\n export const filterSensitiveLog = (obj: ListBucketIntelligentTieringConfigurationsRequest): any => ({\n ...obj,\n });\n}\n\nexport interface ListBucketInventoryConfigurationsOutput {\n /**\n *If sent in the request, the marker that is used as a starting point for this inventory\n * configuration list response.
\n */\n ContinuationToken?: string;\n\n /**\n *The list of inventory configurations for a bucket.
\n */\n InventoryConfigurationList?: InventoryConfiguration[];\n\n /**\n *Tells whether the returned list of inventory configurations is complete. A value of true\n * indicates that the list is not complete and the NextContinuationToken is provided for a\n * subsequent request.
\n */\n IsTruncated?: boolean;\n\n /**\n *The marker used to continue this inventory configuration listing. Use the\n * NextContinuationToken from this response to continue the listing in a\n * subsequent request. The continuation token is an opaque value that Amazon S3 understands.
The name of the bucket containing the inventory configurations to retrieve.
\n */\n Bucket: string | undefined;\n\n /**\n *The marker used to continue an inventory configuration listing that has been truncated.\n * Use the NextContinuationToken from a previously truncated list response to continue the\n * listing. The continuation token is an opaque value that Amazon S3 understands.
\n */\n ContinuationToken?: string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Indicates whether the returned list of metrics configurations is complete. A value of\n * true indicates that the list is not complete and the NextContinuationToken will be provided\n * for a subsequent request.
\n */\n IsTruncated?: boolean;\n\n /**\n *The marker that is used as a starting point for this metrics configuration list\n * response. This value is present if it was sent in the request.
\n */\n ContinuationToken?: string;\n\n /**\n *The marker used to continue a metrics configuration listing that has been truncated. Use\n * the NextContinuationToken from a previously truncated list response to\n * continue the listing. The continuation token is an opaque value that Amazon S3\n * understands.
The list of metrics configurations for a bucket.
\n */\n MetricsConfigurationList?: MetricsConfiguration[];\n}\n\nexport namespace ListBucketMetricsConfigurationsOutput {\n export const filterSensitiveLog = (obj: ListBucketMetricsConfigurationsOutput): any => ({\n ...obj,\n ...(obj.MetricsConfigurationList && {\n MetricsConfigurationList: obj.MetricsConfigurationList.map((item) =>\n MetricsConfiguration.filterSensitiveLog(item)\n ),\n }),\n });\n}\n\nexport interface ListBucketMetricsConfigurationsRequest {\n /**\n *The name of the bucket containing the metrics configurations to retrieve.
\n */\n Bucket: string | undefined;\n\n /**\n *The marker that is used to continue a metrics configuration listing that has been\n * truncated. Use the NextContinuationToken from a previously truncated list response to\n * continue the listing. The continuation token is an opaque value that Amazon S3\n * understands.
\n */\n ContinuationToken?: string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
In terms of implementation, a Bucket is a resource. An Amazon S3 bucket name is globally\n * unique, and the namespace is shared by all AWS accounts.
\n */\nexport interface Bucket {\n /**\n *The name of the bucket.
\n */\n Name?: string;\n\n /**\n *Date the bucket was created. This date can change when making changes to your bucket, such as editing its bucket policy.
\n */\n CreationDate?: Date;\n}\n\nexport namespace Bucket {\n export const filterSensitiveLog = (obj: Bucket): any => ({\n ...obj,\n });\n}\n\nexport interface ListBucketsOutput {\n /**\n *The list of buckets owned by the requestor.
\n */\n Buckets?: Bucket[];\n\n /**\n *The owner of the buckets listed.
\n */\n Owner?: Owner;\n}\n\nexport namespace ListBucketsOutput {\n export const filterSensitiveLog = (obj: ListBucketsOutput): any => ({\n ...obj,\n });\n}\n\n/**\n *Container for all (if there are any) keys between Prefix and the next occurrence of the\n * string specified by a delimiter. CommonPrefixes lists keys that act like subdirectories in\n * the directory specified by Prefix. For example, if the prefix is notes/ and the delimiter\n * is a slash (/) as in notes/summer/july, the common prefix is notes/summer/.
\n */\nexport interface CommonPrefix {\n /**\n *Container for the specified common prefix.
\n */\n Prefix?: string;\n}\n\nexport namespace CommonPrefix {\n export const filterSensitiveLog = (obj: CommonPrefix): any => ({\n ...obj,\n });\n}\n\nexport type EncodingType = \"url\";\n\n/**\n *Container element that identifies who initiated the multipart upload.
\n */\nexport interface Initiator {\n /**\n *If the principal is an AWS account, it provides the Canonical User ID. If the principal\n * is an IAM User, it provides a user ARN value.
\n */\n ID?: string;\n\n /**\n *Name of the Principal.
\n */\n DisplayName?: string;\n}\n\nexport namespace Initiator {\n export const filterSensitiveLog = (obj: Initiator): any => ({\n ...obj,\n });\n}\n\n/**\n *Container for the MultipartUpload for the Amazon S3 object.
Upload ID that identifies the multipart upload.
\n */\n UploadId?: string;\n\n /**\n *Key of the object for which the multipart upload was initiated.
\n */\n Key?: string;\n\n /**\n *Date and time at which the multipart upload was initiated.
\n */\n Initiated?: Date;\n\n /**\n *The class of storage used to store the object.
\n */\n StorageClass?: StorageClass | string;\n\n /**\n *Specifies the owner of the object that is part of the multipart upload.
\n */\n Owner?: Owner;\n\n /**\n *Identifies who initiated the multipart upload.
\n */\n Initiator?: Initiator;\n}\n\nexport namespace MultipartUpload {\n export const filterSensitiveLog = (obj: MultipartUpload): any => ({\n ...obj,\n });\n}\n\nexport interface ListMultipartUploadsOutput {\n /**\n *The name of the bucket to which the multipart upload was initiated.
\n */\n Bucket?: string;\n\n /**\n *The key at or after which the listing began.
\n */\n KeyMarker?: string;\n\n /**\n *Upload ID after which listing began.
\n */\n UploadIdMarker?: string;\n\n /**\n *When a list is truncated, this element specifies the value that should be used for the\n * key-marker request parameter in a subsequent request.
\n */\n NextKeyMarker?: string;\n\n /**\n *When a prefix is provided in the request, this field contains the specified prefix. The\n * result contains only keys starting with the specified prefix.
\n */\n Prefix?: string;\n\n /**\n *Contains the delimiter you specified in the request. If you don't specify a delimiter in\n * your request, this element is absent from the response.
\n */\n Delimiter?: string;\n\n /**\n *When a list is truncated, this element specifies the value that should be used for the\n * upload-id-marker request parameter in a subsequent request.
Maximum number of multipart uploads that could have been included in the\n * response.
\n */\n MaxUploads?: number;\n\n /**\n *Indicates whether the returned list of multipart uploads is truncated. A value of true\n * indicates that the list was truncated. The list can be truncated if the number of multipart\n * uploads exceeds the limit allowed or specified by max uploads.
\n */\n IsTruncated?: boolean;\n\n /**\n *Container for elements related to a particular multipart upload. A response can contain\n * zero or more Upload elements.
If you specify a delimiter in the request, then the result returns each distinct key\n * prefix containing the delimiter in a CommonPrefixes element. The distinct key\n * prefixes are returned in the Prefix child element.
Encoding type used by Amazon S3 to encode object keys in the response.
\n *If you specify encoding-type request parameter, Amazon S3 includes this element\n * in the response, and returns encoded key name values in the following response\n * elements:
\n * Delimiter, KeyMarker, Prefix,\n * NextKeyMarker, Key.
The name of the bucket to which the multipart upload was initiated.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n *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 Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket: string | undefined;\n\n /**\n *Character you use to group keys.
\n *All keys that contain the same string between the prefix, if specified, and the first\n * occurrence of the delimiter after the prefix are grouped under a single result element,\n * CommonPrefixes. If you don't specify the prefix parameter, then the\n * substring starts at the beginning of the key. The keys that are grouped under\n * CommonPrefixes result element are not returned elsewhere in the\n * response.
Requests Amazon S3 to encode the object keys in the response and specifies the encoding\n * method to use. An object key may contain any Unicode character; however, XML 1.0 parser\n * cannot parse some characters, such as characters with an ASCII value from 0 to 10. For\n * characters that are not supported in XML 1.0, you can add this parameter to request that\n * Amazon S3 encode the keys in the response.
\n */\n EncodingType?: EncodingType | string;\n\n /**\n *Together with upload-id-marker, this parameter specifies the multipart upload after\n * which listing should begin.
\n *If upload-id-marker is not specified, only the keys lexicographically\n * greater than the specified key-marker will be included in the list.
If upload-id-marker is specified, any multipart uploads for a key equal to\n * the key-marker might also be included, provided those multipart uploads have\n * upload IDs lexicographically greater than the specified\n * upload-id-marker.
Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response\n * body. 1,000 is the maximum number of uploads that can be returned in a response.
\n */\n MaxUploads?: number;\n\n /**\n *Lists in-progress uploads only for those keys that begin with the specified prefix. You\n * can use prefixes to separate a bucket into different grouping of keys. (You can think of\n * using prefix to make groups in the same way you'd use a folder in a file system.)
\n */\n Prefix?: string;\n\n /**\n *Together with key-marker, specifies the multipart upload after which listing should\n * begin. If key-marker is not specified, the upload-id-marker parameter is ignored.\n * Otherwise, any multipart uploads for a key equal to the key-marker might be included in the\n * list only if they have an upload ID lexicographically greater than the specified\n * upload-id-marker.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
An object consists of data and its descriptive metadata.
\n */\nexport interface _Object {\n /**\n *The name that you assign to an object. You use the object key to retrieve the\n * object.
\n */\n Key?: string;\n\n /**\n *The date the Object was Last Modified
\n */\n LastModified?: Date;\n\n /**\n *The entity tag is a hash of the object. The ETag reflects changes only to the contents\n * of an object, not its metadata. The ETag may or may not be an MD5 digest of the object\n * data. Whether or not it is depends on how the object was created and how it is encrypted as\n * described below:
\n *Objects created by the PUT Object, POST Object, or Copy operation, or through the\n * AWS Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are\n * an MD5 digest of their object data.
\n *Objects created by the PUT Object, POST Object, or Copy operation, or through the\n * AWS Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are\n * not an MD5 digest of their object data.
\n *If an object is created by either the Multipart Upload or Part Copy operation, the\n * ETag is not an MD5 digest, regardless of the method of encryption.
\n *Size in bytes of the object
\n */\n Size?: number;\n\n /**\n *The class of storage used to store the object.
\n */\n StorageClass?: ObjectStorageClass | string;\n\n /**\n *The owner of the object
\n */\n Owner?: Owner;\n}\n\nexport namespace _Object {\n export const filterSensitiveLog = (obj: _Object): any => ({\n ...obj,\n });\n}\n\nexport interface ListObjectsOutput {\n /**\n *A flag that indicates whether Amazon S3 returned all of the results that satisfied the search\n * criteria.
\n */\n IsTruncated?: boolean;\n\n /**\n *Indicates where in the bucket listing begins. Marker is included in the response if it\n * was sent with the request.
\n */\n Marker?: string;\n\n /**\n *When response is truncated (the IsTruncated element value in the response is true), you\n * can use the key name in this field as marker in the subsequent request to get next set of\n * objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if\n * you have delimiter request parameter specified. If response does not include the NextMarker\n * and it is truncated, you can use the value of the last Key in the response as the marker in\n * the subsequent request to get the next set of object keys.
\n */\n NextMarker?: string;\n\n /**\n *Metadata about each object returned.
\n */\n Contents?: _Object[];\n\n /**\n *The bucket name.
\n */\n Name?: string;\n\n /**\n *Keys that begin with the indicated prefix.
\n */\n Prefix?: string;\n\n /**\n *Causes keys that contain the same string between the prefix and the first occurrence of\n * the delimiter to be rolled up into a single result element in the\n * CommonPrefixes collection. These rolled-up keys are not returned elsewhere\n * in the response. Each rolled-up result counts as only one return against the\n * MaxKeys value.
The maximum number of keys returned in the response body.
\n */\n MaxKeys?: number;\n\n /**\n *All of the keys rolled up in a common prefix count as a single return when calculating\n * the number of returns.
\n *\n *A response can contain CommonPrefixes only if you specify a delimiter.
\n *\n *CommonPrefixes contains all (if there are any) keys between Prefix and the next\n * occurrence of the string specified by the delimiter.
\n *\n *CommonPrefixes lists keys that act like subdirectories in the directory specified by\n * Prefix.
\n *\n *For example, if the prefix is notes/ and the delimiter is a slash (/) as in\n * notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a\n * common prefix count as a single return when calculating the number of returns.
\n */\n CommonPrefixes?: CommonPrefix[];\n\n /**\n *Encoding type used by Amazon S3 to encode object keys in the response.
\n */\n EncodingType?: EncodingType | string;\n}\n\nexport namespace ListObjectsOutput {\n export const filterSensitiveLog = (obj: ListObjectsOutput): any => ({\n ...obj,\n });\n}\n\nexport interface ListObjectsRequest {\n /**\n *The name of the bucket containing the objects.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n *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 Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket: string | undefined;\n\n /**\n *A delimiter is a character you use to group keys.
\n */\n Delimiter?: string;\n\n /**\n *Requests Amazon S3 to encode the object keys in the response and specifies the encoding\n * method to use. An object key may contain any Unicode character; however, XML 1.0 parser\n * cannot parse some characters, such as characters with an ASCII value from 0 to 10. For\n * characters that are not supported in XML 1.0, you can add this parameter to request that\n * Amazon S3 encode the keys in the response.
\n */\n EncodingType?: EncodingType | string;\n\n /**\n *Specifies the key to start with when listing objects in a bucket.
\n */\n Marker?: string;\n\n /**\n *Sets the maximum number of keys returned in the response. By default the API returns up\n * to 1,000 key names. The response might contain fewer keys but will never contain more.\n *
\n */\n MaxKeys?: number;\n\n /**\n *Limits the response to keys that begin with the specified prefix.
\n */\n Prefix?: string;\n\n /**\n *Confirms that the requester knows that she or he will be charged for the list objects\n * request. Bucket owners need not specify this parameter in their requests.
\n */\n RequestPayer?: RequestPayer | string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Set to false if all of the results were returned. Set to true if more keys are available\n * to return. If the number of results exceeds that specified by MaxKeys, all of the results\n * might not be returned.
\n */\n IsTruncated?: boolean;\n\n /**\n *Metadata about each object returned.
\n */\n Contents?: _Object[];\n\n /**\n *The bucket name.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n *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 Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
\n */\n Name?: string;\n\n /**\n *Keys that begin with the indicated prefix.
\n */\n Prefix?: string;\n\n /**\n *Causes keys that contain the same string between the prefix and the first occurrence of\n * the delimiter to be rolled up into a single result element in the CommonPrefixes\n * collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up\n * result counts as only one return against the MaxKeys value.
Sets the maximum number of keys returned in the response. By default the API returns up\n * to 1,000 key names. The response might contain fewer keys but will never contain\n * more.
\n */\n MaxKeys?: number;\n\n /**\n *All of the keys rolled up into a common prefix count as a single return when calculating\n * the number of returns.
\n *\n *A response can contain CommonPrefixes only if you specify a\n * delimiter.
\n * CommonPrefixes contains all (if there are any) keys between\n * Prefix and the next occurrence of the string specified by a\n * delimiter.
\n * CommonPrefixes lists keys that act like subdirectories in the directory\n * specified by Prefix.
For example, if the prefix is notes/ and the delimiter is a slash\n * (/) as in notes/summer/july, the common prefix is\n * notes/summer/. All of the keys that roll up into a common prefix count as a\n * single return when calculating the number of returns.
Encoding type used by Amazon S3 to encode object key names in the XML response.
\n *\n *If you specify the encoding-type request parameter, Amazon S3 includes this element in the\n * response, and returns encoded key name values in the following response elements:
\n *\n *\n * Delimiter, Prefix, Key, and StartAfter.
KeyCount is the number of keys returned with this request. KeyCount will always be less\n * than equals to MaxKeys field. Say you ask for 50 keys, your result will include less than\n * equals 50 keys
\n */\n KeyCount?: number;\n\n /**\n *If ContinuationToken was sent with the request, it is included in the response.
\n */\n ContinuationToken?: string;\n\n /**\n *\n * NextContinuationToken is sent when isTruncated is true, which\n * means there are more keys in the bucket that can be listed. The next list requests to Amazon S3\n * can be continued with this NextContinuationToken.\n * NextContinuationToken is obfuscated and is not a real key
If StartAfter was sent with the request, it is included in the response.
\n */\n StartAfter?: string;\n}\n\nexport namespace ListObjectsV2Output {\n export const filterSensitiveLog = (obj: ListObjectsV2Output): any => ({\n ...obj,\n });\n}\n\nexport interface ListObjectsV2Request {\n /**\n *Bucket name to list.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n *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 Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket: string | undefined;\n\n /**\n *A delimiter is a character you use to group keys.
\n */\n Delimiter?: string;\n\n /**\n *Encoding type used by Amazon S3 to encode object keys in the response.
\n */\n EncodingType?: EncodingType | string;\n\n /**\n *Sets the maximum number of keys returned in the response. By default the API returns up\n * to 1,000 key names. The response might contain fewer keys but will never contain\n * more.
\n */\n MaxKeys?: number;\n\n /**\n *Limits the response to keys that begin with the specified prefix.
\n */\n Prefix?: string;\n\n /**\n *ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a\n * token. ContinuationToken is obfuscated and is not a real key.
\n */\n ContinuationToken?: string;\n\n /**\n *The owner field is not present in listV2 by default, if you want to return owner field\n * with each key in the result then set the fetch owner field to true.
\n */\n FetchOwner?: boolean;\n\n /**\n *StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this\n * specified key. StartAfter can be any key in the bucket.
\n */\n StartAfter?: string;\n\n /**\n *Confirms that the requester knows that she or he will be charged for the list objects\n * request in V2 style. Bucket owners need not specify this parameter in their\n * requests.
\n */\n RequestPayer?: RequestPayer | string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Information about the delete marker.
\n */\nexport interface DeleteMarkerEntry {\n /**\n *The account that created the delete marker.>
\n */\n Owner?: Owner;\n\n /**\n *The object key.
\n */\n Key?: string;\n\n /**\n *Version ID of an object.
\n */\n VersionId?: string;\n\n /**\n *Specifies whether the object is (true) or is not (false) the latest version of an\n * object.
\n */\n IsLatest?: boolean;\n\n /**\n *Date and time the object was last modified.
\n */\n LastModified?: Date;\n}\n\nexport namespace DeleteMarkerEntry {\n export const filterSensitiveLog = (obj: DeleteMarkerEntry): any => ({\n ...obj,\n });\n}\n\nexport type ObjectVersionStorageClass = \"STANDARD\";\n\n/**\n *The version of an object.
\n */\nexport interface ObjectVersion {\n /**\n *The entity tag is an MD5 hash of that version of the object.
\n */\n ETag?: string;\n\n /**\n *Size in bytes of the object.
\n */\n Size?: number;\n\n /**\n *The class of storage used to store the object.
\n */\n StorageClass?: ObjectVersionStorageClass | string;\n\n /**\n *The object key.
\n */\n Key?: string;\n\n /**\n *Version ID of an object.
\n */\n VersionId?: string;\n\n /**\n *Specifies whether the object is (true) or is not (false) the latest version of an\n * object.
\n */\n IsLatest?: boolean;\n\n /**\n *Date and time the object was last modified.
\n */\n LastModified?: Date;\n\n /**\n *Specifies the owner of the object.
\n */\n Owner?: Owner;\n}\n\nexport namespace ObjectVersion {\n export const filterSensitiveLog = (obj: ObjectVersion): any => ({\n ...obj,\n });\n}\n\nexport interface ListObjectVersionsOutput {\n /**\n *A flag that indicates whether Amazon S3 returned all of the results that satisfied the search\n * criteria. If your results were truncated, you can make a follow-up paginated request using\n * the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in\n * another request to return the rest of the results.
\n */\n IsTruncated?: boolean;\n\n /**\n *Marks the last key returned in a truncated response.
\n */\n KeyMarker?: string;\n\n /**\n *Marks the last version of the key returned in a truncated response.
\n */\n VersionIdMarker?: string;\n\n /**\n *When the number of responses exceeds the value of MaxKeys,\n * NextKeyMarker specifies the first key not returned that satisfies the\n * search criteria. Use this value for the key-marker request parameter in a subsequent\n * request.
When the number of responses exceeds the value of MaxKeys,\n * NextVersionIdMarker specifies the first object version not returned that\n * satisfies the search criteria. Use this value for the version-id-marker request parameter\n * in a subsequent request.
Container for version information.
\n */\n Versions?: ObjectVersion[];\n\n /**\n *Container for an object that is a delete marker.
\n */\n DeleteMarkers?: DeleteMarkerEntry[];\n\n /**\n *The bucket name.
\n */\n Name?: string;\n\n /**\n *Selects objects that start with the value supplied by this parameter.
\n */\n Prefix?: string;\n\n /**\n *The delimiter grouping the included keys. A delimiter is a character that you specify to\n * group keys. All keys that contain the same string between the prefix and the first\n * occurrence of the delimiter are grouped under a single result element in\n * CommonPrefixes. These groups are counted as one result against the max-keys\n * limitation. These keys are not returned elsewhere in the response.
Specifies the maximum number of objects to return.
\n */\n MaxKeys?: number;\n\n /**\n *All of the keys rolled up into a common prefix count as a single return when calculating\n * the number of returns.
\n */\n CommonPrefixes?: CommonPrefix[];\n\n /**\n *Encoding type used by Amazon S3 to encode object key names in the XML response.
\n *\n *If you specify encoding-type request parameter, Amazon S3 includes this element in the\n * response, and returns encoded key name values in the following response elements:
\n *\n *\n * KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.
The bucket name that contains the objects.
\n */\n Bucket: string | undefined;\n\n /**\n *A delimiter is a character that you specify to group keys. All keys that contain the\n * same string between the prefix and the first occurrence of the delimiter are\n * grouped under a single result element in CommonPrefixes. These groups are counted as one\n * result against the max-keys limitation. These keys are not returned elsewhere in the\n * response.
Requests Amazon S3 to encode the object keys in the response and specifies the encoding\n * method to use. An object key may contain any Unicode character; however, XML 1.0 parser\n * cannot parse some characters, such as characters with an ASCII value from 0 to 10. For\n * characters that are not supported in XML 1.0, you can add this parameter to request that\n * Amazon S3 encode the keys in the response.
\n */\n EncodingType?: EncodingType | string;\n\n /**\n *Specifies the key to start with when listing objects in a bucket.
\n */\n KeyMarker?: string;\n\n /**\n *Sets the maximum number of keys returned in the response. By default the API returns up\n * to 1,000 key names. The response might contain fewer keys but will never contain more. If\n * additional keys satisfy the search criteria, but were not returned because max-keys was\n * exceeded, the response contains
Use this parameter to select only those keys that begin with the specified prefix. You\n * can use prefixes to separate a bucket into different groupings of keys. (You can think of\n * using prefix to make groups in the same way you'd use a folder in a file system.) You can\n * use prefix with delimiter to roll up numerous objects into a single result under\n * CommonPrefixes.
\n */\n Prefix?: string;\n\n /**\n *Specifies the object version you want to start listing from.
\n */\n VersionIdMarker?: string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Container for elements related to a part.
\n */\nexport interface Part {\n /**\n *Part number identifying the part. This is a positive integer between 1 and\n * 10,000.
\n */\n PartNumber?: number;\n\n /**\n *Date and time at which the part was uploaded.
\n */\n LastModified?: Date;\n\n /**\n *Entity tag returned when the part was uploaded.
\n */\n ETag?: string;\n\n /**\n *Size in bytes of the uploaded part data.
\n */\n Size?: number;\n}\n\nexport namespace Part {\n export const filterSensitiveLog = (obj: Part): any => ({\n ...obj,\n });\n}\n\nexport interface ListPartsOutput {\n /**\n *If the bucket has a lifecycle rule configured with an action to abort incomplete\n * multipart uploads and the prefix in the lifecycle rule matches the object name in the\n * request, then the response includes this header indicating when the initiated multipart\n * upload will become eligible for abort operation. For more information, see Aborting\n * Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.
\n *\n *The response will also include the x-amz-abort-rule-id header that will\n * provide the ID of the lifecycle configuration rule that defines this action.
This header is returned along with the x-amz-abort-date header. It\n * identifies applicable lifecycle configuration rule that defines the action to abort\n * incomplete multipart uploads.
The name of the bucket to which the multipart upload was initiated.
\n */\n Bucket?: string;\n\n /**\n *Object key for which the multipart upload was initiated.
\n */\n Key?: string;\n\n /**\n *Upload ID identifying the multipart upload whose parts are being listed.
\n */\n UploadId?: string;\n\n /**\n *When a list is truncated, this element specifies the last part in the list, as well as\n * the value to use for the part-number-marker request parameter in a subsequent\n * request.
\n */\n PartNumberMarker?: string;\n\n /**\n *When a list is truncated, this element specifies the last part in the list, as well as\n * the value to use for the part-number-marker request parameter in a subsequent\n * request.
\n */\n NextPartNumberMarker?: string;\n\n /**\n *Maximum number of parts that were allowed in the response.
\n */\n MaxParts?: number;\n\n /**\n *Indicates whether the returned list of parts is truncated. A true value indicates that\n * the list was truncated. A list can be truncated if the number of parts exceeds the limit\n * returned in the MaxParts element.
\n */\n IsTruncated?: boolean;\n\n /**\n * Container for elements related to a particular part. A response can contain zero or\n * more Part elements.
Container element that identifies who initiated the multipart upload. If the initiator\n * is an AWS account, this element provides the same information as the Owner\n * element. If the initiator is an IAM User, this element provides the user ARN and display\n * name.
Container element that identifies the object owner, after the object is created. If\n * multipart upload is initiated by an IAM user, this element provides the parent account ID\n * and display name.
\n */\n Owner?: Owner;\n\n /**\n *Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the uploaded\n * object.
\n */\n StorageClass?: StorageClass | string;\n\n /**\n *If present, indicates that the requester was successfully charged for the\n * request.
\n */\n RequestCharged?: RequestCharged | string;\n}\n\nexport namespace ListPartsOutput {\n export const filterSensitiveLog = (obj: ListPartsOutput): any => ({\n ...obj,\n });\n}\n\nexport interface ListPartsRequest {\n /**\n *The name of the bucket to which the parts are being uploaded.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n *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 Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket: string | undefined;\n\n /**\n *Object key for which the multipart upload was initiated.
\n */\n Key: string | undefined;\n\n /**\n *Sets the maximum number of parts to return.
\n */\n MaxParts?: number;\n\n /**\n *Specifies the part after which listing should begin. Only parts with higher part numbers\n * will be listed.
\n */\n PartNumberMarker?: string;\n\n /**\n *Upload ID identifying the multipart upload whose parts are being listed.
\n */\n UploadId: string | undefined;\n\n /**\n *Confirms that the requester knows that they will be charged for the request. Bucket\n * owners need not specify this parameter in their requests. For information about downloading\n * objects from requester pays buckets, see Downloading Objects in\n * Requestor Pays Buckets in the Amazon S3 Developer Guide.
\n */\n RequestPayer?: RequestPayer | string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The name of the bucket for which the accelerate configuration is set.
\n */\n Bucket: string | undefined;\n\n /**\n *Container for setting the transfer acceleration state.
\n */\n AccelerateConfiguration: AccelerateConfiguration | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The canned ACL to apply to the bucket.
\n */\n ACL?: BucketCannedACL | string;\n\n /**\n *Contains the elements that set the ACL permissions for an object per grantee.
\n */\n AccessControlPolicy?: AccessControlPolicy;\n\n /**\n *The bucket to which to apply the ACL.
\n */\n Bucket: string | undefined;\n\n /**\n *The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message\n * integrity check to verify that the request body was not corrupted in transit. For more\n * information, go to RFC\n * 1864.\n *
\n *For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.
\n */\n ContentMD5?: string;\n\n /**\n *Allows grantee the read, write, read ACP, and write ACP permissions on the\n * bucket.
\n */\n GrantFullControl?: string;\n\n /**\n *Allows grantee to list the objects in the bucket.
\n */\n GrantRead?: string;\n\n /**\n *Allows grantee to read the bucket ACL.
\n */\n GrantReadACP?: string;\n\n /**\n *Allows grantee to create, overwrite, and delete any object in the bucket.
\n */\n GrantWrite?: string;\n\n /**\n *Allows grantee to write the ACL for the applicable bucket.
\n */\n GrantWriteACP?: string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The name of the bucket to which an analytics configuration is stored.
\n */\n Bucket: string | undefined;\n\n /**\n *The ID that identifies the analytics configuration.
\n */\n Id: string | undefined;\n\n /**\n *The configuration and any analyses for the analytics filter.
\n */\n AnalyticsConfiguration: AnalyticsConfiguration | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more\n * information, see Enabling\n * Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer\n * Guide.
\n */\nexport interface CORSConfiguration {\n /**\n *A set of origins and methods (cross-origin access that you want to allow). You can add\n * up to 100 rules to the configuration.
\n */\n CORSRules: CORSRule[] | undefined;\n}\n\nexport namespace CORSConfiguration {\n export const filterSensitiveLog = (obj: CORSConfiguration): any => ({\n ...obj,\n });\n}\n\nexport interface PutBucketCorsRequest {\n /**\n *Specifies the bucket impacted by the corsconfiguration.
Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more\n * information, see Enabling Cross-Origin Resource\n * Sharing in the Amazon Simple Storage Service Developer Guide.
\n */\n CORSConfiguration: CORSConfiguration | undefined;\n\n /**\n *The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message\n * integrity check to verify that the request body was not corrupted in transit. For more\n * information, go to RFC\n * 1864.\n *
\n *For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.
\n */\n ContentMD5?: string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed\n * keys (SSE-S3) or customer master keys stored in AWS KMS (SSE-KMS). For information about\n * the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption\n * in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket: string | undefined;\n\n /**\n *The base64-encoded 128-bit MD5 digest of the server-side encryption configuration.
\n *For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.
\n */\n ContentMD5?: string;\n\n /**\n *Specifies the default server-side-encryption configuration.
\n */\n ServerSideEncryptionConfiguration: ServerSideEncryptionConfiguration | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.
\n */\n Bucket: string | undefined;\n\n /**\n *The ID used to identify the S3 Intelligent-Tiering configuration.
\n */\n Id: string | undefined;\n\n /**\n *Container for S3 Intelligent-Tiering configuration.
\n */\n IntelligentTieringConfiguration: IntelligentTieringConfiguration | undefined;\n}\n\nexport namespace PutBucketIntelligentTieringConfigurationRequest {\n export const filterSensitiveLog = (obj: PutBucketIntelligentTieringConfigurationRequest): any => ({\n ...obj,\n });\n}\n\nexport interface PutBucketInventoryConfigurationRequest {\n /**\n *The name of the bucket where the inventory configuration will be stored.
\n */\n Bucket: string | undefined;\n\n /**\n *The ID used to identify the inventory configuration.
\n */\n Id: string | undefined;\n\n /**\n *Specifies the inventory configuration.
\n */\n InventoryConfiguration: InventoryConfiguration | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more\n * information, see Object Lifecycle Management\n * in the Amazon Simple Storage Service Developer Guide.
\n */\nexport interface BucketLifecycleConfiguration {\n /**\n *A lifecycle rule for individual objects in an Amazon S3 bucket.
\n */\n Rules: LifecycleRule[] | undefined;\n}\n\nexport namespace BucketLifecycleConfiguration {\n export const filterSensitiveLog = (obj: BucketLifecycleConfiguration): any => ({\n ...obj,\n ...(obj.Rules && { Rules: obj.Rules.map((item) => LifecycleRule.filterSensitiveLog(item)) }),\n });\n}\n\nexport interface PutBucketLifecycleConfigurationRequest {\n /**\n *The name of the bucket for which to set the configuration.
\n */\n Bucket: string | undefined;\n\n /**\n *Container for lifecycle rules. You can add as many as 1,000 rules.
\n */\n LifecycleConfiguration?: BucketLifecycleConfiguration;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Container for logging status information.
\n */\nexport interface BucketLoggingStatus {\n /**\n *Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys\n * for a bucket. For more information, see PUT Bucket logging in the\n * Amazon Simple Storage Service API Reference.
\n */\n LoggingEnabled?: LoggingEnabled;\n}\n\nexport namespace BucketLoggingStatus {\n export const filterSensitiveLog = (obj: BucketLoggingStatus): any => ({\n ...obj,\n });\n}\n\nexport interface PutBucketLoggingRequest {\n /**\n *The name of the bucket for which to set the logging parameters.
\n */\n Bucket: string | undefined;\n\n /**\n *Container for logging status information.
\n */\n BucketLoggingStatus: BucketLoggingStatus | undefined;\n\n /**\n *The MD5 hash of the PutBucketLogging request body.
For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.
\n */\n ContentMD5?: string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The name of the bucket for which the metrics configuration is set.
\n */\n Bucket: string | undefined;\n\n /**\n *The ID used to identify the metrics configuration.
\n */\n Id: string | undefined;\n\n /**\n *Specifies the metrics configuration.
\n */\n MetricsConfiguration: MetricsConfiguration | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The name of the bucket.
\n */\n Bucket: string | undefined;\n\n /**\n *A container for specifying the notification configuration of the bucket. If this element\n * is empty, notifications are turned off for the bucket.
\n */\n NotificationConfiguration: NotificationConfiguration | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The name of the Amazon S3 bucket whose OwnershipControls you want to set.
The MD5 hash of the OwnershipControls request body.
For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.
\n */\n ContentMD5?: string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The OwnershipControls (BucketOwnerPreferred or ObjectWriter) that you want\n * to apply to this Amazon S3 bucket.
The name of the bucket.
\n */\n Bucket: string | undefined;\n\n /**\n *The MD5 hash of the request body.
\n *For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.
\n */\n ContentMD5?: string;\n\n /**\n *Set this parameter to true to confirm that you want to remove your permissions to change\n * this bucket policy in the future.
\n */\n ConfirmRemoveSelfBucketAccess?: boolean;\n\n /**\n *The bucket policy as a JSON document.
\n */\n Policy: string | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The name of the bucket
\n */\n Bucket: string | undefined;\n\n /**\n *The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message\n * integrity check to verify that the request body was not corrupted in transit. For more\n * information, see RFC 1864.
\n *For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.
\n */\n ContentMD5?: string;\n\n /**\n *A container for replication rules. You can add up to 1,000 rules. The maximum size of a\n * replication configuration is 2 MB.
\n */\n ReplicationConfiguration: ReplicationConfiguration | undefined;\n\n /**\n *A token to allow Object Lock to be enabled for an existing bucket.
\n */\n Token?: string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Container for Payer.
\n */\nexport interface RequestPaymentConfiguration {\n /**\n *Specifies who pays for the download and request fees.
\n */\n Payer: Payer | string | undefined;\n}\n\nexport namespace RequestPaymentConfiguration {\n export const filterSensitiveLog = (obj: RequestPaymentConfiguration): any => ({\n ...obj,\n });\n}\n\nexport interface PutBucketRequestPaymentRequest {\n /**\n *The bucket name.
\n */\n Bucket: string | undefined;\n\n /**\n *>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a\n * message integrity check to verify that the request body was not corrupted in transit. For\n * more information, see RFC\n * 1864.
\n *For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.
\n */\n ContentMD5?: string;\n\n /**\n *Container for Payer.
\n */\n RequestPaymentConfiguration: RequestPaymentConfiguration | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Container for TagSet elements.
A collection for a set of tags
\n */\n TagSet: Tag[] | undefined;\n}\n\nexport namespace Tagging {\n export const filterSensitiveLog = (obj: Tagging): any => ({\n ...obj,\n });\n}\n\nexport interface PutBucketTaggingRequest {\n /**\n *The bucket name.
\n */\n Bucket: string | undefined;\n\n /**\n *The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message\n * integrity check to verify that the request body was not corrupted in transit. For more\n * information, see RFC 1864.
\n *For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.
\n */\n ContentMD5?: string;\n\n /**\n *Container for the TagSet and Tag elements.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Describes the versioning state of an Amazon S3 bucket. For more information, see PUT\n * Bucket versioning in the Amazon Simple Storage Service API Reference.
\n */\nexport interface VersioningConfiguration {\n /**\n *Specifies whether MFA delete is enabled in the bucket versioning configuration. This\n * element is only returned if the bucket has been configured with MFA delete. If the bucket\n * has never been so configured, this element is not returned.
\n */\n MFADelete?: MFADelete | string;\n\n /**\n *The versioning state of the bucket.
\n */\n Status?: BucketVersioningStatus | string;\n}\n\nexport namespace VersioningConfiguration {\n export const filterSensitiveLog = (obj: VersioningConfiguration): any => ({\n ...obj,\n });\n}\n\nexport interface PutBucketVersioningRequest {\n /**\n *The bucket name.
\n */\n Bucket: string | undefined;\n\n /**\n *>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a\n * message integrity check to verify that the request body was not corrupted in transit. For\n * more information, see RFC\n * 1864.
\n *For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.
\n */\n ContentMD5?: string;\n\n /**\n *The concatenation of the authentication device's serial number, a space, and the value\n * that is displayed on your authentication device.
\n */\n MFA?: string;\n\n /**\n *Container for setting the versioning state.
\n */\n VersioningConfiguration: VersioningConfiguration | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Specifies website configuration parameters for an Amazon S3 bucket.
\n */\nexport interface WebsiteConfiguration {\n /**\n *The name of the error document for the website.
\n */\n ErrorDocument?: ErrorDocument;\n\n /**\n *The name of the index document for the website.
\n */\n IndexDocument?: IndexDocument;\n\n /**\n *The redirect behavior for every request to this bucket's website endpoint.
\n *If you specify this property, you can't specify any other property.
\n *Rules that define when a redirect is applied and the redirect behavior.
\n */\n RoutingRules?: RoutingRule[];\n}\n\nexport namespace WebsiteConfiguration {\n export const filterSensitiveLog = (obj: WebsiteConfiguration): any => ({\n ...obj,\n });\n}\n\nexport interface PutBucketWebsiteRequest {\n /**\n *The bucket name.
\n */\n Bucket: string | undefined;\n\n /**\n *The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message\n * integrity check to verify that the request body was not corrupted in transit. For more\n * information, see RFC 1864.
\n *For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.
\n */\n ContentMD5?: string;\n\n /**\n *Container for the request.
\n */\n WebsiteConfiguration: WebsiteConfiguration | undefined;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
If the expiration is configured for the object (see PutBucketLifecycleConfiguration), the response includes this header. It\n * includes the expiry-date and rule-id key-value pairs that provide information about object\n * expiration. The value of the rule-id is URL encoded.
\n */\n Expiration?: string;\n\n /**\n *Entity tag for the uploaded object.
\n */\n ETag?: string;\n\n /**\n *If you specified server-side encryption either with an AWS KMS customer master key (CMK)\n * or Amazon S3-managed encryption key in your PUT request, the response includes this header. It\n * confirms the encryption algorithm that Amazon S3 used to encrypt the object.
\n */\n ServerSideEncryption?: ServerSideEncryption | string;\n\n /**\n *Version of the object.
\n */\n VersionId?: string;\n\n /**\n *If server-side encryption with a customer-provided encryption key was requested, the\n * response will include this header confirming the encryption algorithm used.
\n */\n SSECustomerAlgorithm?: string;\n\n /**\n *If server-side encryption with a customer-provided encryption key was requested, the\n * response will include this header to provide round-trip message integrity verification of\n * the customer-provided encryption key.
\n */\n SSECustomerKeyMD5?: string;\n\n /**\n *If x-amz-server-side-encryption is present and has the value of\n * aws:kms, this header specifies the ID of the AWS Key Management Service\n * (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the\n * object.
If present, specifies the AWS KMS Encryption Context to use for object encryption. The\n * value of this header is a base64-encoded UTF-8 string holding JSON with the encryption\n * context key-value pairs.
\n */\n SSEKMSEncryptionContext?: string;\n\n /**\n *Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).
\n */\n BucketKeyEnabled?: boolean;\n\n /**\n *If present, indicates that the requester was successfully charged for the\n * request.
\n */\n RequestCharged?: RequestCharged | string;\n}\n\nexport namespace PutObjectOutput {\n export const filterSensitiveLog = (obj: PutObjectOutput): any => ({\n ...obj,\n ...(obj.SSEKMSKeyId && { SSEKMSKeyId: SENSITIVE_STRING }),\n ...(obj.SSEKMSEncryptionContext && { SSEKMSEncryptionContext: SENSITIVE_STRING }),\n });\n}\n\nexport interface PutObjectRequest {\n /**\n *The canned ACL to apply to the object. For more information, see Canned\n * ACL.
\n *This action is not supported by Amazon S3 on Outposts.
\n */\n ACL?: ObjectCannedACL | string;\n\n /**\n *Object data.
\n */\n Body?: Readable | ReadableStream | Blob;\n\n /**\n *The bucket name to which the PUT operation was initiated.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n *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 Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket: string | undefined;\n\n /**\n *Can be used to specify caching behavior along the request/reply chain. For more\n * information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
\n */\n CacheControl?: string;\n\n /**\n *Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.
\n */\n ContentDisposition?: string;\n\n /**\n *Specifies what content encodings have been applied to the object and thus what decoding\n * mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n * field. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.
\n */\n ContentEncoding?: string;\n\n /**\n *The language the content is in.
\n */\n ContentLanguage?: string;\n\n /**\n *Size of the body in bytes. This parameter is useful when the size of the body cannot be\n * determined automatically. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.
\n */\n ContentLength?: number;\n\n /**\n *The base64-encoded 128-bit MD5 digest of the message (without the headers) according to\n * RFC 1864. This header can be used as a message integrity check to verify that the data is\n * the same data that was originally sent. Although it is optional, we recommend using the\n * Content-MD5 mechanism as an end-to-end integrity check. For more information about REST\n * request authentication, see REST\n * Authentication.
\n */\n ContentMD5?: string;\n\n /**\n *A standard MIME type describing the format of the contents. For more information, see\n * http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.
\n */\n ContentType?: string;\n\n /**\n *The date and time at which the object is no longer cacheable. For more information, see\n * http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.
\n */\n Expires?: Date;\n\n /**\n *Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the\n * object.
\n *This action is not supported by Amazon S3 on Outposts.
\n */\n GrantFullControl?: string;\n\n /**\n *Allows grantee to read the object data and its\n * metadata.
\n *This action is not supported by Amazon S3 on Outposts.
\n */\n GrantRead?: string;\n\n /**\n *Allows grantee to read the object ACL.
\n *This action is not supported by Amazon S3 on Outposts.
\n */\n GrantReadACP?: string;\n\n /**\n *Allows grantee to write the ACL for the applicable\n * object.
\n *This action is not supported by Amazon S3 on Outposts.
\n */\n GrantWriteACP?: string;\n\n /**\n *Object key for which the PUT operation was initiated.
\n */\n Key: string | undefined;\n\n /**\n *A map of metadata to store with the object in S3.
\n */\n Metadata?: { [key: string]: string };\n\n /**\n *The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n * AES256, aws:kms).
\n */\n ServerSideEncryption?: ServerSideEncryption | string;\n\n /**\n *By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n * STANDARD storage class provides high durability and high availability. Depending on\n * performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n * the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3\n * Service Developer Guide.
\n */\n StorageClass?: StorageClass | string;\n\n /**\n *If the bucket is configured as a website, redirects requests for this object to another\n * object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n * the object metadata. For information about object metadata, see Object Key and Metadata.
\n *\n *In the following example, the request header sets the redirect to an object\n * (anotherPage.html) in the same bucket:
\n *\n *\n * x-amz-website-redirect-location: /anotherPage.html\n *
In the following example, the request header sets the object redirect to another\n * website:
\n *\n *\n * x-amz-website-redirect-location: http://www.example.com/\n *
For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page\n * Redirects.
\n */\n WebsiteRedirectLocation?: string;\n\n /**\n *Specifies the algorithm to use to when encrypting the object (for example,\n * AES256).
\n */\n SSECustomerAlgorithm?: string;\n\n /**\n *Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n * value is used to store the object and then it is discarded; Amazon S3 does not store the\n * encryption key. The key must be appropriate for use with the algorithm specified in the\n * x-amz-server-side-encryption-customer-algorithm header.
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n * this header for a message integrity check to ensure that the encryption key was transmitted\n * without error.
\n */\n SSECustomerKeyMD5?: string;\n\n /**\n *If x-amz-server-side-encryption is present and has the value of\n * aws:kms, this header specifies the ID of the AWS Key Management Service\n * (AWS KMS) symmetrical customer managed customer master key (CMK) that was used for the\n * object.
If the value of x-amz-server-side-encryption is aws:kms, this\n * header specifies the ID of the symmetric customer managed AWS KMS CMK that will be used for\n * the object. If you specify x-amz-server-side-encryption:aws:kms, but do not\n * provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS\n * managed CMK in AWS to protect the data.
Specifies the AWS KMS Encryption Context to use for object encryption. The value of this\n * header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value\n * pairs.
\n */\n SSEKMSEncryptionContext?: string;\n\n /**\n *Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.
Specifying this header with a PUT operation doesn’t affect bucket-level settings for S3 Bucket Key.
\n */\n BucketKeyEnabled?: boolean;\n\n /**\n *Confirms that the requester knows that they will be charged for the request. Bucket\n * owners need not specify this parameter in their requests. For information about downloading\n * objects from requester pays buckets, see Downloading Objects in\n * Requestor Pays Buckets in the Amazon S3 Developer Guide.
\n */\n RequestPayer?: RequestPayer | string;\n\n /**\n *The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For\n * example, \"Key1=Value1\")
\n */\n Tagging?: string;\n\n /**\n *The Object Lock mode that you want to apply to this object.
\n */\n ObjectLockMode?: ObjectLockMode | string;\n\n /**\n *The date and time when you want this object's Object Lock to expire.
\n */\n ObjectLockRetainUntilDate?: Date;\n\n /**\n *Specifies whether a legal hold will be applied to this object. For more information\n * about S3 Object Lock, see Object\n * Lock.
\n */\n ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus | string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
If present, indicates that the requester was successfully charged for the\n * request.
\n */\n RequestCharged?: RequestCharged | string;\n}\n\nexport namespace PutObjectAclOutput {\n export const filterSensitiveLog = (obj: PutObjectAclOutput): any => ({\n ...obj,\n });\n}\n\nexport interface PutObjectAclRequest {\n /**\n *The canned ACL to apply to the object. For more information, see Canned ACL.
\n */\n ACL?: ObjectCannedACL | string;\n\n /**\n *Contains the elements that set the ACL permissions for an object per grantee.
\n */\n AccessControlPolicy?: AccessControlPolicy;\n\n /**\n *The bucket name that contains the object to which you want to attach the ACL.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket: string | undefined;\n\n /**\n *The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message\n * integrity check to verify that the request body was not corrupted in transit. For more\n * information, go to RFC\n * 1864.>\n *
\n *For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.
\n */\n ContentMD5?: string;\n\n /**\n *Allows grantee the read, write, read ACP, and write ACP permissions on the\n * bucket.
\n *This action is not supported by Amazon S3 on Outposts.
\n */\n GrantFullControl?: string;\n\n /**\n *Allows grantee to list the objects in the\n * bucket.
\n *This action is not supported by Amazon S3 on Outposts.
\n */\n GrantRead?: string;\n\n /**\n *Allows grantee to read the bucket ACL.
\n *This action is not supported by Amazon S3 on Outposts.
\n */\n GrantReadACP?: string;\n\n /**\n *Allows grantee to create, overwrite, and delete any object in the bucket.
\n */\n GrantWrite?: string;\n\n /**\n *Allows grantee to write the ACL for the applicable\n * bucket.
\n *This action is not supported by Amazon S3 on Outposts.
\n */\n GrantWriteACP?: string;\n\n /**\n *Key for which the PUT operation was initiated.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n *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 Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
\n */\n Key: string | undefined;\n\n /**\n *Confirms that the requester knows that they will be charged for the request. Bucket\n * owners need not specify this parameter in their requests. For information about downloading\n * objects from requester pays buckets, see Downloading Objects in\n * Requestor Pays Buckets in the Amazon S3 Developer Guide.
\n */\n RequestPayer?: RequestPayer | string;\n\n /**\n *VersionId used to reference a specific version of the object.
\n */\n VersionId?: string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
If present, indicates that the requester was successfully charged for the\n * request.
\n */\n RequestCharged?: RequestCharged | string;\n}\n\nexport namespace PutObjectLegalHoldOutput {\n export const filterSensitiveLog = (obj: PutObjectLegalHoldOutput): any => ({\n ...obj,\n });\n}\n\nexport interface PutObjectLegalHoldRequest {\n /**\n *The bucket name containing the object that you want to place a Legal Hold on.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket: string | undefined;\n\n /**\n *The key name for the object that you want to place a Legal Hold on.
\n */\n Key: string | undefined;\n\n /**\n *Container element for the Legal Hold configuration you want to apply to the specified\n * object.
\n */\n LegalHold?: ObjectLockLegalHold;\n\n /**\n *Confirms that the requester knows that they will be charged for the request. Bucket\n * owners need not specify this parameter in their requests. For information about downloading\n * objects from requester pays buckets, see Downloading Objects in\n * Requestor Pays Buckets in the Amazon S3 Developer Guide.
\n */\n RequestPayer?: RequestPayer | string;\n\n /**\n *The version ID of the object that you want to place a Legal Hold on.
\n */\n VersionId?: string;\n\n /**\n *The MD5 hash for the request body.
\n *For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.
\n */\n ContentMD5?: string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
If present, indicates that the requester was successfully charged for the\n * request.
\n */\n RequestCharged?: RequestCharged | string;\n}\n\nexport namespace PutObjectLockConfigurationOutput {\n export const filterSensitiveLog = (obj: PutObjectLockConfigurationOutput): any => ({\n ...obj,\n });\n}\n\nexport interface PutObjectLockConfigurationRequest {\n /**\n *The bucket whose Object Lock configuration you want to create or replace.
\n */\n Bucket: string | undefined;\n\n /**\n *The Object Lock configuration that you want to apply to the specified bucket.
\n */\n ObjectLockConfiguration?: ObjectLockConfiguration;\n\n /**\n *Confirms that the requester knows that they will be charged for the request. Bucket\n * owners need not specify this parameter in their requests. For information about downloading\n * objects from requester pays buckets, see Downloading Objects in\n * Requestor Pays Buckets in the Amazon S3 Developer Guide.
\n */\n RequestPayer?: RequestPayer | string;\n\n /**\n *A token to allow Object Lock to be enabled for an existing bucket.
\n */\n Token?: string;\n\n /**\n *The MD5 hash for the request body.
\n *For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.
\n */\n ContentMD5?: string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
If present, indicates that the requester was successfully charged for the\n * request.
\n */\n RequestCharged?: RequestCharged | string;\n}\n\nexport namespace PutObjectRetentionOutput {\n export const filterSensitiveLog = (obj: PutObjectRetentionOutput): any => ({\n ...obj,\n });\n}\n\nexport interface PutObjectRetentionRequest {\n /**\n *The bucket name that contains the object you want to apply this Object Retention\n * configuration to.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket: string | undefined;\n\n /**\n *The key name for the object that you want to apply this Object Retention configuration\n * to.
\n */\n Key: string | undefined;\n\n /**\n *The container element for the Object Retention configuration.
\n */\n Retention?: ObjectLockRetention;\n\n /**\n *Confirms that the requester knows that they will be charged for the request. Bucket\n * owners need not specify this parameter in their requests. For information about downloading\n * objects from requester pays buckets, see Downloading Objects in\n * Requestor Pays Buckets in the Amazon S3 Developer Guide.
\n */\n RequestPayer?: RequestPayer | string;\n\n /**\n *The version ID for the object that you want to apply this Object Retention configuration\n * to.
\n */\n VersionId?: string;\n\n /**\n *Indicates whether this operation should bypass Governance-mode restrictions.
\n */\n BypassGovernanceRetention?: boolean;\n\n /**\n *The MD5 hash for the request body.
\n *For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.
\n */\n ContentMD5?: string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The versionId of the object the tag-set was added to.
\n */\n VersionId?: string;\n}\n\nexport namespace PutObjectTaggingOutput {\n export const filterSensitiveLog = (obj: PutObjectTaggingOutput): any => ({\n ...obj,\n });\n}\n\nexport interface PutObjectTaggingRequest {\n /**\n *The bucket name containing the object.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n *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 Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket: string | undefined;\n\n /**\n *Name of the object key.
\n */\n Key: string | undefined;\n\n /**\n *The versionId of the object that the tag-set will be added to.
\n */\n VersionId?: string;\n\n /**\n *The MD5 hash for the request body.
\n *For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.
\n */\n ContentMD5?: string;\n\n /**\n *Container for the TagSet and Tag elements
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want\n * to set.
The MD5 hash of the PutPublicAccessBlock request body.
For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.
\n */\n ContentMD5?: string;\n\n /**\n *The PublicAccessBlock configuration that you want to apply to this Amazon S3\n * bucket. You can enable the configuration options in any combination. For more information\n * about when Amazon S3 considers a bucket or object public, see The Meaning of \"Public\" in the Amazon Simple Storage Service Developer\n * Guide.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
This operation is not allowed against this storage tier.
\n */\nexport interface ObjectAlreadyInActiveTierError extends __SmithyException, $MetadataBearer {\n name: \"ObjectAlreadyInActiveTierError\";\n $fault: \"client\";\n}\n\nexport namespace ObjectAlreadyInActiveTierError {\n export const filterSensitiveLog = (obj: ObjectAlreadyInActiveTierError): any => ({\n ...obj,\n });\n}\n\nexport interface RestoreObjectOutput {\n /**\n *If present, indicates that the requester was successfully charged for the\n * request.
\n */\n RequestCharged?: RequestCharged | string;\n\n /**\n *Indicates the path in the provided S3 output location where Select results will be\n * restored to.
\n */\n RestoreOutputPath?: string;\n}\n\nexport namespace RestoreObjectOutput {\n export const filterSensitiveLog = (obj: RestoreObjectOutput): any => ({\n ...obj,\n });\n}\n\nexport type Tier = \"Bulk\" | \"Expedited\" | \"Standard\";\n\n/**\n *Container for S3 Glacier job parameters.
\n */\nexport interface GlacierJobParameters {\n /**\n *Retrieval tier at which the restore will be processed.
\n */\n Tier: Tier | string | undefined;\n}\n\nexport namespace GlacierJobParameters {\n export const filterSensitiveLog = (obj: GlacierJobParameters): any => ({\n ...obj,\n });\n}\n\n/**\n *Contains the type of server-side encryption used.
\n */\nexport interface Encryption {\n /**\n *The server-side encryption algorithm used when storing job results in Amazon S3 (for example,\n * AES256, aws:kms).
\n */\n EncryptionType: ServerSideEncryption | string | undefined;\n\n /**\n *If the encryption type is aws:kms, this optional value specifies the ID of\n * the symmetric customer managed AWS KMS CMK to use for encryption of job results. Amazon S3 only\n * supports symmetric CMKs. For more information, see Using Symmetric and\n * Asymmetric Keys in the AWS Key Management Service Developer\n * Guide.
If the encryption type is aws:kms, this optional value can be used to\n * specify the encryption context for the restore results.
A metadata key-value pair to store with an object.
\n */\nexport interface MetadataEntry {\n /**\n *Name of the Object.
\n */\n Name?: string;\n\n /**\n *Value of the Object.
\n */\n Value?: string;\n}\n\nexport namespace MetadataEntry {\n export const filterSensitiveLog = (obj: MetadataEntry): any => ({\n ...obj,\n });\n}\n\n/**\n *Describes an Amazon S3 location that will receive the results of the restore request.
\n */\nexport interface S3Location {\n /**\n *The name of the bucket where the restore results will be placed.
\n */\n BucketName: string | undefined;\n\n /**\n *The prefix that is prepended to the restore results for this request.
\n */\n Prefix: string | undefined;\n\n /**\n *Contains the type of server-side encryption used.
\n */\n Encryption?: Encryption;\n\n /**\n *The canned ACL to apply to the restore results.
\n */\n CannedACL?: ObjectCannedACL | string;\n\n /**\n *A list of grants that control access to the staged results.
\n */\n AccessControlList?: Grant[];\n\n /**\n *The tag-set that is applied to the restore results.
\n */\n Tagging?: Tagging;\n\n /**\n *A list of metadata to store with the restore results in S3.
\n */\n UserMetadata?: MetadataEntry[];\n\n /**\n *The class of storage used to store the restore results.
\n */\n StorageClass?: StorageClass | string;\n}\n\nexport namespace S3Location {\n export const filterSensitiveLog = (obj: S3Location): any => ({\n ...obj,\n ...(obj.Encryption && { Encryption: Encryption.filterSensitiveLog(obj.Encryption) }),\n });\n}\n\n/**\n *Describes the location where the restore job's output is stored.
\n */\nexport interface OutputLocation {\n /**\n *Describes an S3 location that will receive the results of the restore request.
\n */\n S3?: S3Location;\n}\n\nexport namespace OutputLocation {\n export const filterSensitiveLog = (obj: OutputLocation): any => ({\n ...obj,\n ...(obj.S3 && { S3: S3Location.filterSensitiveLog(obj.S3) }),\n });\n}\n\nexport type ExpressionType = \"SQL\";\n\nexport type CompressionType = \"BZIP2\" | \"GZIP\" | \"NONE\";\n\nexport enum FileHeaderInfo {\n IGNORE = \"IGNORE\",\n NONE = \"NONE\",\n USE = \"USE\",\n}\n\n/**\n *Describes how an uncompressed comma-separated values (CSV)-formatted input object is\n * formatted.
\n */\nexport interface CSVInput {\n /**\n *Describes the first line of input. Valid values are:
\n *\n * NONE: First line is not a header.
\n * IGNORE: First line is a header, but you can't use the header values\n * to indicate the column in an expression. You can use column position (such as _1, _2,\n * …) to indicate the column (SELECT s._1 FROM OBJECT s).
\n * Use: First line is a header, and you can use the header value to\n * identify a column in an expression (SELECT \"name\" FROM OBJECT).
A single character used to indicate that a row should be ignored when the character is\n * present at the start of that row. You can specify any character to indicate a comment\n * line.
\n */\n Comments?: string;\n\n /**\n *A single character used for escaping the quotation mark character inside an already\n * escaped value. For example, the value \"\"\" a , b \"\"\" is parsed as \" a , b \".
\n */\n QuoteEscapeCharacter?: string;\n\n /**\n *A single character used to separate individual records in the input. Instead of the\n * default value, you can specify an arbitrary delimiter.
\n */\n RecordDelimiter?: string;\n\n /**\n *A single character used to separate individual fields in a record. You can specify an\n * arbitrary delimiter.
\n */\n FieldDelimiter?: string;\n\n /**\n *A single character used for escaping when the field delimiter is part of the value. For\n * example, if the value is a, b, Amazon S3 wraps this field value in quotation marks,\n * as follows: \" a , b \".
Type: String
\n *Default: \"\n *
Ancestors: CSV\n *
Specifies that CSV field values may contain quoted record delimiters and such records\n * should be allowed. Default value is FALSE. Setting this value to TRUE may lower\n * performance.
\n */\n AllowQuotedRecordDelimiter?: boolean;\n}\n\nexport namespace CSVInput {\n export const filterSensitiveLog = (obj: CSVInput): any => ({\n ...obj,\n });\n}\n\nexport enum JSONType {\n DOCUMENT = \"DOCUMENT\",\n LINES = \"LINES\",\n}\n\n/**\n *Specifies JSON as object's input serialization format.
\n */\nexport interface JSONInput {\n /**\n *The type of JSON. Valid values: Document, Lines.
\n */\n Type?: JSONType | string;\n}\n\nexport namespace JSONInput {\n export const filterSensitiveLog = (obj: JSONInput): any => ({\n ...obj,\n });\n}\n\n/**\n *Container for Parquet.
\n */\nexport interface ParquetInput {}\n\nexport namespace ParquetInput {\n export const filterSensitiveLog = (obj: ParquetInput): any => ({\n ...obj,\n });\n}\n\n/**\n *Describes the serialization format of the object.
\n */\nexport interface InputSerialization {\n /**\n *Describes the serialization of a CSV-encoded object.
\n */\n CSV?: CSVInput;\n\n /**\n *Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value:\n * NONE.
\n */\n CompressionType?: CompressionType | string;\n\n /**\n *Specifies JSON as object's input serialization format.
\n */\n JSON?: JSONInput;\n\n /**\n *Specifies Parquet as object's input serialization format.
\n */\n Parquet?: ParquetInput;\n}\n\nexport namespace InputSerialization {\n export const filterSensitiveLog = (obj: InputSerialization): any => ({\n ...obj,\n });\n}\n\nexport enum QuoteFields {\n ALWAYS = \"ALWAYS\",\n ASNEEDED = \"ASNEEDED\",\n}\n\n/**\n *Describes how uncompressed comma-separated values (CSV)-formatted results are\n * formatted.
\n */\nexport interface CSVOutput {\n /**\n *Indicates whether to use quotation marks around output fields.
\n *\n * ALWAYS: Always use quotation marks for output fields.
\n * ASNEEDED: Use quotation marks for output fields when needed.
The single character used for escaping the quote character inside an already escaped\n * value.
\n */\n QuoteEscapeCharacter?: string;\n\n /**\n *A single character used to separate individual records in the output. Instead of the\n * default value, you can specify an arbitrary delimiter.
\n */\n RecordDelimiter?: string;\n\n /**\n *The value used to separate individual fields in a record. You can specify an arbitrary\n * delimiter.
\n */\n FieldDelimiter?: string;\n\n /**\n *A single character used for escaping when the field delimiter is part of the value. For\n * example, if the value is a, b, Amazon S3 wraps this field value in quotation marks,\n * as follows: \" a , b \".
Specifies JSON as request's output serialization format.
\n */\nexport interface JSONOutput {\n /**\n *The value used to separate individual records in the output. If no value is specified,\n * Amazon S3 uses a newline character ('\\n').
\n */\n RecordDelimiter?: string;\n}\n\nexport namespace JSONOutput {\n export const filterSensitiveLog = (obj: JSONOutput): any => ({\n ...obj,\n });\n}\n\n/**\n *Describes how results of the Select job are serialized.
\n */\nexport interface OutputSerialization {\n /**\n *Describes the serialization of CSV-encoded Select results.
\n */\n CSV?: CSVOutput;\n\n /**\n *Specifies JSON as request's output serialization format.
\n */\n JSON?: JSONOutput;\n}\n\nexport namespace OutputSerialization {\n export const filterSensitiveLog = (obj: OutputSerialization): any => ({\n ...obj,\n });\n}\n\n/**\n *Describes the parameters for Select job types.
\n */\nexport interface SelectParameters {\n /**\n *Describes the serialization format of the object.
\n */\n InputSerialization: InputSerialization | undefined;\n\n /**\n *The type of the provided expression (for example, SQL).
\n */\n ExpressionType: ExpressionType | string | undefined;\n\n /**\n *The expression that is used to query the object.
\n */\n Expression: string | undefined;\n\n /**\n *Describes how the results of the Select job are serialized.
\n */\n OutputSerialization: OutputSerialization | undefined;\n}\n\nexport namespace SelectParameters {\n export const filterSensitiveLog = (obj: SelectParameters): any => ({\n ...obj,\n });\n}\n\nexport enum RestoreRequestType {\n SELECT = \"SELECT\",\n}\n\n/**\n *Container for restore job parameters.
\n */\nexport interface RestoreRequest {\n /**\n *Lifetime of the active copy in days. Do not use with restores that specify\n * OutputLocation.
The Days element is required for regular restores, and must not be provided for select\n * requests.
\n */\n Days?: number;\n\n /**\n *S3 Glacier related parameters pertaining to this job. Do not use with restores that\n * specify OutputLocation.
Type of restore request.
\n */\n Type?: RestoreRequestType | string;\n\n /**\n *Retrieval tier at which the restore will be processed.
\n */\n Tier?: Tier | string;\n\n /**\n *The optional description for the job.
\n */\n Description?: string;\n\n /**\n *Describes the parameters for Select job types.
\n */\n SelectParameters?: SelectParameters;\n\n /**\n *Describes the location where the restore job's output is stored.
\n */\n OutputLocation?: OutputLocation;\n}\n\nexport namespace RestoreRequest {\n export const filterSensitiveLog = (obj: RestoreRequest): any => ({\n ...obj,\n ...(obj.OutputLocation && { OutputLocation: OutputLocation.filterSensitiveLog(obj.OutputLocation) }),\n });\n}\n\nexport interface RestoreObjectRequest {\n /**\n *The bucket name containing the object to restore.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n *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 Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket: string | undefined;\n\n /**\n *Object key for which the operation was initiated.
\n */\n Key: string | undefined;\n\n /**\n *VersionId used to reference a specific version of the object.
\n */\n VersionId?: string;\n\n /**\n *Container for restore job parameters.
\n */\n RestoreRequest?: RestoreRequest;\n\n /**\n *Confirms that the requester knows that they will be charged for the request. Bucket\n * owners need not specify this parameter in their requests. For information about downloading\n * objects from requester pays buckets, see Downloading Objects in\n * Requestor Pays Buckets in the Amazon S3 Developer Guide.
\n */\n RequestPayer?: RequestPayer | string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
A message that indicates the request is complete and no more messages will be sent. You\n * should not assume that the request is complete until the client receives an\n * EndEvent.
This data type contains information about progress of an operation.
\n */\nexport interface Progress {\n /**\n *The current number of object bytes scanned.
\n */\n BytesScanned?: number;\n\n /**\n *The current number of uncompressed object bytes processed.
\n */\n BytesProcessed?: number;\n\n /**\n *The current number of bytes of records payload data returned.
\n */\n BytesReturned?: number;\n}\n\nexport namespace Progress {\n export const filterSensitiveLog = (obj: Progress): any => ({\n ...obj,\n });\n}\n\n/**\n *This data type contains information about the progress event of an operation.
\n */\nexport interface ProgressEvent {\n /**\n *The Progress event details.
\n */\n Details?: Progress;\n}\n\nexport namespace ProgressEvent {\n export const filterSensitiveLog = (obj: ProgressEvent): any => ({\n ...obj,\n });\n}\n\n/**\n *The container for the records event.
\n */\nexport interface RecordsEvent {\n /**\n *The byte array of partial, one or more result records.
\n */\n Payload?: Uint8Array;\n}\n\nexport namespace RecordsEvent {\n export const filterSensitiveLog = (obj: RecordsEvent): any => ({\n ...obj,\n });\n}\n\n/**\n *Container for the stats details.
\n */\nexport interface Stats {\n /**\n *The total number of object bytes scanned.
\n */\n BytesScanned?: number;\n\n /**\n *The total number of uncompressed object bytes processed.
\n */\n BytesProcessed?: number;\n\n /**\n *The total number of bytes of records payload data returned.
\n */\n BytesReturned?: number;\n}\n\nexport namespace Stats {\n export const filterSensitiveLog = (obj: Stats): any => ({\n ...obj,\n });\n}\n\n/**\n *Container for the Stats Event.
\n */\nexport interface StatsEvent {\n /**\n *The Stats event details.
\n */\n Details?: Stats;\n}\n\nexport namespace StatsEvent {\n export const filterSensitiveLog = (obj: StatsEvent): any => ({\n ...obj,\n });\n}\n\n/**\n *The container for selecting objects from a content event stream.
\n */\nexport type SelectObjectContentEventStream =\n | SelectObjectContentEventStream.ContMember\n | SelectObjectContentEventStream.EndMember\n | SelectObjectContentEventStream.ProgressMember\n | SelectObjectContentEventStream.RecordsMember\n | SelectObjectContentEventStream.StatsMember\n | SelectObjectContentEventStream.$UnknownMember;\n\nexport namespace SelectObjectContentEventStream {\n /**\n *The Records Event.
\n */\n export interface RecordsMember {\n Records: RecordsEvent;\n Stats?: never;\n Progress?: never;\n Cont?: never;\n End?: never;\n $unknown?: never;\n }\n\n /**\n *The Stats Event.
\n */\n export interface StatsMember {\n Records?: never;\n Stats: StatsEvent;\n Progress?: never;\n Cont?: never;\n End?: never;\n $unknown?: never;\n }\n\n /**\n *The Progress Event.
\n */\n export interface ProgressMember {\n Records?: never;\n Stats?: never;\n Progress: ProgressEvent;\n Cont?: never;\n End?: never;\n $unknown?: never;\n }\n\n /**\n *The Continuation Event.
\n */\n export interface ContMember {\n Records?: never;\n Stats?: never;\n Progress?: never;\n Cont: ContinuationEvent;\n End?: never;\n $unknown?: never;\n }\n\n /**\n *The End Event.
\n */\n export interface EndMember {\n Records?: never;\n Stats?: never;\n Progress?: never;\n Cont?: never;\n End: EndEvent;\n $unknown?: never;\n }\n\n export interface $UnknownMember {\n Records?: never;\n Stats?: never;\n Progress?: never;\n Cont?: never;\n End?: never;\n $unknown: [string, any];\n }\n\n export interface VisitorThe array of results.
\n */\n Payload?: AsyncIterableContainer for specifying if periodic QueryProgress messages should be\n * sent.
Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE,\n * FALSE. Default value: FALSE.
\n */\n Enabled?: boolean;\n}\n\nexport namespace RequestProgress {\n export const filterSensitiveLog = (obj: RequestProgress): any => ({\n ...obj,\n });\n}\n\n/**\n *Specifies the byte range of the object to get the records from. A record is processed\n * when its first byte is contained by the range. This parameter is optional, but when\n * specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the\n * start and end of the range.
\n */\nexport interface ScanRange {\n /**\n *Specifies the start of the byte range. This parameter is optional. Valid values:\n * non-negative integers. The default value is 0. If only start is supplied, it means scan\n * from that point to the end of the file.For example;\n *
Specifies the end of the byte range. This parameter is optional. Valid values:\n * non-negative integers. The default value is one less than the size of the object being\n * queried. If only the End parameter is supplied, it is interpreted to mean scan the last N\n * bytes of the file. For example,\n *
Request to filter the contents of an Amazon S3 object based on a simple Structured Query\n * Language (SQL) statement. In the request, along with the SQL expression, you must specify a\n * data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data\n * into records. It returns only records that match the specified SQL expression. You must\n * also specify the data serialization format for the response. For more information, see\n * S3Select API Documentation.
\n */\nexport interface SelectObjectContentRequest {\n /**\n *The S3 bucket.
\n */\n Bucket: string | undefined;\n\n /**\n *The object key.
\n */\n Key: string | undefined;\n\n /**\n *The SSE Algorithm used to encrypt the object. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.
\n */\n SSECustomerAlgorithm?: string;\n\n /**\n *The SSE Customer Key. For more information, see Server-Side Encryption\n * (Using Customer-Provided Encryption Keys.
\n */\n SSECustomerKey?: string;\n\n /**\n *The SSE Customer Key MD5. For more information, see Server-Side Encryption\n * (Using Customer-Provided Encryption Keys.
\n */\n SSECustomerKeyMD5?: string;\n\n /**\n *The expression that is used to query the object.
\n */\n Expression: string | undefined;\n\n /**\n *The type of the provided expression (for example, SQL).
\n */\n ExpressionType: ExpressionType | string | undefined;\n\n /**\n *Specifies if periodic request progress information should be enabled.
\n */\n RequestProgress?: RequestProgress;\n\n /**\n *Describes the format of the data in the object that is being queried.
\n */\n InputSerialization: InputSerialization | undefined;\n\n /**\n *Describes the format of the data that you want Amazon S3 to return in response.
\n */\n OutputSerialization: OutputSerialization | undefined;\n\n /**\n *Specifies the byte range of the object to get the records from. A record is processed\n * when its first byte is contained by the range. This parameter is optional, but when\n * specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the\n * start and end of the range.
\n *\n * ScanRangemay be used in the following ways:
\n *
\n *
\n *
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n * AES256, aws:kms).
\n */\n ServerSideEncryption?: ServerSideEncryption | string;\n\n /**\n *Entity tag for the uploaded object.
\n */\n ETag?: string;\n\n /**\n *If server-side encryption with a customer-provided encryption key was requested, the\n * response will include this header confirming the encryption algorithm used.
\n */\n SSECustomerAlgorithm?: string;\n\n /**\n *If server-side encryption with a customer-provided encryption key was requested, the\n * response will include this header to provide round-trip message integrity verification of\n * the customer-provided encryption key.
\n */\n SSECustomerKeyMD5?: string;\n\n /**\n *If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n * customer managed customer master key (CMK) was used for the object.
\n */\n SSEKMSKeyId?: string;\n\n /**\n *Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).
\n */\n BucketKeyEnabled?: boolean;\n\n /**\n *If present, indicates that the requester was successfully charged for the\n * request.
\n */\n RequestCharged?: RequestCharged | string;\n}\n\nexport namespace UploadPartOutput {\n export const filterSensitiveLog = (obj: UploadPartOutput): any => ({\n ...obj,\n ...(obj.SSEKMSKeyId && { SSEKMSKeyId: SENSITIVE_STRING }),\n });\n}\n\nexport interface UploadPartRequest {\n /**\n *Object data.
\n */\n Body?: Readable | ReadableStream | Blob;\n\n /**\n *The name of the bucket to which the multipart upload was initiated.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n *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 Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket: string | undefined;\n\n /**\n *Size of the body in bytes. This parameter is useful when the size of the body cannot be\n * determined automatically.
\n */\n ContentLength?: number;\n\n /**\n *The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated\n * when using the command from the CLI. This parameter is required if object lock parameters\n * are specified.
\n */\n ContentMD5?: string;\n\n /**\n *Object key for which the multipart upload was initiated.
\n */\n Key: string | undefined;\n\n /**\n *Part number of part being uploaded. This is a positive integer between 1 and\n * 10,000.
\n */\n PartNumber: number | undefined;\n\n /**\n *Upload ID identifying the multipart upload whose part is being uploaded.
\n */\n UploadId: string | undefined;\n\n /**\n *Specifies the algorithm to use to when encrypting the object (for example,\n * AES256).
\n */\n SSECustomerAlgorithm?: string;\n\n /**\n *Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n * value is used to store the object and then it is discarded; Amazon S3 does not store the\n * encryption key. The key must be appropriate for use with the algorithm specified in the\n * x-amz-server-side-encryption-customer-algorithm header. This must be the\n * same encryption key specified in the initiate multipart upload request.
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n * this header for a message integrity check to ensure that the encryption key was transmitted\n * without error.
\n */\n SSECustomerKeyMD5?: string;\n\n /**\n *Confirms that the requester knows that they will be charged for the request. Bucket\n * owners need not specify this parameter in their requests. For information about downloading\n * objects from requester pays buckets, see Downloading Objects in\n * Requestor Pays Buckets in the Amazon S3 Developer Guide.
\n */\n RequestPayer?: RequestPayer | string;\n\n /**\n *The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
Container for all response elements.
\n */\nexport interface CopyPartResult {\n /**\n *Entity tag of the object.
\n */\n ETag?: string;\n\n /**\n *Date and time at which the object was uploaded.
\n */\n LastModified?: Date;\n}\n\nexport namespace CopyPartResult {\n export const filterSensitiveLog = (obj: CopyPartResult): any => ({\n ...obj,\n });\n}\n\nexport interface UploadPartCopyOutput {\n /**\n *The version of the source object that was copied, if you have enabled versioning on the\n * source bucket.
\n */\n CopySourceVersionId?: string;\n\n /**\n *Container for all response elements.
\n */\n CopyPartResult?: CopyPartResult;\n\n /**\n *The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n * AES256, aws:kms).
\n */\n ServerSideEncryption?: ServerSideEncryption | string;\n\n /**\n *If server-side encryption with a customer-provided encryption key was requested, the\n * response will include this header confirming the encryption algorithm used.
\n */\n SSECustomerAlgorithm?: string;\n\n /**\n *If server-side encryption with a customer-provided encryption key was requested, the\n * response will include this header to provide round-trip message integrity verification of\n * the customer-provided encryption key.
\n */\n SSECustomerKeyMD5?: string;\n\n /**\n *If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n * customer managed customer master key (CMK) that was used for the object.
\n */\n SSEKMSKeyId?: string;\n\n /**\n *Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).
\n */\n BucketKeyEnabled?: boolean;\n\n /**\n *If present, indicates that the requester was successfully charged for the\n * request.
\n */\n RequestCharged?: RequestCharged | string;\n}\n\nexport namespace UploadPartCopyOutput {\n export const filterSensitiveLog = (obj: UploadPartCopyOutput): any => ({\n ...obj,\n ...(obj.SSEKMSKeyId && { SSEKMSKeyId: SENSITIVE_STRING }),\n });\n}\n\nexport interface UploadPartCopyRequest {\n /**\n *The bucket name.
\n *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 Using Access Points in the Amazon Simple Storage Service Developer Guide.
\n *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 Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
\n */\n Bucket: string | undefined;\n\n /**\n *Specifies the source object for the copy operation. You specify the value in one of two\n * formats, depending on whether you want to access the source object through an access\n * point:
\n *For objects not accessed through an access point, specify the name of the source\n * bucket and key of the source object, separated by a slash (/). For example, to copy\n * the object reports/january.pdf from the bucket\n * awsexamplebucket, use\n * awsexamplebucket/reports/january.pdf. The value must be URL\n * encoded.
For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.
Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same AWS Region.
\n *Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL encoded.
To copy a specific version of an object, append ?versionId=\n * to the value (for example,\n * awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893).\n * If you don't specify a version ID, Amazon S3 copies the latest version of the source\n * object.
Copies the object if its entity tag (ETag) matches the specified tag.
\n */\n CopySourceIfMatch?: string;\n\n /**\n *Copies the object if it has been modified since the specified time.
\n */\n CopySourceIfModifiedSince?: Date;\n\n /**\n *Copies the object if its entity tag (ETag) is different than the specified ETag.
\n */\n CopySourceIfNoneMatch?: string;\n\n /**\n *Copies the object if it hasn't been modified since the specified time.
\n */\n CopySourceIfUnmodifiedSince?: Date;\n\n /**\n *The range of bytes to copy from the source object. The range value must use the form\n * bytes=first-last, where the first and last are the zero-based byte offsets to copy. For\n * example, bytes=0-9 indicates that you want to copy the first 10 bytes of the source. You\n * can copy a range only if the source object is greater than 5 MB.
\n */\n CopySourceRange?: string;\n\n /**\n *Object key for which the multipart upload was initiated.
\n */\n Key: string | undefined;\n\n /**\n *Part number of part being copied. This is a positive integer between 1 and\n * 10,000.
\n */\n PartNumber: number | undefined;\n\n /**\n *Upload ID identifying the multipart upload whose part is being copied.
\n */\n UploadId: string | undefined;\n\n /**\n *Specifies the algorithm to use to when encrypting the object (for example,\n * AES256).
\n */\n SSECustomerAlgorithm?: string;\n\n /**\n *Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n * value is used to store the object and then it is discarded; Amazon S3 does not store the\n * encryption key. The key must be appropriate for use with the algorithm specified in the\n * x-amz-server-side-encryption-customer-algorithm header. This must be the\n * same encryption key specified in the initiate multipart upload request.
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n * this header for a message integrity check to ensure that the encryption key was transmitted\n * without error.
\n */\n SSECustomerKeyMD5?: string;\n\n /**\n *Specifies the algorithm to use when decrypting the source object (for example,\n * AES256).
\n */\n CopySourceSSECustomerAlgorithm?: string;\n\n /**\n *Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source\n * object. The encryption key provided in this header must be one that was used when the\n * source object was created.
\n */\n CopySourceSSECustomerKey?: string;\n\n /**\n *Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n * this header for a message integrity check to ensure that the encryption key was transmitted\n * without error.
\n */\n CopySourceSSECustomerKeyMD5?: string;\n\n /**\n *Confirms that the requester knows that they will be charged for the request. Bucket\n * owners need not specify this parameter in their requests. For information about downloading\n * objects from requester pays buckets, see Downloading Objects in\n * Requestor Pays Buckets in the Amazon S3 Developer Guide.
\n */\n RequestPayer?: RequestPayer | string;\n\n /**\n *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 403 (Access Denied) error.
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 403 (Access Denied) error.