@aws-sdk/client-s3

import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client"; import { StreamingBlobTypes } from "@smithy/types"; import { AccessControlPolicy, BucketVersioningStatus, ChecksumAlgorithm, ChecksumType, CORSRule, ErrorDocument, Grant, IndexDocument, IntelligentTieringConfiguration, InventoryConfiguration, LifecycleRule, LoggingEnabled, MetricsConfiguration, NotificationConfiguration, ObjectCannedACL, ObjectLockConfiguration, ObjectLockLegalHold, ObjectLockLegalHoldStatus, ObjectLockMode, ObjectLockRetention, OwnershipControls, Payer, PublicAccessBlockConfiguration, RedirectAllRequestsTo, ReplicationConfiguration, ReplicationStatus, RequestCharged, RequestPayer, RoutingRule, ServerSideEncryption, ServerSideEncryptionConfiguration, StorageClass, Tag, TransitionDefaultMinimumObjectSize } from "./models_0"; import { S3ServiceException as __BaseException } from "./S3ServiceException"; /** * Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling * Cross-Origin Resource Sharing</a> in the * Amazon S3 User Guide. * @public */ export interface CORSConfiguration { /** * A set of origins and methods (cross-origin access that you want to allow). You can add * up to 100 rules to the configuration. * @public */ CORSRules: CORSRule[] | undefined; } /** * @public */ export interface PutBucketCorsRequest { /** * Specifies the bucket impacted by the <code>cors</code>configuration. * Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues * @public */ Bucket: string | undefined; /** * Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling * Cross-Origin Resource Sharing</a> in the * Amazon S3 User Guide. * @public */ CORSConfiguration: CORSConfiguration | undefined; /** * The Base64 encoded 128-bit <code>MD5</code> digest of the data. This header must be used as a message * integrity check to verify that the request body was not corrupted in transit. For more * information, go to <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC * 1864.</a> * * For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically. * @public */ ContentMD5?: string | undefined; /** * Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in * the Amazon S3 User Guide. * If you provide an individual checksum, Amazon S3 ignores any provided * <code>ChecksumAlgorithm</code> parameter. * @public */ ChecksumAlgorithm?: ChecksumAlgorithm | undefined; /** * The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied). * @public */ ExpectedBucketOwner?: string | undefined; } /** * @public */ export interface PutBucketEncryptionRequest { /** * Specifies default encryption for a bucket using server-side encryption with different * key options. * * Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format <code>https://s3express-control.region-code.amazonaws.com/bucket-name * </code>. Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format <code> * bucket-base-name--zone-id--x-s3</code> (for example, <code> * DOC-EXAMPLE-BUCKET--usw2-az1--x-s3</code>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the Amazon S3 User Guide * * Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues * @public */ Bucket: string | undefined; /** * The Base64 encoded 128-bit <code>MD5</code> digest of the server-side encryption * configuration. * For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically. * <note> * This functionality is not supported for directory buckets. * </note> * @public */ ContentMD5?: string | undefined; /** * Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in * the Amazon S3 User Guide. * If you provide an individual checksum, Amazon S3 ignores any provided * <code>ChecksumAlgorithm</code> parameter. * <note> * For directory buckets, when you use Amazon Web Services SDKs, <code>CRC32</code> is the default checksum algorithm that's used for performance. * </note> * @public */ ChecksumAlgorithm?: ChecksumAlgorithm | undefined; /** * Specifies the default server-side-encryption configuration. * @public */ ServerSideEncryptionConfiguration: ServerSideEncryptionConfiguration | undefined; /** * The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied). * <note> * For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code * <code>501 Not Implemented</code>. * </note> * @public */ ExpectedBucketOwner?: string | undefined; } /** * @public */ export interface PutBucketIntelligentTieringConfigurationRequest { /** * The name of the Amazon S3 bucket whose configuration you want to modify or retrieve. * Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues * @public */ Bucket: string | undefined; /** * The ID used to identify the S3 Intelligent-Tiering configuration. * @public */ Id: string | undefined; /** * Container for S3 Intelligent-Tiering configuration. * @public */ IntelligentTieringConfiguration: IntelligentTieringConfiguration | undefined; } /** * @public */ export interface PutBucketInventoryConfigurationRequest { /** * The name of the bucket where the inventory configuration will be stored. * Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues * @public */ Bucket: string | undefined; /** * The ID used to identify the inventory configuration. * @public */ Id: string | undefined; /** * Specifies the inventory configuration. * @public */ InventoryConfiguration: InventoryConfiguration | undefined; /** * The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied). * @public */ ExpectedBucketOwner?: string | undefined; } /** * @public */ export interface PutBucketLifecycleConfigurationOutput { /** * Indicates which default minimum object size behavior is applied to the lifecycle * configuration. * <note> * This parameter applies to general purpose buckets only. It is not supported for * directory bucket lifecycle configurations. * </note> * <ul> * <li> * * <code>all_storage_classes_128K</code> - Objects smaller than 128 KB will not * transition to any storage class by default. * </li> * <li> * * <code>varies_by_storage_class</code> - Objects smaller than 128 KB will * transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By * default, all other storage classes will prevent transitions smaller than 128 KB. * * </li> * </ul> * To customize the minimum object size for any transition you can add a filter that * specifies a custom <code>ObjectSizeGreaterThan</code> or <code>ObjectSizeLessThan</code> in * the body of your transition rule. Custom filters always take precedence over the default * transition behavior. * @public */ TransitionDefaultMinimumObjectSize?: TransitionDefaultMinimumObjectSize | undefined; } /** * Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle Management</a> * in the Amazon S3 User Guide. * @public */ export interface BucketLifecycleConfiguration { /** * A lifecycle rule for individual objects in an Amazon S3 bucket. * @public */ Rules: LifecycleRule[] | undefined; } /** * @public */ export interface PutBucketLifecycleConfigurationRequest { /** * The name of the bucket for which to set the configuration. * Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues * @public */ Bucket: string | undefined; /** * Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in * the Amazon S3 User Guide. * If you provide an individual checksum, Amazon S3 ignores any provided * <code>ChecksumAlgorithm</code> parameter. * @public */ ChecksumAlgorithm?: ChecksumAlgorithm | undefined; /** * Container for lifecycle rules. You can add as many as 1,000 rules. * @public */ LifecycleConfiguration?: BucketLifecycleConfiguration | undefined; /** * The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied). * <note> * This parameter applies to general purpose buckets only. It is not supported for * directory bucket lifecycle configurations. * </note> * @public */ ExpectedBucketOwner?: string | undefined; /** * Indicates which default minimum object size behavior is applied to the lifecycle * configuration. * <note> * This parameter applies to general purpose buckets only. It is not supported for * directory bucket lifecycle configurations. * </note> * <ul> * <li> * * <code>all_storage_classes_128K</code> - Objects smaller than 128 KB will not * transition to any storage class by default. * </li> * <li> * * <code>varies_by_storage_class</code> - Objects smaller than 128 KB will * transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By * default, all other storage classes will prevent transitions smaller than 128 KB. * * </li> * </ul> * To customize the minimum object size for any transition you can add a filter that * specifies a custom <code>ObjectSizeGreaterThan</code> or <code>ObjectSizeLessThan</code> in * the body of your transition rule. Custom filters always take precedence over the default * transition behavior. * @public */ TransitionDefaultMinimumObjectSize?: TransitionDefaultMinimumObjectSize | undefined; } /** * Container for logging status information. * @public */ export interface BucketLoggingStatus { /** * Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys * for a bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html">PUT Bucket logging</a> in the * Amazon S3 API Reference. * @public */ LoggingEnabled?: LoggingEnabled | undefined; } /** * @public */ export interface PutBucketLoggingRequest { /** * The name of the bucket for which to set the logging parameters. * Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues * @public */ Bucket: string | undefined; /** * Container for logging status information. * @public */ BucketLoggingStatus: BucketLoggingStatus | undefined; /** * The MD5 hash of the <code>PutBucketLogging</code> request body. * For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically. * @public */ ContentMD5?: string | undefined; /** * Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in * the Amazon S3 User Guide. * If you provide an individual checksum, Amazon S3 ignores any provided * <code>ChecksumAlgorithm</code> parameter. * @public */ ChecksumAlgorithm?: ChecksumAlgorithm | undefined; /** * The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied). * @public */ ExpectedBucketOwner?: string | undefined; } /** * @public */ export interface PutBucketMetricsConfigurationRequest { /** * The name of the bucket for which the metrics configuration is set. * Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues * @public */ Bucket: string | undefined; /** * The ID used to identify the metrics configuration. The ID has a 64 character limit and * can only contain letters, numbers, periods, dashes, and underscores. * @public */ Id: string | undefined; /** * Specifies the metrics configuration. * @public */ MetricsConfiguration: MetricsConfiguration | undefined; /** * The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied). * @public */ ExpectedBucketOwner?: string | undefined; } /** * @public */ export interface PutBucketNotificationConfigurationRequest { /** * The name of the bucket. * Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues * @public */ Bucket: string | undefined; /** * A container for specifying the notification configuration of the bucket. If this element * is empty, notifications are turned off for the bucket. * @public */ NotificationConfiguration: NotificationConfiguration | undefined; /** * The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied). * @public */ ExpectedBucketOwner?: string | undefined; /** * Skips validation of Amazon SQS, Amazon SNS, and Lambda * destinations. True or false value. * @public */ SkipDestinationValidation?: boolean | undefined; } /** * @public */ export interface PutBucketOwnershipControlsRequest { /** * The name of the Amazon S3 bucket whose <code>OwnershipControls</code> you want to set. * Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues * @public */ Bucket: string | undefined; /** * The MD5 hash of the <code>OwnershipControls</code> request body. * For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically. * @public */ ContentMD5?: string | undefined; /** * The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied). * @public */ ExpectedBucketOwner?: string | undefined; /** * The <code>OwnershipControls</code> (BucketOwnerEnforced, BucketOwnerPreferred, or * ObjectWriter) that you want to apply to this Amazon S3 bucket. * @public */ OwnershipControls: OwnershipControls | undefined; /** * Indicates the algorithm used to create the checksum for the object when you use the * SDK. This header will not provide any additional functionality if you don't use the * SDK. When you send this header, there must be a corresponding * <code>x-amz-checksum-algorithm * </code> header sent. Otherwise, Amazon S3 fails the request with the HTTP * status code <code>400 Bad Request</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object * integrity</a> in the Amazon S3 User Guide. * If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter. * @public */ ChecksumAlgorithm?: ChecksumAlgorithm | undefined; } /** * @public */ export interface PutBucketPolicyRequest { /** * The name of the bucket. * * Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format <code>https://s3express-control.region-code.amazonaws.com/bucket-name * </code>. Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format <code> * bucket-base-name--zone-id--x-s3</code> (for example, <code> * DOC-EXAMPLE-BUCKET--usw2-az1--x-s3</code>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the Amazon S3 User Guide * * Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues * @public */ Bucket: string | undefined; /** * The MD5 hash of the request body. * For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically. * <note> * This functionality is not supported for directory buckets. * </note> * @public */ ContentMD5?: string | undefined; /** * Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum-algorithm * </code> or * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. * For the <code>x-amz-checksum-algorithm * </code> header, replace <code> * algorithm * </code> with the supported algorithm from the following list: * <ul> * <li> * * <code>CRC32</code> * * </li> * <li> * * <code>CRC32C</code> * * </li> * <li> * * <code>CRC64NVME</code> * * </li> * <li> * * <code>SHA1</code> * * </li> * <li> * * <code>SHA256</code> * * </li> * </ul> * For more * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in * the Amazon S3 User Guide. * If the individual checksum value you provide through <code>x-amz-checksum-algorithm * </code> doesn't match the checksum algorithm you set through <code>x-amz-sdk-checksum-algorithm</code>, Amazon S3 fails the request with a <code>BadDigest</code> error. * <note> * For directory buckets, when you use Amazon Web Services SDKs, <code>CRC32</code> is the default checksum algorithm that's used for performance. * </note> * @public */ ChecksumAlgorithm?: ChecksumAlgorithm | undefined; /** * Set this parameter to true to confirm that you want to remove your permissions to change * this bucket policy in the future. * <note> * This functionality is not supported for directory buckets. * </note> * @public */ ConfirmRemoveSelfBucketAccess?: boolean | undefined; /** * The bucket policy as a JSON document. * For directory buckets, the only IAM action supported in the bucket policy is * <code>s3express:CreateSession</code>. * @public */ Policy: string | undefined; /** * The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied). * <note> * For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code * <code>501 Not Implemented</code>. * </note> * @public */ ExpectedBucketOwner?: string | undefined; } /** * @public */ export interface PutBucketReplicationRequest { /** * The name of the bucket * Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues * @public */ Bucket: string | undefined; /** * The Base64 encoded 128-bit <code>MD5</code> digest of the data. You must use this header as a message * integrity check to verify that the request body was not corrupted in transit. For more * information, see <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864</a>. * For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically. * @public */ ContentMD5?: string | undefined; /** * Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in * the Amazon S3 User Guide. * If you provide an individual checksum, Amazon S3 ignores any provided * <code>ChecksumAlgorithm</code> parameter. * @public */ ChecksumAlgorithm?: ChecksumAlgorithm | undefined; /** * A container for replication rules. You can add up to 1,000 rules. The maximum size of a * replication configuration is 2 MB. * @public */ ReplicationConfiguration: ReplicationConfiguration | undefined; /** * A token to allow Object Lock to be enabled for an existing bucket. * @public */ Token?: string | undefined; /** * The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied). * @public */ ExpectedBucketOwner?: string | undefined; } /** * Container for Payer. * @public */ export interface RequestPaymentConfiguration { /** * Specifies who pays for the download and request fees. * @public */ Payer: Payer | undefined; } /** * @public */ export interface PutBucketRequestPaymentRequest { /** * The bucket name. * Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues * @public */ Bucket: string | undefined; /** * The Base64 encoded 128-bit <code>MD5</code> digest of the data. You must use this header as a message * integrity check to verify that the request body was not corrupted in transit. For more * information, see <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864</a>. * For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically. * @public */ ContentMD5?: string | undefined; /** * Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in * the Amazon S3 User Guide. * If you provide an individual checksum, Amazon S3 ignores any provided * <code>ChecksumAlgorithm</code> parameter. * @public */ ChecksumAlgorithm?: ChecksumAlgorithm | undefined; /** * Container for Payer. * @public */ RequestPaymentConfiguration: RequestPaymentConfiguration | undefined; /** * The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied). * @public */ ExpectedBucketOwner?: string | undefined; } /** * Container for <code>TagSet</code> elements. * @public */ export interface Tagging { /** * A collection for a set of tags * @public */ TagSet: Tag[] | undefined; } /** * @public */ export interface PutBucketTaggingRequest { /** * The bucket name. * Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues * @public */ Bucket: string | undefined; /** * The Base64 encoded 128-bit <code>MD5</code> digest of the data. You must use this header as a message * integrity check to verify that the request body was not corrupted in transit. For more * information, see <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864</a>. * For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically. * @public */ ContentMD5?: string | undefined; /** * Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in * the Amazon S3 User Guide. * If you provide an individual checksum, Amazon S3 ignores any provided * <code>ChecksumAlgorithm</code> parameter. * @public */ ChecksumAlgorithm?: ChecksumAlgorithm | undefined; /** * Container for the <code>TagSet</code> and <code>Tag</code> elements. * @public */ Tagging: Tagging | undefined; /** * The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied). * @public */ ExpectedBucketOwner?: string | undefined; } /** * @public * @enum */ export declare const MFADelete: { readonly Disabled: "Disabled"; readonly Enabled: "Enabled"; }; /** * @public */ export type MFADelete = (typeof MFADelete)[keyof typeof MFADelete]; /** * Describes the versioning state of an Amazon S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html">PUT * Bucket versioning</a> in the Amazon S3 API Reference. * @public */ export interface VersioningConfiguration { /** * Specifies whether MFA delete is enabled in the bucket versioning configuration. This * element is only returned if the bucket has been configured with MFA delete. If the bucket * has never been so configured, this element is not returned. * @public */ MFADelete?: MFADelete | undefined; /** * The versioning state of the bucket. * @public */ Status?: BucketVersioningStatus | undefined; } /** * @public */ export interface PutBucketVersioningRequest { /** * The bucket name. * Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues * @public */ Bucket: string | undefined; /** * >The Base64 encoded 128-bit <code>MD5</code> digest of the data. You must use this header as a * message integrity check to verify that the request body was not corrupted in transit. For * more information, see <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC * 1864</a>. * For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically. * @public */ ContentMD5?: string | undefined; /** * Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in * the Amazon S3 User Guide. * If you provide an individual checksum, Amazon S3 ignores any provided * <code>ChecksumAlgorithm</code> parameter. * @public */ ChecksumAlgorithm?: ChecksumAlgorithm | undefined; /** * The concatenation of the authentication device's serial number, a space, and the value * that is displayed on your authentication device. * @public */ MFA?: string | undefined; /** * Container for setting the versioning state. * @public */ VersioningConfiguration: VersioningConfiguration | undefined; /** * The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied). * @public */ ExpectedBucketOwner?: string | undefined; } /** * Specifies website configuration parameters for an Amazon S3 bucket. * @public */ export interface WebsiteConfiguration { /** * The name of the error document for the website. * @public */ ErrorDocument?: ErrorDocument | undefined; /** * The name of the index document for the website. * @public */ IndexDocument?: IndexDocument | undefined; /** * The redirect behavior for every request to this bucket's website endpoint. * <important> * If you specify this property, you can't specify any other property. * </important> * @public */ RedirectAllRequestsTo?: RedirectAllRequestsTo | undefined; /** * Rules that define when a redirect is applied and the redirect behavior. * @public */ RoutingRules?: RoutingRule[] | undefined; } /** * @public */ export interface PutBucketWebsiteRequest { /** * The bucket name. * Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues * @public */ Bucket: string | undefined; /** * The Base64 encoded 128-bit <code>MD5</code> digest of the data. You must use this header as a message * integrity check to verify that the request body was not corrupted in transit. For more * information, see <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864</a>. * For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically. * @public */ ContentMD5?: string | undefined; /** * Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in * the Amazon S3 User Guide. * If you provide an individual checksum, Amazon S3 ignores any provided * <code>ChecksumAlgorithm</code> parameter. * @public */ ChecksumAlgorithm?: ChecksumAlgorithm | undefined; /** * Container for the request. * @public */ WebsiteConfiguration: WebsiteConfiguration | undefined; /** * The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied). * @public */ ExpectedBucketOwner?: string | undefined; } /** * * The existing object was created with a different encryption type. * Subsequent write requests must include the appropriate encryption * parameters in the request or while creating the session. * * @public */ export declare class EncryptionTypeMismatch extends __BaseException { readonly name: "EncryptionTypeMismatch"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<EncryptionTypeMismatch, __BaseException>); } /** * You may receive this error in multiple cases. Depending on the reason for the error, you may receive one of the messages below: * <ul> * <li> * Cannot specify both a write offset value and user-defined object metadata for existing objects. * </li> * <li> * Checksum Type mismatch occurred, expected checksum Type: sha1, actual checksum Type: crc32c. * </li> * <li> * Request body cannot be empty when 'write offset' is specified. * </li> * </ul> * @public */ export declare class InvalidRequest extends __BaseException { readonly name: "InvalidRequest"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<InvalidRequest, __BaseException>); } /** * * The write offset value that you specified does not match the current object size. * * @public */ export declare class InvalidWriteOffset extends __BaseException { readonly name: "InvalidWriteOffset"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<InvalidWriteOffset, __BaseException>); } /** * @public */ export interface PutObjectOutput { /** * If the expiration is configured for the object (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a>) in the Amazon S3 User Guide, * the response includes this header. It includes the <code>expiry-date</code> and * <code>rule-id</code> key-value pairs that provide information about object expiration. * The value of the <code>rule-id</code> is URL-encoded. * <note> * Object expiration information is not returned in directory buckets and this header returns the value "<code>NotImplemented</code>" in all responses for directory buckets. * </note> * @public */ Expiration?: string | undefined; /** * Entity tag for the uploaded object. * * General purpose buckets - To ensure that data is not * corrupted traversing the network, for objects where the ETag is the MD5 digest of the * object, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned * ETag to the calculated MD5 value. * * Directory buckets - The ETag for the object in * a directory bucket isn't the MD5 digest of the object. * @public */ ETag?: string | undefined; /** * The Base64 encoded, 32-bit <code>CRC32 checksum</code> of the object. This checksum is only be present if the checksum was uploaded * with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated * with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> * Checking object integrity</a> in the Amazon S3 User Guide. * @public */ ChecksumCRC32?: string | undefined; /** * The Base64 encoded, 32-bit <code>CRC32C</code> checksum of the object. This checksum is only present if the checksum was uploaded * with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated * with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> * Checking object integrity</a> in the Amazon S3 User Guide. * @public */ ChecksumCRC32C?: string | undefined; /** * The Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the object. This header * is present if the object was uploaded with the <code>CRC64NVME</code> checksum algorithm, or if it * was uploaded without a checksum (and Amazon S3 added the default checksum, * <code>CRC64NVME</code>, to the uploaded object). For more information about how * checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity * in the Amazon S3 User Guide</a>. * @public */ ChecksumCRC64NVME?: string | undefined; /** * The Base64 encoded, 160-bit <code>SHA1</code> digest of the object. This will only be present if the object was uploaded * with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated * with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> * Checking object integrity</a> in the Amazon S3 User Guide. * @public */ ChecksumSHA1?: string | undefined; /** * The Base64 encoded, 256-bit <code>SHA256</code> digest of the object. This will only be present if the object was uploaded * with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated * with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> * Checking object integrity</a> in the Amazon S3 User Guide. * @public */ ChecksumSHA256?: string | undefined; /** * This header specifies the checksum type of the object, which determines how part-level * checksums are combined to create an object-level checksum for multipart objects. For * <code>PutObject</code> uploads, the checksum type is always <code>FULL_OBJECT</code>. You can use this header as a * data integrity check to verify that the checksum type that is receive